Add unit tests to coefficients calc

.github/workflows/unit_tests.yml

@@ -0,0 +1,41 @@
+name: Unit tests
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  unit-tests:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v1
+
+    - name: Install Yarn
+      run: npm install -g yarn
+
+    - name: Start docker containers
+      run: cd app && docker-compose -f "docker-compose.yaml" up -d --build
+
+    - name: Install node
+      uses: actions/setup-node@v1
+      with:
+        node-version: 16.x
+
+    - name: Install dependencies
+      run: cd app && yarn install
+
+    - name: Run unit tests
+      run: cd app && yarn run test
+
+    - name: Stop docker containers
+      if: always()
+      run: cd app && docker-compose -f "docker-compose.yaml" down

app/helpers/calculate/coefficients.js

@@ -3,7 +3,7 @@
 const math = require('mathjs')
 const _ = require('lodash')
 
-module.exports = function calculateAlunoCoefficientsData(disciplinas, graduation) {
+function calculateAlunoCoefficientsData(disciplinas, graduation) {
 
   var hash_disciplinas = {}
   disciplinas.forEach(function (disciplina) {
@@ -36,7 +36,7 @@ module.exports = function calculateAlunoCoefficientsData(disciplinas, graduation
       for(let disciplina in hash_disciplinas[year][period]) {
         var current_disciplina = hash_disciplinas[year][period][disciplina]
         var creditos = parseInt(current_disciplina.creditos)
-        var convertable = convertLetterToNumber(current_disciplina.conceito) * creditos
+        var convertable = convertGradeToNumber(current_disciplina.conceito) * creditos
 
         const category = parseCategory(current_disciplina.categoria)
 
@@ -113,27 +113,36 @@ module.exports = function calculateAlunoCoefficientsData(disciplinas, graduation
   return hash_disciplinas
 }
 
-function isAprovado (letter) {
-  if(letter !== 'F' && letter !== '0' && letter !== 'O' && letter !== 'I') return true
+function isAprovado (grade) {
+  const disapprovingGrades = ['F', '0', 'O', 'I']
+
+  return !disapprovingGrades.includes(grade)
 }
 
-function convertLetterToNumber(letter) {
-  if(letter === 'A') return 4
-  else if(letter === 'B') return 3
-  else if(letter === 'C') return 2
-  else if(letter === 'D') return 1
-  else if(letter === 'F') return 0
-  else if(letter === 'O') return 0
-
-  else if(letter === '-') return -1
-  else if(letter === 'E') return -1
-  else if(letter === 'I') return -1
+function convertGradeToNumber(grade) {
+  const gradeToNumberMap = {
+    'A': 4,
+    'B': 3,
+    'C': 2,
+    'D': 1,
+    'F': 0,
+    'O': 0,
+    '-': -1,
+    'E': -1,
+    'I': -1
+  }
+
+  return gradeToNumberMap[grade]
 }
 
 function parseCategory(category) {
-  if(category === 'Livre Escolha') return 'free'
-  else if(category === 'Obrigatória') return 'mandatory'
-  else if(category === 'Opção Limitada') return 'limited'
+  const categoryParser = {
+    'Livre Escolha': 'free',
+    'Obrigatória': 'mandatory',
+    'Opção Limitada': 'limited'
+  }
+
+  return categoryParser[category]
+}
 
-  return null
-}
+module.exports = {calculateAlunoCoefficientsData, isAprovado, convertGradeToNumber, parseCategory}

app/helpers/calculate/coefficients.spec.js

@@ -0,0 +1,117 @@
+const assert = require('assert')
+
+const func = require('./coefficients')
+
+describe('helpers.calculate.coefficients', function () {
+  describe('isAprovado', function () {
+    it('should return true when student is approved', function () {
+      assert.equal(true, func.isAprovado('A'))
+      assert.equal(true, func.isAprovado('B'))
+      assert.equal(true, func.isAprovado('C'))
+      assert.equal(true, func.isAprovado('D'))
+    })
+
+    it('should return false when student is not approved', function () {
+      assert.equal(false, func.isAprovado('F'))
+      assert.equal(false, func.isAprovado('O'))
+      assert.equal(false, func.isAprovado('I'))
+    })
+  })
+
+  describe('parseCategory', function () {
+    it('should return correct category', function () {
+      assert.equal('free', func.parseCategory('Livre Escolha'))
+      assert.equal('mandatory', func.parseCategory('Obrigatória'))
+      assert.equal('limited', func.parseCategory('Opção Limitada'))
+      assert.equal(null, func.parseCategory('invalid category'))
+    })
+  })
+
+  describe('convertGradeToNumber', function () {
+    it('should return correct number', function () {
+      assert.equal(4, func.convertGradeToNumber('A'))
+      assert.equal(1, func.convertGradeToNumber('D'))
+      assert.equal(0, func.convertGradeToNumber('F'))
+      assert.equal(0, func.convertGradeToNumber('O'))
+      assert.equal(-1, func.convertGradeToNumber('E'))
+      assert.equal(-1, func.convertGradeToNumber('I'))
+    })
+  })
+
+  describe('calculateAlunoCoefficientsData', function () {
+    it('should return correct cp accumulated', function () {
+      const result = func.calculateAlunoCoefficientsData(mockedDisciplines, mockedGraduation)
+      assert.equal(0.089, result['2020'][3].cp_acumulado)
+      assert.equal(0.211, result['2021'][1].cp_acumulado)
+    })
+  })
+})
+
+const mockedDisciplines = [{
+  ano: 2020,
+  periodo: 3,
+  creditos: 3,
+  categoria: 'Obrigatória'
+},
+{
+  ano: 2020,
+  periodo: 3,
+  creditos: 5,
+  categoria: 'Livre Escolha'
+},
+{
+  ano: 2020,
+  periodo: 3,
+  creditos: 5,
+  categoria: 'Obrigatória'
+},
+{
+  ano: 2020,
+  periodo: 3,
+  creditos: 4,
+  categoria: 'Opção Limitada'
+},
+{
+  ano: 2021,
+  periodo: 1,
+  creditos: 5,
+  categoria: 'Obrigatória'
+},
+{
+  ano: 2021,
+  periodo: 1,
+  creditos: 3,
+  categoria: 'Opção Limitada'
+},
+{
+  ano: 2021,
+  periodo: 1,
+  creditos: 5,
+  categoria: 'Obrigatória'
+},
+{
+  ano: 2021,
+  periodo: 1,
+  creditos: 2,
+  categoria: 'Opção Limitada'
+},
+{
+  ano: 2021,
+  periodo: 1,
+  creditos: 3,
+  categoria: 'Livre Escolha'
+},
+{
+  ano: 2021,
+  periodo: 1,
+  creditos: 5,
+  categoria: 'Opção Limitada'
+},
+]
+
+const mockedGraduation = {
+  credits_total: 190,
+  limited_credits_number: 70,
+  free_credits_number: 30,
+  mandatory_credits_number: 90
+}