open-consul/ui-v2
John Cowen 6126f24acd
ui: Remove with-listeners mixin (#8142)
This mixin was a very thin mixin over the top of our listeners utility,
and we have been gradually preferring using the utility straight rather
than using the mixin. This commit removes the last places where we still
used the mixin, and also potentially the last few places where we
continued to use the old API for our listeners utility.
2020-06-18 14:54:31 +01:00
..
app ui: Remove with-listeners mixin (#8142) 2020-06-18 14:54:31 +01:00
blueprints ui: Adds blueprint for creating css-components (#7460) 2020-05-12 17:14:17 +00:00
config ui: Ensure value is always passed to CONSUL_SSO_ENABLED (#7913) 2020-05-18 20:22:37 +01:00
lib UI: Improved Login/Logout flow inc SSO support (#7790) 2020-05-12 17:14:51 +00:00
node-tests/config ui: Ensure value is always passed to CONSUL_SSO_ENABLED (#7913) 2020-05-18 20:22:37 +01:00
public UI: Improved Login/Logout flow inc SSO support (#7790) 2020-05-12 17:14:51 +00:00
server UI: Improved Login/Logout flow inc SSO support (#7790) 2020-05-12 17:14:51 +00:00
tests ui: Remove with-listeners mixin (#8142) 2020-06-18 14:54:31 +01:00
.dev.eslintrc.js UI V2 (#4086) 2018-05-10 19:52:53 +01:00
.editorconfig ui: Upgrade to ember 3.16 Octane Edition (#7334) 2020-05-12 17:14:10 +00:00
.ember-cli ui: Move to new ember nested file structure for components (#7403) 2020-05-12 17:14:15 +00:00
.eslintignore ui: UI Release Merge (ui-staging merge) (#6527) 2019-09-30 14:47:49 +01:00
.eslintrc.js ui: Create PopoverSelect, CatalogToolbar, and update tests (#7489) 2020-05-12 17:14:48 +00:00
.gitignore ui: UI Release Merge (ui-staging merge) (#6527) 2019-09-30 14:47:49 +01:00
.istanbul.yml ui: replace Makefile sed directive for coverage 2020-05-12 17:14:34 +00:00
.nvmrc ui: Upgrade to node 12 LTS (#7248) 2020-05-12 17:13:53 +00:00
.prettierrc UI V2 (#4086) 2018-05-10 19:52:53 +01:00
.template-lintrc.js ui: Upgrade to ember 3.16 Octane Edition (#7334) 2020-05-12 17:14:10 +00:00
.travis.yml ui: Upgrade to ember 3.16 Octane Edition (#7334) 2020-05-12 17:14:10 +00:00
.watchmanconfig UI V2 (#4086) 2018-05-10 19:52:53 +01:00
GNUmakefile ui: replace Makefile sed directive for coverage 2020-05-12 17:14:34 +00:00
README.md ui: [dev] Adds express middleware, removes need to run api dev server (#6750) 2019-12-18 12:26:41 +00:00
_redirects ui: Netlify previews (#6419) 2019-09-04 08:35:17 +00:00
ember-cli-build.js ui: Ensure encoder.js polyfill is available (#8094) 2020-06-12 14:28:36 +01:00
package.json ui: Switch out WithResizingMixin for on-window helper (#8130) 2020-06-17 14:26:50 +01:00
testem.js ui: Upgrade to ember 3.16 Octane Edition (#7334) 2020-05-12 17:14:10 +00:00
yarn.lock ui: Switch out WithResizingMixin for on-window helper (#8130) 2020-06-17 14:26:50 +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-v2
  • yarn install

All tooling scripts below primarily use make which in turn call node package scripts.

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.

To enable ACLs using the mock API, use Web Inspector to set a cookie as follows:

CONSUL_ACLS_ENABLE=1

This will enable the ACLs login page, to which you can login with any ACL token/secret.

You can also use a number of other cookie key/values to set various things whilst developing the UI, such as (but not limited to):

CONSUL_SERVICE_COUNT=1000
CONSUL_NODE_CODE=1000
// etc etc

See ./node_modules/@hashicorp/consul-api-double for more details.

If you wish to run the UI code against a running consul instance, uncomment the proxy line in .ember-cli to point ember-cli to your consul instance.

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

make start-consul or yarn run start:consul will use the CONSUL_HTTP_ADDR environment variable to locate the Consul installation. If that it not set start-consul will use http://localhost:8500.

Example usage:

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

Code Generators

Make use of the many generators for code, try ember help generate for more details

Running Tests

Please note: You do not need to run make start-api/yarn run start:api to run the tests, but the same mock consul API is used.

  • make test or yarn run test
  • make test-view or yarn run test: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

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.