graphql-engine/console/cypress
Karthikeyan Chinnakonda 64e2201179 server: enable inherited roles by default
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/2325
Co-authored-by: Nicolas Beaussart <7281023+beaussan@users.noreply.github.com>
GitOrigin-RevId: 8ad6fe25a3788892128c1d56b8fa0e8feed2caca
2021-10-05 12:29:32 +00:00
..
fixtures add console to graphql-engine 2018-06-28 10:27:37 +05:30
helpers console: oss test optimisation 2021-08-18 08:38:34 +00:00
integration server: enable inherited roles by default 2021-10-05 12:29:32 +00:00
plugins console: more tests (#35) 2018-07-04 18:27:56 +05:30
support console: add citus support 2021-06-21 06:47:18 +00:00
.eslintrc console: revert improve data/relationships e2e tests 2021-05-12 07:37:45 +00:00
global.d.ts console: migrate cypress tests to TypeScript (#4550) 2020-05-27 14:56:29 +05:30
README.md console: improve cypress testing docs 2021-03-19 08:29:56 +00:00
tsconfig.json console: migrate cypress tests to TypeScript (#4550) 2020-05-27 14:56:29 +05:30

Test

Running all tests to generate coverage

  1. Set the TEST_MODE field in cypress.json to cli
  2. Run the command npm run test from the console directory to run all the tests.

You can also run the complete tests from the cypress electron app:

  1. Set the TEST_MODE field in cypress.json to cli
  2. Run npm run cypress from the console directory.
  3. Click on test_complete.js

Running tests individually

Tests are modularized into following modules:

  • API-Explorer
  • Data
    • Migration Mode
    • Create Table
    • Insert Browse
    • Modify Table
    • Table Relationships
    • Table and View Permissions
    • Views

To run the tests for the modules individually (say for create table),

  • Go to the cypress.json and set the env > TEST_MODE variable to ui.
{
  "env": {
    "TEST_MODE": "ui"
  }
}
  • Run the command npm run cypress and click on create-table > test.js

Writing Tests

  • Read ups

    • If this is your first time with cypress, check out this getting started guide

    • Read cypress best practices

  • File Structure

    The top-level directories in console/cypress are auto-generated by cypress except helpers. To understand the use of each directory check out Folder Structure

    helpers directory is used for sharing reusable functions/constants across tests. Before adding a resubale function in this directory, consider if it will be better as a custom cypress command, if so, then add it to Support directory following this guide, preferrably to command.ts file.

  • Adding a Test

    Tests go to integration directory, where there are folders corresponding to Components in Services directory (The top-level routes on the console).

    Each of these folders contains different test folders, named after the particular feature they are testing. For example create-table folder tests the functionality of creating a table from the console UI.