Skip to content

Commit a73a94c

Browse files
docs: adding steps to run e2e tests locally (#822)
Added steps on how to run e2e tests locally
1 parent 5aeb4e9 commit a73a94c

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,22 @@ Run pytest with the add-on and SA-eventgen installed and enabled in docker
141141
142142
For full usage instructions, please visit the `pytest-splunk-addon documentation pages over at readthedocs`_.
143143

144+
Run e2e tests locally
145+
---------------------
146+
147+
* 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.
148+
* e2e tests can be found under /tests/e2e
149+
150+
Note: Must install docker desktop.
151+
152+
.. code:: bash
153+
154+
$ git clone --recurse-submodules -j8 git@github.com:splunk/pytest-splunk-addon.git
155+
$ cd pytest-splunk-addon
156+
$ poetry install
157+
$ poetry run pytest -v --splunk-version=${splunk-version} -m docker -m ${test-marker} tests/e2e
158+
159+
144160
Contributing
145161
------------
146162
Contributions are very welcome. Tests can be run with `pytest`_, please ensure

0 commit comments

Comments
 (0)