feat: add package dependency file to each test suite

Signed-off-by: Saw-jan <[email protected]>

Author: saw-jan

.drone.star

@@ -727,10 +727,8 @@ def e2eTests(ctx):
                      "environment": environment,
                      "commands": [
                          "cat %s/tests/drone/suites.env" % dir["web"],
-                         "source %s/tests/drone/suites.env || true" % dir["web"],
+                         ". %s/tests/drone/suites.env || true" % dir["web"],
                          "cd tests/e2e",
-                         "echo $TEST_SUITES",
-                         "echo $FEATURE_FILES",
                          "bash run-e2e.sh",
                      ],
                  }] + \

tests/drone/filterTestSuitesToRun.js

@@ -7,60 +7,68 @@ const targetBranch = process.env.DRONE_TARGET_BRANCH || 'master'
 // INFO: 1 and 2 elements are node and script name respectively
 const scriptDir = path.dirname(process.argv[1])
 const suitesToCheck = process.argv[2]
+  .split(',')
+  .map((suite) => suite.trim())
+  .filter((suite) => suite)
 
-const pacToTests = {
-  'web-app-activities': [],
-  'web-app-admin-settings': ['admin-settings', 'keycloak', 'smoke', 'user-settings'],
-  'web-app-app-store': ['app-store'],
-  'web-app-epub-reader': [],
-  'web-app-external': ['app-provider'],
-  'web-app-files': [
-    'a11y',
-    'admin-settings',
-    'app-provider',
-    'app-store',
-    'file-action',
-    'journeys',
-    'keycloak',
-    'navigation',
-    'ocm',
-    'oidc',
-    'search',
-    'shares',
-    'smoke',
-    'spaces',
-    'user-settings'
-  ],
-  'web-app-ocm': ['ocm'],
-  'web-app-password-protected-folders': ['file-action'],
-  'web-app-pdf-viewer': [],
-  'web-app-preview': ['spaces', 'shares', 'file-action', 'navigation', 'ocm'],
-  'web-app-search': [
-    'a11y',
-    'admin-settings',
-    'app-provider',
-    'app-store',
-    'file-action',
-    'journeys',
-    'keycloak',
-    'navigation',
-    'ocm',
-    'oidc',
-    'search',
-    'shares',
-    'smoke',
-    'spaces',
-    'user-settings'
-  ],
-  'web-app-text-editor': ['keycloak', 'oidc'],
-  'web-app-webfinger': []
-}
+// list of test suites with dependent packages
+// Example:
+// {
+//   'web-app-ocm': ['ocm'],
+//   'web-app-search': ['search']
+// }
+const packageToTestSuiteMap = {}
+
+/*
+--------------------
+ web packages
+--------------------
+ */
+const excludePackages = ['web-container', 'web-test-helpers']
+// default packages that affect all test suites
+const defaultPackages = ['web-client', 'web-runtime', 'web-pkg']
+const packagesDir = `${scriptDir}/../../packages`
+const allWebPackages = fs
+  .readdirSync(packagesDir)
+  .filter(
+    (entry) =>
+      entry.startsWith('web-') &&
+      fs.statSync(path.join(packagesDir, entry)).isDirectory() &&
+      !excludePackages.includes(entry)
+  )
 
-// get test suites
+/*
+--------------------
+ test suites
+--------------------
+ */
 const testSuitesDir = `${scriptDir}/../e2e/cucumber/features`
