feat: add docker

Author: allohamora

__tests__/utils/run-command.test.ts

@@ -10,13 +10,19 @@ beforeEach(() => {
   jest.clearAllMocks();
 });
 
-const spawnMock = async <EV>(event: 'exit' | 'error' = 'exit', emitValue?: EV, delayMs = 200) => {
-  const ee = new EventEmitter();
+class ChildMock extends EventEmitter {
+  public stdout = new EventEmitter();
+}
 
-  const exitHandler = () => ee.emit(event, emitValue);
+const spawnMock = <EV>(event: 'exit' | 'error' = 'exit', emitValue?: EV, delayMs = 200) => {
+  const child = new ChildMock();
+
+  const exitHandler = () => child.emit(event, emitValue);
   delay(delayMs).then(exitHandler);
 
-  childProcessMocked.spawn.mockReturnValueOnce(ee as ReturnType<typeof childProcess.spawn>);
+  childProcessMocked.spawn.mockReturnValueOnce(child as ReturnType<typeof childProcess.spawn>);
+
+  return child;
 };
 
 describe('spawnCommand', () => {
@@ -51,6 +57,21 @@ describe('spawnCommand', () => {
 
     throw new Error(`command doesn't crashed`);
   });
+
+  test('should return stdout result', async () => {
+    const child = spawnMock('exit');
+    const chunks = ['Hello', 'World'].map((value) => Buffer.from(value, 'utf-8'));
+
+    const spawnResult = spawnCommand(command, args);
+
+    for (const chunk of chunks) {
+      child.stdout.emit('data', chunk);
+    }
+
+    const result = await spawnResult;
+
+    expect(result).toBe(chunks.join(''));
+  });
 });
 
 describe('runCommand', () => {

src/categories/js/docker/config/default.config.ts

@@ -0,0 +1,40 @@
+import { readableMultilineString } from 'src/utils/string';
+import { DOCKER_FILE_NAME, DOCKER_IGNORE_NAME } from '../docker.const';
+
+interface GetDockerFileArgs {
+  version: string;
+}
+
+export const getDockerFile = ({ version }: GetDockerFileArgs) => readableMultilineString`
+  FROM node:${version}
+  WORKDIR /app
+
+  COPY package*.json ./
+  RUN npm ci
+
+  COPY . .
+  ENV NODE_ENV production
+  RUN npm run build
+
+  EXPOSE 3000
+
+  CMD npm run start
+`;
+
+export const dockerIgnore = readableMultilineString`
+  node_modules
+  dist
+  build
+
+  .husky
+  .git
+
+  ${DOCKER_IGNORE_NAME}
+  ${DOCKER_FILE_NAME}
+  .docker-compose.yml
+`;
+
+export const defaultConfig = {
+  getDockerFile,
+  dockerIgnore,
+};

src/categories/js/docker/docker.config.ts

@@ -0,0 +1,6 @@
+import { jsCategoryState } from 'src/states/categories';
+import { defaultConfig } from './config/default.config';
+
+export const [getConfig] = jsCategoryState.useConfigState({
+  default: defaultConfig,
+});

src/categories/js/docker/docker.const.ts

@@ -0,0 +1,2 @@
+export const DOCKER_FILE_NAME = 'DockerFile';
+export const DOCKER_IGNORE_NAME = '.dockerignore';

src/categories/js/docker/docker.entrypoint.ts

@@ -0,0 +1,13 @@
+import { addFileToRoot } from 'src/utils/fs';
+import { getNodeVersion } from 'src/utils/node';
+import { getConfig } from './docker.config';
+import { DOCKER_FILE_NAME, DOCKER_IGNORE_NAME } from './docker.const';
+
+export const docker = async () => {
+  const { getDockerFile, dockerIgnore } = getConfig();
+  const version = await getNodeVersion();
+  const dockerFile = getDockerFile({ version });
+
+  await addFileToRoot(DOCKER_FILE_NAME, dockerFile);
+  await addFileToRoot(DOCKER_IGNORE_NAME, dockerIgnore);
+};

src/categories/js/index.ts

@@ -11,6 +11,7 @@ import { testWorkflow } from './test-workflow/test-workflow.entrypoint';
 import { codeqlWorkflow } from './codeql-workflow/codeql-workflow.entrypoint';
 import { buildWorkflow } from './build-workflow/build-workflow.entrypoint';
 import { dependabot } from './dependabot/dependabot.entrypoint';
+import { docker } from './docker/docker.entrypoint';
 
 // order have matter
 const options = {
@@ -27,6 +28,7 @@ const options = {
   codeqlWorkflow,
   buildWorkflow,
   dependabot,
+  docker,
 };
 
 export default {

src/utils/node.ts

@@ -0,0 +1,7 @@
+import { runCommand, spawnCommand } from './run-command';
+
+export const getNodeVersion = async () => {
+  const versionConsoleOutput = await runCommand('node -v');
+
+  return versionConsoleOutput.trim().replace('v', '');
+};

src/utils/run-command.ts

@@ -1,12 +1,19 @@
 import { spawn } from 'child_process';
+import { on } from 'events';
 
-export const spawnCommand = async (command: string, args: string[]) =>
-  new Promise((res, rej) => {
+export const spawnCommand = async (command: string, args: string[]): Promise<string> => {
+  return new Promise(async (res, rej) => {
     const child = spawn(command, args);
+    let result = Buffer.alloc(0);
 
     child.on('error', (err) => rej(err));
-    child.on('exit', () => res(undefined));
+    child.on('exit', () => res(result.toString('utf-8')));
+
+    for await (const [chunk] of on(child.stdout, 'data')) {
+      result = Buffer.concat([result, chunk]);
+    }
   });
+};
 
 export const runCommand = async (command: string) => {
   const [name, ...args] = command.split(' ');