This tool will help recruiters to maintain the programming tasks for candidates. After every merge, it will be executed from the pipeline. Among other things, the program will replace the content of the test files that are in the GraphQL with those that are on the computer.
Project is created with:
To run test script you must have bash installed.
To run this project, navigate to inside the project folder using terminal where package.json file is located then type
$ npm install
$ node uploadFile.js [path to local folder containing test files]
To run validator_test.js locally you should use npm test command in the Recruitment folder.
Environment variables used in the project:
- BEARER_TOKEN - bearer token that can be taken from developer tools from the browser. It's one of the headers in the GraphQL query.
- PROJECT_ID - it's the project's id that can be taken from URL address when the project is opened.
Those variables are stored in Github secrets for pipelines. To run the project locally, you must either create environment variables named as above or declare them temporarily when running the script.
To add a new file, you have to clone the main branch. On your branch add new exercises as it is mentioned below. When every file is ready to be uploaded to recruitment platform (we suggest running npm test locally to make sure, that everything went well), you should create a new pull request. After that another recruiter merges changes from your branch to main branch. After the recruiter accepts pull request and all files are uploaded to the main branch, Github's workflow will run validator_test.js for every directory. If every test passed, uploadFile.js - a script, which uploads every file named task.js and task_validator.js and all configuration files on recruitment platform - will be executed. If any test fails,
uploadFile.js will be not executed and you should correct your tasks.
Only Recruitment directory is uploaded to the recruitment platform. This directory should contain configuration files and directories with lists of exercises. Every directory with exercises is including 4 files:
- file task.js
- file model_solutions.js
- file task_validator.js
- file validator_test.js
When you add new exercises to the project, you should include files, mentioned below, to Recruitment/index.html file.
Example
<script src="01/task.js"></script>
<script src="01/task_validator.js"></script>This file contains tasks as functions declarations and their descriptions. Candidate has to implement them. We suggest to name this module as general_{directory name}. Module in every directory has to have unique name.
Example
window.general_01 = (function() {
return{
/**
* Returns sum of a and b.
*/
add: function(a, b) {
},
};
})();
module.exports = {
general_01,
}This file should contain correct solutions enclosed in an object named as module in file taks.js. Correct solutions' names should be the same as in task.js file. Object incorrectSolutions should contain incorrect solutions, also named as tasks in task.js file. Module general has to have the same name as in task.js file.
Example
general_01 = (function() {
return {
add: function(a, b) {
return a + b
}
};
})();
const incorrectSolution = {
add: function(a, b) {
return a + b + 1
},
};
module.exports = {
general_01,
incorrectSolution
}This file should contain tests for all tasks in task.js file. Tests' names should be different than tested function name (we recommend to name them {tested function name}_test). Additionaly you should rename value of javascript TASKS_LIST_NAME to tasks' list name. In separate scope we make assertions and later we check results using it method in describe function. Every testing function, which is added to the file, should be also added to module.exports object. Labels used in it methods should follow this pattern:
name of the testing function: This method should explain, what function should do
Example
const expect = require('chai').expect
const TASKS_LIST_NAME = 'List 01'
const add_test = (functionToTest) => {
expect(functionToTest(5, 7)).to.eql(12);
expect(functionToTest(-4, -3)).to.eql(-7);
expect(functionToTest(0, 0)).to.eql(0);
expect(functionToTest(-2, 2)).to.eql(0);
expect(functionToTest(4, 4)).to.eql(8)
}
describe(`${TASKS_LIST_NAME}:`, function () {
it('add: This method should add two numbers', () => add_test(general_01.add));
});
module.exports = {
add: add_test,
}In this file we are checking if every test from validator return expected output - true for functions from general module and false for functions from incorrectSolutions module from model_solutions.js file. It is crucial to do import from the file (in this case) general_01 from the model_solutions.js.
Example
const general = require('./model_solutions.js').general_01