Merge pull request #421 from pharindoko/feat/add-validation-cli-option

Feat/add validation cli option

Author: pharindoko

.travis.yml

@@ -12,7 +12,6 @@ notifications:
 node_js:
   - '10'
 before_install:
-  - pip install awscli
   - git log $(git describe --tags --abbrev=0)..HEAD --oneline
   - echo $COMMITCOUNT
 install:
@@ -38,16 +37,6 @@ jobs:
         - npm run test
       before_script: cd packages/server
       name: test-server
-    - script:
-        - npm run build
-        - bin/run --version
-        - npm run deploy
-      before_script:
-        - make fake-credentials
-        - cd packages/cli
-      after_script: npm run remove
-      name: deploy-cli
-
     - stage: release
       if: (type = push AND branch = master)
       before_script:

.vscode/launch.json

@@ -19,7 +19,7 @@ $ npm install -g json-serverless
 $ jsonsls COMMAND
 running command...
 $ jsonsls (-v|--version|version)
-json-serverless/1.5.41 linux-x64 node-v10.21.0
+json-serverless/1.5.41 darwin-x64 node-v14.2.0
 $ jsonsls --help [COMMAND]
 USAGE
   $ jsonsls COMMAND
@@ -32,6 +32,7 @@ USAGE
 * [`jsonsls help [COMMAND]`](#jsonsls-help-command)
 * [`jsonsls run FILE`](#jsonsls-run-file)
 * [`jsonsls update-stack`](#jsonsls-update-stack)
+* [`jsonsls validate`](#jsonsls-validate)
 
 ## `jsonsls create-stack FILE [STAGE]`
 
@@ -106,4 +107,20 @@ OPTIONS
   -r, --readonly                           set api to readonly (true) or writeable (false)
   -s, --[no-]swagger                       enable or disable swagger interface support
 ```
+
+## `jsonsls validate`
+
+Describe the command here
+
+```
+USAGE
+  $ jsonsls validate
+
+OPTIONS
+  -n, --name=name  name to print
+
+DESCRIPTION
+  ...
+  Extra documentation goes here
+```
 <!-- commandsstop -->

packages/cli/README.md

@@ -6,6 +6,16 @@ import figlet from 'figlet';
 import chalk from 'chalk';
 import cli from 'cli-ux';
 export class Helpers {
+  static readFileSync(directoryPath: string): string {
+    const normalizedPath = path.normalize(directoryPath);
+    if (!fs.existsSync(normalizedPath)) {
+      throw new Error('file' + normalizedPath + ' does not exist');
+    } else {
+      const file = fs.readFileSync(normalizedPath, 'UTF-8');
+      return file;
+    }
+  }
+
   static validateFile(filePath: string): string {
     if (!path.isAbsolute(filePath)) {
       filePath = path.normalize(process.cwd() + '/' + filePath);
@@ -217,7 +227,6 @@ export class Helpers {
     apiAuth: boolean,
     enableSwagger: boolean
   ) {
-
     const rows = JSON.stringify(slsinfo).split('\\n') as any[];
     const createKeyValues = rows.map((x, i, rows) => {
       if (x.startsWith('  ANY -')) {

packages/cli/src/actions/helpers.ts

@@ -2,15 +2,16 @@ import * as inquirer from 'inquirer';
 import fs from 'fs-extra';
 import { Command, flags } from '@oclif/command';
 import Listr = require('listr');
-import { AppConfig } from 'json-serverless-lib';
+import { AppConfig, LogLevel } from 'json-serverless-lib';
 import * as path from 'path';
 import cli from 'cli-ux';
 import { Helpers } from '../actions/helpers';
 import { AWSActions } from '../actions/aws-actions';
 import { ServerlessConfig } from '../classes/serverlessconfig';
 import chalk from 'chalk';
 export class CreateStackCommand extends Command {
-  static description = 'create the stackfolder and deploy the stack in the cloud';
+  static description =
+    'create the stackfolder and deploy the stack in the cloud';
 
   static flags = {
     help: flags.help({ char: 'h' }),
@@ -65,6 +66,14 @@ export class CreateStackCommand extends Command {
       default: false, // default value if flag not passed (can be a function that returns a string or undefined)
       required: false, // make flag required (this is not common and you should probably use an argument instead)
     }),
+    loglevel: flags.string({
+      char: 'l', // shorter flag version
+      description: 'loglevel of outputs', // help description for flag
+      hidden: false, // hide from help
+      default: 'info',
+      options: ['info', 'debug'], // default value if flag not passed (can be a function that returns a string or undefined)
+      required: false, // make flag required (this is not common and you should probably use an argument instead)
+    }),
   };
 
   static args = [
@@ -186,6 +195,7 @@ export class CreateStackCommand extends Command {
             appconfig.readOnly = flags.readonly;
             appconfig.enableSwagger = flags.swagger;
             appconfig.stackName = stackName!;
+            appconfig.logLevel = flags.loglevel as LogLevel;;
             Helpers.createDir(stackFolder + '/config');
             fs.writeFileSync(
               path.normalize(stackFolder + '/config/appconfig.json'),

packages/cli/src/commands/create-stack.ts

@@ -1,5 +1,5 @@
 import { Command, flags } from '@oclif/command';
-import { startServer, AppConfig } from 'json-serverless-lib';
+import { startServer, AppConfig, LogLevel } from 'json-serverless-lib';
 import express from 'express';
 import { Helpers } from '../actions/helpers';
 import cli from 'cli-ux';
@@ -33,6 +33,14 @@ export class Run extends Command {
       default: false, // default value if flag not passed (can be a function that returns a string or undefined)
       required: false, // default value if flag not passed (can be a function that returns a string or undefined)
     }),
+    loglevel: flags.string({
+      char: 'l', // shorter flag version
+      description: 'loglevel of outputs', // help description for flag
+      hidden: false, // hide from help
+      default: 'info',
+      options: ['info', 'debug'], // default value if flag not passed (can be a function that returns a string or undefined)
+      required: false, // make flag required (this is not common and you should probably use an argument instead)
+    }),
   };
 
   static args = [
@@ -53,6 +61,7 @@ export class Run extends Command {
     const defaultConfig = new AppConfig();
     defaultConfig.readOnly = flags.readonly;
     defaultConfig.enableSwagger = flags.swagger;
+    defaultConfig.logLevel = flags.loglevel as LogLevel;
     defaultConfig.jsonFile = args.file;
     if (args.file && flags.env) {
       const promise = startServer(

packages/cli/src/commands/run.ts

@@ -6,10 +6,11 @@ import { Helpers } from '../actions/helpers';
 import { AWSActions } from '../actions/aws-actions';
 import chalk from 'chalk';
 import cli from 'cli-ux';
-import { AppConfig } from 'json-serverless-lib';
+import { AppConfig, LogLevel } from 'json-serverless-lib';
 
 export class UpdateStackCommand extends Command {
-  static description = 'update the stackfolder and update the stack in the cloud';
+  static description =
+    'update the stackfolder and update the stack in the cloud';
 
   static flags = {
     help: flags.help({ char: 'h' }),
@@ -43,6 +44,14 @@ export class UpdateStackCommand extends Command {
       default: '', // default value if flag not passed (can be a function that returns a string or undefined)
       required: false, // make flag required (this is not common and you should probably use an argument instead)
     }),
+    loglevel: flags.string({
+      char: 'l', // shorter flag version
+      description: 'loglevel of outputs', // help description for flag
+      hidden: false, // hide from help
+      default: 'info',
+      options: ['info', 'debug'], // default value if flag not passed (can be a function that returns a string or undefined)
+      required: false, // make flag required (this is not common and you should probably use an argument instead)
+    }),
   };
 
   async run() {
@@ -116,12 +125,13 @@ export class UpdateStackCommand extends Command {
       {
         title: 'Update Appconfig',
         task: (ctx, task) => {
-          const appConfig = JSON.parse(
+          const appConfig: AppConfig = JSON.parse(
             fs.readFileSync(stackFolder + '/config/appconfig.json', 'UTF-8')
           );
           appConfig.enableApiKeyAuth = flags.apikeyauth;
           appConfig.readOnly = flags.readonly;
           appConfig.enableSwagger = flags.swagger;
+          appConfig.logLevel = flags.loglevel as LogLevel;
           fs.writeFileSync(
             path.normalize(stackFolder + '/config/appconfig.json'),
             JSON.stringify(appConfig, null, 2),
@@ -190,7 +200,6 @@ export class UpdateStackCommand extends Command {
         appConfig.enableApiKeyAuth,
         appConfig.enableSwagger
       );
-
     } catch (error) {
       this.log(`${chalk.red(error.message)}`);
       this.log(slsinfo);

packages/cli/src/commands/update-stack.ts

@@ -0,0 +1,52 @@
+import { Command, flags } from '@oclif/command';
+import { JSONValidator, Output } from 'json-serverless-lib';
+import { Helpers } from '../actions/helpers';
+import chalk from 'chalk';
+export class Validate extends Command {
+  static description = 'describe the command here';
+
+  static flags = {
+    help: flags.help({ char: 'h' }),
+    swagger: flags.boolean({
+      char: 's', // shorter flag version
+      description: 'enable or disable swagger interface support', // help description for flag
+      hidden: false, // hide from help
+      default: true, // default value if flag not passed (can be a function that returns a string or undefined)
+      required: false, // make flag required (this is not common and you should probably use an argument instead)
+      allowNo: true,
+    }),
+  };
+
+  static args = [
+    {
+      name: 'file', // name of arg to show in help and reference with args[name]
+      required: true, // make the arg required with `required: true`
+      description: 'path of JSON file', // help description
+      hidden: false, // hide this arg from help
+    },
+  ];
+
+  async run() {
+    const logo = await Helpers.generateLogo('json-serverless');
+    this.log(`${chalk.blueBright(logo)}`);
+    this.log();
+    const { args, flags } = this.parse(Validate);
+    const filePath = Helpers.validateFile(args.file);
+    const jsonFileContent = JSON.parse(Helpers.readFileSync(filePath));
+    const validationResult = JSONValidator.validate(
+      jsonFileContent,
+      flags.swagger
+    );
+    if (validationResult.isValid) {
+      this.log(
+        `${chalk.green('Validation was successful - No errors found.')}`
+      );
+    } else {
+      this.log(
+        `${chalk.red('Validation was not successful - see details below.')}`
+      );
+    }
+    this.log();
+    Output.printValidationReport(validationResult);
+  }
+}

packages/cli/src/commands/validate.ts

@@ -10,6 +10,7 @@
   },
   "scripts": {
     "test": "npx jest",
+    "debug": "nodemon --watch 'src/**/*.ts' --ignore 'src/**/*.spec.ts' --exec node --inspect-brk -r ts-node/register example/index.ts",
     "start": "nodemon --watch 'src/**/*.ts' --ignore 'src/**/*.spec.ts' --exec 'ts-node' example/index.ts",
     "type-check": "tsc --noEmit",
     "type-check:watch": "npm run type-check -- --watch",
@@ -29,6 +30,7 @@
   },
   "homepage": "https://github.com/pharindoko/json-serverless.git#readme",
   "dependencies": {
+    "ajv": "^6.12.2",
     "cors": "^2.8.5",
     "dotenv": "^8.2.0",
     "express": "^4.17.1",
@@ -47,7 +49,8 @@
     "source-map-support": "^0.5.16",
     "supertest": "^4.0.2",
     "swagger-to-graphql": "^4.0.2",
-    "swagger-ui-express": "^4.1.4"
+    "swagger-ui-express": "^4.1.4",
+    "table": "^5.4.6"
   },
   "devDependencies": {
     "@types/aws-lambda": "8.10.52",
@@ -65,6 +68,7 @@
     "@types/supertest": "2.0.9",
     "@types/swagger-schema-official": "2.0.21",
     "@types/swagger-ui-express": "4.1.2",
+    "@types/table": "^5.0.0",
     "cz-conventional-changelog": "3.2.0",
     "eslint": "7.1.0",
     "eslint-config-airbnb-base": "14.1.0",
@@ -75,7 +79,7 @@
     "nodemon": "2.0.4",
     "ts-jest": "26.1.0",
     "ts-loader": "7.0.5",
-    "typescript": "3.9.3"
+    "typescript": "^3.9.3"
   },
   "config": {
     "commitizen": {