Merge pull request #2541 from Tyriar/2539

Skip puppeteer download on unit test runs, fix windows tests, polish pipeline

azure-pipelines.yml

@@ -7,6 +7,8 @@ jobs:
 - job: Linux
   pool:
     vmImage: 'ubuntu-16.04'
+  variables:
+    PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 1
   steps:
   - task: NodeTool@0
     inputs:
@@ -16,38 +18,39 @@ jobs:
     inputs:
       versionSpec: '1.x'
     displayName: 'Install Yarn'
-  - script: yarn
+  - task: CacheBeta@1
+    inputs:
+      key: yarn2 | $(Agent.OS) | yarn.lock
+      path: node_modules
+    displayName: Cache node modules
+  - script: yarn --frozen-lockfile
     displayName: 'Install dependencies and build'
-  - script: yarn test-unit --forbid-only
+  - script: yarn test-unit-coverage --forbid-only
     displayName: 'Unit tests'
   - script: yarn lint
     displayName: 'Lint'
-  - script: |
-      NODE_PATH=$(pwd)/out ./node_modules/.bin/nyc ./node_modules/.bin/mocha './out/*test.js' './out/**/*test.js'
-      ./node_modules/.bin/nyc report --reporter=cobertura
-    displayName: 'Coverage report'
   - task: PublishCodeCoverageResults@1
     inputs:
       codeCoverageTool: Cobertura
       summaryFileLocation: '$(System.DefaultWorkingDirectory)/**/*coverage.xml'
     displayName: 'Publish coverage'
-  - task: mspremier.BuildQualityChecks.QualityChecks-task.BuildQualityChecks@6
-    displayName: 'Check build quality'
-    inputs:
-      checkCoverage: true
-      coverageType: lines
-      coverageThreshold: 60
-      coverageFailOption: fixed
 
 - job: macOS
   pool:
     vmImage: 'xcode9-macos10.13'
+  variables:
+    PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 1
   steps:
   - task: NodeTool@0
     inputs:
       versionSpec: '8.x'
     displayName: 'Install Node.js'
-  - script: yarn
+  - task: CacheBeta@1
+    inputs:
+      key: yarn2 | $(Agent.OS) | yarn.lock
+      path: node_modules
+    displayName: Cache node modules
+  - script: yarn --frozen-lockfile
     displayName: 'Install dependencies and build'
   - script: yarn test-unit --forbid-only
     displayName: 'Unit tests'
@@ -57,12 +60,19 @@ jobs:
 - job: Windows
   pool:
     vmImage: 'vs2017-win2016'
+  variables:
+    PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 1
   steps:
   - task: NodeTool@0
     inputs:
       versionSpec: '8.x'
     displayName: 'Install Node.js'
-  - script: yarn
+  - task: CacheBeta@1
+    inputs:
+      key: yarn2 | $(Agent.OS) | yarn.lock
+      path: node_modules
+    displayName: Cache node modules
+  - script: yarn --frozen-lockfile
     displayName: 'Install dependencies and build'
   - script: yarn test-unit --forbid-only
     displayName: 'Unit tests'
@@ -77,12 +87,19 @@ jobs:
     inputs:
       versionSpec: '8.x'
     displayName: 'Install Node.js'
+  - task: CacheBeta@1
+    inputs:
+      key: yarn_puppeteer | $(Agent.OS) | yarn.lock
+      path: node_modules
+    displayName: Cache node modules
   - task: YarnInstaller@3
     inputs:
       versionSpec: '1.x'
     displayName: 'Install Yarn'
-  - script: yarn
+  - script: yarn --frozen-lockfile
     displayName: 'Install dependencies and build'
+  - script: yarn add puppeteer
+    displayName: 'Install puppeteer'
   - script: |
       yarn start &
       sleep 10
@@ -97,8 +114,10 @@ jobs:
     inputs:
       versionSpec: '8.x'
     displayName: 'Install Node.js'
-  - script: yarn
+  - script: yarn --frozen-lockfile
     displayName: 'Install dependencies and build'
