open-consul/ui-v2
John Cowen 45a2fa5a01 UI: Add blocking cursor validation and more straightforward throttle (#5470)
More recommendations for blocking queries clients was added here:

https://github.com/hashicorp/consul/pull/5358

This commit mainly adds cursor/index validation/correction based on
these recommendations (plus tests)

The recommendations also suggest that clients should include rate
limiting. Because of this, we've moved the throttling out of Consul UI
specific code and into Blocking Query specific code. Currently the 'rate
limiting' in this commit only adds a sleep to every iteration of the
loop, which is not the recommended approach, but the code here organizes
the throttling functionality into something we can work with later to
provide something more apt.
2019-05-01 18:22:21 +00:00
..
app UI: Add blocking cursor validation and more straightforward throttle (#5470) 2019-05-01 18:22:21 +00:00
config ui: Bump footer date (#5279) 2019-01-28 17:50:37 +00:00
lib UI: Add ember steps:list command for listing available steps (#5255) 2019-05-01 18:22:08 +00:00
public ui: serve /robots.txt when UI is enabled. (#5089) 2018-12-17 19:35:03 +01:00
tests UI: Add blocking cursor validation and more straightforward throttle (#5470) 2019-05-01 18:22:21 +00:00
.dev.eslintrc.js UI V2 (#4086) 2018-05-10 19:52:53 +01:00
.editorconfig UI V2 (#4086) 2018-05-10 19:52:53 +01:00
.ember-cli Move testing doubles to use data embedded in the HTML vs HTTP/fetch 2018-07-02 19:02:16 +01:00
.eslintignore UI: Add EventSource ready for implementing blocking queries (#5070) 2019-05-01 18:22:06 +00:00
.eslintrc.js UI V2 (#4086) 2018-05-10 19:52:53 +01:00
.gitignore WIP: Feature/acceptance tests 2018-06-12 11:24:35 +01:00
.nvmrc UI V2 (#4086) 2018-05-10 19:52:53 +01:00
.prettierrc UI V2 (#4086) 2018-05-10 19:52:53 +01:00
.watchmanconfig UI V2 (#4086) 2018-05-10 19:52:53 +01:00
GNUmakefile UI: Add ember steps:list command for listing available steps (#5255) 2019-05-01 18:22:08 +00:00
README.md add documentation on how to use ember-exam 2019-01-03 23:50:02 -05:00
ember-cli-build.js ui: Rename extended Component variables, tweak some comments (#5021) 2019-05-01 18:21:50 +00:00
package.json UI: Add ember steps:list command for listing available steps (#5255) 2019-05-01 18:22:08 +00:00
testem.js output XML test results 2019-01-03 22:21:19 -05:00
yarn.lock UI: Add forking based on service instance id existence (#5392) 2019-05-01 18:22:15 +00: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

Running / Development

The source code comes with a small server 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.

  • make start-api or yarn start:api (this starts a Consul API double running on http://localhost:3000)
  • make start or yarn start to start the ember app that connects to the above API double
  • Visit your app at http://localhost:4200.

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.

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

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:

yarn test-parallel

To run manually:

$ EMBER_EXAM_PARALLEL=true ember exam --split <num> --parallel

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