test: add ability to add setup steps to integration tests (#1346)

integration-tests/config/config.json

@@ -282,6 +282,17 @@
         "en/**/*.md"
       ],
       "commit": "165dc45bd31449019425b28b2ed48f78b02710a2"
+    },
+    {
+      "path": "streetsidesoftware/cspell-dicts",
+      "url": "https://github.com/streetsidesoftware/cspell-dicts.git",
+      "postCheckoutSteps": [
+        "yarn"
+      ],
+      "args": [
+        "**/*.*"
+      ],
+      "commit": "3e04648f52500fc5ffa4c4c02644ad07a10173be"
     }
   ]
 }

integration-tests/snapshots/streetsidesoftware/cspell-dicts/snapshot.txt

@@ -0,0 +1,10 @@
+
+Repository: streetsidesoftware/cspell-dicts
+Url: "https://github.com/streetsidesoftware/cspell-dicts.git"
+Args: ["**/*.*"]
+Lines:
+ CSpell: Files checked: 1047, Issues found: 3 in 2 files
+ exit code: 1
+./generator-cspell-dicts/README.md:20:1      - Unknown word (mkdir)      -- mkdir monkey
+./generator-cspell-dicts/package.json:23:6      - Unknown word (yosay)       -- "yosay": "^2.0.2"
+./generator-cspell-dicts/package.json:4:46      - Unknown word (subprojects) -- Generate cspell dictionary subprojects.",

integration-tests/src/check.ts

@@ -93,6 +93,11 @@ async function execCheck(context: CheckContext, update: boolean): Promise<CheckR
         return Promise.resolve({ success: false, rep, elapsedTime: 0 });
     }
     log(time());
+    if (!(await execPostCheckoutSteps(context))) {
+        logger.log('******** fail ********');
+        return Promise.resolve({ success: false, rep, elapsedTime: 0 });
+    }
+    log(time());
     const cspellResult = await execCommand(logger, path, cspellCommand, rep.args);
     log(resultReport(cspellResult));
     const r = checkResult(rep, cspellResult, update);
@@ -127,6 +132,22 @@ async function execCommand(logger: Logger, path: string, command: string, args:
     });
 }
 
+async function execPostCheckoutSteps(context: CheckContext) {
+    const { rep, logger } = context;
+    const path = Path.join(repositoryDir, rep.path);
+
+    const steps = rep.postCheckoutSteps || [];
+    for (const step of steps) {
+        logger.log(`Step: %j`, step);
+        const r = await execCommand(logger, path, step, []);
+        if (r.code !== 0) {
+            logger.error(r.stderr);
+            return false;
+        }
+    }
+    return true;
+}
+
 function resultReport(result: Result) {
     const fullOutputLines = formatExecOutput(result).split('\n');
     return (fullOutputLines.length > 7 ? '...\n' : '') + fullOutputLines.slice(-7).join('\n');

integration-tests/src/config.ts

@@ -41,11 +41,13 @@ export function addRepository(path: string, url: string, commit: string, branch:
     const entries = new Map<string, Repository>(config.repositories.map((r) => [r.path, r]));
     const existingEntry: Partial<Repository> = entries.get(path) || {};
     const args = existingEntry.args || ['**/*.*'];
+    const postCheckoutSteps = existingEntry.postCheckoutSteps;
 
     const entry: Repository = {
         ...existingEntry,
         path,
         url,
+        postCheckoutSteps,
         args,
         commit,
         branch,

integration-tests/src/configDef.ts

@@ -8,4 +8,5 @@ export interface Repository {
     branch: string | undefined;
     commit: string;
     args: string[];
+    postCheckoutSteps: string[] | undefined;
 }

integration-tests/src/repositoryHelper.test.ts

@@ -32,6 +32,7 @@ describe('Validate repository helper', () => {
             commit: '',
             branch: undefined,
             args: [],
+            postCheckoutSteps: undefined,
         }));
     });