76e742ba32
* UI: HDS adoption replace AlertBanner part 1 (#21163) * rename test selector * replace db banner * add class * replace db role edit * db creds * generate creds * simpler class * license banner component * oidc callback plash * raft * aws * secret create or update * change to compact alert for form field * change back to inline * combine alert banners * wrap in conditional * remove references to message class * UI: HDS adoption replace AlertBanner part 2 (#21243) * token expire warning * delete css * edit form * item details distribute mfa step 2 transit verify * back to secondary * distribute * oidc lease error * sign * kv obj and repl dash * more repl * update test selector * show, creds * shamir * pki csr * pki banners * add hds library to ember engines * woops comma * fix k8 test * update message error component for last! * hold off MessageError changes until next pr * revert test selectors * update pki tests * UI: part 3 remove alert banner (#21334) * final component swap * and actual final of MessageError * update MessageError selectors * delete alert-banner and remove references * update next step alerts to highlight color * finishing touches, auth form test and client dashboard inline link * fix more selectors * fix shamir flow test * ui: part 4 final cleanup (#21365) * replace AlertPopup * add test tag * move tag * one more message error tag * delete alert popup * final css cleanup * move preformatted flash into <p> tag * ui: address comments for sidebranch (#21388) * add periods, move link to trailing * more periods and typo fix
Table of Contents
Vault UI
This README outlines the details of collaborating on this Ember application.
Ember CLI Version Upgrade Matrix
| Vault Version | Ember Version |
|---|---|
| 1.13.x | 4.4.0 |
| 1.10.x | 3.28.5 |
| 1.9.x | 3.22.0 |
| 1.8.x | 3.22.0 |
| 1.7.x | 3.11 |
Prerequisites
You will need the following things properly installed on your computer.
In order to enforce the same version of yarn across installs, the yarn binary is included in the repo
in the .yarn/releases folder. To update to a different version of yarn, use the yarn policies set-version VERSION command. For more information on this, see the documentation.
Running a Vault Server
Before running Vault UI locally, a Vault server must be running. First, ensure
Vault dev is built according the the instructions in ../README.md.
- To start a single local Vault server:
yarn vault - To start a local Vault cluster:
yarn 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:
yarn
- Run Vault UI and proxy back to a Vault server running on the default port, 8200:
yarn 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 yarn with mirage: yarn start:mirage handlername
Where handlername is one of the options exported in mirage/handlers/index
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 |
|---|---|
yarn start |
start the app with live reloading |
yarn start:mirage <handler> |
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 |
yarn test:quick -f='<test name>' -s |
run tests in the browser, filtering by test name |
yarn 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.
yarn run test:ossyarn run test:oss -sto keep the test server running after the initial run.yarn run test -f="policies"to filter the tests that are run.-fgets passed into QUnit'sfilterconfig
Linting
yarn lint:jsyarn lint:hbsyarn 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.