feat(repo): add a command to test create-nx-workspace

CONTRIBUTING.md

@@ -61,6 +61,8 @@ yarn local-registry enable
 yarn local-registry disable
 ```
 
+You can also run `yarn test-create-nx-workspace 30.0.0`. It will set up local registry, publish the packages, create the workspace with Angular and React applications in it, and will run some basic checks against the workspace.
+
 ### Running Unit Tests
 
 To make sure your changes do not break any unit tests, run the following:

e2e/commands/README

@@ -0,0 +1 @@
+These aren't exactly e2e tests. We are just using e2e utilities to implement these two commands.

e2e/commands/create-nx-workspace.test.ts

@@ -0,0 +1,151 @@
+import { exec, execSync } from 'child_process';
+import { dirSync } from 'tmp';
+import { readdirSync, readFileSync, statSync, writeFileSync } from 'fs';
+import * as path from 'path';
+
+describe('create-nx-workspace', () => {
+  afterEach(() => {
+    execSync(`yarn local-registry disable`);
+  });
+
+  it('creates a new project', async done => {
+    if (!process.env.PUBLISHED_VERSION) {
+      console.error(`Please provision the version you are publishing`);
+      process.exit(1);
+    }
+
+    const tmpFolder = dirSync().name;
+    const workspaceDir = `${tmpFolder}/happyorg`;
+
+    await startRegistry();
+    await execCommand('Enabling local registry', `yarn local-registry enable`);
+    await execCommand(
+      'Publishing packages',
+      `yarn nx-release ${process.env.PUBLISHED_VERSION} --local`
+    );
+
+    await execCommand(
+      `Create a workspace in "${workspaceDir}"`,
+      `npx create-nx-workspace@latest happyorg --preset=angular --appName=ngapp --style=css`,
+      tmpFolder
+    );
+    await execCommand(
+      'Add ngrx to the Angular app',
+      `ng g @nrwl/angular:ngrx state --module=apps/ngapp/src/app/app.module.ts --root`,
+      workspaceDir
+    );
+
+    await addReact(workspaceDir);
+    await execCommand(
+      `Generate a React app`,
+      `ng g @nrwl/react:app reactapp`,
+      workspaceDir
+    );
+    await execCommand(`Building angular app`, `ng build ngapp`, workspaceDir);
+    await execCommand(`Building react app`, `ng build reactapp`, workspaceDir);
+
+    const webpacks = allVersionsOf(workspaceDir, 'webpack');
+    if (webpacks.length > 1) {
+      console.log(`more than one version of webpack: ${webpacks.join(', ')}`);
+    }
+    expect(webpacks.length).toEqual(1);
+
+    // filtering out rxjs in the listr package.
+    const rxjs = allVersionsOf(workspaceDir, 'rxjs').filter(
+      value => value !== '5.5.12'
+    );
+    if (rxjs.length > 1) {
+      console.log(`more than one version of rxjs: ${rxjs.join(', ')}`);
+    }
+    expect(rxjs.length).toEqual(1);
+
+    console.log('The automatic tests have passed.');
+    console.log(
+      `Go to "${workspaceDir}" to verify that the workspace works as expected`
+    );
+
+    done();
+  }, 120000);
+});
+
+function wait() {
+  return new Promise(r => {
+    setTimeout(() => r(), 500);
+  });
+}
+
+function startRegistry() {
+  return new Promise((res, rej) => {
+    const server = exec('yarn local-registry start');
+    server.stdout.on('data', d => {
+      if (d.toString().indexOf('http address') > -1) {
+        res();
+      }
+    });
+
+    server.on('exit', s => {
+      if (s !== 0) {
+        rej(`Cannot start local registry`);
+      }
+    });
+  });
+}
+
+function allVersionsOf(dir: string, packageToCheck: string) {
+  const r = packageJsonFilesInNodeModules(`${dir}/node_modules`)
+    .map(p => {
+      try {
+        const parsed = JSON.parse(readFileSync(p).toString());
+        if (parsed.name == packageToCheck) {
+          return parsed.version;
+        }
+        return null;
+      } catch (e) {
+        return null;
+      }
+    })
+    .filter(p => !!p);
+  return r.filter((value, index, self) => self.indexOf(value) === index);
+}
+
+function addReact(workspaceDir: string) {
+  const packageJson = JSON.parse(
+    readFileSync(`${workspaceDir}/package.json`).toString()
+  );
+  packageJson.dependencies[`@nrwl/react`] = process.env.PUBLISHED_VERSION;
+  writeFileSync(
+    `${workspaceDir}/package.json`,
+    JSON.stringify(packageJson, null, 2)
+  );
+  execSync(`npm config set registry http://localhost:4873/ && npm install`, {
+    cwd: workspaceDir,
+    shell: 'bash'
+  });
+}
+
+async function execCommand(description: string, cmd: string, cwd?: string) {
+  console.log(description);
+  execSync(cmd, {
+    stdio: [0, 1, 2],
+    cwd
+  });
+  await wait();
+}
+
+function packageJsonFilesInNodeModules(dirName: string): string[] {
+  let res = [];
+  try {
+    readdirSync(dirName).forEach(c => {
+      try {
+        const child = path.join(dirName, c);
+        const s = statSync(child);
+        if (child.endsWith('package.json')) {
+          res.push(child);
+        } else if (s.isDirectory()) {
+          res = [...res, ...packageJsonFilesInNodeModules(child)];
+        }
+      } catch (e) {}
+    });
+  } catch (e) {}
+  return res;
+}

