Skip to content

Latest commit

 

History

History
104 lines (68 loc) · 3.24 KB

README.md

File metadata and controls

104 lines (68 loc) · 3.24 KB
Raw

ODF Console

ODF Console is the UI plugin for Openshift Data Foundation Operator. It works as a remote module for OpenShift Container Platform console.

Running in Development Mode

ODF console works as a remote bundle for OCP console. To run ODF Console there should be a instance of OCP console up and running.

Steps to run OCP Console as a server in development mode:

  1. Follow everything as mentioned in the console README.md to build the application.
  2. Run the console bridge as follows ./bin/bridge -plugins odf-console=http://localhost:9001/
  3. Run developemnt mode of console by going into console/frontend and running yarn run dev

After the OCP console is set as required by ODF Console. Performs the following steps to make it run.

  1. Install ODF Operator
  2. Create a Storage System
  3. Clone this repo.
  4. Pull all required dependencies by running yarn install.
  5. Run the development mode of odf-console using yarn run dev. This runs a webserver in port 9001.

Steps to run OCP Console as a container in development mode:

  1. Install ODF Operator.
  2. Create a Storage System.
  3. Clone this repo.
  4. Pull all required dependencies by running yarn install.
  5. Run the development mode of odf-console using CONSOLE_VERSION=4.18 I8N_NS=plugin__odf-console PLUGIN=odf yarn run dev:c. This runs a container running both the console bridge and a webserver in port 9001.
  6. For more OCP container related environment variables Refer.

Unit Tests

Run all unit tests:

yarn test
# Run them with coverage:
yarn test-coverage

E2E Tests

E2E tests are written in Cypress.

Launch Cypress test runner:

yarn test-cypress

This will launch the Cypress Test Runner UI, where you can run one or all cypress tests after choosing the required browser.

It is also possible to run the Cypress tests in headless mode:

yarn test-cypress-headless

By default, it will look for Chrome in the system and use it, but if you want to use Firefox instead, set BRIDGE_E2E_BROWSER_NAME environment variable in your shell with the value firefox.

Debugging with VSCode

To debug with VSCode breakpoints, do the following:

  • Run: yarn dev:c

  • To display the value of the variables inline, add this to your settings.json:

    "debug.inlineValues": "on"

    This setting also works with the debugger; statement.

  • Create a launch.json file from the template:

    cp .vscode/launch.{template.json,json}

  • Set webRoot: your odf-console directory path. Check if the template value works for you.

  • Set a breakpoint in the code.

  • Go to Run and Debug panel, select "Debug odf-console" and start debugging.

    A Google Chrome instance will be launched.

  • Interact with the browser until you reach the breakpoint.

Build the CI runner image

Build a beta for testing:

docker build -t quay.io/ocs-dev/odf-console-ci-runner:beta -f Dockerfile.ci.runner .

Push it:

docker push quay.io/ocs-dev/odf-console-ci-runner:beta

Only for testing purposes (don't merge this), add a separate commit updating .ci-operator.yaml: tag: beta