policies-ui-frontend

Policies frontend for Red Hat Insights

Build app

1. yarn

2. yarn start

   • starts webpack bundler and serves the files with webpack dev server

Testing

• yarn verify will run linters and tests
• Travis is used to test the build for this code.
  • You are always notified on failed builds
  • You are only notified on successful builds if the build before it failed
  • By default, both push events as well as pull_request events send notifications

Running locally

To run locally, we need the following:

1. Run insights proxy
2. Run policies-ui-frontend application.

Running insights proxy

In order to run it locally, you need to have insights-proxy repository placed under PROXY_PATH.

There are two modes to run the proxy, one is used when you want to provide your own backend and engine for development or testing of the components. You do that by starting the proxy by running:

yarn proxy

The other mode is when you want to hook to the whole environment (ci, qa, etc) only replacing the UI. In this mode, the UI will talk to servers in the environment you choose (depending the url). This is convenient when you need to use the data that is already there. To do that, simple start the proxy by running:

yarn proxy-ui

Running policies-ui-frontend

Install the dependencies:

yarn

and run the application:

yarn start

After that, you can head to the dev page, qa page or prod page.

You will likely need to accept the certificates of these pages and the websocket page

For more info refer to Insights Frontend Starter App README

Deploying

Deployments come from the .travis/custom_release.sh file. Push to certain branches to deploy to certain environments:

Pushing to master

Anytime a build of the master branch happens, Travis builds and pushes a new commit to the ci-beta & qa-beta branch in your build repo. Pull requests on master will not be deployed until they are merged, but they will be built to assure linting, snapshots, etc. are working as expected.

master -> qa-beta & ci-beta prod-beta -> prod-beta master-stable -> qa-stable & ci-stable prod-stable -> prod-stable

Testing - jest

When you want to test your code with unit tests please use jest which is preconfigured in a way to collect codecoverage as well. If you want to see your coverage on server the travis config has been set in a way that it will send data to codecov.io the only thing you have to do is visit their website (register), enable your repository and add CODECOV_TOKEN to your travis web config (do not add it to .travis file, but trough travis-ci.org)

Tools

Generating types from Openapi file

The ui-frontend depends on types from the ui-backend, these are generated from the Openapi spec file, run yarn schema to reload the types. Generate types can be found in: src/generated/, check package.json for more info.

Generating random trigger history

Requirements

• Access to Kafka topic
• kafkacat installed and in the PATH

Usage

Run yarn pushhost --account <account-number>.

Use yarn pushhost --help for more information. For the data being sent, check src/cli/pushhost.ts.

You can store the account number in .push-host.env under the INSIGHTS_ACCOUNT and omit the argument from the command line if used frequently.

$ cat .push-host.env 
INSIGHTS_ACCOUNT=940527