e2e/create-playground.test.ts → e2e/commands/create-playground.test.ts

@@ -1,4 +1,4 @@
-import { ensureProject, forEachCli, newProject, runCLI } from './utils';
+import { ensureProject, forEachCli, newProject, runCLI } from '../utils';
 
 forEachCli(() => {
   describe('create playground', () => {

package.json

@@ -12,6 +12,7 @@
     "e2e": "./scripts/e2e.sh",
     "e2e-rerun": "./scripts/e2e-rerun.sh",
     "create-playground": "./scripts/e2e.sh create-playground",
+    "test-create-nx-workspace": "./scripts/test-create-nx-workspace.sh",
     "e2e-ci1": "./scripts/e2e-ci1.sh",
     "e2e-ci2": "./scripts/e2e-ci2.sh",
     "format": "./scripts/format.sh",

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nrwl/cli",
-  "version": "0.0.2",
+  "version": "0.0.1",
   "description": "",
   "repository": {
     "type": "git",

packages/create-nx-plugin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-nx-plugin",
-  "version": "0.0.2",
+  "version": "0.0.1",
   "description": "Extensible Dev Tools for Monorepos",
   "repository": {
     "type": "git",

packages/create-nx-workspace/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-nx-workspace",
-  "version": "0.0.2",
+  "version": "0.0.1",
   "description": "Extensible Dev Tools for Monorepos",
   "repository": {
     "type": "git",

scripts/create-playground.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+./scripts/link.sh
+
+rm -rf tmp
+mkdir -p tmp/angular
+mkdir -p tmp/nx
+
+jest --maxWorkers=1 ./build/e2e/commands/create-playground.test.js
+
+

scripts/link.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 if [ "$1" = "fast" ]; then
-  ./scripts/build_for_test.sh
+  ./scripts/build-for-test.sh
 fi
 
 if [ "$1" != "fast" ]; then

scripts/nx-release.js

@@ -132,6 +132,28 @@ childProcess.execSync(`find build/npm -maxdepth 1 -name "*.tgz" -delete`, {
  */
 const DRY_RUN = !!parsedArgs['dry-run'];
 
+const pkgFiles = [
+  'package.json',
+  'build/npm/create-nx-workspace/package.json',
+  'build/npm/create-nx-plugin/package.json',
+  'build/npm/schematics/package.json',
+  'build/npm/jest/package.json',
+  'build/npm/cypress/package.json',
+  'build/npm/storybook/package.json',
+  'build/npm/angular/package.json',
+  'build/npm/react/package.json',
+  'build/npm/next/package.json',
+  'build/npm/web/package.json',
+  'build/npm/node/package.json',
+  'build/npm/express/package.json',
+  'build/npm/nest/package.json',
+  'build/npm/workspace/package.json',
+  'build/npm/cli/package.json',
+  'build/npm/tao/package.json',
+  'build/npm/eslint-plugin-nx/package.json',
+  'build/npm/linter/package.json',
+  'build/npm/nx-plugin/package.json'
+];
 /**
  * Set the static options for release-it
  */
@@ -147,28 +169,7 @@ const options = {
    * All the package.json files that will have their version updated
    * by release-it
    */
-  pkgFiles: [
-    'package.json',
-    'build/npm/schematics/package.json',
-    'build/npm/create-nx-workspace/package.json',
-    'build/npm/create-nx-plugin/package.json',
-    'build/npm/jest/package.json',
-    'build/npm/cypress/package.json',
-    'build/npm/storybook/package.json',
-    'build/npm/angular/package.json',
-    'build/npm/react/package.json',
-    'build/npm/next/package.json',
-    'build/npm/web/package.json',
-    'build/npm/node/package.json',
-    'build/npm/express/package.json',
-    'build/npm/nest/package.json',
-    'build/npm/workspace/package.json',
-    'build/npm/cli/package.json',
-    'build/npm/tao/package.json',
-    'build/npm/eslint-plugin-nx/package.json',
-    'build/npm/linter/package.json',
-    'build/npm/nx-plugin/package.json'
-  ],
+  pkgFiles: pkgFiles,
   increment: parsedVersion.version,
   requireUpstream: false,
   github: {
@@ -192,37 +193,46 @@ const options = {
   requireCleanWorkingDir: false
 };
 
-releaseIt(options)
-  .then(output => {
-    if (DRY_RUN) {
-      console.warn('WARNING: In DRY_RUN mode - not running publishing script');
-      process.exit(0);
-      return;
-    }
+childProcess.execSync('rm -rf ./build/packages/bazel');
+childProcess.execSync('rm -rf ./build/npm/bazel');
 
-    // if (parsedArgs.nobazel) {
-    childProcess.execSync('rm -rf ./build/packages/bazel');
-    childProcess.execSync('rm -rf ./build/npm/bazel');
-    // }
-
-    /**
-     * We always use either "latest" or "next" (i.e. no separate tags for alpha, beta etc)
-     */
-    const npmTag = parsedVersion.isPrerelease ? 'next' : 'latest';
-    const npmPublishCommand = `./scripts/publish.sh ${
-      output.version
-    } ${npmTag} ${parsedArgs.local ? '--local' : ''}`;
-    console.log('Executing publishing script for all packages:');
-    console.log(`> ${npmPublishCommand}`);
-    console.log(
-      `Note: You will need to authenticate with your NPM credentials`
-    );
-    childProcess.execSync(npmPublishCommand, {
+if (parsedArgs.local) {
+  pkgFiles.forEach(p => {
+    const content = JSON.parse(fs.readFileSync(p).toString());
+    content.version = parsedVersion.version;
+    fs.writeFileSync(p, JSON.stringify(content, null, 2));
+  });
+  childProcess.execSync(
+    `./scripts/publish.sh ${parsedVersion.version} latest --local`,
+    {
       stdio: [0, 1, 2]
+    }
+  );
+  process.exit(0);
+} else {
+  releaseIt(options)
+    .then(output => {
+      if (DRY_RUN) {
+        console.warn(
+          'WARNING: In DRY_RUN mode - not running publishing script'
+        );
+        process.exit(0);
+        return;
+      }
+      const npmTag = parsedVersion.isPrerelease ? 'next' : 'latest';
+      const npmPublishCommand = `./scripts/publish.sh ${output.version} ${npmTag}`;
+      console.log('Executing publishing script for all packages:');
+      console.log(`> ${npmPublishCommand}`);
+      console.log(
+        `Note: You will need to authenticate with your NPM credentials`
+      );
+      childProcess.execSync(npmPublishCommand, {
+        stdio: [0, 1, 2]
+      });
+      process.exit(0);
+    })
+    .catch(err => {
+      console.error(err.message);
+      process.exit(1);
     });
-    process.exit(0);
-  })
-  .catch(err => {
-    console.error(err.message);
-    process.exit(1);
-  });
+}

scripts/test-create-nx-workspace.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+./scripts/link.sh
+PUBLISHED_VERSION=$1 jest --maxWorkers=1 ./build/e2e/commands/create-nx-workspace.test.js