feat(runner): support custom job template

NivLipetz · web-flow · commit ad191e99c7cf · 2020-06-29T20:15:22.000+03:00
diff --git a/docs/devguide/docs/swagger-docs.yaml b/docs/devguide/docs/swagger-docs.yaml
@@ -2359,6 +2359,9 @@ components:
               description: Percentage of the score affected by requests per second results.
               allOf:
                 - $ref: '#/components/schemas/benchmark_weights'
+        custom_runner_definition:
+          description: custom json that will be merged with the kubernetes/metronome predator runner job definition
+          type: object
     benchmark_weights:
       type: object
       required:
diff --git a/docs/openapi3.yaml b/docs/openapi3.yaml
@@ -2326,6 +2326,9 @@ components:
               description: Percentage of the score affected by requests per second results.
               allOf:
                 - $ref: '#/components/schemas/benchmark_weights'
+        custom_runner_definition:
+          description: custom json that will be merged with the kubernetes/metronome predator runner job definition
+          type: object
     benchmark_weights:
       type: object
       required:
diff --git a/src/common/consts.js b/src/common/consts.js
@@ -30,6 +30,7 @@ module.exports = {
         SMTP_SERVER: 'smtp_server',
         BENCHMARK_THRESHOLD: 'benchmark_threshold',
         BENCHMARK_THRESHOLD_WEBHOOK_URL: 'benchmark_threshold_webhook_url',
-        BENCHMARK_WEIGHTS: 'benchmark_weights'
+        BENCHMARK_WEIGHTS: 'benchmark_weights',
+        CUSTOM_RUNNER_DEFINITION: 'custom_runner_definition'
     }
 };
diff --git a/src/configManager/helpers/configDataMap.js b/src/configManager/helpers/configDataMap.js
@@ -40,7 +40,9 @@ let configDataMap = {
     },
     [constConfig.BENCHMARK_THRESHOLD]: { value: process.env.BENCHMARK_THRESHOLD, type: 'int' },
     [constConfig.BENCHMARK_THRESHOLD_WEBHOOK_URL]: { value: process.env.BENCHMARK_THRESHOLD_WEBHOOK_URL, type: 'string' },
-    [constConfig.BENCHMARK_WEIGHTS]: { value: process.env.BENCHMARK_WEIGHTS || JSON.stringify(BENCHMARK_WEIGHTS_DEFAULT), type: 'json' }
+    [constConfig.BENCHMARK_WEIGHTS]: { value: process.env.BENCHMARK_WEIGHTS || JSON.stringify(BENCHMARK_WEIGHTS_DEFAULT), type: 'json' },
+    [constConfig.CUSTOM_RUNNER_DEFINITION]: { value: process.env.CUSTOM_RUNNER_DEFINITION, type: 'json' }
+
 };
 
 module.exports.getConstType = (configValue) => {
diff --git a/src/jobs/models/jobManager.js b/src/jobs/models/jobManager.js
@@ -258,7 +258,8 @@ function createJobRequest(jobId, runId, jobBody, dockerImage, configData) {
         });
     }
 
-    let jobRequest = jobTemplate.createJobRequest(jobName, runId, parallelism, environmentVariables, dockerImage, configData, PREDATOR_RUNNER_PREFIX);
+    const customRunnerDefinition = configData.custom_runner_definition;
+    let jobRequest = jobTemplate.createJobRequest(jobName, runId, parallelism, environmentVariables, dockerImage, configData, PREDATOR_RUNNER_PREFIX, customRunnerDefinition);
 
     return jobRequest;
 }
