60eb60c24f
* updates kmip scope roles route to ts * updates kmip scope roles route to use api service and adds page component * converts kmip role route to ts * fixes a11y error in kmip header-credentials component * updates kmip role route to use api service and adds page component * removes kmip operation-field-display component that was moved into role page component * converts kmip role create route to ts * moves kmip role form component to component directory root * converts kmip role form component to ts * adds operation-groups helper and refactors kmip role page to use it * adds operation-label helper and updates kmip role page to use it * converts kmip edit role route to ts * updates kmip role test to use operation-groups helper * adds kmip role form * updates kmip role edit and create routes to use api service and form class * updates kmip role form component to work with form class * updates kmip acceptance tests * converts kmip credentials index route to ts * updates kmip credentials route to use api service * adds kmip credentials page component * converts kmip credentials show route to ts * updates kmip credentials show route to use api service and adds page component * fixes flash message issue on kmip role form submit success * converts kmip credentials generate route to ts * reverts kmip credentials show page component in favor of details-credentials component which is also used in generate route * fixes kmip details-credentials tests * update kmip credentials generate route to use api service and updates page component * removes store and pagination services from kmip engine * converts kmip breadcrumb component to ts * converts kmip header scope component to ts * removes kmip Ember Data models and adapters * removes store reference from kmip acceptance tests * fixes issues routing back to secrets engine via breadcrumb in kmip roles and credentials routes * removes kmip role adapter test * updates open api helpers tests Co-authored-by: Jordan Reimer <zofskeez@gmail.com> |
||
|---|---|---|
| .. | ||
| app | ||
| config | ||
| docs | ||
| lib | ||
| mirage | ||
| public | ||
| scripts | ||
| tests | ||
| types | ||
| vault-reporting | ||
| vendor | ||
| .browserslistrc | ||
| .copywrite.hcl | ||
| .editorconfig | ||
| .ember-cli | ||
| .env | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.js | ||
| .stylelintignore | ||
| .stylelintrc.js | ||
| .template-lintrc.js | ||
| .watchmanconfig | ||
| ember-cli-build.js | ||
| jsconfig.json | ||
| jsdoc2md.json | ||
| lint-staged.config.mjs | ||
| metadata.json | ||
| MODULE_REPORT.md | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| README.md | ||
| testem.js | ||
| tsconfig.json | ||
| vercel.json | ||
| webpack.jsondiffpatch.config.js | ||
Table of Contents
Vault UI
This README outlines the details of collaborating on this Ember application.
Ember Version Upgrade Matrix
Respective versions for ember-cli, ember-source and ember-data for each version of Vault that contains an upgrade.
| Vault Version | Ember CLI | Ember Source | Ember Data |
|---|---|---|---|
| 1.19.x | 5.8.0 | 5.8.0 | 5.3.2 |
| 1.17.x | 5.4.2 | 5.4.0 | 4.12.4 |
| 1.15.x | 4.12.1 | 4.12.0 | 4.11.3 |
| 1.13.x | 4.4.0 | 4.4.4 | 4.5.0 |
| 1.11.x | 3.28.5 | 3.28.10 | 3.28.6 |
| 1.10.x | 3.24.0 | 3.24.7 | 3.24.0 |
| 1.9.x | 3.22.0 | 3.22.0 | 3.22.0 |
Prerequisites
You will need the following things properly installed on your computer.
Running a Vault Server
Before running Vault UI locally, a Vault server must be running. First, ensure
Vault dev is built according the instructions in ../README.md.
- To start a single local Vault server:
pnpm vault - To start a local Vault cluster:
pnpm vault:cluster
These commands may also be aliased on your local device.
Running the UI locally
To spin up the UI, a Vault server must be running (see previous step).
All of the commands below assume you're in the ui/ directory.
These steps will start an Ember CLI server that proxies requests to port 8200, and enable live rebuilding of the application as you change the UI application code. Visit your app at http://localhost:4200.
- Install dependencies:
pnpm i
- Run Vault UI and proxy back to a Vault server running on the default port, 8200:
pnpm start
If your Vault server is running on a different port you can use the long-form version of the npm script:
ember server --proxy=http://localhost:PORT
Mirage
Mirage can be helpful for mocking backend endpoints. Look in mirage/handlers for existing mocked backends.
Run pnpm with mirage: export MIRAGE_DEV_HANDLER=<handler> && pnpm start
Where handlername is one of the options exported in mirage/handlers/index
To stop using the handler, kill the pnpm process (Ctrl+c) and then unset the environment variable.
unset MIRAGE_DEV_HANDLER
Building Vault UI into a Vault Binary
We use the embed package from Go >1.20 to build the static assets of the Ember application into a Vault binary.
This can be done by running these commands from the root directory:
make static-dist
make dev-ui
This will result in a Vault binary that has the UI built-in - though in
a non-dev setup it will still need to be enabled via the ui config or
setting VAULT_UI environment variable.
Development
Quick commands
| Command | Description |
|---|---|
pnpm start |
start the app with live reloading (vault must be running on port :8200) |
export MIRAGE_DEV_HANDLER=<handler>; pnpm start |
start the app with the mocked mirage backend, with handler provided |
make static-dist && make dev-ui |
build a Vault binary with UI assets (run from root directory not /ui) |
ember g component foo -ir core |
generate a component in the /addon engine |
pnpm test:filter |
run non-enterprise in the browser |
pnpm test:filter -f='<test name>' |
run tests in the browser, filtering by test name |
pnpm lint:js |
lint javascript files |
Code Generators
Make use of the many generators for code, try ember help generate for more details. If you're using a component that can be widely-used, consider making it an addon component instead (see this PR for more details)
eg. a reusable component named foo that you'd like in the core engine (read more about Ember engines here).
ember g component foo -ir core
The above command creates a template-only component by default. If you'd like to add a backing class, add the -gc flag:
ember g component foo -gc -ir core
Running Tests
Running tests will spin up a Vault dev server on port :9200 via a pretest script that testem (the test runner) executes. All of the acceptance tests then run, which proxy requests back to that server. The normal test scripts use ember-exam which split into parallel runs, which is excellent for speed but makes it harder to debug. So we have a custom package script that automatically opens all the tests in a browser, and we can pass the -f flag to target the test(s) we're debugging.
pnpm run testlint & run all the tests (CI uses this)pnpm run test:osslint & run all the non-enterprise tests (CI uses this)pnpm run test:quickrun all the tests without lintingpnpm run test:quick-ossrun all the non-enterprise tests without lintingpnpm run test:filter -f="policies"run the filtered test in the browser with no splitting.-fis set to!enterpriseby default QUnit'sfilterconfig
Linting
pnpm lint:jspnpm lint:hbspnpm lint:fix
Contributing / Best Practices
Hello and thank you for contributing to the Vault UI! Below is a list of patterns we follow on the UI team to keep in mind when contributing to the UI codebase. This is an ever-evolving process, so we welcome any comments, questions or general feedback.
Remember prefixing your branch name with
ui/will run UI tests and skip the go tests. If your PR includes backend changes, do not prefix your branch, instead add theuilabel on github. This will trigger the UI test suite to run, in addition to the backend Go tests.
Updating @hashicorp-internal/vault-reporting
Code regarding vault-reporting module lives in the shared-secure-ui repo, and it is being used as a tarball in this repo.
We use the script update-vault-reporting-addon.sh to fetch the latest tarball from artifactory and update package.json accordingly. To run the script, you'll need to have Doormat CLI and jq installed locally.
Example:
./scripts/update-vault-reporting-addon.sh