GATE Teamware Documentation

# Testing

All the tests can be run using the following command:

npm run test

# Backend Testing

Pytest is used for testing the backend.

npm run test:backend

# Backend test files

  • Unit test files are located in /backend/tests

# Frontend testing

Jest (opens new window) is used for frontend testing. The Vue testing-library (opens new window) is used for testing Vue components.

npm run test:frontend

# Frontend test files

  • Frontend test files are located in /fontend/tests/unit and should the extension .spec.js

# Testing JS functions

describe("Description of a group of tests to be run", () =>{

    beforeAll(() =>{
        //The code here is run before each test
    })

    it("A single test's description", async () =>{

        // Assertions are done with the expect() function e.g.
        let funcOutput = 30 + 10
        expect(funcOutput).toBe(40)
      

    })
})

# Mocking JS classes

This is an example of a mock harness for the JRPCClient class.

A mock file is created inside a __mock__ directory placed next to the file that's being mocked, e.g. for our JRPCClient class at /frontend/src/jrpc/index.js, the mock file is /frontend/src/jrpc/__mock__/index.js.

Inside the mock file /frontend/src/jrpc/__mock__/index.js:

// Mocking jrpc/index.js
//Mocking the JRPCClient class
//Replacing the call function with a custom mockCall function
export const mockCall = jest.fn(()=> 30);
const mock = jest.fn().mockImplementation(() => {
  return {call: mockCall};
});

export default mock;

Inside the test file *.spec.js:

import JRPCClient from "@/jrpc";
jest.mock('@/jrpc')

import store from '@/store'
//Example on how to mock the jrpc call

describe("Vuex functions testing", () =>{

    beforeAll(() =>{

        //Re-implement custom mock call implementation if needed
        JRPCClient.mockImplementation(()=>{
            return {
                call(){
                    return 50
                }
            }
        })

    })

    it("testfunc", async () =>{

        const noutput = await store.dispatch("testnormal")
        expect(noutput).toBe("Hello world")

        const aoutput = await store.dispatch("testasync")
        expect(aoutput).toBe("Hello world")

        const rpc = new JRPCClient("/")
        const result = await rpc.call("some param")
        expect(result).toBe(50)

    })
})

# Testing Vue components

//Example of how a component could be tested
import { render, fireEvent } from '@testing-library/vue'


import HelloWorld from '@/components/HelloWorld.vue'

//Testing a component e.g. HelloWorld
describe('HelloWorld.vue', () => {

  it('renders props.msg when passed', () => {
    const msg = 'new message'
    const { getByText } = render(HelloWorld)

    getByText("Installed CLI Plugins")
  })
})

# Integration testing

Cypress (opens new window) is used for integration testing.

The integration settings are located at teamware/settings/integration.py

To run the integration test:

npm run test:integration

The test can also be run in interactive mode using:

npm run serve:cypressintegration

# Integration test files

Files related to integration testing are located in /cypress

  • Test files are located in the /cypress/integration directory and should have the extension .spec.js.

# Re-seeding the database

The command npm run migrate:integration resets the database and performs migration, use with beforeEach to run it before every test case in a suite:

describe('Example test suite', () => {

    beforeEach(() => {
        // Resets the database every time before
        // the test is run
        cy.exec('npm run migrate:integration')
    })

    it('Test case 1', () => {
        // Test something
    })
  
    it('Test case 2', () => {
        // Test something
    })
})

← Managing Releases →