3abca46464
* manual cherry pick to deal with all the merge things * changelog * test fixes * Update 28148.txt * fix tests failures after main merge * fix test failures after main merge * Add Access Type and conditionally render WIF fields (#28149) * initial work. * remove access_type * better no model logic well kind of * rollback attrs * remove defaults * stopping point * wip changing back to sidebranch * hustling shuffling and serializing * some of the component test coverage * disable acces type if editing * test coverage * hide max retries that sneaky bugger * cleanup * cleanup * Update root-config.js * remove flash message check, locally passes great but on ci flaky * clean up * thank you chelsea * test clean up per enterprise vs community * address pr comments * welp a miss add * UI (sidebranch) WIF Issuer field (#28187) * Add type declaration files for aws config models * use updated task syntax for save method on configure-aws * fix types on edit route * fetch issuer on configure edit page if aws + enterprise * track issuer within configure-aws component * add placeholder support on form-field * Add warning if issuer changed from previous value or could not be read * cleanup * preliminary tests * dont use while loop so we can test the modal * tests * cleanup * fix tests * remove extra tracked value and duplicate changed attrs check * modal footer --------- Co-authored-by: Angel Garbarino <argarbarino@gmail.com> * Display issuer on Configuration details (#28209) * display issuer on configuration details * workflow complete, now on to testing * handle issuer things * fix all the broken tests things * add test coveragE: * cleanup * rename model/adapter * Update configure-aws.ts * Update aws-configuration-test.js * 90 percent there for pr comments * last one for tonight * a few more because why not * hasDirtyAttributes fixes * revert back to previous noRead->queryIssuerError --------- Co-authored-by: Chelsea Shaw <82459713+hashishaw@users.noreply.github.com>
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.17.x | 5.4.2 |
| 1.15.x | 4.12.0 |
| 1.14.x | 4.4.0 |
| 1.13.x | 4.4.0 |
| 1.12.x | 3.28.5 |
| 1.11.x | 3.28.5 |
| 1.10.x | 3.28.5 |
| 1.9.x | 3.22.0 |
| 1.8.x | 3.22.0 |
| 1.7.x | 3.11.0 |
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 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: export MIRAGE_DEV_HANDLER=<handler> yarn start
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 (vault must be running on port :8200) |
export MIRAGE_DEV_HANDLER=<handler>; yarn 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 |
yarn test:filter |
run non-enterprise in the browser |
yarn test:filter -f='<test name>' |
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. 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 yarn 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.
yarn run testlint & run all the tests (CI uses this)yarn run test:osslint & run all the non-enterprise tests (CI uses this)yarn run test:quickrun all the tests without lintingyarn run test:quick-ossrun all the non-enterprise tests without lintingyarn run test:filter -f="policies"run the filtered test in the browser with no splitting.-fis set to!enterpriseby default 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.