Toggle navigation
Inizia qui

Shopfloor ui tests

Tests for the Shopfloor app.

These are end-to-end & unit tests that cover the frontend of the application. Not testing the WMS part at this time.

Note that the tests use demo data for two reasons:

  • We don’t rely on Odoo to be running.
  • We test the demo mode to make sure it’s always consistent with the befaviour of the application.

Tech details

  • The end-to-end tests are built using Cypress.
  • The unit tests are built using jest.

Warning, the Jest units tests have been disabled on Github !

End-to-end tests with Cypress

Pre-requisites

  • You should have npm and Cypress installed.
  • You should have module shopfloor_example installed.
  • Your Odoo instance must be running.

Open the Cypress interface

  • In a terminal, go to path/to/shopfloor_ui_tests.
  • >> npm install
  • >> npx cypress open

Select a test

With the Cypress interface open, select your test. A new browser window will be open and will run the test.

To run the full test suit, click the Run n Integration specs button.

For more information regarding the Cypress interface, visit Cypress features. If you want to run the test in a specific browser, visit Cypress browsers.

Test output

  • If any of the steps fail, the Test Status Menu will highlight it in red and give you relevant information about the issue.
  • If all steps of your test are green, you’re good to go!

Unit tests with jest

Pre-requisites

  • You should have npm installed.

Run your tests

  • Navigate to path/to/shopfloor_ui_tests.
  • If this is the first time you’re running these tests:
    • npm install
  • To run all tests:
    • npm run unit-tests
  • To run tests in a specific file:
    • npm run unit-tests file_name
    • Note: file_name corresponds to the file name without .test.js (e.g. for searchbar.test.js, the command would be npm run unit-tests searchbar).

Add new tests

To add a new test, simply create a new **.test.js file inside the unit_tests folder.

A few considerations for component tests:

  • If the component uses a library (e.g. Vuetify), it needs to be included in the second parameter of the shallowMount method:
    • Install the library using npm, if it hasn’t been installed yet.
    • In jest.config.js:
    const Vuetify = require("Vuetify");
Vue.use(Vuetify);
    • In your test:
    shallowMount(Component, {
    Vuetify,
});
  • If the component accesses $ attributes from Vue, you can mock them:
shallowMount(Component, {
    mocks: {
        $t: () => {},
    },
});
  • If the component accesses $root, a special mock is needed. For that, a $root mock object has been created in /unit_tests/mocks/root.js. To use it, add it to parentComponent in shallowMount:
const root_config = {config_key: custom_test_config_value};

    shallowMount(Component, {
        parentComponent: {
            data() {
                return MockRoot(root_config);
            },
        },
    });

Known issues / Roadmap

Cypress:

  • At this stage, the features of the Shopfloor app that are covered by Cypress tests are:
    • Authentication via username and password.
    • Authentication via apikey.
    • Navigation throughout the main pages of the app.
    • Selection and representation of profiles.
    • Translations.
    • Shopfloor example.
  • Test the WMS features from shopfloor_mobile.
  • NOTE: THE CYPRESS TESTS ARE NOT CURRENTLY PART OF THE CI/CD PIPELINE.

jest:

  • Increase coverage.