chore: change name of API functional test to api_func_v4

JohnVillalovos · JohnVillalovos · commit 8cf5cd935cde · 2022-07-17T22:24:17.000-07:00
The CLI test is `cli_func_v4` and using `api_func_v4` matches with
that naming convention.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -61,7 +61,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        toxenv: [py_func_v4, cli_func_v4]
+        toxenv: [api_func_v4, cli_func_v4]
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -89,15 +89,15 @@ To run these tests:
    tox -e cli_func_v4
 
    # run the python API tests:
-   tox -e py_func_v4
+   tox -e api_func_v4
 
 When developing tests it can be a little frustrating to wait for GitLab to spin
 up every run. To prevent the containers from being cleaned up afterwards, pass
 `--keep-containers` to pytest, i.e.:
 
 .. code-block:: bash
 
-   tox -e py_func_v4 -- --keep-containers
+   tox -e api_func_v4 -- --keep-containers
 
 If you then wish to test against a clean slate, you may perform a manual clean
 up of the containers by running:
@@ -117,11 +117,11 @@ The tag must match an exact tag on Docker Hub:
 .. code-block:: bash
 
    # run tests against `nightly` or specific tag
-   GITLAB_TAG=nightly tox -e py_func_v4
-   GITLAB_TAG=12.8.0-ce.0 tox -e py_func_v4
+   GITLAB_TAG=nightly tox -e api_func_v4
+   GITLAB_TAG=12.8.0-ce.0 tox -e api_func_v4
 
    # run tests against the latest gitlab EE image
-   GITLAB_IMAGE=gitlab/gitlab-ee tox -e py_func_v4
+   GITLAB_IMAGE=gitlab/gitlab-ee tox -e api_func_v4
 
 A freshly configured gitlab container will be available at
 http://localhost:8080 (login ``root`` / password ``5iveL!fe``). A configuration
diff --git a/codecov.yml b/codecov.yml
@@ -7,7 +7,7 @@ coverage:
   range: "70...100"
 
 comment:
-  after_n_builds: 3 # coverage, py_func_v4, py_func_cli
+  after_n_builds: 3 # coverage, api_func_v4, py_func_cli
   layout: "diff,flags,files"
   behavior: default
   require_changes: yes
diff --git a/tox.ini b/tox.ini
@@ -106,7 +106,7 @@ deps = -r{toxinidir}/requirements-docker.txt
 commands =
   pytest --script-launch-mode=subprocess --cov --cov-report xml tests/functional/cli {posargs}
 
-[testenv:py_func_v4]
+[testenv:api_func_v4]
 deps = -r{toxinidir}/requirements-docker.txt
 commands =
   pytest --cov --cov-report xml tests/functional/api {posargs}
