Use `nox` as a test runner instead of `tox` #1735

namurphy · 2022-09-09T20:24:49Z

This PR adds a prototype testing configuration with nox instead of tox. As described in #1734, the motivations for using nox are:

The test configuration files are written in Python.
We will be able to more easily (less difficultly?) dynamically generate tests.

The configuration file is noxfile.py, which I'm adapting from the test setup for XRTpy.

Closes #1734.

This is very close to the noxfile.py that I added for XRTpy.

This also came from what I added previously to XRTpy.

namurphy · 2022-09-09T20:45:10Z

Yay it's doing stuff!

An issue it's running into now is that it's not finding Python 3.9 for macOS, which is also happening on XRTpy (though it did work in the not-too-distant past, I think).

StanczakDominik · 2022-09-12T18:16:38Z

.github/workflows/testing.yml

-      uses: codecov/codecov-action@v3
-      with:
-        file: ./coverage.xml
+        python-version: '3.10'


This line needs reverting - as it is, it's installing 3.10 in all three currently attempted test envs. 3.8 Seems to already be there for 3.8/Windows, which is why that one isn't failing. I suspect it should fix the 3.9/MacOS failure

so that the python version matrix actually has an effect!

github-actions · 2022-09-13T04:35:14Z

Based on https://github.com/PlasmaPy/PlasmaPy/actions/runs/3039593035/jobs/4894695172#step:6:22, it looks like the docs environment is failing because it can't import `plasmapy.utils.pytest_helpers`. If so, I guess we should include `pytest` as a dependency of the [docs] extra. Hell, we could even do, in `requirements/docs.txt`, ``` sphinx pyramid hieroglyph ... -r tests.txt ``` or some such, so that `tests` is strictly a subset of `docs`. But getting just pytest in is probably faster on the CI executor.

StanczakDominik · 2022-09-13T04:39:09Z

I hope you don't mind me tinkering with your branch a little 😅 see comment on the latest commit for my reasoning!

namurphy · 2022-09-13T14:09:47Z

I hope you don't mind me tinkering with your branch a little sweat_smile see comment on the latest commit for my reasoning!

Not a problem! I might not have a chance to look into this for a few days, so please tinker away!

noxfile.py

namurphy · 2022-09-19T03:31:46Z

noxfile.py

+sphinx_no_notebooks = ["-D", "nbsphinx_execute=never"]
+sphinx_nitpicky = ["-n"]
+
+pytest_options = ["--showlocals"]


Make sure to keep all of the options that are currently in tox.ini

namurphy · 2022-10-06T17:48:26Z

pre-commit.ci autofix

namurphy · 2022-10-06T18:55:56Z

Hm...there's still an issue with one test for coverage that's seemingly not being run:

Python 3.8, all tests, code coverage Expected — Waiting for status to be reported

namurphy · 2022-12-05T19:14:22Z

The main testing functionality I still need to cross over:

Enable code coverage via nox
Enable nox env for codespell in testing.yml
Building wheels, etc.

Other stuff...

Update testing guide to describe nox instead of tox

namurphy · 2022-12-21T19:49:36Z

Before marking this as ready for review, I'll need to:

Verify that changes made in .github/workflows/testing.yml in the last few months have been ported over, including:
Printing out link to troubleshooting section of contributor guide in test output
Printing out link to testing guide in test output

StanczakDominik

If we're doing this in halves, then it might make sense to merge this to a feature branch first. Then I'll work off that before we put this on main.

StanczakDominik · 2023-02-07T19:27:36Z

requirements.txt

@@ -233,6 +233,7 @@ nest-asyncio==1.5.6
    #   jupyter-client
 nodeenv==1.7.0
    # via pre-commit
+nox


Remember that you should pin a version here! The command to do that is up top, but it won't work until you add nox to pyproject.toml first.

StanczakDominik · 2023-02-07T19:28:49Z

noxfile.py

+
+
+@nox.session
+def build_docs_no_examples(session):


Suggested change

def build_docs_no_examples(session):

def build_docs_no_examples(session): # TODO: "parametrize" this? the same

I would absolutely not want to hold this up, but I'm curious, and I just want to make sure I notice this when picking it up later 😉

StanczakDominik · 2023-02-07T19:29:56Z

noxfile.py

