test(cli): add test cases for basic commands

Author: oscar60310

.gitignore

@@ -39,4 +39,5 @@ testem.log
 Thumbs.db
 
 # testing folder from cli
-my-first-vulcan-project
+my-first-vulcan-project
+test-vulcan-project

packages/cli/src/cli.ts

@@ -0,0 +1,61 @@
+import { program } from 'commander';
+import { handleInit, handleStart, handleVersion } from './commands';
+import { handleBuild } from './commands/build';
+import { handleServe } from './commands/serve';
+
+program.exitOverride();
+
+program
+  .command('version')
+  .description('show the version of CLI and Vulcan packages')
+  .action(async () => {
+    await handleVersion();
+  });
+
+program
+  .command('init')
+  .description('create a new Vulcan project')
+  .option('-p --project-name <project-name>', 'specify project name')
+  .action(async (options) => {
+    await handleInit(options);
+  });
+
+program
+  .command('build')
+  .description('build Vulcan project')
+  .option(
+    '-c --config <config-path>',
+    'path to Vulcan config file',
+    './vulcan.yaml'
+  )
+  .action(async (options) => {
+    await handleBuild(options);
+  });
+
+program
+  .command('serve')
+  .description('serve Vulcan project')
+  .option(
+    '-c --config <config-path>',
+    'path to Vulcan config file',
+    './vulcan.yaml'
+  )
+  .option('-p --port <port>', 'server port', '3000')
+  .action(async (options) => {
+    await handleServe(options);
+  });
+
+program
+  .command('start')
+  .description('build and serve Vulcan project')
+  .option(
+    '-c --config <config-path>',
+    'path to Vulcan config file',
+    './vulcan.yaml'
+  )
+  .option('-p --port <port>', 'server port', '3000')
+  .action(async (options) => {
+    await handleStart(options);
+  });
+
+export { program };

packages/cli/src/commands/init.ts

@@ -52,7 +52,8 @@ export const createProject = async (
           name: options.projectName,
           dependencies: {
             '@vulcan-sql/core': options.version,
-            // TODO: Install build/serve package when they are ready
+            '@vulcan-sql/build': options.version,
+            '@vulcan-sql/serve': options.version,
           },
         },
         null,

packages/cli/src/index.ts

@@ -1,65 +1,7 @@
 #!/usr/bin/env node
 
-import { program } from 'commander';
-import { handleInit, handleStart, handleVersion } from './commands';
-import { handleBuild } from './commands/build';
-import { handleServe } from './commands/serve';
 import { logger } from './utils';
-
-program.exitOverride();
-
-program
-  .command('version')
-  .description('show the version of CLI and Vulcan packages')
-  .action(async () => {
-    await handleVersion();
-  });
-
-program
-  .command('init')
-  .description('create a new Vulcan project')
-  .option('-p --project-name <project-name>', 'specify project name')
-  .action(async (options) => {
-    await handleInit(options);
-  });
-
-program
-  .command('build')
-  .description('build Vulcan project')
-  .option(
-    '-c --config <config-path>',
-    'path to Vulcan config file',
-    './vulcan.yaml'
-  )
-  .action(async (options) => {
-    await handleBuild(options);
-  });
-
-program
-  .command('serve')
-  .description('serve Vulcan project')
-  .option(
-    '-c --config <config-path>',
-    'path to Vulcan config file',
-    './vulcan.yaml'
-  )
-  .option('-p --port <port>', 'server port', '3000')
-  .action(async (options) => {
-    await handleServe(options);
-  });
-
-program
-  .command('start')
-  .description('build and serve Vulcan project')
-  .option(
-    '-c --config <config-path>',
-    'path to Vulcan config file',
-    './vulcan.yaml'
-  )
-  .option('-p --port <port>', 'server port', '3000')
-  .action(async (options) => {
-    await handleStart(options);
-  });
+import { program } from './cli';
 
 (async () => {
   try {

packages/cli/src/utils/shutdown.ts

@@ -8,9 +8,13 @@ export const addShutdownJob = (job: JobBeforeShutdown) => {
   shutdownJobs.push(job);
 };
 
-process.on('SIGINT', async () => {
+export const runShutdownJobs = async () => {
   logger.info('Ctrl-C signal caught, stopping services...');
   await Promise.all(shutdownJobs.map((job) => job()));
   logger.info('Bye.');
+};
+
+process.on('SIGINT', async () => {
+  await runShutdownJobs();
   process.exit(0);
 });

packages/cli/test/cli.spec.ts

@@ -0,0 +1,64 @@
+import { program } from '../src/cli';
+import { promises as fs } from 'fs';
+import * as jsYAML from 'js-yaml';
+import * as path from 'path';
+import { runShutdownJobs } from '../src/utils';
+import * as supertest from 'supertest';
+
+const projectName = 'test-vulcan-project';
+
+const workspaceRoot = path.resolve(__dirname, '..', '..', '..');
+const projectRoot = path.resolve(workspaceRoot, projectName);
+
+beforeAll(async () => {
+  await fs.rm(projectRoot, { recursive: true, force: true });
+  await program.parseAsync(['node', 'vulcan', 'init', '-p', projectName]);
+  process.chdir(projectRoot);
+}, 30000);
+
+afterAll(async () => {
+  await fs.rm(projectRoot, { recursive: true, force: true });
+});
+
+afterEach(async () => {
+  await runShutdownJobs();
+});
+
+it('Init command should create new folder with default config', async () => {
+  // Action
+  const config: any = jsYAML.load(
+    await fs.readFile(path.resolve(projectRoot, 'vulcan.yaml'), 'utf8')
+  );
+  // Assert
+  expect(config.name).toBe(projectName);
+});
+
+it('Build command should make result.json', async () => {
+  // Action
+  await program.parseAsync(['node', 'vulcan', 'build']);
+  // Assert
+  expect(
+    fs.readFile(path.resolve(projectRoot, 'result.json'), 'utf-8')
+  ).resolves.not.toThrow();
+});
+
+it('Serve command should start Vulcan server', async () => {
+  // Action
+  await program.parseAsync(['node', 'vulcan', 'build']);
+  await program.parseAsync(['node', 'vulcan', 'serve', '-p', '12345']);
+  const agent = supertest('http://localhost:12345');
+  const result = await agent.get('/');
+  // Assert
+  expect(result.statusCode).toBe(200);
+  await runShutdownJobs();
+});
+
+it('Start command should build the project and start Vulcan server', async () => {
+  // Action
+  await program.parseAsync(['node', 'vulcan', 'start', '-p', '12345']);
+  const agent = supertest('http://localhost:12345');
+  const result = await agent.get('/');
+  // Assert
+  expect(result.statusCode).toBe(200);
+  await runShutdownJobs();
+});

packages/cli/tsconfig.spec.json

@@ -5,5 +5,11 @@
     "module": "commonjs",
     "types": ["jest", "node"]
   },
-  "include": ["jest.config.ts", "**/*.test.ts", "**/*.spec.ts", "**/*.d.ts"]
+  "include": [
+    "jest.config.ts",
+    "**/*.test.ts",
+    "**/*.spec.ts",
+    "**/*.d.ts.",
+    "../../types/*.d.ts"
+  ]
 }