summaryrefslogtreecommitdiff
path: root/qa/README.md
diff options
context:
space:
mode:
authorRobert Speicher <rspeicher@gmail.com>2017-10-05 12:36:28 +0200
committerRobert Speicher <rspeicher@gmail.com>2017-10-05 12:37:16 +0200
commit32c30203b2399b2cce23ee68fa67e854d1edbe45 (patch)
treeb83d7181918f59de7004a43429b00a115dcd66ee /qa/README.md
parent6ba961499c732d930d4939c0fa3743afa20fd2a8 (diff)
downloadgitlab-ce-32c30203b2399b2cce23ee68fa67e854d1edbe45.tar.gz
Use the default password from the GDK's root user
[ci skip]
Diffstat (limited to 'qa/README.md')
-rw-r--r--qa/README.md30
1 files changed, 23 insertions, 7 deletions
diff --git a/qa/README.md b/qa/README.md
index e0ebb53a2e9..1cfbbdd9d42 100644
--- a/qa/README.md
+++ b/qa/README.md
@@ -1,10 +1,10 @@
-## Integration tests for GitLab
+# GitLab QA - Integration tests for GitLab
This directory contains integration tests for GitLab.
-It is part of [GitLab QA project](https://gitlab.com/gitlab-org/gitlab-qa).
+It is part of the [GitLab QA project](https://gitlab.com/gitlab-org/gitlab-qa).
-## What GitLab QA is?
+## What is it?
GitLab QA is an integration tests suite for GitLab.
@@ -20,18 +20,34 @@ against any existing instance.
## How can I use it?
You can use GitLab QA to exercise tests on any live instance! For example, the
-follow call would login to the local GitLab instance and run all specs in
+following call would login to a local [GDK] instance and run all specs in
`qa/specs/features`:
```
-GITLAB_USERNAME='root' GITLAB_PASSWORD='5iveL!fe' bin/qa Test::Instance http://localhost
+bin/qa Test::Instance http://localhost:3000
```
-You can also supply a specific tests to run as another parameter. For example, to
+### Running specific tests
+
+You can also supply specific tests to run as another parameter. For example, to
test the EE license specs, you can run:
```
-EE_LICENSE="<YOUR LICENSE KEY>" GITLAB_USERNAME='root' GITLAB_PASSWORD='5iveL!fe' bin/qa Test::Instance http://localhost qa/ee
+EE_LICENSE="<YOUR LICENSE KEY>" bin/qa Test::Instance http://localhost qa/ee
+```
+
+### Overriding the authenticated user
+
+Unless told otherwise, the QA tests will run as the default `root` user seeded
+by the GDK.
+
+If you need to authenticate as a different user, you can provide the
+`GITLAB_USERNAME` and `GITLAB_PASSWORD` environment variables:
+
+```
+GITLAB_USERNAME=jsmith GITLAB_PASSWORD=password bin/qa Test::Instance https://gitlab.example.com
```
All [supported environment variables are here](https://gitlab.com/gitlab-org/gitlab-qa#supported-environment-variables).
+
+[GDK]: https://gitlab.com/gitlab-org/gitlab-development-kit/