feature(test): add command tests

- added unit and integration tests for the init, launch and serve commands
- refactored the init command codebase to make them easier to test and debug
- moved flags and questions(prompts) config now live to separate files outside the command classes
- added config to query-engine flag to prevent invalid engines
- added config to storage flag to prevent an invalid string
- configured proper test environment to prevent overwriting the user's config file

Author: hjaraujof

.gitignore

@@ -14,4 +14,7 @@ yalc.lock
 /src/plugins
 /cg
 /dgraph
-.DS_Store
+.DS_Store
+/coverage
+/test/.testConfigDir
+/test/.testData

jest.config.js

@@ -0,0 +1,25 @@
+module.exports = {
+  collectCoverage: true,
+  collectCoverageFrom: ['src/**/*.ts'],
+  coveragePathIgnorePatterns: [
+    '/templates/',
+    '/plugins/',
+    '/examples/',
+    '/docs/',
+    '/coverage/',
+    '/bin/',
+  ],
+  coverageReporters: ['lcov', 'text-summary'],
+  coverageThreshold: {
+    global: {
+      branches: 80,
+      functions: 80,
+      lines: 80,
+      statements: 80,
+    },
+  },
+  moduleFileExtensions: ['ts', 'js', 'json'],
+  testEnvironment: 'node',
+  testMatch: ['<rootDir>/test/**/*.test.ts'],
+  transform: { '\\.ts$': 'ts-jest' },
+}

package.json

