Add CDS sources using the CLI

jest.config.js

@@ -9,5 +9,11 @@ module.exports = {
     '<rootDir>/test/express',
     '<rootDir>/test/[^/]*/[^/]*-spec'
   ],
-  roots: ['test']
+  setupFilesAfterEnv: ['jest-extended'],
+  roots: ['test'],
+  globals: {
+    'ts-jest': {
+      diagnostics: false,
+    }
+  }
 };

package.json

@@ -15,6 +15,7 @@
     "@oclif/plugin-help": "^2.2.2",
     "@oclif/plugin-not-found": "^1.2.3",
     "@oclif/plugin-warn-if-update-available": "^1.7.0",
+    "boxen": "^4.2.0",
     "cli-ux": "^5.3.3",
     "execa": "^3.4.0",
     "fast-glob": "^3.1.1",
@@ -29,6 +30,7 @@
   "devDependencies": {
     "@oclif/dev-cli": "^1.22.2",
     "@oclif/tslint": "^3.1.1",
+    "@types/boxen": "^3.0.1",
     "@types/fs-extra": "^8.0.1",
     "@types/jest": "^24.0.23",
     "@types/js-yaml": "^3.12.1",
@@ -38,6 +40,7 @@
     "fs-extra": "^8.1.0",
     "globby": "^10.0.1",
     "jest": "^24.9.0",
+    "jest-extended": "^0.11.2",
     "np": "^5.2.1",
     "prettier": "^1.19.1",
     "ts-jest": "^24.2.0",
@@ -90,6 +93,7 @@
     "fix:formatting": "tslint -p . -t stylish --fix && tslint -p test -t stylish --fix && prettier --write \"**/*.ts\"",
     "prepack": "rm -rf lib && tsc -b && cp -R src/templates lib/ && oclif-dev manifest && oclif-dev readme",
     "test": "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-approuter.ts

@@ -4,9 +4,8 @@
 
 import { Command, flags } from '@oclif/command';
 import cli from 'cli-ux';
-import * as fs from 'fs';
-import * as yaml from 'js-yaml';
 import * as Listr from 'listr';
+import { getProjectNameFromManifest } from '../utils/manifest-yaml';
 import { copyFiles, findConflicts, getCopyDescriptors, getTemplatePaths } from '../utils/templates';
 
 export default class AddApprouter extends Command {
@@ -15,26 +14,33 @@ export default class AddApprouter extends Command {
   static examples = ['$ sap-cloud-sdk add-approuter'];
 
   static flags = {
-    projectDir: flags.string({
-      hidden: true,
-      default: '',
-      description: 'Path to the folder in which the project should be created.'
-    }),
     force: flags.boolean({
       description: 'Do not fail if a file already exist and overwrite it.'
     }),
-    help: flags.help({ char: 'h' })
+    help: flags.help({
+      char: 'h',
+      description: 'Show help for the add-approuter command.'
+    })
   };
 
+  static args = [
+    {
+      name: 'projectDir',
+      description: 'Path to the project directory to which the approuter should be added.'
+    }
+  ];
+
   async run() {
-    const { flags } = this.parse(AddApprouter);
+    const { flags, args } = this.parse(AddApprouter);
+    const projectDir = args.projectDir || '.';
+
     try {
       const options = await this.getOptions();
       const tasks = new Listr([
         {
           title: 'Creating files',
           task: () => {
-            const copyDescriptors = getCopyDescriptors(flags.projectDir, getTemplatePaths(['add-approuter']));
+            const copyDescriptors = getCopyDescriptors(projectDir, getTemplatePaths(['add-approuter']));
             findConflicts(copyDescriptors, flags.force);
             copyFiles(copyDescriptors, options);
           }
@@ -50,21 +56,7 @@ export default class AddApprouter extends Command {
   }
 
   private async getOptions() {
-    const warn = () => this.warn('Could not read name from `manifest.yml`. Please ensure you ran `sap-cloud-sdk init` before adding the approuter.');
-    let projectName: string | null = null;
-    try {
-      const manifestStr = fs.readFileSync('manifest.yml', { encoding: 'utf8' });
-      const manifest = yaml.safeLoad(manifestStr, {
-        filename: 'manifest.yml',
-        onWarning: warn
-      });
-      if (manifest['applications'].length > 1) {
-        this.warn('There were multiple apps in the `manifest.yml`, this command only considers the first app.');
-      }
-      projectName = manifest['applications'].map((app: any) => app.name)[0];
-    } catch (error) {
-      this.log(`Unable to read "manifest.yml" (${error.message}).`);
-    }
+    const projectName = getProjectNameFromManifest(this);
 
     const options: { [key: string]: string } = {
       projectName: projectName || (await cli.prompt('Enter project name as maintained in Cloud Foundry'))

src/commands/add-cds.ts

@@ -0,0 +1,112 @@
+/*!
+ * Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
+ */
+
+import { Command, flags } from '@oclif/command';
+import cli from 'cli-ux';
+import * as Listr from 'listr';
+import { installDependencies, modifyGitIgnore, modifyPackageJson } from '../utils';
+import { getProjectNameFromManifest } from '../utils/manifest-yaml';
+import { copyFiles, findConflicts, getCopyDescriptors, getTemplatePaths } from '../utils/templates';
+
+export default class AddCds extends Command {
+  static description = 'Setup your Cloud Foundry app to use a CDS service';
+  static aliases = ['add-cap'];
+  static examples = ['$ sap-cloud-sdk add-cds'];
+
+  static flags = {
+    // visible
+    force: flags.boolean({
+      description: 'Do not fail if a file or npm script already exist and overwrite it.'
+    }),
+    help: flags.help({
+      char: 'h',
+      description: 'Show help for the add-cds command.'
+    }),
+    verbose: flags.boolean({
+      char: 'v',
+      description: 'Show more detailed output.'
+    }),
+    // hidden
+    projectName: flags.string({
+      hidden: true,
+      description: 'Give project name which is used for the Cloud Foundry mainfest.yml.'
+    }),
+    skipInstall: flags.boolean({
+      hidden: true,
+      description: 'Skip installing npm dependencies. If you use this, make sure to install manually afterwards.'
+    })
+  };
+
+  static args = [
+    {
+      name: 'projectDir',
+      description: 'Path to the project directory in which the cds sources should be added.'
+    }
+  ];
+
+  async run() {
+    const { flags, args } = this.parse(AddCds);
+    const projectDir = args.projectDir || '.';
+
+    try {
+      const options = await this.getOptions();
+      const tasks = new Listr([
+        {
+          title: 'Creating files',
+          task: () => {
+            const copyDescriptors = getCopyDescriptors(projectDir, getTemplatePaths(['add-cds']));
+            findConflicts(copyDescriptors, flags.force);
+            copyFiles(copyDescriptors, options);
+          }
+        },
+        {
+          title: 'Adding dependencies to package.json',
+          task: () => modifyPackageJson({ projectDir, force: flags.force, addCds: true })
+        },
+        {
+          title: 'Installing dependencies',
+          task: () => installDependencies(projectDir, flags.verbose).catch(e => this.error(`Error during npm install: ${e.message}`, { exit: 13 })),
+          enabled: () => !flags.skipInstall
+        },
+        {
+          title: 'Modifying `.gitignore`',
+          task: () => modifyGitIgnore(projectDir, true)
+        }
+      ]);
+
+      await tasks.run();
+
+      this.printSuccessMessage();
+    } catch (error) {
+      this.error(error, { exit: 1 });
+    }
+  }
+
+  private async getOptions() {
+    const projectName = getProjectNameFromManifest(this);
+
+    const options: { [key: string]: string } = {
+      projectName: projectName || (await cli.prompt('Enter project name as maintained in Cloud Foundry'))
+    };
+
+    return options;
+  }
+
+  private printSuccessMessage() {
+    this.log(
+      [
+        '✅ Successfully added a cds service to your project.',
+        '',
+        'Generated service needs to be exposed.',
+        'For express apps you can do this by adding the following snippet to your code:',
+        'cds',
+        '  .connect()',
+        "  .serve('CatalogService')",
+        '  .in(<your-express-app>)',
+        '',
+        'For other frameworks please refer to the documentation.'
+      ].join('\n')
+    );
+  }
+}

src/commands/add-cx-server.ts

@@ -15,11 +15,6 @@ export default class AddCxServer extends Command {
   static examples = ['$ sap-cloud-sdk add-cx-server'];
 
   static flags = {
-    projectDir: flags.string({
-      hidden: true,
-      default: '',
-      description: 'Path to the folder in which the project should be created.'
-    }),
     force: flags.boolean({
       description: 'Do not fail if a file already exist and overwrite it.'
     }),
@@ -28,17 +23,28 @@ export default class AddCxServer extends Command {
       default: process.platform,
       description: 'The currently running OS.'
     }),
-    help: flags.help({ char: 'h' })
+    help: flags.help({
+      char: 'h',
+      description: 'Show help for the add-cx-server command.'
+    })
   };
 
+  static args = [
+    {
+      name: 'projectDir',
+      description: 'Path to the project directory to which the cx-server should be added.'
+    }
+  ];
+
   async run() {
-    const { flags } = this.parse(AddCxServer);
+    const { flags, args } = this.parse(AddCxServer);
+    const projectDir = args.projectDir || '.';
     const options = await this.getOptions();
 
     try {
-      const files = [this.copyDescriptorForGithub('cx-server', flags), this.copyDescriptorForGithub('server.cfg', flags)];
+      const files = [this.copyDescriptorForGithub('cx-server', projectDir), this.copyDescriptorForGithub('server.cfg', projectDir)];
       if (flags.platform === 'win32') {
-        files.push(this.copyDescriptorForGithub('cx-server.bat', flags));
+        files.push(this.copyDescriptorForGithub('cx-server.bat', projectDir));
       }
 
       const tasks = new Listr([
@@ -58,12 +64,12 @@ export default class AddCxServer extends Command {
     }
   }
 
-  private copyDescriptorForGithub(fileName: string, flags: Flags): CopyDescriptor {
+  private copyDescriptorForGithub(fileName: string, projectDir: string): CopyDescriptor {
     const githubPrefix = 'https://raw.githubusercontent.com/SAP/devops-docker-cx-server/master/cx-server-companion/life-cycle-scripts/';
 
     return {
       sourcePath: new URL(fileName, githubPrefix),
-      fileName: path.resolve(flags.projectDir, 'cx-server', fileName)
+      fileName: path.resolve(projectDir, 'cx-server', fileName)
     };
   }