Commit 7d9270b0 authored by Amy Qualls's avatar Amy Qualls

Add hard wraps to document

This page needs hard line wraps to conform to our style. To prevent
merge conflicts later, let's do the hard wraps first.
parent 7415ddf8
......@@ -8,11 +8,14 @@ info: To determine the technical writer assigned to the Stage/Group associated w
## See what the browser is doing
If something has gone wrong when trying to run the end-to-end tests, it can be very helpful to see what is happening in your
browser when it fails. For example, if the tests don't run at all, it might be because the test framework is trying to
open a URL that isn't valid on your machine, which should be clearer if you see it fail in the browser.
If something has gone wrong when trying to run the end-to-end tests, it can be
very helpful to see what is happening in your browser when it fails. For example,
if the tests don't run at all, it might be because the test framework is trying to
open a URL that isn't valid on your machine, which should be clearer if you see
it fail in the browser.
To make the test framework show the browser as it runs the tests, set `WEBDRIVER_HEADLESS=false`. For example:
To make the test framework show the browser as it runs the tests,
set `WEBDRIVER_HEADLESS=false`. For example:
```shell
cd gitlab/qa
......@@ -21,15 +24,17 @@ WEBDRIVER_HEADLESS=false bundle exec bin/qa Test::Instance::All http://localhost
## Enable logging to see what the test framework tries to do
Sometimes a test might fail and the failure stacktrace doesn't provide enough information to determine what went wrong.
You can get more information by enabling debug logs by setting `QA_DEBUG=true`. For example:
Sometimes a test might fail and the failure stack trace doesn't provide enough
information to determine what went wrong. You can get more information by enabling
debug logs by setting `QA_DEBUG=true`. For example:
```shell
cd gitlab/qa
QA_DEBUG=true bundle exec bin/qa Test::Instance::All http://localhost:3000
```
The test framework will then output a lot of logs showing the actions taken during the tests. For example:
The test framework then outputs a lot of logs showing the actions taken during
the tests. For example:
```plaintext
[date=2022-03-31 23:19:47 from=QA Tests] INFO -- Starting test: Create Merge request creation from fork can merge feature branch fork to mainline
......@@ -41,9 +46,11 @@ The test framework will then output a lot of logs showing the actions taken duri
## Tests don't run at all
This assumes that you're running the tests locally (e.g., on GDK) and you're doing so from the `gitlab/qa/` folder, not via `gitlab-qa`.
This assumes that you're running the tests locally (e.g., on GDK) and you're doing
so from the `gitlab/qa/` folder, not via `gitlab-qa`.
If you see a `Net::ReadTimeout` error this might be because the browser is not able to load the specified URL. For example:
If you see a `Net::ReadTimeout` error this might be because the browser is not able
to load the specified URL. For example:
```shell
cd gitlab/qa
......@@ -53,9 +60,11 @@ bundler: failed to load command: bin/qa (bin/qa)
Net::ReadTimeout: Net::ReadTimeout with #<TCPSocket:(closed)>
```
That can happen if you have GitLab running on an address that does not resolve from `localhost`. For example, if you
That can happen if you have GitLab running on an address that does not resolve
from `localhost`. For example, if you
[set GDK's `hostname` to a specific local IP address](https://gitlab.com/gitlab-org/gitlab-qa/-/blob/master/docs/run_qa_against_gdk.md#run-qa-tests-against-your-gdk-setup),
you will need to use that IP address instead of `localhost` in the command. For example, if your IP is `192.168.0.12`:
you will need to use that IP address instead of `localhost` in the command.
For example, if your IP is `192.168.0.12`:
```shell
bundle exec bin/qa Test::Instance::All http://192.168.0.12:3000
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment