feat: add check softwareDesignTraining

Related #52

Author: UlisesGascon

__tests__/checks/softwareDesignTraining.test.js

@@ -0,0 +1,114 @@
+const knexInit = require('knex')
+const { getConfig } = require('../../src/config')
+const softwareDesignTraining = require('../../src/checks/complianceChecks/softwareDesignTraining')
+const {
+  resetDatabase, addProject, getAllResults, getAllTasks, getAllAlerts,
+  addAlert, addTask, addResult, getCheckByCodeName, addSSoftwareDesignTraining, getAllSoftwareDesignTrainings
+} = require('../../__utils__')
+
+const { dbSettings } = getConfig('test')
+
+let knex
+let project
+let check
+
+beforeAll(async () => {
+  knex = knexInit(dbSettings)
+  check = await getCheckByCodeName(knex, 'softwareDesignTraining')
+})
+
+beforeEach(async () => {
+  await resetDatabase(knex)
+  project = await addProject(knex, { name: 'project', category: 'impact' })
+})
+
+afterAll(async () => {
+  await knex.destroy()
+})
+
+describe('Integration: softwareDesignTraining', () => {
+  test('Should add results without alerts or tasks', async () => {
+    // Add a passed check scenario
+    await addSSoftwareDesignTraining(knex, { project_id: project.id, description: 'learning accomplished', training_date: new Date().toISOString() })
+    let trainings = await getAllSoftwareDesignTrainings(knex)
+    expect(trainings.length).toBe(1)
+    // Check that the database is empty
+    let results = await getAllResults(knex)
+    expect(results.length).toBe(0)
+    let alerts = await getAllAlerts(knex)
+    expect(alerts.length).toBe(0)
+    let tasks = await getAllTasks(knex)
+    expect(tasks.length).toBe(0)
+    // Run the check
+    await expect(softwareDesignTraining(knex)).resolves.toBeUndefined()
+    // Check that the database has the expected results
+    trainings = await getAllSoftwareDesignTrainings(knex)
+    expect(trainings.length).toBe(1)
+    results = await getAllResults(knex)
+    expect(results.length).toBe(1)
+    expect(results[0].status).toBe('passed')
+    expect(results[0].compliance_check_id).toBe(check.id)
+    alerts = await getAllAlerts(knex)
+    expect(alerts.length).toBe(0)
+    tasks = await getAllTasks(knex)
+    expect(tasks.length).toBe(0)
+  })
+  test('Should delete (previous alerts and tasks) and add results', async () => {
+    // Add a passed check scenario
+    await addSSoftwareDesignTraining(knex, { project_id: project.id, description: 'learning accomplished', training_date: new Date().toISOString() })
+    // Add previous alerts and tasks
+    await addAlert(knex, { compliance_check_id: check.id, project_id: project.id, title: 'existing', description: 'existing', severity: 'critical' })
+    await addTask(knex, { compliance_check_id: check.id, project_id: project.id, title: 'existing', description: 'existing', severity: 'critical' })
+    // Check that the database has the expected results
+    const trainings = await getAllSoftwareDesignTrainings(knex)
+    expect(trainings.length).toBe(1)
+    let results = await getAllResults(knex)
+    expect(results.length).toBe(0)
+    let alerts = await getAllAlerts(knex)
+    expect(alerts.length).toBe(1)
+    expect(alerts[0].compliance_check_id).toBe(check.id)
+    let tasks = await getAllTasks(knex)
+    expect(tasks.length).toBe(1)
+    expect(tasks[0].compliance_check_id).toBe(check.id)
+    // Run the check
+    await expect(softwareDesignTraining(knex)).resolves.toBeUndefined()
+    // Check that the database has the expected results
+    results = await getAllResults(knex)
+    expect(results.length).toBe(1)
+    expect(results[0].status).toBe('passed')
+    expect(results[0].compliance_check_id).toBe(check.id)
+    alerts = await getAllAlerts(knex)
+    expect(alerts.length).toBe(0)
+    tasks = await getAllTasks(knex)
+    expect(tasks.length).toBe(0)
+  })
+  test('Should add (alerts and tasks) and update results', async () => {
+    await addResult(knex, { compliance_check_id: check.id, project_id: project.id, status: 'failed', rationale: 'failed previously', severity: 'critical' })
+    // Check that the database is empty
+    let results = await getAllResults(knex)
+    expect(results.length).toBe(1)
+    expect(results[0].compliance_check_id).toBe(check.id)
+    let trainings = await getAllSoftwareDesignTrainings(knex)
+    expect(trainings.length).toBe(0)
+    let alerts = await getAllAlerts(knex)
+    expect(alerts.length).toBe(0)
+    let tasks = await getAllTasks(knex)
+    expect(tasks.length).toBe(0)
+    // Run the check
+    await expect(softwareDesignTraining(knex)).resolves.toBeUndefined()
+    // Check that the database has the expected results
+    results = await getAllResults(knex)
+    expect(results.length).toBe(1)
+    expect(results[0].status).toBe('failed')
+    expect(results[0].rationale).not.toBe('failed previously')
+    expect(results[0].compliance_check_id).toBe(check.id)
+    trainings = await getAllSoftwareDesignTrainings(knex)
+    expect(trainings.length).toBe(0)
+    alerts = await getAllAlerts(knex)
+    expect(alerts.length).toBe(1)
+    expect(alerts[0].compliance_check_id).toBe(check.id)
+    tasks = await getAllTasks(knex)
+    expect(tasks.length).toBe(1)
+    expect(tasks[0].compliance_check_id).toBe(check.id)
+  })
+})

