From a016cfae289731a74e486c53d942989701abcfdc Mon Sep 17 00:00:00 2001 From: "Jay R. Newlin (PromptWorks)" Date: Wed, 27 Nov 2019 16:09:24 -0500 Subject: [PATCH] Start Ghost Inspector README with details extracted from main README --- uitests/README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 uitests/README.md diff --git a/uitests/README.md b/uitests/README.md new file mode 100644 index 00000000..18d92351 --- /dev/null +++ b/uitests/README.md @@ -0,0 +1,29 @@ +# Ghost Inspector Readme + +To run the Ghost Inspector tests against a local instance of AT-AT, +you will need the following: + +- [docker](https://docs.docker.com/v17.12/install/) +- [circleci CLI tool](https://circleci.com/docs/2.0/local-cli/#installation) +- the prerequisite variable information listed [here](https://ghostinspector.com/docs/integration/circle-ci/) + +The version of our CircleCI config (2.1) is incompatible with the +`circleci` tool. First run: + +``` +circleci config process .circleci/config.yml > local-ci.yml +``` + +Then run the job: + +``` +circleci local execute -e GI_SUITE= -e GI_API_KEY= -e NGROK_TOKEN= --job integration-tests -c local-ci.yml +``` + +If the job fails and you want to re-run it, you may receive errors +about running docker containers or the network already existing. +Some version of the following should reset your local docker state: + +``` +docker container stop redis postgres test-atat; docker container rm redis postgres test-atat ; docker network rm atat +```