open-vault/ui/README.md
Jordan Reimer be632db682
Ember Upgrade to 4.4 (#17086)
* runs ember-cli-update to 4.4.0

* updates yarn.lock

* updates dependencies causing runtime errors (#17135)

* Inject Store Service When Accessed Implicitly (#17345)

* adds codemod for injecting store service

* adds custom babylon parser with decorators-legacy plugin for jscodeshift transforms

* updates inject-store-service codemod to only look for .extend object expressions and adds recast options

* runs inject-store-service codemod on js files

* replace query-params helper with hash (#17404)

* Updates/removes dependencies throwing errors in Ember 4.4 (#17396)

* updates ember-responsive to latest

* updates ember-composable-helpers to latest and uses includes helper since contains was removed

* updates ember-concurrency to latest

* updates ember-cli-clipboard to latest

* temporary workaround for toolbar-link component throwing errors for using params arg with LinkTo

* adds missing store injection to auth configure route

* fixes issue with string-list component throwing error for accessing prop in same computation

* fixes non-iterable query params issue in mfa methods controller

* refactors field-to-attrs to handle belongsTo rather than fragments

* converts mount-config fragment to belongsTo on auth-method model

* removes ember-api-actions and adds tune method to auth-method adapter

* converts cluster replication attributes from fragment to relationship

* updates ember-data, removes ember-data-fragments and updates yarn to latest

* removes fragments from secret-engine model

* removes fragment from test-form-model

* removes commented out code

* minor change to inject-store-service codemod and runs again on js files

* Remove LinkTo positional params (#17421)

* updates ember-cli-page-object to latest version

* update toolbar-link to support link-to args and not positional params

* adds replace arg to toolbar-link component

* Clean up js lint errors (#17426)

* replaces assert.equal to assert.strictEqual

* update eslint no-console to error and disables invididual intended uses of console

* cleans up hbs lint warnings (#17432)

* Upgrade bug and test fixes (#17500)

* updates inject-service codemod to take arg for service name and runs for flashMessages service

* fixes hbs lint error after merging main

* fixes flash messages

* updates more deps

* bug fixes

* test fixes

* updates ember-cli-content-security-policy and prevents default form submission throwing errors

* more bug and test fixes

* removes commented out code

* fixes issue with code-mirror modifier sending change event on setup causing same computation error

* Upgrade Clean Up (#17543)

* updates deprecation workflow and filter

* cleans up build errors, removes unused ivy-codemirror and sass and updates ember-cli-sass and node-sass to latest

* fixes control groups test that was skipped after upgrade

* updates control group service tests

* addresses review feedback

* updates control group service handleError method to use router.currentURL rather that transition.intent.url

* adds changelog entry
2022-10-18 09:46:02 -06:00

5.1 KiB

Table of Contents

Vault UI

This README outlines the details of collaborating on this Ember application.

Ember CLI Version 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.

* lint-staged is an optional dependency - running yarn will install it. If don't want optional dependencies installed you can run yarn --ignore-optional. If you've ignored the optional deps previously and want to install them, you have to tell yarn to refetch all deps by running yarn --force.

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 / Development

To get all of the JavaScript dependencies installed, run this in the ui directory:

  • yarn

If you want to run Vault UI and proxy back to a Vault server running on the default port, 8200, run the following in the ui directory:

  • yarn start

This 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.

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

To run yarn with mirage, do:

  • yarn start:mirage handlername

Where handlername is one of the options exported in mirage/handlers/index

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

  • ember g component foo --in lib/core
  • echo "export { default } from 'core/components/foo';" > lib/core/app/components/foo.js

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, proxing requests back to that server.

  • yarn run test:oss
  • yarn run test:oss -s to keep the test server running after the initial run.
  • yarn run test -f="policies" to filter the tests that are run. -f gets passed into QUnit's filter config

Linting

  • yarn lint
  • yarn lint:fix

Building Vault UI into a Vault Binary

We use the embed package from Go 1.16+ 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 run: 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.