__utils__/index.js

@@ -1,4 +1,5 @@
 const resetDatabase = async (knex) => {
+  await knex.raw('TRUNCATE TABLE software_design_training RESTART IDENTITY CASCADE')
   await knex.raw('TRUNCATE TABLE compliance_checks_results RESTART IDENTITY CASCADE')
   await knex.raw('TRUNCATE TABLE compliance_checks_tasks RESTART IDENTITY CASCADE')
   await knex.raw('TRUNCATE TABLE compliance_checks_alerts RESTART IDENTITY CASCADE')
@@ -50,6 +51,13 @@ const getCheckByCodeName = async (knex, codeName) => {
   return check
 }
 
+const addSSoftwareDesignTraining = async (knex, data) => {
+  const [training] = await knex('software_design_training').insert(data).returning('*')
+  return training
+}
+
+const getAllSoftwareDesignTrainings = (knex) => knex('software_design_training').select('*')
+
 module.exports = {
   getAllComplianceChecks,
   resetDatabase,
@@ -65,5 +73,7 @@ module.exports = {
   addAlert,
   addTask,
   addResult,
-  getCheckByCodeName
+  getCheckByCodeName,
+  addSSoftwareDesignTraining,
+  getAllSoftwareDesignTrainings
 }

src/checks/complianceChecks/softwareDesignTraining.js

@@ -0,0 +1,28 @@
+const validators = require('../validators')
+const { initializeStore } = require('../../store')
+const debug = require('debug')('checks:softwareDesignTraining')
+
+module.exports = async (knex) => {
+  const {
+    getAllSSoftwareDesignTrainings, getCheckByCodeName,
+    getAllProjects, addAlert, addTask, upsertComplianceCheckResult,
+    deleteAlertsByComplianceCheckId, deleteTasksByComplianceCheckId
+  } = initializeStore(knex)
+  debug('Collecting relevant data...')
+  const check = await getCheckByCodeName('softwareDesignTraining')
+  const trainings = await getAllSSoftwareDesignTrainings()
+  const projects = await getAllProjects()
+
+  debug('Extracting the validation results...')
+  const analysis = validators.softwareDesignTraining({ trainings, check, projects })
+  debug('Deleting previous alerts and tasks to avoid orphaned records...')
+  await deleteAlertsByComplianceCheckId(check.id)
+  await deleteTasksByComplianceCheckId(check.id)
+
+  debug('Upserting the new results...')
+  await Promise.all(analysis.results.map(result => upsertComplianceCheckResult(result)))
+
+  debug('Inserting the new Alerts and Tasks...')
+  await Promise.all(analysis.alerts.map(alert => addAlert(alert)))
+  await Promise.all(analysis.tasks.map(task => addTask(task)))
+}