Skip to content

Commit a8b8323

Browse files
dlabrecqdlabrecq
committed
Merge remote-tracking branch 'origin/main' into stage-stable
2 parents 33c10e1 + 7f13df7 commit a8b8323

File tree

88 files changed

+1610
-419
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+1610
-419
lines changed

‎.github/workflows/ci.yml

+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
branches: [ main, prod-beta, prod-stable, stage-beta, stage-stable ]
6+
push:
7+
branches: [ main, prod-beta, prod-stable, stage-beta, stage-stable ]
8+
9+
env:
10+
BRANCH: ${{ github.base_ref }}
11+
NODEJS_VERSION: '18'
12+
13+
jobs:
14+
build:
15+
# This job is run for PRs only, as a sanity check, to confirm ci.ext.devshift.net is working properly
16+
if: ${{ github.event_name == 'pull_request' }}
17+
name: Build
18+
runs-on: ubuntu-latest
19+
20+
steps:
21+
- name: Checkout code
22+
uses: actions/checkout@v4
23+
24+
- name: Setup Node.js
25+
uses: actions/setup-node@v4
26+
with:
27+
node-version: ${{ env.NODEJS_VERSION }}
28+
29+
- name: Cache node modules
30+
id: cache-npm
31+
uses: actions/cache@v4
32+
env:
33+
cache-name: cache-node-modules
34+
with:
35+
# npm cache files are stored in `~/.npm` on Linux/macOS
36+
path: ~/.npm
37+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
38+
restore-keys: |
39+
${{ runner.os }}-build-${{ env.cache-name }}-
40+
${{ runner.os }}-build-
41+
${{ runner.os }}-
42+
43+
- name: Install dependencies
44+
run: npm install
45+
46+
- name: Build
47+
run: npm run build
48+
49+
- name: Lint
50+
run: npm run lint
51+
52+
units:
53+
name: Units
54+
runs-on: ubuntu-latest
55+
56+
steps:
57+
- name: Checkout code
58+
uses: actions/checkout@v4
59+
60+
- name: Setup Node.js
61+
uses: actions/setup-node@v4
62+
with:
63+
node-version: ${{ env.NODEJS_VERSION }}
64+
65+
- name: Cache node modules
66+
id: cache-npm
67+
uses: actions/cache@v4
68+
env:
69+
cache-name: cache-node-modules
70+
with:
71+
# npm cache files are stored in `~/.npm` on Linux/macOS
72+
path: ~/.npm
73+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
74+
restore-keys: |
75+
${{ runner.os }}-build-${{ env.cache-name }}-
76+
${{ runner.os }}-build-
77+
${{ runner.os }}-
78+
79+
- name: Install dependencies
80+
run: npm install
81+
82+
- name: Test
83+
id: test_run
84+
run: npm test -- --collect-coverage --max-workers=4
85+
86+
- uses: actions/upload-artifact@v4
87+
if: ${{ steps.test_run.outcome == 'success' }}
88+
name: Save coverage report
89+
with:
90+
name: coverage_report
91+
path: coverage/
92+
retention-days: 10
93+
94+
coverage:
95+
name: Coverage
96+
needs: [units]
97+
runs-on: ubuntu-latest
98+
99+
steps:
100+
- name: Checkout code
101+
uses: actions/checkout@v4
102+
103+
- name: Download coverage report
104+
uses: actions/download-artifact@v4
105+
with:
106+
name: coverage_report
107+
path: coverage
108+
109+
- name: Upload coverage report
110+
if: ${{ success() }}
111+
uses: codecov/codecov-action@v4.2.0
112+
env:
113+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
114+
with:
115+
directory: coverage
116+
plugin: pycoverage # Only run one plugin so that all do not run. There is no way to disable plugins entirely.

‎.github/workflows/pull_request.yml

-66
This file was deleted.

‎README.md

+34-30
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Koku UI
22

