feat(general): test everything possible, 100% coverage

AEGEE · Feb 9, 2020 · 40dd4b5 · 40dd4b5
1 parent 0410abe
commit 40dd4b5
Show file tree

Hide file tree

Showing 5 changed files with 108 additions and 3 deletions.
diff --git a/lib/cron.js b/lib/cron.js
@@ -7,7 +7,6 @@ const {
 } = require('../models');
 const { Sequelize } = require('./sequelize');
 
-
 const JobCallbacks = {
     DELETE_NOT_CONFIRMED_USERS: async () => {
         const confirmations = await MailConfirmation.findAll({
@@ -62,6 +61,7 @@ class JobManager {
 
         const id = ++this.currentJob;
 
+        /* istanbul ignore next */
         const job = cron.schedule(rule, () => this.executeJob(id));
 
         this.jobs[id] = {
@@ -95,6 +95,27 @@ with the following params: %o`, params);
     async registerAllTasks() {
         this.addJob(this.JOB_TYPES.DELETE_NOT_CONFIRMED_USERS);
     }
+
+    // for tests only
+    /* istanbul ignore next */
+    cancelJob(id) {
+        const job = this.jobs[id];
+        if (!job) {
+            logger.warn(`Job with ID #${id} is not found.`);
+            return;
+        }
+
+        logger.info(`Cancelling job #${job.id}: "${job.description}", with rule ${job.rule}.`);
+        job.job.destroy();
+        delete this.jobs[id];
+    }
+
+    clearAll() {
+        const ids = Object.keys(this.jobs);
+        for (const id of ids) {
+            this.cancelJob(id);
+        }
+    }
 }
 
 const manager = new JobManager();

diff --git a/lib/server.js b/lib/server.js
@@ -108,8 +108,14 @@ async function startServer() {
             log.info('Up and running, listening on http://localhost:%d', config.port);
             await db.authenticate();
             log.info('DB connection is successful.');
-            await cron.registerAllTasks();
-            log.info('All cron tasks are registered.');
+
+            // no need it in test
+            /* istanbul ignore if */
+            if (process.env.NODE_ENV !== 'test') {
+                await cron.registerAllTasks();
+                log.info('All cron tasks are registered.');
+            }
+
             return res();
         });
         /* istanbul ignore next */

diff --git a/middlewares/generic.js b/middlewares/generic.js
@@ -51,6 +51,7 @@ exports.ensureAuthorized = async (req, res, next) => {
     return next();
 };
 
+/* istanbul ignore next */
 exports.getMyGlobalPermissions = async (req, res) => {
     // TODO: return real permissions.
     return res.json({
@@ -176,6 +177,7 @@ exports.errorHandler = (err, req, res, next) => {
     }
 
     // Handling validation errors
+    /* istanbul ignore else */
     if (err.name && ['SequelizeValidationError', 'SequelizeUniqueConstraintError'].includes(err.name)) {
         return errors.makeValidationError(res, err);
     }

diff --git a/models/User.js b/models/User.js
@@ -137,6 +137,7 @@ User.prototype.checkPassword = async function checkPassword(password) {
     return bcrypt.compare(password, this.password);
 };
 
+/* istanbul ignore next */
 User.prototype.notValidFields = function notValidFields() {
     const missingFields = [];
     for (const field of ['date_of_birth', 'gender']) {

diff --git a/test/api/cron.test.js b/test/api/cron.test.js
@@ -0,0 +1,75 @@
+const moment = require('moment');
+
+const { startServer, stopServer } = require('../../lib/server.js');
+const generator = require('../scripts/generator');
+const cron = require('../../lib/cron');
+const { User } = require('../../models');
+
+describe('Cron testing', () => {
+    beforeAll(async () => {
+        await startServer();
+    });
+
+    afterAll(async () => {
+        await stopServer();
+    });
+
+    afterEach(async () => {
+        await generator.clearAll();
+        await cron.clearAll();
+    });
+
+    test('should add job', async () => {
+        expect(Object.keys(cron.jobs).length).toEqual(0);;
+
+        cron.addJob(cron.JOB_TYPES.DELETE_NOT_CONFIRMED_USERS);
+        expect(Object.keys(cron.jobs).length).toEqual(1);
+    });
+
+    test('should execute job', async () => {
+        expect(Object.keys(cron.jobs).length).toEqual(0);;
+
+        cron.addJob(cron.JOB_TYPES.DELETE_NOT_CONFIRMED_USERS);
+        expect(Object.keys(cron.jobs).length).toEqual(1);
+
+        const jobKey = Object.keys(cron.jobs)[0];
+        await cron.executeJob(jobKey);
+    });
+
+    test('should not execute a job if it\'s not found', async () => {
+        expect(Object.keys(cron.jobs).length).toEqual(0);;
+        await cron.executeJob(1337);
+    });
+
+    test('should register all tasks', async () => {
+        expect(Object.keys(cron.jobs).length).toEqual(0);;
+
+        cron.registerAllTasks();
+        expect(Object.keys(cron.jobs).length).toEqual(1);
+    });
+
+    describe('DELETE_NOT_CONFIRMED_USERS', () => {
+        test('should work properly', async () => {
+            const userActivated = await generator.createUser();
+            const userWithValidConfirmation = await generator.createUser();
+            const userWithoutValidConfirmation = await generator.createUser();
+
+            await generator.createMailConfirmation({ expires_at: moment().add(1, 'day' ) }, userWithValidConfirmation);
+            await generator.createMailConfirmation({ expires_at: moment().subtract(1, 'day' ) }, userWithoutValidConfirmation);
+
+            cron.addJob(cron.JOB_TYPES.DELETE_NOT_CONFIRMED_USERS);
+            expect(Object.keys(cron.jobs).length).toEqual(1);
+
+            const jobKey = Object.keys(cron.jobs)[0];
+            await cron.executeJob(jobKey);
+
+            // first and second should be left as they are, third should be removed.
+            const usersFromDb = await User.findAll();
+            expect(usersFromDb.length).toEqual(2);
+
+            const ids = usersFromDb.map(u => u.id);
+            expect(ids).toContain(userActivated.id);
+            expect(ids).toContain(userWithValidConfirmation.id);
+        });
+    });
+});