Introduce yarn run test:full (#51)

* Update dependencies

* Only run fast tests with `yarn test`

* Use expect().includeAllMembers()

* Remove timeouts

* Improve error handling with verbose flag

* Change label to E2E

.github/workflows/test.yml

@@ -36,6 +36,6 @@ jobs:
       - name: Install Dependencies
         run: yarn install --frozen-lockfile --ignore-engines
       - name: Run tests
-        run: yarn test
+        run: yarn run test:full
         env:
           CI: true

package.json

@@ -19,7 +19,7 @@
     "cli-ux": "^5.4.1",
     "execa": "^3.4.0",
     "fast-glob": "^3.1.1",
-    "handlebars": "^4.5.3",
+    "handlebars": "^4.6.0",
     "js-yaml": "^3.13.1",
     "listr": "^0.14.3",
     "rimraf": "^3.0.0",
@@ -33,16 +33,16 @@
     "@types/jest": "^24.0.25",
     "@types/js-yaml": "^3.12.1",
     "@types/listr": "^0.14.2",
-    "@types/node": "^12.12.24",
+    "@types/node": ">=10.0.0",
     "@types/rimraf": "^2.0.3",
     "fs-extra": "^8.1.0",
     "globby": "^10.0.2",
     "jest": "^24.9.0",
     "jest-extended": "^0.11.2",
     "np": "^5.2.1",
     "prettier": "^1.19.1",
-    "ts-jest": "^24.2.0",
-    "ts-node": "^8.5.4",
+    "ts-jest": "^24.3.0",
+    "ts-node": "^8.6.0",
     "tslint": "^5.20.1",
     "tslint-config-prettier": "^1.18.0",
     "typescript": "^3.7.4"
@@ -90,7 +90,8 @@
     "prepack": "rm -rf lib && tsc -b && cp -R src/templates lib/ && oclif-dev manifest && oclif-dev readme",
     "postpack": "rm -f oclif.manifest.json",
     "pretest": "rm -rf test/test-output/*-spec/ && npm run lint && tsc -b",
-    "test": "jest",
+    "test": "jest --testNamePattern=\"^((?!\\[E2E\\]).)*$\"",
+    "test:full": "jest",
     "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand",
     "test:watch-debug": "node --inspect-brk node_modules/.bin/jest --watch --runInBand",
     "version": "oclif-dev readme && git add README.md"

src/commands/add-cds.ts

@@ -54,18 +54,20 @@ export default class AddCds extends Command {
           title: 'Creating files',
           task: async () => {
             const copyDescriptors = getCopyDescriptors(projectDir, getTemplatePaths(['add-cds']));
-            await findConflicts(copyDescriptors, flags.force).catch(e => this.error(e, { exit: 11 }));
+            await findConflicts(copyDescriptors, flags.force).catch(e => this.error(flags.verbose ? e.stack : e.message, { exit: 11 }));
             await copyFiles(copyDescriptors, options);
           }
         },
         {
           title: 'Adding dependencies to package.json',
-          task: async () => modifyPackageJson({ projectDir, force: flags.force, addCds: true }).catch(e => this.error(e, { exit: 12 }))
+          task: async () =>
+            modifyPackageJson({ projectDir, force: flags.force, addCds: true }).catch(e =>
+              this.error(flags.verbose ? e.stack : e.message, { exit: 12 })
+            )
         },
         {
           title: 'Installing dependencies',
-          task: async () =>
-            installDependencies(projectDir, flags.verbose).catch(e => this.error(`Error during npm install: ${e.message}`, { exit: 13 })),
+          task: async () => installDependencies(projectDir, flags.verbose).catch(e => this.error(flags.verbose ? e.stack : e.message, { exit: 13 })),
           enabled: () => !flags.skipInstall
         },
         {
@@ -77,8 +79,8 @@ export default class AddCds extends Command {
       await tasks.run();
 
       this.printSuccessMessage();
-    } catch (error) {
-      this.error(error, { exit: 1 });
+    } catch (e) {
+      this.error(flags.verbose ? e.stack : e.message, { exit: 1 });
     }
   }
 

src/commands/init.ts

@@ -96,7 +96,9 @@ export default class Init extends Command {
       if (isScaffold) {
         await buildScaffold(projectDir, flags.verbose, flags.addCds);
       }
-      const options = await this.getOptions(projectDir, isScaffold ? 'npm run start:prod' : flags.startCommand, flags.projectName);
+      const options = await this.getOptions(projectDir, isScaffold ? 'npm run start:prod' : flags.startCommand, flags.projectName).catch(e =>
+        this.error(flags.verbose ? e.stack : e.message, { exit: 10 })
+      );
 
       await usageAnalytics(projectDir, flags.analytics, flags.analyticsSalt);
 
@@ -105,7 +107,7 @@ export default class Init extends Command {
           title: 'Creating files',
           task: async () => {
             const copyDescriptors = getCopyDescriptors(projectDir, getTemplatePaths(this.getTemplateNames(isScaffold, flags.addCds)));
-            await findConflicts(copyDescriptors, flags.force).catch(e => this.error(e, { exit: 11 }));
+            await findConflicts(copyDescriptors, flags.force).catch(e => this.error(flags.verbose ? e.stack : e.message, { exit: 11 }));
             await copyFiles(copyDescriptors, options);
           }
         },
@@ -118,13 +120,12 @@ export default class Init extends Command {
           title: 'Adding dependencies to package.json',
           task: async () =>
             modifyPackageJson({ projectDir, isScaffold, frontendScripts: flags.frontendScripts, force: flags.force, addCds: flags.addCds }).catch(e =>
-              this.error(e, { exit: 12 })
+              this.error(flags.verbose ? e.stack : e.message, { exit: 12 })
             )
         },
         {
           title: 'Installing dependencies',
-          task: async () =>
-            installDependencies(projectDir, flags.verbose).catch(e => this.error(`Error during npm install: ${e.message}`, { exit: 13 })),
+          task: async () => installDependencies(projectDir, flags.verbose).catch(e => this.error(flags.verbose ? e.stack : e.message, { exit: 13 })),
           enabled: () => !flags.skipInstall
         },
         {
@@ -137,7 +138,7 @@ export default class Init extends Command {
 
       this.printSuccessMessage(isScaffold, flags.addCds);
     } catch (error) {
-      this.error(error, { exit: 1 });
+      this.error(flags.verbose ? error.stack : error.message, { exit: 1 });
     }
   }
 
@@ -158,7 +159,7 @@ export default class Init extends Command {
   }
 
   private async getOptions(projectDir: string, startCommand?: string, projectName?: string) {
-    const { name, scripts } = await parsePackageJson(projectDir).catch(err => this.error(err, { exit: 10 }));
+    const { name, scripts } = await parsePackageJson(projectDir);
 
     const options: { [key: string]: string } = {
       projectName:

test/add-approuter.spec.ts

@@ -34,11 +34,7 @@ describe('Add Approuter', () => {
     expect(files).toContain('approuter');
 
     const approuterFiles = fs.readdirSync(path.resolve(projectDir, 'approuter'));
-    expect(approuterFiles).toContain('.npmrc');
-    expect(approuterFiles).toContain('manifest.yml');
-    expect(approuterFiles).toContain('package.json');
-    expect(approuterFiles).toContain('xs-app.json');
-    expect(approuterFiles).toContain('xs-security.json');
+    expect(approuterFiles).toIncludeAllMembers(['.npmrc', 'manifest.yml', 'package.json', 'xs-app.json', 'xs-security.json']);
   });
 
   it('should add necessary files to an existing project', async () => {
@@ -52,11 +48,7 @@ describe('Add Approuter', () => {
     expect(files).toContain('approuter');
 
     const approuterFiles = fs.readdirSync(path.resolve(projectDir, 'approuter'));
-    expect(approuterFiles).toContain('.npmrc');
-    expect(approuterFiles).toContain('manifest.yml');
-    expect(approuterFiles).toContain('package.json');
-    expect(approuterFiles).toContain('xs-app.json');
-    expect(approuterFiles).toContain('xs-security.json');
+    expect(approuterFiles).toIncludeAllMembers(['.npmrc', 'manifest.yml', 'package.json', 'xs-app.json', 'xs-security.json']);
   });
 
   it('should detect and fail if there are conflicts', async () => {

test/add-cds.spec.ts

@@ -42,7 +42,7 @@ describe('Add CDS', () => {
     expect(dbFiles).toContain('data-model.cds');
     const srvFiles = fs.readdirSync(path.resolve(projectDir, 'srv'));
     expect(srvFiles).toContain('cat-service.cds');
-  }, 15000);
+  });
 
   it('should detect and fail if there are conflicts', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'add-cds-conflicts');
@@ -53,5 +53,5 @@ describe('Add CDS', () => {
     fs.writeFileSync(path.resolve(projectDir, 'db', 'data-model.cds'), 'some text', 'utf8');
 
     await expect(AddCds.run([projectDir, '--skipInstall'])).rejects.toMatchSnapshot();
-  }, 10000);
+  });
 });

test/add-cx-server.spec.ts

@@ -23,9 +23,8 @@ describe('Add CX Server', () => {
     expect(files).toContain('cx-server');
 
     const approuterFiles = fs.readdirSync(path.resolve(projectDir, 'cx-server'));
-    expect(approuterFiles).toContain('cx-server');
-    expect(approuterFiles).toContain('server.cfg');
-  }, 30000);
+    expect(approuterFiles).toIncludeAllMembers(['cx-server', 'server.cfg']);
+  });
 
   it('should add the necessary files on windows', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'add-cx-server');