-const testSuites = fs
-  .readdirSync(testSuitesDir)
-  .filter((entry) => fs.statSync(path.join(testSuitesDir, entry)).isDirectory())
+const testSuites = fs.readdirSync(testSuitesDir).filter((entry) => {
+  if (!fs.statSync(path.join(testSuitesDir, entry)).isDirectory()) {
+    return false
+  }
+  const webPackagesFile = path.join(testSuitesDir, entry, 'web-packages.txt')
+  if (fs.existsSync(webPackagesFile)) {
+    const content = fs.readFileSync(webPackagesFile, 'utf-8')
+    const depPackages = content.split('\n').filter((line) => line && line.startsWith('web-'))
+    if (depPackages.length) {
+      depPackages.forEach((pkg) => {
+        if (!(pkg in packageToTestSuiteMap)) {
+          packageToTestSuiteMap[pkg] = []
+        }
+        !packageToTestSuiteMap[pkg].includes(entry) && packageToTestSuiteMap[pkg].push(entry)
+      })
+      return true
+    }
+  }
+  allWebPackages.forEach((pkg) => {
+    if (!(pkg in packageToTestSuiteMap)) {
+      packageToTestSuiteMap[pkg] = []
+    }
+    !packageToTestSuiteMap[pkg].includes(entry) && packageToTestSuiteMap[pkg].push(entry)
+  })
+  return true
+})
 
 function getChangedFiles() {
   const changedFiles = execSync(`git diff --name-only origin/${targetBranch} HEAD`).toString()
@@ -72,7 +80,7 @@ function getPackageFromFile(file) {
   if (!file.startsWith('packages/')) {
     return
   }
-  const packages = Object.keys(pacToTests)
+  const packages = Object.keys(packageToTestSuiteMap)
   for (const pkg of packages) {
     if (file.startsWith(`packages/${pkg}`)) {
       return pkg
@@ -83,6 +91,7 @@ function getPackageFromFile(file) {
 function getAffectedTestSuites(changedFiles) {
   const affectedSuites = new Set()
   for (const file of changedFiles) {
+    // run all test suites if changes are in the following paths
     if (
       file.startsWith('tests/e2e/') ||
       file.startsWith('tests/drone/') ||
@@ -93,14 +102,16 @@ function getAffectedTestSuites(changedFiles) {
       return testSuites
     }
     const packageName = getPackageFromFile(file)
-    if (packageName && packageName in pacToTests) {
-      pacToTests[packageName].forEach((suite) => affectedSuites.add(suite))
+    if (packageName && packageName in packageToTestSuiteMap) {
+      packageToTestSuiteMap[packageName].forEach((suite) => affectedSuites.add(suite))
     }
   }
   return Array.from(affectedSuites)
 }
 
 function createSuitesToRunEnvFile(suites = []) {
+  console.log('[INFO] Provided test suites/features:\n  - ' + suitesToCheck.join('\n  - '))
+  console.log('[INFO] Test suites/features to run:\n  - ' + suites.join('\n  - '))
   const envContent = ['TEST_SUITES', suites.join(',')]
   if (suites[0].startsWith('cucumber/')) {
     envContent[0] = ['FEATURE_FILES']
@@ -117,11 +128,11 @@ function main() {
   }
   const affectedTestSuites = getAffectedTestSuites(changedFiles)
   if (affectedTestSuites.length === 0) {
-    console.log('[INFO] No affected test suites to run.')
+    console.log('[INFO] No affected test suites/features to run.')
     process.exit(78) // Skip the pipeline
   }
-  if (suitesToCheck) {
-    const suitesToRun = suitesToCheck.split(',').filter((suite) => {
+  if (suitesToCheck.length) {
+    const suitesToRun = suitesToCheck.filter((suite) => {
       suite = suite.trim()
       if (suite.startsWith('cucumber/')) {
         suite = suite.replace('cucumber/features/', '').split('/').shift()
@@ -130,8 +141,8 @@ function main() {
     })
     if (suitesToRun.length === 0) {
       console.log(
-        '[INFO] The following test suites are not affected and will be skipped:',
-        suitesToCheck.split(',').join('\n')
+        '[INFO] The following test suites/features are not affected and will be skipped:\n  - ',
+        suitesToCheck.join('\n  - ')
       )
       process.exit(78) // Skip the pipeline
     }

tests/e2e/cucumber/features/admin-settings/web-packages.txt

@@ -0,0 +1,4 @@
+# FOR CI ONLY
+# Run the test suite only if the changes are in the following packages: 
+
+web-app-admin-settings

tests/e2e/cucumber/features/app-provider/web-packages.txt

@@ -0,0 +1,5 @@
+# FOR CI ONLY
+# Run the test suite only if the changes are in the following packages: 
+
+web-app-external
+web-app-files

tests/e2e/cucumber/features/app-store/web-packages.txt

@@ -0,0 +1,4 @@
+# FOR CI ONLY
+# Run the test suite only if the changes are in the following packages: 
+
+web-app-app-store

tests/e2e/cucumber/features/file-action/web-packages.txt

@@ -0,0 +1,5 @@
+# FOR CI ONLY
+# Run the test suite only if the changes are in the following packages: 
+
+web-app-files
+web-app-preview

tests/e2e/cucumber/features/ocm/web-packages.txt

@@ -0,0 +1,4 @@
+# FOR CI ONLY
+# Run the test suite only if the changes are in the following packages: 
+
+web-app-ocm