@@ -40,7 +40,7 @@
   "devDependencies": {
     "@autocloud/eslint-config": "^0.1.0",
     "@oclif/dev-cli": "^1",
-    "@oclif/test": "^1",
+    "@oclif/test": "^1.2.8",
     "@semantic-release/changelog": "^5.0.1",
     "@semantic-release/git": "^9.0.0",
     "@semantic-release/gitlab": "^6.2.2",
@@ -49,12 +49,12 @@
     "@types/cli-table": "^0.3.0",
     "@types/express": "^4.17.13",
     "@types/inquirer": "^7.3.2",
-    "@types/mocha": "^5",
+    "@types/jest": "^27.0.1",
     "@types/node": "^14",
     "@types/pino": "^6.3.8",
     "@typescript-eslint/eslint-plugin": "^4.28.5",
     "@typescript-eslint/parser": "^4.28.5",
-    "chai": "^4",
+    "chai": "^4.3.4",
     "eslint-config-airbnb-base": "14.2.1",
     "eslint-config-oclif": "^3.1",
     "eslint-config-oclif-typescript": "^0.1",
@@ -63,11 +63,12 @@
     "eslint-plugin-prettier": "^3.4.0",
     "globby": "^10",
     "husky": "^4.3.0",
+    "jest": "^27.1.0",
+    "jest-diff": "^27.1.0",
     "lint-staged": "^11.1.1",
-    "mocha": "^5",
-    "nyc": "^14",
     "semantic-release": "^17.4.4",
-    "ts-node": "^8",
+    "ts-jest": "^27.0.5",
+    "ts-node": "^10.2.1",
     "typescript": "^4.3.5"
   },
   "engines": {
@@ -106,7 +107,8 @@
     "run:scan": "NODE_ENV=development ./bin/run scan",
     "run:scan:aws": "NODE_ENV=development ./bin/run scan aws",
     "run:launch": "NODE_ENV=development ./bin/run launch",
-    "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "test": "CG_DEBUG=-1 NODE_ENV=test jest --coverage=true --detectOpenHandles --runInBand --forceExit",
+    "test:debug": "CG_DEBUG=5 NODE_ENV=test jest --coverage=false --detectOpenHandles --runInBand --forceExit",
     "version": "oclif-dev readme && git add README.md",
     "lint": "eslint --config .eslintrc.json --ext .js,.ts ./",
     "lint:fix": "eslint --fix --config .eslintrc.json --ext .js,.ts ./"

src/commands/base.ts

@@ -1,18 +1,24 @@
-import Command, { flags } from '@oclif/command'
+import Command from '@oclif/command'
 import { Input } from '@oclif/parser'
 import CloudGraph, { Logger } from '@cloudgraph/sdk'
 import { cosmiconfigSync } from 'cosmiconfig'
-import path from 'path'
-import inquirer from 'inquirer'
 import chalk from 'chalk'
+import inquirer from 'inquirer'
+import path from 'path'
 import gt from 'semver/functions/gt'
 import Manager from '../manager'
 import EngineMap from '../storage'
 import QueryEngine from '../server'
 import { StorageEngine, StorageEngineConnectionConfig } from '../storage/types'
-import { getStorageEngineConnectionConfig, printWelcomeMessage, printBoxMessage } from '../utils'
+import {
+  getDefaultEndpoint,
+  getDefaultStorageEngineConnectionConfig,
+  getStorageEngineConnectionConfig,
+  printWelcomeMessage,
+  printBoxMessage
+} from '../utils'
+import flagsDefinition from '../utils/flags'
 import openBrowser from '../utils/open'
-import { DEFAULT_CONFIG } from '../utils/constants'
 
 export default abstract class BaseCommand extends Command {
   constructor(argv: any, config: any) {
@@ -37,49 +43,7 @@ export default abstract class BaseCommand extends Command {
 
   storedConfig: { [key: string]: any } | undefined
 
-  static flags = {
-    // devMode flag
-    dev: flags.boolean({ description: 'Turn on developer mode' }),
-    // dgraph host
-    dgraph: flags.string({
-      char: 'd',
-      env: 'CG_HOST_PORT',
-      description: 'Set where dgraph is running (default localhost:8997)',
-    }),
-    // storage engine to use
-    storage: flags.string({
-      char: 's',
-      description:
-        'Select a storage engine to use. Currently only supports Dgraph',
-    }),
-    // dir to store cloud graph data versions in
-    directory: flags.string({
-      description:
-        'Set the folder where CloudGraph will store data. (default cg)',
-    }),
-    // serve query engine after scan/load
-    'no-serve': flags.boolean({
-      default: false,
-      description: 'Set to not serve a query engine',
-    }),
-    // port for query engine
-    port: flags.integer({
-      char: 'p',
-      env: 'CG_QUERY_PORT',
-      description: 'Set port to serve query engine',
-    }),
-    // Query Engine to use
-    'query-engine': flags.string({
-      char: 'q',
-      description: 'Query engine to launch',
-    }),
-    // version limit
-    'version-limit': flags.string({
-      char: 'l',
-      description:
-        'Limit the amount of version folders stored on the filesystem (default 10)',
-    }),
-  }
+  static flags = flagsDefinition
 
   static hidden = true
 
@@ -205,12 +169,10 @@ Run ${chalk.italic.green('npm i -g @cloudgraph/cli')} to install`)
       // nothing found, return default location
 
       showInitialStatus &&
-        this.logger.info(
-          `Dgraph host set as: ${DEFAULT_CONFIG.scheme}://${DEFAULT_CONFIG.host}:${DEFAULT_CONFIG.port}`
-        )
-      return DEFAULT_CONFIG
+        this.logger.info(`Dgraph host set as: ${getDefaultEndpoint()}`)
+      return getDefaultStorageEngineConnectionConfig()
     }
-    return DEFAULT_CONFIG
+    return getDefaultStorageEngineConnectionConfig()
   }
 
   getHost(config: StorageEngineConnectionConfig): string {
@@ -222,7 +184,11 @@ Run ${chalk.italic.green('npm i -g @cloudgraph/cli')} to install`)
       flags: { dev: devMode },
     } = this.parse(this.constructor as Input<{ dev: boolean }>)
     if (!this.manager) {
-      this.manager = new Manager({ logger: this.logger, devMode, cliConfig: this.config })
+      this.manager = new Manager({
+        logger: this.logger,
+        devMode,
+        cliConfig: this.config,
+      })
     }
     return this.manager
   }