From 73137364cc6ca822120c70aad731f33ad232c7e8 Mon Sep 17 00:00:00 2001 From: Robert Sparks Date: Fri, 11 Aug 2023 11:21:38 -0500 Subject: [PATCH] chore: rename test settings and shorten runserver instructions (#6131) --- .github/workflows/build.yml | 4 ++-- .github/workflows/ci-run-tests.yml | 2 +- .vscode/tasks.json | 4 ++-- README.md | 4 ++-- docker-compose.yml | 2 +- docker/README.md | 2 +- docker/configs/nginx-502.html | 2 +- docker/scripts/app-init.sh | 4 ++-- docker/scripts/db-load-default-extensions.sh | 2 +- ietf/{settings_postgrestest.py => settings_test.py} | 2 +- 10 files changed, 14 insertions(+), 14 deletions(-) rename ietf/{settings_postgrestest.py => settings_test.py} (96%) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8e0cc2acf..0c2ab8a43 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -137,9 +137,9 @@ jobs: echo "Running tests..." if [[ "x${{ github.event.inputs.ignoreLowerCoverage }}" == "xtrue" ]]; then echo "Lower coverage failures will be ignored." - ./ietf/manage.py test --validate-html-harder --settings=settings_postgrestest --ignore-lower-coverage + ./ietf/manage.py test --validate-html-harder --settings=settings_test --ignore-lower-coverage else - ./ietf/manage.py test --validate-html-harder --settings=settings_postgrestest + ./ietf/manage.py test --validate-html-harder --settings=settings_test fi coverage xml diff --git a/.github/workflows/ci-run-tests.yml b/.github/workflows/ci-run-tests.yml index a2f2e3d95..eec60cb64 100644 --- a/.github/workflows/ci-run-tests.yml +++ b/.github/workflows/ci-run-tests.yml @@ -45,7 +45,7 @@ jobs: exit 1 fi echo "Running tests..." - ./ietf/manage.py test --validate-html-harder --settings=settings_postgrestest + ./ietf/manage.py test --validate-html-harder --settings=settings_test coverage xml - name: Upload Coverage Results to Codecov diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 7e43a30f8..4bd0b9936 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -48,7 +48,7 @@ "args": [ "${workspaceFolder}/ietf/manage.py", "test", - "--settings=settings_postgrestest" + "--settings=settings_test" ], "group": "test", "presentation": { @@ -68,7 +68,7 @@ "args": [ "${workspaceFolder}/ietf/manage.py", "test", - "--settings=settings_postgrestest", + "--settings=settings_test", "--pattern=tests_js.py" ], "group": "test", diff --git a/README.md b/README.md index 7a46bd9cd..20c9f3e59 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ If VS Code is not available to you, in your clone, type `cd docker; ./run` Once the containers are started, run the tests to make sure your checkout is a good place to start from (all tests should pass - if any fail, ask for help at tools-develop@). Inside the app container's shell type: ```sh -ietf/manage.py test --settings=settings_postgrestest +ietf/manage.py test --settings=settings_test ``` Note that we recently moved the datatracker onto PostgreSQL - you may still find older documentation that suggests testing with settings_sqlitetest. That will no longer work. @@ -228,7 +228,7 @@ before activating a new release. From a datatracker container, run the command: ```sh -./ietf/manage.py test --settings=settings_postgrestest +./ietf/manage.py test --settings=settings_test ``` > You can limit the run to specific tests using the `--pattern` argument. diff --git a/docker-compose.yml b/docker-compose.yml index 3b13fc46e..413c04ff6 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -26,7 +26,7 @@ services: # UID: 1001 # GID: 1001 # DATADIR: data - # DJANGO_SETTINGS_MODULE: settings_postgrestest + # DJANGO_SETTINGS_MODULE: settings_test # Uncomment the next line to use a non-root user for all processes. # user: dev diff --git a/docker/README.md b/docker/README.md index 61fdcfa85..bc9af7c21 100644 --- a/docker/README.md +++ b/docker/README.md @@ -99,7 +99,7 @@ You can also open the datatracker project folder and click the **Reopen in conta 2. Wait for the containers to initialize. Upon completion, you will be dropped into a shell from which you can start the datatracker and execute related commands as usual, for example ``` - ietf/manage.py runserver 0.0.0.0:8001 + ietf/manage.py runserver 8001 ``` to start the datatracker. diff --git a/docker/configs/nginx-502.html b/docker/configs/nginx-502.html index 9e4374f3c..b5577d3e1 100644 --- a/docker/configs/nginx-502.html +++ b/docker/configs/nginx-502.html @@ -51,7 +51,7 @@

Is the datatracker server running?

Using VS Code, open the Run and Debug tab on the left and click the ‣ symbol (Run Server) to start the server.

-

Otherwise, run the command ietf/manage.py runserver 0.0.0.0:8001 from the terminal.

+

Otherwise, run the command ietf/manage.py runserver 8001 from the terminal.

You can manage the database at /pgadmin.

diff --git a/docker/scripts/app-init.sh b/docker/scripts/app-init.sh index e15aed38b..7e58e797c 100755 --- a/docker/scripts/app-init.sh +++ b/docker/scripts/app-init.sh @@ -106,11 +106,11 @@ if [ -z "$EDITOR_VSCODE" ]; then echo echo "You can execute arbitrary commands now, e.g.," echo - echo " ietf/manage.py runserver 0.0.0.0:8001" + echo " ietf/manage.py runserver 8001" echo echo "to start a development instance of the Datatracker." echo - echo " ietf/manage.py test --settings=settings_postgrestest" + echo " ietf/manage.py test --settings=settings_test" echo echo "to run all the python tests." echo diff --git a/docker/scripts/db-load-default-extensions.sh b/docker/scripts/db-load-default-extensions.sh index 23329267c..efb64b75d 100644 --- a/docker/scripts/db-load-default-extensions.sh +++ b/docker/scripts/db-load-default-extensions.sh @@ -2,7 +2,7 @@ set -e # Adding the extension to the default template is needed to allow the test-suite -# to be run on postgres (see ietf.settings_postgrestest). The test runner always +# to be run on postgres (see ietf.settings_test). The test runner always # makes a fresh test database instance, and since we are bypassing the migration # framework and using a fixture to set the database structure, there's no reaonable # way to install the extension as part of the test run. diff --git a/ietf/settings_postgrestest.py b/ietf/settings_test.py similarity index 96% rename from ietf/settings_postgrestest.py rename to ietf/settings_test.py index 13bbc9239..3f69f0ae3 100755 --- a/ietf/settings_postgrestest.py +++ b/ietf/settings_test.py @@ -6,7 +6,7 @@ # useful for speeding up tests that depend on the test database, try # for instance: # -# ./manage.py test --settings=settings_postgrestest doc.ChangeStateTestCase +# ./manage.py test --settings=settings_test doc.ChangeStateTestCase # import os