fix: improve test reliability and cleanup logic

AniketDev7 · AniketDev7 · commit 1397d9b0a209 · 2026-01-23T21:06:14.000+05:30
- Fix publish rules to use correct SDK method (workflow().publishRule())
- Make workflow, asset, and release tests self-contained by creating temp environments if needed
- Increase timeouts for global field and asset tests
- Preserve user-created management tokens in cleanup (only delete test-created ones)
- Improve webhook cleanup with sequential deletion and logging
- Use shorter environment names (max 10 chars)
diff --git a/test/sanity-check/api/asset-test.js b/test/sanity-check/api/asset-test.js
@@ -385,7 +385,7 @@ describe('Asset API Tests', () => {
     let publishEnvironment = null
 
     before(async function () {
-      this.timeout(30000)
+      this.timeout(60000)
       
       // Get environment name from testData (created by environment-test.js)
       if (testData.environments && testData.environments.development) {
@@ -403,8 +403,26 @@ describe('Asset API Tests', () => {
         }
       }
       
+      // If no environment exists, create a temporary one for publishing
       if (!publishEnvironment) {
-        console.log('No environment available for publish tests')
+        try {
+          const tempEnvName = `pub_${Math.random().toString(36).substring(2, 7)}`
+          const envResponse = await stack.environment().create({
+            environment: {
+              name: tempEnvName,
+              urls: [{ locale: 'en-us', url: 'https://publish-test.example.com' }]
+            }
+          })
+          publishEnvironment = envResponse.name || tempEnvName
+          console.log(`Asset Publishing created temporary environment: ${publishEnvironment}`)
+          await wait(2000)
+        } catch (e) {
+          console.log('Could not create environment for publishing:', e.message)
+        }
+      }
+      
+      if (!publishEnvironment) {
+        console.log('No environment available for publish tests - will skip')
         return
       }
       
@@ -482,7 +500,7 @@ describe('Asset API Tests', () => {
     let versionedAssetUid
 
     before(async function () {
-      this.timeout(30000)
+      this.timeout(60000)
       // SDK returns the asset object directly
       const asset = await stack.asset().create({
         upload: assetPath,
@@ -495,7 +513,8 @@ describe('Asset API Tests', () => {
       // NOTE: Deletion removed - assets persist for other tests
     })
 
-    it('should increment version on update', async () => {
+    it('should increment version on update', async function () {
+      this.timeout(30000)
       const asset = await stack.asset(versionedAssetUid).fetch()
       const currentVersion = asset._version || 1
 
diff --git a/test/sanity-check/api/globalfield-test.js b/test/sanity-check/api/globalfield-test.js
@@ -53,7 +53,7 @@ describe('Global Field API Tests', () => {
     })
 
     it('should create a simple global field', async function () {
-      this.timeout(30000)
+      this.timeout(60000)
       const gfData = JSON.parse(JSON.stringify(seoGlobalField))
       gfData.global_field.uid = seoGfUid
       gfData.global_field.title = `SEO ${Date.now()}`
diff --git a/test/sanity-check/api/release-test.js b/test/sanity-check/api/release-test.js
@@ -266,23 +266,43 @@ describe('Release API Tests', () => {
     let deployEnvironment = null
 
     before(async function () {
-      this.timeout(30000)
+      this.timeout(60000)
       
       // Get environment name from testData or query
       if (testData.environments && testData.environments.development) {
         deployEnvironment = testData.environments.development.name
+        console.log(`Release Deployment using environment from testData: ${deployEnvironment}`)
       } else {
         try {
           const envResponse = await stack.environment().query().find()
           const environments = envResponse.items || envResponse.environments || []
           if (environments.length > 0) {
             deployEnvironment = environments[0].name
+            console.log(`Release Deployment using existing environment: ${deployEnvironment}`)
           }
         } catch (e) {
           console.log('Could not fetch environments:', e.message)
         }
       }
       
+      // If no environment exists, create a temporary one for deployment
+      if (!deployEnvironment) {
+        try {
+          const tempEnvName = `dep_${Math.random().toString(36).substring(2, 7)}`
+          const envResponse = await stack.environment().create({
+            environment: {
+              name: tempEnvName,
+              urls: [{ locale: 'en-us', url: 'https://deploy-test.example.com' }]
+            }
+          })
+          deployEnvironment = envResponse.name || tempEnvName
+          console.log(`Release Deployment created temporary environment: ${deployEnvironment}`)
+          await wait(2000)
+        } catch (e) {
+          console.log('Could not create environment for deployment:', e.message)
+        }
+      }
+      
       const releaseData = {
         release: {
           name: `Deploy Test Release ${Date.now()}`,
diff --git a/test/sanity-check/api/workflow-test.js b/test/sanity-check/api/workflow-test.js
@@ -211,23 +211,43 @@ describe('Workflow API Tests', () => {
     let ruleEnvironment = null
 
     before(async function () {
-      this.timeout(30000)
+      this.timeout(60000)
       
       // Get environment name from testData or query
       if (testData.environments && testData.environments.development) {
         ruleEnvironment = testData.environments.development.name
+        console.log(`Publish Rules using environment from testData: ${ruleEnvironment}`)
       } else {
         try {
           const envResponse = await stack.environment().query().find()
           const environments = envResponse.items || envResponse.environments || []
           if (environments.length > 0) {
             ruleEnvironment = environments[0].name
+            console.log(`Publish Rules using existing environment: ${ruleEnvironment}`)
           }
         } catch (e) {
           console.log('Could not fetch environments:', e.message)
         }
       }
       
+      // If no environment exists, create a temporary one for publish rules
+      if (!ruleEnvironment) {
+        try {
+          const tempEnvName = `wf_${Math.random().toString(36).substring(2, 7)}`
+          const envResponse = await stack.environment().create({
+            environment: {
+              name: tempEnvName,
+              urls: [{ locale: 'en-us', url: 'https://workflow-test.example.com' }]
+            }
+          })
+          ruleEnvironment = envResponse.name || tempEnvName
+          console.log(`Publish Rules created temporary environment: ${ruleEnvironment}`)
+          await wait(2000)
+        } catch (e) {
+          console.log('Could not create environment for publish rules:', e.message)
+        }
+      }
+      
       // Try to use existing workflow from testData instead of creating new one
       // This avoids "Workflow already exists for all content types" error
       if (testData.workflows && testData.workflows.simple && testData.workflows.simple.uid) {
@@ -294,6 +314,12 @@ describe('Workflow API Tests', () => {
         return
       }
       
+      if (!workflowForRulesUid) {
+        console.log('Skipping - no workflow available for publish rule')
+        this.skip()
+        return
+      }
+      
       try {
         const ruleData = {
           publishing_rule: {
@@ -306,12 +332,16 @@ describe('Workflow API Tests', () => {
           }
         }
 
-        const response = await stack.workflow(workflowForRulesUid).publishRule().create(ruleData)
+        // Note: publishRule() is on workflow() collection, not on workflow(uid)
+        const response = await stack.workflow().publishRule().create(ruleData)
 
         expect(response).to.be.an('object')
         if (response.publishing_rule) {
           publishRuleUid = response.publishing_rule.uid
           testData.workflows.publishRule = response.publishing_rule
+        } else if (response.uid) {
+          publishRuleUid = response.uid
+          testData.workflows.publishRule = response
         }
       } catch (error) {
         // Publish rules might require specific environment
@@ -322,7 +352,8 @@ describe('Workflow API Tests', () => {
 
     it('should fetch all publish rules', async () => {
       try {
-        const response = await stack.workflow(workflowForRulesUid).publishRule().fetchAll()
+        // Note: publishRule() is on workflow() collection, not on workflow(uid)
+        const response = await stack.workflow().publishRule().fetchAll()
 
         expect(response).to.be.an('object')
       } catch (error) {
diff --git a/test/sanity-check/utility/testSetup.js b/test/sanity-check/utility/testSetup.js
@@ -336,10 +336,19 @@ export async function cleanupStack() {
     // 11. Delete Webhooks
     console.log('   Deleting webhooks...')
     const whData = await apiGet('/webhooks')
-    if (whData?.webhooks) {
-      await Promise.all(whData.webhooks.map(async (wh) => {
-        if (await apiDelete(`/webhooks/${wh.uid}`)) results.webhooks++
-      }))
+    if (whData?.webhooks && whData.webhooks.length > 0) {
+      console.log(`      Found ${whData.webhooks.length} webhooks to delete`)
+      for (const wh of whData.webhooks) {
+        // Webhooks require sequential deletion
+        const deleted = await apiDelete(`/webhooks/${wh.uid}`)
+        if (deleted) {
+          results.webhooks++
+          console.log(`      Deleted webhook: ${wh.uid}`)
+        }
+        await new Promise(r => setTimeout(r, 500)) // Small delay between deletions
+      }
+    } else {
+      console.log('      No webhooks found to delete')
     }
     
     // 12. Delete Delivery Tokens
@@ -351,12 +360,27 @@ export async function cleanupStack() {
       }))
     }
     
-    // 13. Delete Management Tokens
-    console.log('   Deleting management tokens...')
+    // 13. Delete Management Tokens (only test-created ones, preserve user tokens)
+    console.log('   Deleting management tokens (only test-created)...')
     const mtData = await apiGet('/stacks/management_tokens')
     if (mtData?.tokens) {
       await Promise.all(mtData.tokens.map(async (token) => {
-        if (await apiDelete(`/stacks/management_tokens/${token.uid}`)) results.managementTokens++
+        // Only delete tokens created by test suite (identified by naming pattern)
+        // Preserve user-created tokens like those used for MANAGEMENT_TOKEN env
+        const isTestCreatedToken = token.name && (
+          token.name.includes('Bulk Job Status Token') ||
+          token.name.includes('Test Token') ||
+          token.name.includes('test_') ||
+          token.name.startsWith('mgmt_')
+        )
+        if (isTestCreatedToken) {
+          if (await apiDelete(`/stacks/management_tokens/${token.uid}`)) {
+            results.managementTokens++
+            console.log(`      Deleted test token: ${token.name}`)
+          }
+        } else {
+          console.log(`      Preserved user token: ${token.name}`)
+        }
       }))
     }
     
