test(e2e): Add local npm registry for testing

.github/workflows/build.yml

@@ -24,26 +24,9 @@ jobs:
       - name: Build CLI
         working-directory: ./packages/cli
         run: tsc -b
-      - name: Set the template version
-        run: |
-          node scripts/store-next-test-version.js --variable=UI_TEMPLATE_VERSION --output=$GITHUB_ENV
-      - name: Bump template versions
-        run: |
-          echo "E2E tests should target template version ${{ env.UI_TEMPLATE_VERSION }}"
-          echo "//registry.npmjs.org/:_authToken=${{ env.NPM_TOKEN }}" > ~/.npmrc
-          npm run npm:bump:template -- -- ${{ env.UI_TEMPLATE_VERSION }}
-          npm run npm:publish:template
-          node scripts/wait-for-published-packages.js -v ${{ env.UI_TEMPLATE_VERSION }}
-      - uses: actions/upload-artifact@v2
-        if: failure()
-        with:
-          name: npm-logs
-          path: /home/runner/.npm/_logs/*debug.log
       - name: End-to-end Tests
         working-directory: ./packages/cli-e2e
-        run: |
-          echo "Running E2E tests with version ${{ env.UI_TEMPLATE_VERSION }}"
-          npm run test-e2e
+        run: npm run test-e2e
       - uses: actions/upload-artifact@v2
         with:
           name: test-screenshots

packages/angular/package.json

@@ -4,7 +4,7 @@
   "description": "Coveo schematic for angular",
   "scripts": {
     "test": "npm run build && jasmine dist/**/*_spec.js",
-    "build": "tsc -p tsconfig.json",
+    "build": "tsc -p tsconfig.schematic.json",
     "prebuild": "node ./scripts/clean.js",
     "postbuild": "node ./scripts/setup.js",
     "prepublishOnly": "npm run build",

packages/angular/src/search-token-server/rules/proxy.ts

