e568cded17
In an ember environment `config/environment.js` exports a JSON object whereas the file itself exports a function that receives a string of the environment name that would like returning. This is so ember can automatically provide you with an already configured object containing configuration values dependent on which environment you passed to `ember-cli` using `serve`, `build` or `test`. In order to bypass this so we can easily test what is returned for different environments, we've installed a lightweight functional test harness that is simple to use `substack/tape`, that can be run easily outside of ember. We've then written as simple test case using this to enable us to test/assert that different environments return the correct configuration values. Additionally we've added some yarn scripts/make targets (yarn run test-node / make test-node) to make this easy to run. We're yet to integrate this into CI. |
||
|---|---|---|
| .. | ||
| app | ||
| blueprints | ||
| config | ||
| lib | ||
| node-tests/config | ||
| public | ||
| tests | ||
| .dev.eslintrc.js | ||
| .editorconfig | ||
| .ember-cli | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .nvmrc | ||
| .prettierrc | ||
| .template-lintrc.js | ||
| .watchmanconfig | ||
| GNUmakefile | ||
| README.md | ||
| _redirects | ||
| ember-cli-build.js | ||
| package.json | ||
| testem.js | ||
| yarn.lock | ||
README.md
consul-ui
Prerequisites
You will need the following things properly installed on your computer.
- Git
- Node.js (with npm)
- yarn
- Ember CLI
- Google Chrome
Installation
git clone https://github.com/hashicorp/consul.gitthis repositorycd ui-v2yarn 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.
make startoryarn startto start the ember app- 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.
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 testoryarn run testmake test-vieworyarn run test:viewto 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 buildbuilds the UI for production usage (env=production)make build-cibuilds 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.