consul/ui-v2
John Cowen 1d324b726f
ui: Leader API polling (#8814)
* Allow configuring a datasource to poll instead of block

* Add 30 second polling to the leader API request
2020-10-06 14:26:44 +01:00
..
app ui: Leader API polling (#8814) 2020-10-06 14:26:44 +01:00
blueprints
config ci: fix bindata autoupdate (#8801) 2020-10-02 15:23:38 -04:00
lib Refactor uiserver to separate package, cleaner Reloading 2020-10-01 11:32:25 +01:00
node-tests/config ui: Go back to expecting falsey values during config env tests (#8710) 2020-09-23 09:19:04 +01:00
public
server
tests ui: Leader API polling (#8814) 2020-10-06 14:26:44 +01:00
.dev.eslintrc.js
.editorconfig
.ember-cli
.eslintignore
.eslintrc.js
.gitignore ui: Reinstate listing of available test steps via CLI (#8614) 2020-09-09 09:12:42 +01:00
.istanbul.yml
.nvmrc
.prettierrc
.template-lintrc.js
.travis.yml
.watchmanconfig
GNUmakefile
README.md
_redirects
ember-cli-build.js ui: Add in-repo addon to configure inclusion of components/**/*.scss (#8660) 2020-09-15 18:45:08 +01:00
package.json ui: Service Mesh - Topology tab and basic layout (#8788) 2020-10-05 13:07:35 -04:00
testem.js
yarn.lock ui: Service Mesh - Topology tab and basic layout (#8788) 2020-10-05 13:07:35 -04: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.