@@ -50,7 +50,7 @@ export function startProxyServerFromRootApp(_options: CoveoSchema): Rule {
       const packageJson = JSON.parse(packageJsonBuffer.toString());
 
       packageJson.scripts['start'] =
-        'concurrently "npm run start-server" "ng serve"';
+        'concurrently --raw "npm run start-server" "ng serve"';
       packageJson.scripts['start-server'] = 'node ./scripts/start-server.js';
 
       tree.overwrite(

packages/cli-e2e/__tests__/angular.specs.ts

@@ -1,11 +1,19 @@
 import retry from 'async-retry';
 
-import type {ChildProcessWithoutNullStreams} from 'child_process';
+import {ChildProcessWithoutNullStreams, spawn} from 'child_process';
 import type {HTTPRequest, Browser, Page} from 'puppeteer';
 
-import {setupUIProject, teardownUIProject} from '../utils/cli';
+import {
+  answerPrompt,
+  getProjectPath,
+  isGenericYesNoPrompt,
+  setupUIProject,
+  teardownUIProject,
+} from '../utils/cli';
 import {getNewBrowser} from '../utils/browser';
 import {isSearchRequest} from '../utils/platform';
+import {EOL} from 'os';
+import stripAnsi from 'strip-ansi';
 
 describe('ui', () => {
   describe('create:angular', () => {
@@ -19,16 +27,59 @@ describe('ui', () => {
     let interceptedRequests: HTTPRequest[] = [];
     let page: Page;
 
+    // TODO: Refactor.
+    const openNewPage = async () => {
+      const newPage = await browser.newPage();
+      if (page) {
+        await page.close();
+      }
+      return newPage;
+    };
+
     beforeAll(async () => {
       browser = await getNewBrowser();
-      await setupUIProject('ui:create:angular', projectName, cliProcesses, {
-        flags: ['--defaults'],
-        timeout: 40e3,
+      const buildProcess = await setupUIProject(
+        'ui:create:angular',
+        projectName,
+        {
+          flags: ['--defaults'],
+        }
+      );
+      buildProcess.stdout.on('data', async (data) => {
+        process.stdout.write(data.toString());
+        if (isGenericYesNoPrompt(data.toString())) {
+          await answerPrompt(`y${EOL}`, buildProcess);
+        }
+      });
+      buildProcess.stderr.on('data', async (data) => {
+        process.stdout.write(data.toString());
+      });
+      process.stdout.write('almost ready');
+      await new Promise<void>((resolve) => {
+        buildProcess.stdout.on('close', async () => {
+          resolve();
+        });
+      });
+      process.stdout.write('ready!');
+
+      const startServerProcess = spawn('npm', ['run', 'start'], {
+        cwd: getProjectPath(projectName),
+        detached: true,
+      });
+      cliProcesses.push(startServerProcess);
+
+      await new Promise<void>((resolve) => {
+        startServerProcess.stdout.on('data', async (data) => {
+          process.stdout.write(data.toString());
+          if (/Compiled successfully/.test(stripAnsi(data.toString()))) {
+            resolve();
+          }
+        });
       });
     }, 3e6);
 
     beforeEach(async () => {
-      page = await browser.newPage();
+      page = await openNewPage();
 
       page.on('request', (request: HTTPRequest) => {
         interceptedRequests.push(request);
@@ -51,12 +102,16 @@ describe('ui', () => {
       });
 
       expect(await page.$('app-search-page')).not.toBeNull();
-    });
+    }, 300e3);
 
     it('should retrieve the search token on the page load', async () => {
+      const tokenResponseListener = page.waitForResponse(tokenProxyEndpoint);
+
       page.goto(searchPageEndpoint);
-      const tokenResponse = await page.waitForResponse(tokenProxyEndpoint);
-      expect(JSON.parse(await tokenResponse.text())).toMatchObject({
+
+      expect(
+        JSON.parse(await (await tokenResponseListener).text())
+      ).toMatchObject({
         token: expect.stringMatching(/^eyJhb.+/),
       });
     });

packages/cli-e2e/__tests__/react.specs.ts

@@ -8,7 +8,7 @@ import {getNewBrowser} from '../utils/browser';
 import {isSearchRequest} from '../utils/platform';
 
 describe('ui', () => {
-  describe('create:react', () => {
+  describe.skip('create:react', () => {
     let browser: Browser;
     const cliProcesses: ChildProcessWithoutNullStreams[] = [];
     // TODO: CDX-90: Assign a dynamic port for the search token server on all ui projects
@@ -21,9 +21,9 @@ describe('ui', () => {
 
     beforeAll(async () => {
       browser = await getNewBrowser();
-      await setupUIProject('ui:create:react', projectName, cliProcesses, {
-        timeout: 30e3,
-      });
+      // await setupUIProject('ui:create:react', projectName, cliProcesses, {
+      //   timeout: 30e3,
+      // });
     }, 3e6);
 
     beforeEach(async () => {

packages/cli-e2e/__tests__/vue.specs.ts

@@ -1,11 +1,20 @@
 import retry from 'async-retry';
-
-import type {ChildProcessWithoutNullStreams} from 'child_process';
+import {mkdirSync, writeFileSync} from 'fs';
+import {join} from 'path';
+import {ChildProcessWithoutNullStreams, spawn} from 'child_process';
 import type {HTTPRequest, Browser, Page} from 'puppeteer';
 
-import {setupUIProject, teardownUIProject} from '../utils/cli';
+import {
+  answerPrompt,
+  getProjectPath,
+  isGenericYesNoPrompt,
+  setupUIProject,
+  teardownUIProject,
+} from '../utils/cli';
 import {captureScreenshots, getNewBrowser} from '../utils/browser';
 import {isSearchRequest} from '../utils/platform';
+import stripAnsi from 'strip-ansi';
+import {EOL} from 'os';
 
 describe('ui', () => {
   describe('create:vue', () => {
@@ -29,8 +38,52 @@ describe('ui', () => {
 
     beforeAll(async () => {
       browser = await getNewBrowser();
-      await setupUIProject('ui:create:vue', projectName, cliProcesses);
-    }, 240e3);
+      const projectPath = getProjectPath(projectName);
+      mkdirSync(projectPath, {recursive: true});
+      writeFileSync(
+        join(projectPath, '.yarnrc'),
+        'registry "http://verdaccio:4873"'
+      );
+      const buildProcess = setupUIProject('ui:create:vue', projectName);
+      cliProcesses.push(buildProcess);
+
+      buildProcess.stdout.on('data', async (data) => {
+        if (
+          /Pick an action: \(Use arrow keys\)/.test(stripAnsi(data.toString()))
+        ) {
+          await answerPrompt('\u001b[B', buildProcess);
+          return;
+        }
+        if (/❯ Merge/.test(stripAnsi(data.toString()))) {
+          await answerPrompt(EOL, buildProcess);
+          return;
+        }
+        if (isGenericYesNoPrompt(data.toString())) {
+          await answerPrompt(`y${EOL}`, buildProcess);
+          return;
+        }
+      });
+
+      await new Promise<void>((resolve) => {
+        buildProcess.stdout.on('close', async () => {
+          resolve();
+        });
+      });
+
+      const startServerProcess = spawn('npm', ['run', 'start'], {
+        cwd: projectPath,
+        detached: true,
+      });
+
+      cliProcesses.push(startServerProcess);
+      await new Promise<void>((resolve) => {
+        startServerProcess.stdout.on('data', async (data) => {
+          if (stripAnsi(data.toString()).indexOf('App running at:') !== -1) {
+            resolve();
+          }
+        });
+      });
+    }, 420e3);
 
     beforeEach(async () => {
       page = await openNewPage();

packages/cli-e2e/docker/config/config.yaml

@@ -0,0 +1,84 @@
+#
+# This is the config file used for the docker images.
+# It allows all users to do anything, so don't use it on production systems.
+#
+# Do not configure host and port under `listen` in this file
+# as it will be ignored when using docker.
+# see https://verdaccio.org/docs/en/docker#docker-and-custom-port-configuration
+#
+# Look here for more config file examples:
+# https://github.com/verdaccio/verdaccio/tree/master/conf
+#
+
+# path to a directory with all packages
+storage: /verdaccio/storage/data
+# path to a directory with plugins to include
+plugins: /verdaccio/plugins
+
+web:
+  # WebUI is enabled as default, if you want disable it, just uncomment this line
+  enable: false
+  title: Verdaccio
+  # comment out to disable gravatar support
+  # gravatar: false
+  # by default packages are ordercer ascendant (asc|desc)
+  # sort_packages: asc
+  # darkMode: true
+
+# translate your registry, api i18n not available yet
+# i18n:
+# list of the available translations https://github.com/verdaccio/ui/tree/master/i18n/translations
+#   web: en-US
+
+auth:
+  htpasswd:
+    file: /verdaccio/storage/htpasswd
+    # Maximum amount of users allowed to register, defaults to "+infinity".
+    # You can set this to -1 to disable registration.
+    # max_users: 1000
+
+# a list of other known repositories we can talk to
+uplinks:
+  npmjs:
+    url: https://registry.npmjs.org/
+
+packages:
+  "@coveo/@(angular|vue-cli-plugin-typescript|cra-template)":
+    # scoped packages
+    access: $all
+    publish: $all
+    unpublish: $all
+
+  "**":
+    # allow all users (including non-authenticated users) to read and
+    # publish all packages
+    #
+    # you can specify usernames/groupnames (depending on your auth plugin)
+    # and three keywords: "$all", "$anonymous", "$authenticated"
+    access: $all
+
+    # allow all known users to publish/publish packages
+    # (anyone can register by default, remember?)
+    publish: $all
+    unpublish: $all
+
+    # if package is not available locally, proxy requests to 'npmjs' registry
+    proxy: npmjs
+
+middlewares:
+  audit:
+    enabled: true
+
+# log settings
+logs:
+  - { type: stdout, format: pretty, level: http }
+  #- {type: file, path: verdaccio.log, level: info}
+#experiments:
+#  # support for npm token command
+#  token: false
+#  # support for the new v1 search endpoint, functional by incomplete read more on ticket 1732
+#  search: false
+
+# This affect the web and api (not developed yet)
+#i18n:
+#web: en-US

packages/cli-e2e/docker/docker-compose.yml

@@ -0,0 +1,34 @@
+version: "3.9"
+
+services:
+  runner:
+    image: "coveo-cli-e2e-image"
+    container_name: "coveo-cli-e2e-container"
+    cap_add:
+      - "IPC_LOCK"
+      - "SYS_ADMIN"
+    env_file: "../.env"
+    privileged: true
+    ports:
+      - "9229:9229"
+    volumes:
+      - ../../..:/home/notGroot/cli
+    networks:
+      - node-network
+    command: "/bin/bash"
+    tty: true
+    stdin_open: true
+  verdaccio:
+    image: verdaccio/verdaccio
+    container_name: "verdaccio"
+    networks:
+      - node-network
+    environment:
+      - VERDACCIO_PORT=4873
+    ports:
+      - "4873:4873"
+    volumes:
+      - "./config:/verdaccio/conf"
+networks:
+  node-network:
+    driver: bridge