feat: v0.1.9 (#33)

* fix: -f flag added to npm clean script, prevents failure if ./dist does not exist

* feat: v0.1.8

* WIP: added dockerfiles for the remaining langs (#32)

* feat: accepting only suported languages

* feat: added dockerfiles for the remaining langs

* fix: trimming outputs before comparing

* fix: error handling got worker.build()

* feat: better error handling, closes #18 and #14

* feat: added log for error

* feat: v0.1.9

Co-authored-by: Rahil Kabani <[email protected]>

Author: roerohan

examples/master.ts

@@ -1,21 +1,18 @@
-/* eslint-disable no-console */
 import CodeExecutor from '../src/CodeExecutor';
 import logger from '../src/utils/logger';
 
 const codeExecutor = new CodeExecutor('myExecutor', 'redis://127.0.0.1:6379');
 
-/**
-  * base64: true is also an option if input,
-  * output and code are encoded in base64,
-  * default is false
-* */
-
 const pythonCode = `
 import time
 time.sleep(1)
 print('hello')
 `;
 
+const bashCode = `
+echo hello
+`;
+
 const inputs = [{
     language: 'Python',
     code: pythonCode,
@@ -29,7 +26,7 @@ const inputs = [{
 },
 {
     language: 'Bash',
-    code: 'echo hello',
+    code: bashCode,
     testCases: [
         {
             input: '',
@@ -43,7 +40,7 @@ async function main() {
     const results = await Promise.all(
         inputs.map((input) => codeExecutor.runCode(input)),
     );
-    logger.info(results);
+    logger.info(JSON.stringify(results));
     codeExecutor.stop();
 }
 

examples/worker.ts

@@ -1,30 +1,11 @@
-import { Worker, languages } from '../src/CodeExecutor';
-import logger from '../src/utils/logger';
+import { Worker } from '../src/CodeExecutor';
 
-/**
-  * name, redis, options
-  *
-  * Options:
-  *
-  * folderPath ( path to mount, default /tmp/code-exec ),
-  * memory (in MB, default 0, ie no limit),
-  * CPUs (no. of CPUs, default 0.5),
-*/
 const worker = new Worker('myExecutor', 'redis://127.0.0.1:6379');
 
 async function main() {
-    logger.info(languages);
-
-    /* array of languages is optional argument */
-    await worker.build(['Python', 'Bash']);
+    await worker.build();
 
     worker.start();
-
-    worker.pause();
-
-    worker.resume();
-
-    // worker.stop();
 }
 
 main();

package.json

@@ -1,6 +1,6 @@
 {
   "name": "code-executor",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "A CLI/library to execute code against test cases in various languages and obtain relevant results.",
   "main": "dist/src/CodeExecutor.js",
   "keywords": [

src/Builder.ts

@@ -26,13 +26,20 @@ export default class Builder {
                     t: `${lang.toLowerCase()}-runner`,
                 }));
             } else {
-                logger.error(`${lang} is not supported`);
+                streams.push(Promise.reject(new Error(`${lang} is not supported`)));
             }
         });
 
-        const progress: Promise<object>[] = [];
+        let resolvedStreams;
+        try {
+            resolvedStreams = await Promise.all(streams);
+        } catch (e) {
+            logger.error(e);
+            return Promise.reject(e);
+        }
 
-        (await Promise.all(streams)).forEach((stream) => {
+        const progress: Promise<object>[] = [];
+        (resolvedStreams).forEach((stream) => {
             stream.on('data', (chunk) => {
                 logger.debug(chunk);
             });
@@ -50,8 +57,13 @@ export default class Builder {
                 });
             }));
         });
-
-        await Promise.all(progress);
+        try {
+            await Promise.all(progress);
+        } catch (e) {
+            logger.error(e);
+            return Promise.reject(e);
+        }
         logger.info('Built containers successfully');
+        return null;
     }
 }

src/CodeExecutor.ts

@@ -1,7 +1,7 @@
 import Bull from 'bull';
 import { v4 as uuid } from 'uuid';
 
-import { CodeParams, Result } from './models/models';
+import { CodeParams } from './models/models';
 import logger from './utils/logger';
 import { extension } from './utils/findExtension';
 
@@ -10,35 +10,21 @@ const languages = Object.keys(extension);
 export default class CodeExecutor {
     private queue: Bull.Queue;
 
-    private jobs: Map<string, { resolve: Function, reject: Function }>;
-
     constructor(name: string, redis: string) {
         this.queue = new Bull(name, redis);
-
-        this.jobs = new Map();
-
-        this.queue.on('global:completed', (_job: Bull.Job, result: string) => {
-            const { id } = <Result>JSON.parse(result);
-
-            logger.debug(`Running on complete for id: ${id}`);
-
-            const currentJob = this.jobs.get(id);
-            if (currentJob) {
-                currentJob.resolve(result);
-                this.jobs.delete(id);
-            }
-        });
     }
 
     async runCode(codeOptions: CodeParams): Promise<void> {
+        if (!languages.includes(codeOptions.language)) {
+            return Promise.reject(new Error('Language not supported!'));
+        }
         const id = uuid();
         const codeObject = { ...codeOptions, id };
         logger.info(`Running code with id: ${id}`);
 
-        return new Promise((resolve, reject) => {
-            this.jobs.set(id, { resolve, reject });
-            this.queue.add(codeObject);
-        });
+        const job = await this.queue.add(codeObject);
+
+        return job.finished();
     }
 
     stop() {

src/Runner.ts

@@ -48,6 +48,7 @@ export default class Runner {
         const promisesToKeep: Array<Promise<Array<object>>> = [];
         for (let i = 0; i < Paths.length; i += 1) {
             promisesToKeep.push(this.docker.run(tag, ['bash', '/start.sh', `${i}`, `${timeout}`], null, {
+                User: 'runner',
                 HostConfig: {
                     CpuPeriod: 100000,
                     CpuQuota: CPUs * 1000000,
@@ -64,7 +65,11 @@ export default class Runner {
         }
         logger.info(`Starting process ${id}`);
         const t0 = performance.now();
-        await Promise.all(promisesToKeep);
+        try {
+            await Promise.all(promisesToKeep);
+        } catch (e) {
+            return Promise.reject(e);
+        }
         const t1 = performance.now();
         logger.info(`Process ${id} completed in ${(t1 - t0) / 1000} seconds`);
 
@@ -88,7 +93,7 @@ export default class Runner {
             if (exitCode === 124) {
                 remarks = 'Time limit exceeded';
             } else if (exitCode === 0) {
-                remarks = expectedOutput === obtainedOutput ? 'Pass' : 'Fail';
+                remarks = expectedOutput.trim() === obtainedOutput.trim() ? 'Pass' : 'Fail';
             } else {
                 remarks = 'Error';
             }

src/Worker.ts

@@ -55,17 +55,26 @@ export default class Worker {
         return result;
     }
 
-    async build(langs?: Array<string>) {
-        await this.builder.build(langs);
+    async build(langs?: Array<string>): Promise<void> {
+        try {
+            await this.builder.build(langs);
+            return null;
+        } catch (e) {
+            return Promise.reject(e);
+        }
     }
 
     start() {
         this.queue.process(async (job, done) => {
             logger.info(`Received: ${job.data.id}`);
-            const result = await this.work(job.data);
-
-            logger.debug(JSON.stringify(result));
-            done(null, result);
+            try {
+                const result = await this.work(job.data);
+                done(null, result);
+                logger.debug(JSON.stringify(result));
+            } catch (e) {
+                done(e);
+                logger.error(e);
+            }
         });
     }
 

src/langs/Bash/Dockerfile

@@ -1,3 +1,4 @@
 FROM bash:5.0.18
+RUN adduser --disabled-password --gecos "" runner
 COPY start.sh start.sh
 WORKDIR /app

src/langs/Brainfuck/Dockerfile

@@ -0,0 +1,4 @@
+FROM esolang/brainfuck-esotope:latest
+RUN adduser --disabled-password --gecos "" runner
+COPY start.sh start.sh
+WORKDIR /app

src/langs/Brainfuck/start.sh

@@ -0,0 +1,5 @@
+i=$1
+date +%s%N > /app/time$i.txt
+timeout $2 bash -c "(cat /app/in$i.txt | brainfuck-esotope /app/Main.bf) 2> /app/error$i.txt 1> /app/output$i.txt"
+echo $? > /app/exitCode$i.txt
+date +%s%N >> /app/time$i.txt

src/langs/C/Dockerfile

@@ -1,3 +1,4 @@
 FROM gcc:4.9
+RUN adduser --disabled-password --gecos "" runner
 COPY start.sh start.sh
 WORKDIR /app

src/langs/Golfscript/Dockerfile

@@ -0,0 +1,4 @@
+FROM esolang/golfscript:latest
+RUN adduser --disabled-password --gecos "" runner
+COPY start.sh start.sh
+WORKDIR /app

src/langs/Golfscript/start.sh

@@ -0,0 +1,5 @@
+i=$1
+date +%s%N > /app/time$i.txt
+timeout $2 bash -c "(cat /app/in$i.txt | golfscript /app/Main.gs) 2> /app/error$i.txt 1> /app/output$i.txt"
+echo $? > /app/exitCode$i.txt
+date +%s%N >> /app/time$i.txt

src/langs/Java/Dockerfile

@@ -1,3 +1,4 @@
 FROM java:8  
+RUN adduser --disabled-password --gecos "" runner
 COPY start.sh start.sh
 WORKDIR /app

src/langs/Javascript/Dockerfile

@@ -1,3 +1,4 @@
 FROM node:10-alpine
+RUN adduser --disabled-password --gecos "" runner
 COPY start.sh start.sh
 WORKDIR /app

src/langs/O5AB1E/Dockerfile

@@ -0,0 +1,4 @@
+FROM esolang/05ab1e:latest
+RUN adduser --disabled-password --gecos "" runner
+COPY start.sh start.sh
+WORKDIR /app

src/langs/O5AB1E/start.sh

@@ -0,0 +1,5 @@
+i=$1
+date +%s%N > /app/time$i.txt
+timeout $2 bash -c "(cat /app/in$i.txt | 05ab1e /app/Main.abe) 2> /app/error$i.txt 1> /app/output$i.txt"
+echo $? > /app/exitCode$i.txt
+date +%s%N >> /app/time$i.txt

src/langs/Perl/Dockerfile

@@ -1,3 +1,4 @@
 FROM perl:5.20
+RUN adduser --disabled-password --gecos "" runner
 COPY start.sh start.sh
 WORKDIR /app

src/langs/Python/Dockerfile

@@ -1,3 +1,4 @@
 FROM python:3.8-slim
+RUN adduser --disabled-password --gecos "" runner
 COPY start.sh start.sh
 WORKDIR /app

src/langs/Ruby/Dockerfile

@@ -1,3 +1,4 @@
 FROM ruby:2  
+RUN adduser --disabled-password --gecos "" runner
 COPY start.sh start.sh
 WORKDIR /app

src/langs/Rust/Dockerfile

@@ -1,3 +1,4 @@
 FROM rust:1.31
+RUN adduser --disabled-password --gecos "" runner
 COPY start.sh start.sh
 WORKDIR /app

src/langs/Swift/Dockerfile

@@ -1,3 +1,4 @@
-FROM swift
+FROM swift:latest
+RUN adduser --disabled-password --gecos "" runner
 COPY start.sh start.sh
 WORKDIR /app

src/utils/findExtension.ts

@@ -5,7 +5,7 @@ export default function findExtension(language: string) {
     let fileExtension = '';
     Object.entries(extension).forEach((entry) => {
         const [key, value] = entry;
-        if (key.toLowerCase() === language.toLowerCase()) {
+        if (key === language) {
             fileExtension = value;
         }
     });