@@ -36,10 +35,8 @@ describe('Add CX Server', () => {
     expect(files).toContain('cx-server');
 
     const approuterFiles = fs.readdirSync(path.resolve(projectDir, 'cx-server'));
-    expect(approuterFiles).toContain('cx-server');
-    expect(approuterFiles).toContain('cx-server.bat');
-    expect(approuterFiles).toContain('server.cfg');
-  }, 30000);
+    expect(approuterFiles).toIncludeAllMembers(['cx-server', 'cx-server.bat', 'server.cfg']);
+  });
 
   it('should add necessary files to an existing project', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'add-cx-server-to-existing-project');
@@ -52,9 +49,8 @@ describe('Add CX Server', () => {
     expect(files).toContain('cx-server');
 
     const approuterFiles = fs.readdirSync(path.resolve(projectDir, 'cx-server'));
-    expect(approuterFiles).toContain('cx-server');
-    expect(approuterFiles).toContain('server.cfg');
-  }, 30000);
+    expect(approuterFiles).toIncludeAllMembers(['cx-server', 'server.cfg']);
+  });
 
   it('should detect and fail if there are conflicts', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'add-cx-server-conflicts');
@@ -63,5 +59,5 @@ describe('Add CX Server', () => {
     fs.createFileSync(path.resolve(projectDir, 'cx-server', 'cx-server'));
 
     await expect(AddCxServer.run([projectDir])).rejects.toMatchSnapshot();
-  }, 30000);
+  });
 });

