consul/ui/packages/consul-ui
John Cowen 38b5367d42
ui: Move nvmrc to the root of the workspace (#14567)
2022-09-29 09:41:57 -07:00
..
app ui: Topology notices testing/refactor prep (#14575) 2022-09-20 15:49:31 +01:00
blueprints ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00
config ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00
docs ui: Move peers to a subapplication (#13725) 2022-07-14 11:22:45 +01:00
lib ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00
mock-api ui: Update mock intention metadata to only include possible values (#14607) 2022-09-15 09:37:40 +01:00
node-tests/config ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00
public Update brand assets (#10081) 2021-05-03 16:19:09 +01:00
server ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00
tests ui: Add more acceptance tests for cluster peering (#14707) 2022-09-29 09:38:41 -07:00
translations ui: Amends to existing topology notice/banner texts (#14527) 2022-09-29 09:39:06 -07:00
vendor ui: Adds a HCP home link when in HCP (#14417) 2022-09-01 18:26:12 +01:00
.docfy-config.js ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00
.editorconfig ui: Move to Workspaced Structure (#8994) 2020-10-21 15:23:16 +01:00
.ember-cli ui: Default to glimmer components (#9121) 2020-11-06 14:54:44 +00:00
.eslintignore ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00
.eslintrc.js ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00
.gitignore ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00
.istanbul.yml ui: Move to Workspaced Structure (#8994) 2020-10-21 15:23:16 +01:00
.prettierignore ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00
.prettierrc ui: Move to Workspaced Structure (#8994) 2020-10-21 15:23:16 +01:00
.prettierrc.js ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00
.template-lintrc.js ui: Search/filtering 'Filtered by:' search status (#9442) 2021-01-25 18:13:54 +00:00
.watchmanconfig ui: Move to Workspaced Structure (#8994) 2020-10-21 15:23:16 +01:00
GNUmakefile ui: Change approach to loading debug.css (#12242) 2022-02-03 08:40:03 +00:00
README.md ui: Amend UI branching docs (#12705) 2022-04-07 11:34:24 +01:00
ember-cli-build.js ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00
package.json ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00
testem.js ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00

README.md

consul-ui

Prerequisites

You will need the following things properly installed on your computer.

Installation

  • git clone https://github.com/hashicorp/consul.git this repository
  • cd ui/packages/consul-ui

then:

To run the UI

From within ui/packages/consul-ui directory run:

  • make start

To run tests

From within ui/packages/consul-ui directory run:

  • make test-oss-view which will run the tests in Chrome

(see below and/or the testing section of the engineering docs for further detail)

Yarn Commands

Most used tooling scripts below primarily use make which will yarn install and in turn call node package scripts.

List of available project commands. yarn run <command-name>

Command Description
build:staging Builds the UI in staging mode (ready for PR preview site).
build:ci Builds the UI for CI.
build Builds the UI for production.
lint Runs all lint commands.
lint:hbs Lints hbs template files.
lint:js Lints js files.
format Runs all auto-formatters.
format:js Auto-formats js files using Prettier.
format:sass Auto-formats scss files using Prettier.
start Runs the development app on a local server using the mock API.
start:consul Runs the development app local server using a real consul instance as the backend.
start:staging Runs the staging app local server.
test Runs the ember tests in a headless browser.
test:view Runs the ember tests in a non-headless browser.
test:oss Runs only the OSS ember tests in a headless browser.
test:oss:view Runs only the OSS ember tests in a non-headless browser.
test:coverage:view Runs only the test specified for coverage in a non-headless browser.
test:node Runs tests that can't be run in ember using node.
doc:toc Automatically generates a table of contents for this README file.

Running / Development

The source code comes with a small development mode that runs enough of the consul API as a set of mocks/fixtures to be able to run the UI without having to run consul.

You can also run the UI against a normal Consul installation.

  • consul server -dev to start consul listening on http://localhost:8500
  • make start-consul to start the ember app proxying to consul (this will respect the CONSUL_HTTP_ADDR environment variable to locate the Consul installation.
  • Visit your app at http://localhost:4200.

Example:

CONSUL_HTTP_ADDR=http://10.0.0.1:8500 make start-consul

Environment Variables

See ./docs/index.mdx

Branching

We follow a ui/**/** branch naming pattern. This branch naming pattern allows front-end focused builds, such as FE tests, to run automatically in Pull Requests. Please note this only works if you are a member of the HashiCorp GitHub Org. If you are an external contributor these tests won't run and will instead be run by a member of our team during review.

Examples:

  • ui/feature/add...
  • ui/bugfix/fix...
  • ui/enhancement/update...

Contributing/Engineering Documentation

We have an in-app (only during development) component storybook and documentation site which can be visited using the Eng Docs link in the top navigation of the UI. Alternatively all of these docs are also readable via GitHub's UI, so folks can use whatever works best for them.

Browser 'Debug Utility' Functions and 'Environment' Variables

Run make start then visit http://localhost:4200/ui/docs/bookmarklets for a list of debug/engineering utilities you can use to help development of the UI under certain scenarios.

Code Generators

Many classes used in the UI can be generated with ember generators, try ember help generate for more details

Running Tests

Tests use the mock api (see ./mock-api for details), the mock-api runs automatically during testing, you don't need to run anything separately from the below commands in order for the tests to use the mock-api.

  • make test or yarn run test
  • make test-view or yarn run test:view to view the tests running in Chrome

For more guidance on running tests, see the testing section of the engineering docs.

OSS only tests can also be run using:

  • make test-oss or yarn run test:oss
  • make test-oss-view or yarn run test:oss:view to view the tests running in Chrome

Linting

make lint currently runs linting on the majority of js files and hbs files (using ember-template-lint).

See .eslintrc.js and .eslintignore for specific configuration.

Building

  • make build builds the UI for production usage (env=production)
  • make build-ci builds the UI for CI/test usage (env=test)

Static files are built into ./dist

Running Tests in Parallel

You probably don't need to understand this if you are simply running some tests locally.

Alternatively, ember-exam can be used to split the tests across multiple browser instances for faster results. Most options are the same as ember test. To see a full list of options, run ember exam --help.

Note: The EMBER_EXAM_PARALLEL environment variable must be set to override the default parallel value of 1 browser instance in testem.js.

To quickly run the tests across 4 parallel browser instances:

make test-parallel

To run manually:

$ EMBER_EXAM_PARALLEL=true ./node_modules/.bin/ember exam --split <num> --parallel

More ways to split tests can be found in the ember-exam README.md.