+  - script: yarn add puppeteer
+    displayName: 'Install puppeteer'
   - script: |
       yarn start &
       sleep 10
@@ -124,7 +143,7 @@ jobs:
     inputs:
       versionSpec: '1.x'
     displayName: 'Install Yarn'
-  - script: yarn
+  - script: yarn --frozen-lockfile
     displayName: 'Install dependencies and build'
   - script: NPM_AUTH_TOKEN="$(NPM_AUTH_TOKEN)" node ./bin/publish.js
     displayName: 'Package and publish to npm'

bin/test.js

@@ -6,6 +6,8 @@
 const cp = require('child_process');
 const path = require('path');
 
+const COVERAGE_LINES_THRESHOLD = 60;
+
 // Add `out` to the NODE_PATH so absolute paths can be resolved.
 const env = { ...process.env };
 env.NODE_PATH = path.resolve(__dirname, '../out');
@@ -28,8 +30,28 @@ if (process.argv.length > 2) {
   }
 }
 
+const checkCoverage = flagArgs.indexOf('--coverage') >= 0;
+
+if (checkCoverage) {
+  flagArgs.splice(flagArgs.indexOf('--coverage'), 1);
+  const executable = npmBinScript('nyc');
+  const args = ['--check-coverage', `--lines=${COVERAGE_LINES_THRESHOLD}`, npmBinScript('mocha'), ...testFiles, ...flagArgs];
+  console.info('executable', executable);
+  console.info('args', args);
+  const run = cp.spawnSync(
+    executable,
+    args,
+    {
+      cwd: path.resolve(__dirname, '..'),
+      env,
+      stdio: 'inherit'
+    }
+  );
+  process.exit(run.status);
+}
+
 const run = cp.spawnSync(
-  path.resolve(__dirname, '../node_modules/.bin/mocha'),
+  npmBinScript('mocha'),
   [...testFiles, ...flagArgs],
   {
     cwd: path.resolve(__dirname, '..'),
@@ -38,4 +60,8 @@ const run = cp.spawnSync(
   }
 );
 
+function npmBinScript(script) {
+  return path.resolve(__dirname, `../node_modules/.bin/` + (process.platform === 'win32' ? `${script}.cmd` : script));
+}
+
 process.exit(run.status);

package.json

@@ -16,6 +16,7 @@
     "posttest": "npm run lint",
     "test-api": "mocha \"**/*.api.js\"",
     "test-unit": "node ./bin/test.js",
+    "test-unit-coverage": "node ./bin/test.js --coverage",
     "build": "tsc -b ./tsconfig.all.json",
     "prepare": "npm run setup",
     "setup": "npm run build",

src/Terminal2.test.ts

@@ -34,7 +34,6 @@ if (os.platform() === 'darwin') {
 // filter skipFilenames
 const FILES = TESTFILES.filter(value => SKIP_FILES.indexOf(value.split('/').slice(-1)[0]) === -1);
 
-
 describe('Escape Sequence Files', function(): void {
   this.timeout(1000);
 
@@ -44,6 +43,9 @@ describe('Escape Sequence Files', function(): void {
   let customHandler: IDisposable | undefined;
 
   before(() => {
+    if (process.platform === 'win32') {
+      return;
+    }
     ptyTerm = (pty as any).open({cols: COLS, rows: ROWS});
     slaveEnd = ptyTerm._slave;
     term = new Terminal({cols: COLS, rows: ROWS});
@@ -51,12 +53,15 @@ describe('Escape Sequence Files', function(): void {
   });
 
   after(() => {
+    if (process.platform === 'win32') {
+      return;
+    }
     ptyTerm._master.end();
     ptyTerm._master.destroy();
   });
 
   FILES.forEach(filename => {
-    it(filename.split('/').slice(-1)[0], async () => {
+    (process.platform === 'win32' ? it.skip : it)(filename.split('/').slice(-1)[0], async () => {
       // reset terminal and handler
       if (customHandler) {
         customHandler.dispose();