diff --git a/src/jobs/models/kubernetes/jobTemplate.js b/src/jobs/models/kubernetes/jobTemplate.js
@@ -1,5 +1,7 @@
-module.exports.createJobRequest = (jobName, runId, parallelism, environmentVariables, dockerImage, configData, predatorRunner) => {
-    return {
+const _ = require('lodash');
+
+module.exports.createJobRequest = (jobName, runId, parallelism, environmentVariables, dockerImage, configData, predatorRunner, customDefinition) => {
+    const jobTemplate = {
         'apiVersion': 'batch/v1',
         'kind': 'Job',
         'metadata': {
@@ -36,4 +38,7 @@ module.exports.createJobRequest = (jobName, runId, parallelism, environmentVaria
             'backoffLimit': 0
         }
     };
+
+    const jobTemplateWithCustomDefinition = _.merge(jobTemplate, customDefinition);
+    return jobTemplateWithCustomDefinition;
 };
diff --git a/src/jobs/models/metronome/jobTemplate.js b/src/jobs/models/metronome/jobTemplate.js
@@ -1,5 +1,7 @@
-module.exports.createJobRequest = (jobName, runId, parallelism, environmentVariables, dockerImage, configData) => {
-    return {
+const _ = require('lodash');
+
+module.exports.createJobRequest = (jobName, runId, parallelism, environmentVariables, dockerImage, configData, customDefinition) => {
+    const jobTemplate = {
         id: jobName,
         description: 'Runs a performance test',
         run: {
@@ -14,4 +16,7 @@ module.exports.createJobRequest = (jobName, runId, parallelism, environmentVaria
         },
         parallelism: parallelism
     };
+
+    const jobTemplateWithCustomDefinition = _.merge(jobTemplate, customDefinition);
+    return jobTemplateWithCustomDefinition;
 };
diff --git a/tests/integration-tests/jobs/createJobDocker-test.js b/tests/integration-tests/jobs/createJobDocker-test.js
@@ -29,7 +29,7 @@ describe('Create job specific docker tests', async function () {
         nock.cleanAll();
     });
     const jobPlatform = process.env.JOB_PLATFORM;
-    if (jobPlatform === 'DOCKER') {
+    if (jobPlatform.toUpperCase() === 'DOCKER') {
         describe('DOCKER', () => {
             before(async () => {
                 await schedulerRequestCreator.init();
diff --git a/tests/integration-tests/jobs/createJobKubernetes-test.js b/tests/integration-tests/jobs/createJobKubernetes-test.js
@@ -1,6 +1,7 @@
 const should = require('should'),
     uuid = require('uuid'),
     schedulerRequestCreator = require('./helpers/requestCreator'),
+    configManagerRequestCreator = require('../configManager/helpers/requestCreator'),
     testsRequestCreator = require('../tests/helpers/requestCreator'),
     nock = require('nock'),
     kubernetesConfig = require('../../../src/config/kubernetesConfig');
@@ -13,10 +14,11 @@ describe('Create job specific kubernetes tests', async function () {
         nock.cleanAll();
     });
     const jobPlatform = process.env.JOB_PLATFORM;
-    if (jobPlatform === 'KUBERNETES') {
+    if (jobPlatform.toUpperCase() === 'KUBERNETES') {
         describe('Kubernetes', () => {
             describe('Good requests', () => {
                 before(async () => {
+                    await configManagerRequestCreator.init();
                     await schedulerRequestCreator.init();
                     await testsRequestCreator.init();
 
@@ -101,7 +103,8 @@ describe('Create job specific kubernetes tests', async function () {
                             arrival_rate: 1,
                             duration: 1,
                             environment: 'test',
-                            enabled: true });
+                            enabled: true
+                        });
 
                         should(relevantJobs).containEql({
                             id: cronJobId,
@@ -285,11 +288,23 @@ describe('Create job specific kubernetes tests', async function () {
                     });
                 });
 
-                describe('Create one time job with parallelism, should create job with the right parameters and run it, finally stop and delete it', () => {
+                describe('Create one time job with parallelism and custom runner definition, should create job with the right parameters and run it, finally stop and delete it', () => {
                     let createJobResponse;
                     let getJobsFromService;
                     let expectedResult;
                     it('Create the job', async () => {
+                        await configManagerRequestCreator.updateConfig({ custom_runner_definition: {
+                            'spec': {
+                                'template': {
+                                    'metadata': {
+                                        'annotations': {
+                                            'traffic.sidecar.istio.io/excludeOutboundPorts': '8060'
+                                        }
+                                    }
+                                }
+                            }
+                        } });
+
                         let validBody = {
                             test_id: testId,
                             arrival_rate: 100,
@@ -310,7 +325,9 @@ describe('Create job specific kubernetes tests', async function () {
                             parallelism: 7
                         };
                         let actualJobEnvVars = {};
+                        let actualAnnotations = {};
                         nock(kubernetesConfig.kubernetesUrl).post(`/apis/batch/v1/namespaces/${kubernetesConfig.kubernetesNamespace}/jobs`, body => {
+                            actualAnnotations = body.spec.template.metadata.annotations;
                             actualJobEnvVars = body.spec.template.spec.containers['0'].env;
                             return true;
                         }).reply(200, {
@@ -337,6 +354,7 @@ describe('Create job specific kubernetes tests', async function () {
                         should(rampTo.value).eql('22');
                         should(arrivalRate.value).eql('15');
                         should(maxVirtualUsers.value).eql('29');
+                        should(actualAnnotations).eql({ 'traffic.sidecar.istio.io/excludeOutboundPorts': '8060' });
                     });
 
                     it('Get the job', async () => {
@@ -391,18 +409,30 @@ describe('Create job specific kubernetes tests', async function () {
                         nock(kubernetesConfig.kubernetesUrl).get(`/api/v1/namespaces/${kubernetesConfig.kubernetesNamespace}/pods/podA`)
                             .reply(200, {
                                 metadata: { labels: { 'job-name': 'predator.job' } },
-                                status: { containerStatuses: [{ name: 'predator-runner',
-                                    state: { terminated: { finishedAt: '2020' } } }, { name: 'podB',
-                                    state: {} }] }
+                                status: {
+                                    containerStatuses: [{
+                                        name: 'predator-runner',
+                                        state: { terminated: { finishedAt: '2020' } }
+                                    }, {
+                                        name: 'podB',
+                                        state: {}
+                                    }]
+                                }
 
                             });
 
                         nock(kubernetesConfig.kubernetesUrl).get(`/api/v1/namespaces/${kubernetesConfig.kubernetesNamespace}/pods/podB`)
                             .reply(200, {
                                 metadata: { labels: { 'job-name': 'someJob.job' } },
-                                status: { containerStatuses: [{ name: 'podC',
-                                    state: { terminated: { finishedAt: '2020' } } }, { name: 'podD',
-                                    state: {} }] }
+                                status: {
+                                    containerStatuses: [{
+                                        name: 'podC',
+                                        state: { terminated: { finishedAt: '2020' } }
+                                    }, {
+                                        name: 'podD',
+                                        state: {}
+                                    }]
+                                }
 
                             });
 
diff --git a/tests/integration-tests/jobs/createJobMetronome-test.js b/tests/integration-tests/jobs/createJobMetronome-test.js
@@ -13,7 +13,7 @@ describe('Create job specific metronome tests', async function () {
         nock.cleanAll();
     });
     const jobPlatform = process.env.JOB_PLATFORM;
-    if (jobPlatform === 'METRONOME') {
+    if (jobPlatform.toUpperCase() === 'METRONOME') {
         describe('Metronome', () => {
             before(async () => {
                 await schedulerRequestCreator.init();
@@ -204,4 +204,4 @@ describe('Create job specific metronome tests', async function () {
             });
         });
     }
-});
+});
diff --git a/tests/integration-tests/run.sh b/tests/integration-tests/run.sh
@@ -16,4 +16,4 @@ fi
 echo Running integration tests with "$DATABASE_TYPE" db and "$JOB_PLATFORM" integration
 source $CURR_DIR/tests/configurations/"$DATABASE_TYPE"Configuration.sh
 source $CURR_DIR/tests/configurations/"$JOB_PLATFORM"Configuration.sh
-node_modules/.bin/_mocha $CURR_DIR/tests/integration-tests --recursive --timeout=20000 --exit
+node_modules/.bin/_mocha $CURR_DIR/tests/integration-tests --recursive --timeout=20000 --exit
diff --git a/tests/unit-tests/configManager/helpers/configDataMap-test.js b/tests/unit-tests/configManager/helpers/configDataMap-test.js
@@ -26,6 +26,7 @@ const expectedTypes = {
     delay_runner_ms: 'int',
     benchmark_threshold: 'int',
     benchmark_threshold_webhook_url: 'string',
+    custom_runner_definition: 'json',
     benchmark_weights: 'json'
 };
 

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ module.exports = {`
`30`	`30`	`SMTP_SERVER: 'smtp_server',`
`31`	`31`	`BENCHMARK_THRESHOLD: 'benchmark_threshold',`
`32`	`32`	`BENCHMARK_THRESHOLD_WEBHOOK_URL: 'benchmark_threshold_webhook_url',`
`33`		`- BENCHMARK_WEIGHTS: 'benchmark_weights'`
	`33`	`+ BENCHMARK_WEIGHTS: 'benchmark_weights',`
	`34`	`+ CUSTOM_RUNNER_DEFINITION: 'custom_runner_definition'`
`34`	`35`	`}`
`35`	`36`	`};`
Original file line number	Diff line number	Diff line change
`@@ -258,7 +258,8 @@ function createJobRequest(jobId, runId, jobBody, dockerImage, configData) {`
`258`	`258`	`});`
`259`	`259`	`}`
`260`	`260`
`261`		`- let jobRequest = jobTemplate.createJobRequest(jobName, runId, parallelism, environmentVariables, dockerImage, configData, PREDATOR_RUNNER_PREFIX);`
	`261`	`+ const customRunnerDefinition = configData.custom_runner_definition;`
	`262`	`+ let jobRequest = jobTemplate.createJobRequest(jobName, runId, parallelism, environmentVariables, dockerImage, configData, PREDATOR_RUNNER_PREFIX, customRunnerDefinition);`
`262`	`263`
`263`	`264`	`return jobRequest;`
`264`	`265`	`}`