Merge pull request #20 from storyprotocol/update-config

Update tests for the latest API version
storyprotocol · Apr 15, 2024 · bf52dc6 · bf52dc6
2 parents ebc9db8 + 3bc5772
commit bf52dc6
Show file tree

Hide file tree

Showing 36 changed files with 144 additions and 166 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -44,25 +44,23 @@ jobs:
         run: pnpm eslint .
         # Ensure you have a lint script in your package.json
 
-      - name: Run Tests On Seplia
+      - name: Run Tests On Sepolia
         continue-on-error: true
         run: |
           echo "Load environment variables" 
-          rm .env.sepolia && touch .env.sepolia
-          echo API_BASE_URL=${{ secrets.API_BASE_URL }} > .env.sepolia
-          echo API_PREFIX=${{ secrets.API_PREFIX_SEPOLIA }} >> .env.sepolia
-          echo API_KEY=${{ secrets.API_KEY }} >> .env.sepolia
+          rm .env && touch .env
+          echo API_BASE_URL=${{ secrets.API_BASE_URL }} > .env
+          echo API_KEY=${{ secrets.API_KEY }} >> .env
           test_env=sepolia npx playwright test
       
-      - name: Run Tests On Renaissance
+      - name: Run Tests On Story
         continue-on-error: true
         run: |
           echo "Load environment variables" 
-          rm .env.renaissance && touch .env.renaissance
-          echo API_BASE_URL=${{ secrets.API_BASE_URL }} > .env.renaissance
-          echo API_PREFIX=${{ secrets.API_PREFIX_RENAISSANCE }} >> .env.renaissance
-          echo API_KEY=${{ secrets.API_KEY }} >> .env.renaissance
-          test_env=renaissance npx playwright test
+          rm .env && touch .env
+          echo API_BASE_URL=${{ secrets.API_BASE_URL }} > .env
+          echo API_KEY=${{ secrets.API_KEY }} >> .env
+          test_env=story npx playwright test
 
       - name: Push Slack Notification
         uses: slackapi/[email protected]
@@ -106,6 +104,6 @@ jobs:
         uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
         # if: failure() && github.event_name == 'push' && github.ref == 'refs/heads/main'
         with:
-          name: renaissance-test-reports
+          name: story-test-reports
           path: |
-            ./playwright-report-renaissance/index.html
+            ./playwright-report-story/index.html
diff --git a/ci.env b/ci.env
@@ -1,3 +1,2 @@
-API_BASE_URL="https://edge.stg.storyprotocol.net"
+API_BASE_URL = "https://edge.stg.storyprotocol.net/api/v1/"
 API_KEY=#API_KEY#
-API_PREFIX="/api/sepolia/v1"
diff --git a/global-setup.ts b/global-setup.ts
diff --git a/playwright.config.ts b/playwright.config.ts
@@ -7,15 +7,14 @@ import { defineConfig } from '@playwright/test';
 import dotenv from 'dotenv';
 dotenv.config();
 
