refactor: scenario architecture

Author: jatinkatyal13

src/taskmaster.ts

@@ -32,10 +32,15 @@ amqp.connect(`amqp://${config.AMQP.USER}:${config.AMQP.PASS}@${config.AMQP.HOST}
         const payload = JSON.parse(msg.content.toString())      
 
         let job
-        if (payload.testcases) {
-          job = new SubmitJob(payload)
-        } else {
-          job = new RunJob(payload)
+        switch (payload.scenario) {
+          case 'submit':
+            job = new SubmitJob(payload)
+            break
+          case 'run':
+            job = new RunJob(payload)
+            break
+          default:
+            throw new Error("Scenario not declared")
         }
 
         const jobResult = await execute(job)

src/tasks/index.ts

@@ -3,8 +3,8 @@ import config = require('../../config.js')
 import {exec, mkdir, rm} from 'shelljs'
 import * as path from 'path'
 
-import RunScenario from './run'
-import SubmissionScenario from './submission'
+import RunScenario from './scenarios/run'
+import SubmissionScenario from './scenarios/submission'
 import { RunJob, SubmitJob, Job } from "./job";
 
 export function execute(job: RunJob): Promise<RunResult>
@@ -14,8 +14,6 @@ export async function execute (job: Job) {
   const currentJobDir = path.join(config.RUNBOX.DIR, job.id.toString())
   mkdir('-p', currentJobDir)
 
-  const LANG_CONFIG = config.LANGS[job.lang]
-
   let scenario
   if (job instanceof RunJob) {
     scenario = RunScenario
@@ -24,22 +22,13 @@ export async function execute (job: Job) {
   }
 
   // Setup RUNBOX
-  await scenario.setup(currentJobDir, job) // TODO:
+  await scenario.setup(currentJobDir, job) 
 
   // Run worker
-  exec(`docker run \\
-    --cpus="${LANG_CONFIG.CPU_SHARE}" \\
-    --memory="${LANG_CONFIG.MEM_LIMIT}" \\
-    --ulimit nofile=64:64 \\
-    --rm \\
-    -v "${currentJobDir}":/usr/src/runbox \\
-    -w /usr/src/runbox \\
-    codingblocks/judge-worker-${job.lang} \\
-    /bin/judge.sh -t ${job.timelimit || 5} 
-  `)
+  await scenario.run(currentJobDir, job)
 
   // Get result
-  const result = await scenario.result(currentJobDir, job.id)
+  const result = await scenario.result(currentJobDir, job)
 
   rm('-rf', currentJobDir)
 

src/tasks/job.ts

@@ -2,6 +2,7 @@ interface JobConstructorOpts {
   id: number
   source: string
   lang: string
+  scenario: "run" | "submit"
   timelimit?: number
 } 
 interface RunJobConstructorOpts extends JobConstructorOpts {
@@ -20,30 +21,32 @@ export class Job {
   id: number
   source: string
   lang: string
+  scenario: string
   timelimit?: number
 
-  constructor({ id, source, lang, timelimit = 5 }: JobConstructorOpts) {
+  constructor({ id, source, lang, timelimit = 5, scenario }: JobConstructorOpts) {
     this.id = id
     this.source = source
     this.lang = lang
     this.timelimit = timelimit
+    this.scenario = scenario
   }
 }
 
 export class RunJob extends Job {
   stdin: string
 
-  constructor({ id, source, lang, timelimit, stdin }: RunJobConstructorOpts) {
-    super({id, source, lang, timelimit})
+  constructor({ id, source, lang, timelimit, scenario, stdin }: RunJobConstructorOpts) {
+    super({id, source, lang, timelimit, scenario})
     this.stdin = stdin
   }
 }
 
 export class SubmitJob extends Job {
   testcases: Array<TestcaseOpts>
 
-  constructor({ id, source, lang, timelimit, testcases }: SubmitJobConstructorOpts) {
-    super({id, source, lang, timelimit})
+  constructor({ id, source, lang, timelimit, scenario, testcases }: SubmitJobConstructorOpts) {
+    super({id, source, lang, timelimit, scenario})
     this.testcases = testcases
   }
 }

src/tasks/scenario.ts

@@ -0,0 +1,26 @@
+import config = require('../../config');
+import { exec } from 'shelljs';
+import { Job } from "./job";
+import { Result } from "types/result";
+
+export class Scenario {
+  setup(currentJobDir: string, job: Job) {
+    throw new Error("Not Implemented")
+  }
+  run(currentJobDir: string, job: Job) {
+    const LANG_CONFIG = config.LANGS[job.lang]
+    return exec(`docker run \\
+      --cpus="${LANG_CONFIG.CPU_SHARE}" \\
+      --memory="${LANG_CONFIG.MEM_LIMIT}" \\
+      --ulimit nofile=64:64 \\
+      --rm \\
+      -v "${currentJobDir}":/usr/src/runbox \\
+      -w /usr/src/runbox \\
+      codingblocks/judge-worker-${job.lang} \\
+      /bin/judge.sh -t ${job.timelimit || 5} 
+    `)
+  }
+  result(currentJobDir: string, job: Job): Promise<Result> {
+    throw new Error("Not Implemented")
+  }
+}

src/tasks/run.ts renamed to src/tasks/scenarios/run.ts

@@ -1,12 +1,12 @@
-import config = require('../../config.js')
+import config = require('../../../config.js')
 import {cat, exec, mkdir, rm, touch, head} from 'shelljs'
-import { RunJob } from './job'
+import { RunJob } from '../job'
 import { RunResult } from 'types/result'
 import * as path from 'path'
 import * as fs from 'fs'
-import { Scenario } from 'types/scenario'
+import { Scenario } from '../scenario'
 
-class RunScenario implements Scenario {
+class RunScenario extends Scenario {
   setup(currentJobDir: string, job: RunJob) {
     const LANG_CONFIG = config.LANGS[job.lang]
 
@@ -16,7 +16,7 @@ class RunScenario implements Scenario {
       (new Buffer(job.stdin, 'base64')).toString('ascii'))    
   }
 
-  async result(currentJobDir: string, jobId: number): Promise<RunResult> {
+  async result(currentJobDir: string, job: RunJob): Promise<RunResult> {
     const stdout = exec(`
       head -c ${config.MAX_OUTPUT_BUFFER} ${path.join(currentJobDir, 'run.stdout')}
     `)
@@ -29,7 +29,7 @@ class RunScenario implements Scenario {
     const code = cat(path.join(currentJobDir, 'runguard.code')).toString()
 
     return {
-      id: jobId,
+      id: job.id,
       stderr: (new Buffer(stderr)).toString('base64'),
       stdout: (new Buffer(stdout)).toString('base64'),
       time: +run_time,

src/tasks/submission.ts renamed to src/tasks/scenarios/submission.ts

@@ -1,11 +1,11 @@
-import config = require('../../config.js')
+import config = require('../../../config.js')
 import { cat, ls, mkdir, exec } from 'shelljs'
-import { SubmitJob } from './job'
+import { SubmitJob } from '../job'
 import { SubmissionResult } from 'types/result'
 import * as path from 'path'
 import * as fs from 'fs'
 import * as https from 'https'
-import { Scenario } from 'types/scenario.js'
+import { Scenario } from '../scenario'
 import { ClientRequest } from 'http';
 
 export const download = (url: string, dest: string): Promise<ClientRequest> => {
@@ -22,7 +22,7 @@ export const download = (url: string, dest: string): Promise<ClientRequest> => {
   )
 }
 
-class SubmissionScenario implements Scenario {
+class SubmissionScenario extends Scenario {
   setup(currentJobDir: string, job: SubmitJob) {
     const LANG_CONFIG = config.LANGS[job.lang]
 
@@ -39,13 +39,13 @@ class SubmissionScenario implements Scenario {
     }))
   }
 
-  async result(currentJobDir: string, jobId: number): Promise<SubmissionResult> {
+  async result(currentJobDir: string, job: SubmitJob): Promise<SubmissionResult> {
     // Check for compile_stderr if can't find a stdout file ; stdout can be ''
     const compile_stderr = cat(path.join(currentJobDir, 'compile.stderr')).toString()
 
     if (compile_stderr) {
       return {
-        id: jobId,
+        id: job.id,
         stderr: (new Buffer(compile_stderr)).toString('base64'),
         testcases: []
       }
@@ -83,7 +83,7 @@ class SubmissionScenario implements Scenario {
     })
 
     return {
-      id: jobId,
+      id: job.id,
       stderr: (new Buffer(compile_stderr)).toString('base64'),
       testcases
     }

src/types/scenario.d.ts

@@ -15,6 +15,7 @@ int main () {
     return 0;
 }
       `)).toString('base64'),
+      scenario: 'run',
       stdin: (new Buffer('World')).toString('base64')
     }))
     expect(new Buffer(runResult.stdout, 'base64').toString('ascii')).to.eq('Hello World')

test/run/run.c.spec.ts

@@ -17,6 +17,7 @@ int main () {
     return 0;
 }
       `)).toString('base64'),
+      scenario: 'run',
       stdin: (new Buffer('World')).toString('base64')
     }))
     expect(new Buffer(runResult.stdout, 'base64').toString('ascii')).to.eq('Hello World')

test/run/run.cpp.spec.ts

@@ -15,6 +15,7 @@ public class HelloWorld {
     }
 }
       `)).toString('base64'),
+      scenario: 'run',
       stdin: (new Buffer('World')).toString('base64')
     }))
     expect(new Buffer(runResult.stdout, 'base64').toString('ascii')).to.eq('Hello World\n')