diff options
Diffstat (limited to 'qa/README.md')
| -rw-r--r-- | qa/README.md | 41 |
1 files changed, 38 insertions, 3 deletions
diff --git a/qa/README.md b/qa/README.md index b6b5a76f1d3..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. @@ -16,3 +16,38 @@ against any existing instance. 1. When we release a new version of GitLab, we build a Docker images for it. 1. Along with GitLab Docker Images we also build and publish GitLab QA images. 1. GitLab QA project uses these images to execute integration tests. + +## How can I use it? + +You can use GitLab QA to exercise tests on any live instance! For example, the +following call would login to a local [GDK] instance and run all specs in +`qa/specs/features`: + +``` +bin/qa Test::Instance http://localhost:3000 +``` + +### 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>" 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/ |