33
[![Apache 2.0][license-badge]](https://github.com/project-koku/koku-ui/blob/main/LICENSE)
4-
[![CI Status][build-badge]](https://github.com/project-koku/koku-ui/actions/workflows/tag_release.yml)
4+
[![CI Status][build-badge]](https://github.com/project-koku/koku-ui/actions/workflows/ci.yml?query=branch%3Amain)
55
[![codecov][codecov-badge]](https://codecov.io/gh/project-koku/koku-ui)
66

77
React.js app for Cost Management.
@@ -11,6 +11,7 @@ User interface is based on [Patternfly].
1111
Submit issues in [Jira].
1212

1313
## Requirements
14+
1415
* [NodeJS v18.15+][nodejs]
1516
* [npm v9.5+][npm]
1617

@@ -28,6 +29,7 @@ sudo bash scripts/patch-etc-hosts.sh
2829
```
2930

3031
## Getting Started
32+
3133
1. Install requirements listed above.
3234
2. Setup `/etc/hosts` entries listed above.
3335
3. Clone the repository, and open a terminal in the base of this project.
@@ -44,6 +46,7 @@ npm test
4446
```
4547

4648
## Running Koku UI against a hosted Koku API, using webpack proxy
49+
4750
Note that this approach currently supports the Insights stage-beta, stage-stable, prod-beta, and prod-stable environments.
4851

4952
1. Start development server
@@ -64,7 +67,7 @@ https://stage.foo.redhat.com:1337/beta/openshift/cost-management
6467

6568
### Running Koku UI with local Cloud Services Backend
6669

67-
See https://github.com/RedHatInsights/chrome-service-backend/blob/main/docs/cloud-services-config.md#serving-files-locally
70+
Refer to the [serving files locally][serving-files-locally] section of cloud services config for more details
6871

6972
1. Serve files locally from Cloud Services Backend repo
7073
```
@@ -78,7 +81,7 @@ npm start:csb
7881

7982
### Running Koku UI with local Koku microfrontend (MFE)
8083

81-
See https://github.com/project-koku/koku-ui-mfe
84+
Refer to the [koku-ui-mfe README][koku-ui-mfe-readme] for more details
8285

8386
1. Start development server in Koku MFE repo
8487
```
@@ -92,8 +95,7 @@ npm start:mfe
9295

9396
### Running Koku UI with local Koku microfrontend (MFE) and Cloud Services Backend
9497

95-
See https://github.com/RedHatInsights/chrome-service-backend/blob/main/docs/cloud-services-config.md#serving-files-locally
96-
and https://github.com/project-koku/koku-ui-mfe
98+
Refer to the [serving files locally][serving-files-locally] section of cloud services config and the [koku-ui-mfe README][koku-ui-mfe-readme] for more details
9799

98100
1. Serve files locally from Cloud Services Backend repo
99101
```
@@ -126,31 +128,32 @@ Follow the prompts that follow.
126128

127129
2. Open the following URL
128130
```
129-
http://localhost:8002/beta/openshift/cost-management
131+
http://localhost:8002/beta/openshift/cost-management
130132
```
131133

132134
#### Koku API
133-
Refer to the project [README][koku-readme] for prerequisites
134135

135-
1. Setup & run Koku API (see project [README][koku-readme] for more details)
136+
Refer to the [koku README][koku-readme] for more details
137+
138+
1. Setup & run Koku API
136139
```
137-
> git clone git@github.com:project-koku/koku.git
138-
> cd [KOKU_GIT_REPO]
139-
> pipenv install --dev
140-
> pipenv shell "pre-commit install"
141-
> make docker-up-min or make docker-up-min-trino
142-
> make create-test-customer
143-
> make load-test-customer-data (use with docker-up-min-trino)
140+
git clone git@github.com:project-koku/koku.git
141+
cd [KOKU_GIT_REPO]
142+
pipenv install --dev
143+
pipenv shell "pre-commit install"
144+
make docker-up-min or make docker-up-min-trino
145+
make create-test-customer
146+
make load-test-customer-data (use with docker-up-min-trino)
144147
```
145148

146149
2. Check to see if containers are running (optional)
147150
```
148-
> docker ps --format "table {{.Names}}\t{{.Image}}\t{{.Ports}}\t{{.Status}}"
151+
docker ps --format "table {{.Names}}\t{{.Image}}\t{{.Ports}}\t{{.Status}}"
149152
```
150153

151154
3. Watch the Koku API logs in another terminal (optional)
152155
```
153-
> docker-compose logs -f koku-server koku-worker
156+
docker compose logs -f koku-server koku-worker
154157
```
155158

156159
4. Clean up (optional)
@@ -164,25 +167,25 @@ exit
164167

165168
## Running local instances of Settings Frontend & Koku API
166169

167-
Follow the [steps](#koku-api) to run a local Koku API instance
170+
Follow the koku API [steps](#koku-api) to run a local Koku API instance
168171

169172
1. Clone the Settings Frontend repository and install dependencies
170173
```
171-
> git clone https://github.com/RedHatInsights/settings-frontend.git
172-
> cd [SETTINGS_FRONTEND_GIT_REPO]
173-
> npm install
174+
git clone https://github.com/RedHatInsights/settings-frontend.git
175+
cd [SETTINGS_FRONTEND_GIT_REPO]
176+
npm install
174177
```
175178

176179
2. Set the following variables in your environment
177180
```
178-
> export API_PORT=8000
179-
> export LOCAL_API="/api/cost-management/v1/"
180-
> export KEYCLOAK_PORT=4020
181+
export API_PORT=8000
182+
export LOCAL_API="/api/cost-management/v1/"
183+
export KEYCLOAK_PORT=4020
181184
```
182185

183186
3. Start development server
184187
```
185-
> npm run start:standalone:beta
188+
npm run start:standalone:beta
186189
```
187190

188191
4. Open the following URL
@@ -194,14 +197,15 @@ http://localhost:1337/beta/settings/applications/cost-management
194197

195198
This [RELEASE][release-doc] doc describes how to release Koku UI to each staging environment.
196199

197-
[build-badge]: https://github.com/project-koku/koku-ui/actions/workflows/tag_release.yml/badge.svg
198-
[license-badge]: https://img.shields.io/github/license/project-koku/koku-ui.svg?longCache=true
200+
[build-badge]: https://github.com/project-koku/koku-ui/actions/workflows/ci.yml/badge.svg?branch=main
199201
[codecov-badge]: https://codecov.io/gh/project-koku/koku-ui/graph/badge.svg?token=1hjFIy1cRe
200-
202+
[Jira]: https://issues.redhat.com/projects/COST/
201203
[koku-readme]: https://github.com/project-koku/koku#readme
204+
[koku-ui-mfe-readme]: https://github.com/project-koku/koku-ui-mfe#readme
205+
[license-badge]: https://img.shields.io/github/license/project-koku/koku-ui.svg?longCache=true
202206
[nodejs]: https://nodejs.org/en/
207+
[npm]: https://www.npmjs.com/
203208
[patch-etc-hosts]: https://github.com/RedHatInsights/insights-proxy/blob/master/scripts/patch-etc-hosts.sh
204209
[Patternfly]: https://www.patternfly.org/
205210
[release-doc]: https://github.com/project-koku/koku-ui/blob/main/RELEASE.md
206-
[npm]: https://www.npmjs.com/
207-
[Jira]: https://issues.redhat.com/projects/COST/
211+
[serving-files-locally]: https://github.com/RedHatInsights/chrome-service-backend/blob/main/docs/cloud-services-config.md#serving-files-locally

‎jest.config.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ module.exports = {
3030
$schema: 'http://json.schemastore.org/swcrc',
3131
jsc: {
3232
experimental: {
33-
plugins: [['jest_workaround', {}]],
33+
plugins: [['swc_mut_cjs_exports', {}]],
3434
},
3535
parser: {
3636
jsx: true,

‎locales/data.json

+6
Original file line numberDiff line numberDiff line change
@@ -1156,6 +1156,12 @@
11561156
"value": "Cost Management"
11571157
}
11581158
],
1159+
"costModel": [
1160+
{
1161+
"type": 0,
1162+
"value": "Cost Model:"
1163+
}
1164+
],
11591165
"costModels": [
11601166
{
11611167
"type": 0,

‎locales/translations.json

+1
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@
8181
"costDistributionTitle": "Overhead cost breakdown",
8282
"costDistributionType": "{value, select, distributed {Distribute through cost models} total {Don't distribute overhead costs} other {}}",
8383
"costManagement": "Cost Management",
84+
"costModel": "Cost Model:",
8485
"costModels": "Cost Models",
8586
"costModelsActions": "Cost model actions",
8687
"costModelsAddTagValues": "Add more tag values",

0 commit comments

Comments
 (0)