Skip to content

Commit 6a16609

Browse files
docs: update prerequisites for running e2e tests (#823)
1 parent a73a94c commit 6a16609

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.rst

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,10 @@ Run e2e tests locally
147147
* For e2e tests we are using a functionality of pytest which creates a temp dir and copies all the required file to that dir and then runs the pytest cmd from the tests.
148148
* e2e tests can be found under /tests/e2e
149149

150-
Note: Must install docker desktop.
150+
Prerequisites:
151+
152+
* Docker version: 25.0.3
153+
* Docker Compose version: v2.24.6-desktop.1
151154

152155
.. code:: bash
153156
@@ -156,6 +159,27 @@ Note: Must install docker desktop.
156159
$ poetry install
157160
$ poetry run pytest -v --splunk-version=${splunk-version} -m docker -m ${test-marker} tests/e2e
158161
162+
Troubleshooting:
163+
164+
1. If you face an error like this:
165+
166+
argparse.ArgumentError: argument -K/--keepalive: conflicting option strings: -K, --keepalive
167+
168+
* This is likely to happen if you have older version of PSA requirements installed, to solve this try to uninstall lovely-pytest-docker and pull the latest main branch and then do `poetry install`
169+
170+
2. If while running the tests you face an exception like this:
171+
172+
`Exception: Command ['docker', 'compose', '-f', '<path>/docker-compose.yml', '-p', '<projectname>', 'down', '-v'] returned 125: """unknown shorthand flag: 'f' in -f`
173+
174+
* This happens due to misconfigurations in docker, try to follow below steps:
175+
* sudo mkdir -p /usr/local/lib/docker
176+
* sudo ln -s /Applications/Docker.app/Contents/Resources/cli-plugins /usr/local/lib/docker/cli-plugins
177+
178+
3. If you face error like this:
179+
180+
ERROR: no match for platform in manifest: not found
181+
182+
* Try adding platform: `linux/amd64` to docker-compose.yml file
159183

160184
Contributing
161185
------------

0 commit comments

Comments
 (0)