test/init.spec.ts

@@ -20,7 +20,7 @@ describe('Init', () => {
     fs.removeSync(testOutputDir);
   });
 
-  it('should create a new project with the necessary files', async () => {
+  it('[E2E] should create a new project with the necessary files', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'full-init');
     await Init.run([projectDir, '--projectName=testingApp', '--buildScaffold', '--no-analytics']);
 
@@ -43,7 +43,7 @@ describe('Init', () => {
     expect(fs.readdirSync(path.resolve(reportsPath, 'coverage-reports', 'backend-integration')).length).toBeGreaterThan(1);
   }, 240000);
 
-  it('should create a new project with the necessary files when adding cds', async () => {
+  it('[E2E] should create a new project with the necessary files when adding cds', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'full-init-cds');
     await Init.run([projectDir, '--projectName=testingApp', '--buildScaffold', '--no-analytics', '--addCds']);
 
@@ -69,7 +69,7 @@ describe('Init', () => {
         expect(fs.existsSync(path)).toBe(true);
       });
     expect(fs.existsSync(path.resolve(projectDir, 'test'))).toBe(false);
-  }, 10000);
+  });
 
   it('should add necessary files to an existing project when adding cds', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'add-to-existing');
@@ -82,7 +82,7 @@ describe('Init', () => {
       .forEach(path => {
         expect(fs.existsSync(path)).toBe(true);
       });
-  }, 10000);
+  });
 
   it('init should detect and fail if there are conflicts', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'detect-conflicts');
@@ -92,7 +92,7 @@ describe('Init', () => {
     await expect(
       Init.run([projectDir, '--projectName=testingApp', '--startCommand="npm start"', '--skipInstall', '--no-analytics'])
     ).rejects.toMatchSnapshot();
-  }, 10000);
+  });
 
   it('should add to .gitignore if there is one', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'add-to-gitignore');
@@ -105,11 +105,9 @@ describe('Init', () => {
       .split('\n')
       .filter(entry => entry !== '');
 
-    expect(gitignoreEntries).toContain('credentials.json');
-    expect(gitignoreEntries).toContain('/s4hana_pipeline');
-    expect(gitignoreEntries).toContain('/deployment');
+    expect(gitignoreEntries).toIncludeAllMembers(['credentials.json', '/s4hana_pipeline', '/deployment']);
     expect(gitignoreEntries.length).toBeGreaterThan(29);
-  }, 10000);
+  });
 
   it('should show a warning if the project is not using git', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'warn-on-no-git');