-const EnvName = process.env.test_env || '';
+const EnvName = process.env.test_env || 'story';
 
 /**
  * See https://playwright.dev/docs/test-configuration.
  */
 export default defineConfig({
   testDir: './tests',
   /* Run tests in files in parallel */
-  globalSetup: require.resolve('./global-setup'),
   fullyParallel: true,
   /* Fail the build on CI if you accidentally left test.only in the source code. */
   forbidOnly: !!process.env.CI,
@@ -49,6 +48,7 @@ export default defineConfig({
           // Add authorization token to all requests.
           // Assuming personal access token available in the environment.
           'X-API-Key': process.env.API_KEY || '',
+          'X-CHAIN': `${EnvName}`,
         },
       }
     },

diff --git a/tests/api/collections/collections.get.spec.ts b/tests/api/collections/collections.get.spec.ts
@@ -1,7 +1,6 @@
 import { test, expect } from "../fixtures/base";
-import { ApiPrefix } from "../../constants";
 
-const endpoint = ApiPrefix + "/collections";
+const endpoint = "./collections";
 
 test.describe("Get a Collection @Collections", async () => {
   test("Should return a Collection detail", async ({

diff --git a/tests/api/collections/collections.post.spec.ts b/tests/api/collections/collections.post.spec.ts
@@ -1,7 +1,6 @@
 import { test, expect } from "@playwright/test";
-import { ApiPrefix } from "../../constants";
 
-const endpoint = ApiPrefix + "/collections";
+const endpoint = "./collections";
 
 test.describe("List Collections @Collections", async () => {
   test("Should return default Collections list", async ({ request }) => {

diff --git a/tests/api/disputes/disputes.get.spec.ts b/tests/api/disputes/disputes.get.spec.ts
@@ -1,7 +1,6 @@
 import { test, expect } from "../fixtures/base";
-import { ApiPrefix } from "../../constants";
 
-const endpoint = ApiPrefix + "/disputes";
+const endpoint =  "./disputes";
 
 test.describe("Get a Dispute @Disputes", async () => {
   test("Should return the Dispute detail", async ({ request, disputes }) => {

diff --git a/tests/api/disputes/disputes.post.spec.ts b/tests/api/disputes/disputes.post.spec.ts
@@ -1,7 +1,6 @@
 import { test, expect } from "../fixtures/base";
-import { ApiPrefix } from "../../constants";
 
-const endpoint = ApiPrefix + "/disputes";
+const endpoint = "./disputes";
 
 test.describe("List Disputes @Disputes", async () => {
   test("Should return default Disputes list", async ({ request }) => {
@@ -32,7 +31,7 @@ test.describe("List Disputes @Disputes", async () => {
   for (const { pagination } of pageParams) {
     test(`Should return Disputes list with pagination ${JSON.stringify(
       pagination
-    )}`, async ({ request }) => {
+    )}`, async ({ request, disputes }) => {
       const payload = {
         options: { pagination: pagination },
       };
@@ -49,8 +48,10 @@ test.describe("List Disputes @Disputes", async () => {
 
       const { errors, data } = await response.json();
       expect(errors).toBeUndefined();
-      expect(data.length).toBe(pagination.limit);
-      expect(data[0]).toMatchObject(firstItem);
+      expect(data.length).toBeLessThanOrEqual(pagination.limit);
+      if (pagination.offset < disputes.length) {
+        expect(data[0]).toMatchObject(firstItem);
+      }
     });
   }
 
@@ -118,7 +119,7 @@ test.describe("List Disputes @Disputes", async () => {
   for (const { pagination, orderBy, orderDirection } of pageAndOrderParams) {
     test(`Should return Disputes list with pagination ${JSON.stringify(
       pagination
-    )} ordered by ${orderBy} ${orderDirection}`, async ({ request }) => {
+    )} ordered by ${orderBy} ${orderDirection}`, async ({ request, disputes }) => {
       const payload = {
         options: { pagination, orderBy, orderDirection },
       };
@@ -129,8 +130,10 @@ test.describe("List Disputes @Disputes", async () => {
 
       const { errors, data } = await response.json();
       expect(errors).toBeUndefined();
-      expect(data.length).toBeGreaterThan(0);
-      expect(data.length).toBe(pagination.limit);
+      if (pagination.offset < disputes.length) {
+        expect(data.length).toBeGreaterThan(0);
+      }
+      expect(data.length).toBeLessThanOrEqual(pagination.limit);
       for (let i = 0; i < data.length - 1; i++) {
         const item = data[i][orderBy].trim() || "\uFFFF";
         const nextItem = data[i + 1][orderBy].trim() || "\uFFFF";
@@ -151,7 +154,7 @@ test.describe("List Disputes @Disputes", async () => {
     const whereParams = [
       {
         where: {
-          targetTag: disputes[1].targetTag,
+          targetTag: disputes[0].targetTag,
         },
         exists: true,
       },
@@ -186,7 +189,7 @@ test.describe("List Disputes @Disputes", async () => {
         exists: false,
       },
       {
-        where: { initiator: disputes[1].initiator },
+        where: { initiator: disputes[0].initiator },
         exists: true,
       },
       {
@@ -195,8 +198,8 @@ test.describe("List Disputes @Disputes", async () => {
       },
       {
         where: {
-          targetTag: disputes[1].targetTag,
-          targetIpId: disputes[1].targetIpId,
+          targetTag: disputes[0].targetTag,
+          targetIpId: disputes[0].targetIpId,
         },
         exists: true,
       },
@@ -247,8 +250,8 @@ test.describe("List Disputes @Disputes", async () => {
         orderBy: "id",
         orderDirection: "desc",
         where: {
-          targetTag: disputes[1].targetTag,
-          initiator: disputes[1].initiator,
+          targetTag: disputes[0].targetTag,
+          initiator: disputes[0].initiator,
         },
       },
       {
@@ -277,7 +280,9 @@ test.describe("List Disputes @Disputes", async () => {
 
         const { errors, data } = await response.json();
         expect(errors).toBeUndefined();
-        expect(data.length).toBeGreaterThan(0);
+        if (p.pagination.offset < disputes.length) {
+          expect(data.length).toBeGreaterThan(0);
+        }
         expect(data.length).toBeLessThanOrEqual(p.pagination.limit);
         for (let i = 0; i < data.length - 1; i++) {
           const item = data[i][p.orderBy].trim() || "\uFFFF";

diff --git a/tests/api/fixtures/base.ts b/tests/api/fixtures/base.ts
@@ -1,5 +1,4 @@
 import { test as base } from "@playwright/test";
-import { ApiPrefix } from "../../constants";
 
 type TestOptions = {
   assets: Array<{
@@ -8,6 +7,9 @@ type TestOptions = {
     tokenId: string;
     metadataResolverAddress: string;
     tokenContract: string;
+    metadata: {
+      registrant: string;
+    }
   }>;
   disputes: Array<{
     id: string;
@@ -28,7 +30,7 @@ type TestOptions = {
   }>;
   licenses: Array<{
     id: string;
-    policyId: string;
+    licenseTermsId: string;
     licensorIpId: string;
     transferable: boolean;
   }>;
@@ -84,72 +86,72 @@ type TestOptions = {
 
 export const test = base.extend<TestOptions>({
   assets: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/assets");
+    const response = await request.post("./assets");
     const { data } = await response.json();
     await use(data);
   },
   disputes: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/disputes");
+    const response = await request.post("./disputes");
     const { data } = await response.json();
     await use(data);
   },
   collections: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/collections");
+    const response = await request.post("./collections");
     const { data } = await response.json();
     await use(data);
   },
   ipapolicies: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/ipapolicies");
+    const response = await request.post("./ipapolicies");
     const { data } = await response.json();
     await use(data);
   },
   licenses: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/licenses");
+    const response = await request.post("./licenses");
     const { data } = await response.json();
     await use(data);
   },
   licensesMintingfees: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/licenses/mintingfees");
+    const response = await request.post("./licenses/mintingfees");
     const { data } = await response.json();
     await use(data);
   },
   licensesOwners: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/licenses/owners");
+    const response = await request.post("./licenses/owners");
     const { data } = await response.json();
     await use(data);
   },
   modules: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/modules");
+    const response = await request.post("./modules");
     const { data } = await response.json();
     await use(data);
   },
   permissionsList: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/permissions");
+    const response = await request.post("./permissions");
     const { data } = await response.json();
     await use(data);
   },
   policies: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/policies");
+    const response = await request.post("./policies");
     const { data } = await response.json();
     await use(data);
   },
   policiesFrameworks: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/policies/frameworks");
+    const response = await request.post("./policies/frameworks");
     const { data } = await response.json();
     await use(data);
   },
   transactions: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/transactions");
+    const response = await request.post("./transactions");
     const { data } = await response.json();
     await use(data);
   },
   royaltiesPayments: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/royalties/payments");
+    const response = await request.post("./royalties/payments");
     const { data } = await response.json();
     await use(data);
   },
   royaltiesPolicies: async ({ request }, use) => {
-    const response = await request.post(ApiPrefix + "/royalties/policies");
+    const response = await request.post("./royalties/policies");
     const { data } = await response.json();
     await use(data);
   },