RedHatInsights/vulnerability-ui

Frontend for vulnerabilities detection service for RHEL system.

Vulnerability UI

Red Hat Insights Vulnerability service is used to assess and monitor the status of security vulnerabilities on RHEL systems, understand the level of exposure of infrastructure, and plan a course of action. This is the front-end repository for this service.

First time setup

1. Make sure you have Node.js version >= 18 installed
2. Run script to patch your /etc/hosts
3. Make sure you are using Red Hat proxy

Running locally

1. Install dependencies with npm install
2. Run development server with npm run start:proxy
3. While you run the command above, you will be prompted to choose an enviroment.

Testing federated modules with another application

If you want to test Vulnerability with another application deployed locally, you can utilise LOCAL_APPS environment variable and deploy the needed application on separate ports. To learn more about the variable, see https://github.com/RedHatInsights/frontend-components/tree/master/packages/config#running-multiple-local-frontend-applications.

Example

We'll take for example insights-inventory-frontend.

Open new terminal, navigate to Inventory repository, and run it on a separate port without proxy:

npm run start -- --port=8003

In a separate terminal, run Vulnerability with proxy enabled and list Inventory:

LOCAL_APPS=inventory:8003~http npm run start:proxy

Testing

Jest and Cypress are used as the testing frameworks

• npm run test - run all tests
• npm run test:ct - run all Cypress tests
• npm run test:jest - run all Jest tests
• npm run test:jest -- testName - run Jest tests for all components matching testName
• npm run test:jest:update - run all Jest tests and update snapshots
• npm run test:jest:watch - run Jest tests in watch mode
• npm run lint - run linter

Internationalization

Translation keys

Translation keys are saved in messages.js.

Generating translation keys

Each time you add a new translation keys you need to run npm run translations, which will automatically generate JSON files for every language into locales/ folder based on the entries in the messages.js.

Using translated strings

There are two ways to use translated strings:

1. With intl.formatMessage(messages.messageId)
2. With <FormattedMessage {...messages.messageId}/>

Design System

This project uses Patternfly React.

Insights Components

This app imports components from Insights Front-end Components library. ESI tags are used to import Insights Chrome which takes care of the header, sidebar, and footer.