+sphinx_opts = sphinx_paths + sphinx_fail_on_warnings + sphinx_builder
+sphinx_skip_notebooks = ["-D", "nbsphinx_execute=never"]
+
+post_doc_build_comments = """


I half expect to see this become tenured_doc_build_comments later.

Add nox configuration file

5c3cbe4

This is very close to the noxfile.py that I added for XRTpy.

namurphy added testing CI Related to continuous integration prototype 🏗️ Trying out an implementation on a trial basis labels Sep 9, 2022

namurphy added 4 commits September 9, 2022 16:38

Add GA for running stuff with nox

0e46c86

This also came from what I added previously to XRTpy.

Remove GA for tox

f0c4a85

Replace tox GA with nox GA

6698d73

Add changelog entry

7c98a47

namurphy added 2 commits September 9, 2022 19:22

Merge branch 'main' of github.com:PlasmaPy/PlasmaPy into nox

a9d179e

Make codespell ignore .nox

798a480

StanczakDominik reviewed Sep 12, 2022

View reviewed changes

StanczakDominik added 2 commits September 12, 2022 20:18

Revert change to actions/setup-python

217447c

so that the python version matrix actually has an effect!

Adjust python env for py3.10

75a9760

StanczakDominik self-assigned this Sep 13, 2022

StanczakDominik requested review from a team and StanczakDominik and removed request for a team September 13, 2022 18:37

namurphy commented Sep 19, 2022

View reviewed changes

noxfile.py Outdated Show resolved Hide resolved

Add --showlocals as a pytest option

d4923d7

namurphy commented Sep 19, 2022

View reviewed changes

namurphy added 2 commits October 6, 2022 13:49

Merge branch 'main' of github.com:PlasmaPy/PlasmaPy into nox

af114aa

Run pre-commit

c28fdcb

Updates to GitHub Action for testing

727cbd5

namurphy added 6 commits December 5, 2022 00:57

Move doc build action to its own file

9f25e73

Update name of action

5fe431f

Update install command

c53ff0f

Move test doc build back to testing.yml

e50ba42

Finish removing docs.yml

08d92f8

Don't use requirements files to install in nox envs

aee6c6e

namurphy mentioned this pull request Dec 9, 2022

Convert setup.cfg to pyproject.toml #1758

Merged

5 tasks

namurphy added 2 commits December 14, 2022 17:19

Merge branch 'main' of github.com:PlasmaPy/PlasmaPy into nox

246a0aa

Merge branch 'main' of github.com:PlasmaPy/PlasmaPy into nox

bed77c0

namurphy added 9 commits January 13, 2023 19:39

Merge branch 'main' of github.com:PlasmaPy/PlasmaPy into nox

257c82c

Merge branch 'main' of github.com:PlasmaPy/PlasmaPy into nox

923baac

Drop Python 3.8 from noxfile.py

3ecb561

Merge branch 'main' of github.com:PlasmaPy/PlasmaPy into nox

38bf40a

Formatting fixes and remove Python 3.8

9345fd0

Remove codespell from noxfile

109bbc6

Add nox to requirements file

c639c25

Remove unknown job for import-plasmapy

3b8ed7b

Merge branch 'main' of github.com:PlasmaPy/PlasmaPy into nox

618b35d

StanczakDominik reviewed Feb 7, 2023

View reviewed changes

namurphy added status: dormant PRs that are stalled size: large 100 ≤ changed lines < 500 labels May 25, 2023

namurphy mentioned this pull request Aug 24, 2023

Set pytest flag to change warnings into test failures in CI #2301

Open

namurphy closed this Feb 1, 2024

namurphy added the nox Related to the nox automation software label May 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use `nox` as a test runner instead of `tox` #1735

Use `nox` as a test runner instead of `tox` #1735

namurphy commented Sep 9, 2022

namurphy commented Sep 9, 2022

StanczakDominik Sep 12, 2022

github-actions bot commented Sep 13, 2022

StanczakDominik commented Sep 13, 2022

namurphy commented Sep 13, 2022

namurphy Sep 19, 2022

namurphy commented Oct 6, 2022

namurphy commented Oct 6, 2022

namurphy commented Dec 5, 2022 •

edited

namurphy commented Dec 21, 2022

StanczakDominik left a comment

StanczakDominik Feb 7, 2023

StanczakDominik Feb 7, 2023

StanczakDominik Feb 7, 2023

	def build_docs_no_examples(session):
	def build_docs_no_examples(session): # TODO: "parametrize" this? the same

Use nox as a test runner instead of tox #1735

Use nox as a test runner instead of tox #1735

Conversation

namurphy commented Sep 9, 2022

namurphy commented Sep 9, 2022

StanczakDominik Sep 12, 2022

Choose a reason for hiding this comment

github-actions bot commented Sep 13, 2022

StanczakDominik commented Sep 13, 2022

namurphy commented Sep 13, 2022

namurphy Sep 19, 2022

Choose a reason for hiding this comment

namurphy commented Oct 6, 2022

namurphy commented Oct 6, 2022

namurphy commented Dec 5, 2022 • edited

namurphy commented Dec 21, 2022

StanczakDominik left a comment

Choose a reason for hiding this comment

StanczakDominik Feb 7, 2023

Choose a reason for hiding this comment

StanczakDominik Feb 7, 2023

Choose a reason for hiding this comment

StanczakDominik Feb 7, 2023

Choose a reason for hiding this comment

Use `nox` as a test runner instead of `tox` #1735

Use `nox` as a test runner instead of `tox` #1735

namurphy commented Dec 5, 2022 •

edited