@@ -128,7 +126,7 @@ describe('Init', () => {
       '  /deployment'
     );
     expect(getWarnings).toHaveBeenCalled();
-  }, 10000);
+  });
 
   it('should add our scripts and dependencies to the package.json', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'add-scripts-and-dependencies');
@@ -145,10 +143,8 @@ describe('Init', () => {
 
     expect(dependencies).toContain('@sap/cloud-sdk-core');
     expect(devDependencies).toContain('@sap/cloud-sdk-test-util');
-    ['ci-build', 'ci-package', 'ci-backend-unit-test', 'ci-frontend-unit-test', 'ci-integration-test', 'ci-e2e'].forEach(script =>
-      expect(scripts).toContain(script)
-    );
-  }, 10000);
+    expect(scripts).toIncludeAllMembers(['ci-build', 'ci-package', 'ci-backend-unit-test', 'ci-frontend-unit-test', 'ci-integration-test', 'ci-e2e']);
+  });
 
   it('should add the analytics file', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'add-to-gitignore');
@@ -173,5 +169,5 @@ describe('Init', () => {
     await Init.run([projectDir, '--projectName=testingApp', '--startCommand="npm start"', '--skipInstall', '--no-analytics']);
 
     expect(JSON.parse(fs.readFileSync(`${projectDir}/sap-cloud-sdk-analytics.json`, 'utf8'))).toEqual({ enabled: false });
-  }, 10000);
+  });
 });

test/package.spec.ts

@@ -43,7 +43,7 @@ describe('Package', () => {
     expect(fs.readdirSync(path.resolve(projectDir, 'deployment'))).toEqual(['README.md']);
   });
 
-  it('should install productive dependencies only', async () => {
+  it('[E2E] should install productive dependencies only', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'productive-dependencies');
     fs.copySync(nestAppDir, projectDir, { recursive: true });
     await Package.run([projectDir]);

test/utils/__snapshots__/scaffold.spec.ts.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`Scaffold Utils should build the scaffold 1`] = `
+exports[`Scaffold Utils [E2E] should build the scaffold 1`] = `
 Array [
   ".git",
   ".gitignore",

test/utils/git-ignore.spec.ts

@@ -21,8 +21,7 @@ describe('Git Ignore Utils', () => {
     modifyGitIgnore(projectDir, false);
 
     const gitIgnoreContent = fs.readFileSync(`${projectDir}/.gitignore`, { encoding: 'utf8' }).split('\n');
-    expect(gitIgnoreContent).toContain('/s4hana_pipeline');
-    expect(gitIgnoreContent).toContain('credentials.json');
+    expect(gitIgnoreContent).toIncludeAllMembers(['/s4hana_pipeline', 'credentials.json']);
   });
 
   it('should add cds paths to empty git ignore', () => {
@@ -32,8 +31,7 @@ describe('Git Ignore Utils', () => {
     modifyGitIgnore(projectDir, true);
 
     const gitIgnoreContent = fs.readFileSync(`${projectDir}/.gitignore`, { encoding: 'utf8' }).split('\n');
-    expect(gitIgnoreContent).toContain('gen/');
-    expect(gitIgnoreContent).toContain('*.db');
+    expect(gitIgnoreContent).toIncludeAllMembers(['gen/', '*.db']);
   });
 
   it('should add paths to existing git ignore', () => {
@@ -49,9 +47,7 @@ describe('Git Ignore Utils', () => {
     modifyGitIgnore(projectDir, false);
 
     const gitIgnoreContent = fs.readFileSync(`${projectDir}/.gitignore`, { encoding: 'utf8' }).split('\n');
-    expect(gitIgnoreContent).toContain('/s4hana_pipeline');
-    expect(gitIgnoreContent).toContain('myPath');
-    expect(gitIgnoreContent).toContain('credentials.json');
+    expect(gitIgnoreContent).toIncludeAllMembers(['/s4hana_pipeline', 'myPath', 'credentials.json']);
   });
 
   it('warn if there is no git ignore', () => {

test/utils/scaffold.spec.ts

@@ -38,7 +38,7 @@ describe('Scaffold Utils', () => {
     expect(await shouldBuildScaffold(projectDir, false)).toBe(false);
   });
 
-  it('should build the scaffold', async () => {
+  it('[E2E] should build the scaffold', async () => {
     const projectDir = getCleanProjectDir(testOutputDir, 'build-scaffold');
 
     await buildScaffold(projectDir, false, false);