Skip to content

Update tests and generate coverage#56

Merged
mcflugen merged 11 commits intodevelopfrom
mdpiper/fix-53
Sep 9, 2021
Merged

Update tests and generate coverage#56
mcflugen merged 11 commits intodevelopfrom
mdpiper/fix-53

Conversation

@mdpiper
Copy link
Copy Markdown
Member

@mdpiper mdpiper commented Aug 13, 2021

The goal of this PR is to update the unit tests for the babelizer and generate code coverage statistics.

One big, questionable, decision: I moved the language-specific tests under the external directory. My rationale is that these tests require the language examples to be built, which takes several extra steps. Only language-agnostic tests remain under the top-level tests directory. I made rules to handle both in the Makefile.

Summary of changes:

  • Moved language tests under the external directory
  • Made new language-agnostic tests in the tests directory
  • Made a babelize update test with the Python example
  • Generated coverage for all tests in the GitHub Actions CI

This fixes #53.

@mdpiper
Copy link
Copy Markdown
Member Author

mdpiper commented Aug 13, 2021

@mcflugen Please let me know what you think!

@mcflugen mcflugen merged commit feaa5d5 into develop Sep 9, 2021
@mcflugen mcflugen deleted the mdpiper/fix-53 branch September 9, 2021 16:15
mcflugen added a commit that referenced this pull request Feb 16, 2022
* Update docs for API changes (#47)

* Update long example for API changes

* Move headings; add acknowledgment

* Spell check

* Update changelog

* Fix minor formatting issues (#49)

* Swallow empty line before sample import statement

* Include docs/conf.py in list of files to format

* Format with black

* Update changelog

* Add conda-forge badge

* Preparing release 0.3.8

* Back to development: 0.3.9

* Complete API documentation (#55)

* Help autodoc find babelizer package

* Use sphinx-click to autodoc babelizer.cli

It works wonderfully. See https://sphinx-click.readthedocs.io.

* Remove unused Submodules and Module contents headings

* Edit docstrings in babelizer.cli module

I tried to make them look good at the CLI and in the docs.

* Add docstrings to exception classes

* Ensure autodoc sees docstring in ctr

* Add docstrings to metadata module

* The wrap module is no longer used

* Add docstrings for render and utils modules

* Make pretty with unforgiving black

* Be sure to blacken conf.py

* Remove single-page API docs

* Switch to multi-page API docs

* Tidying after building and reviewing docs

* Update changelog

* Update and clarify example (#54)

* Add final directory structure image

* Tweak summary in sample babelizer input file

* Update example to use relative paths

* docs: improve the readme documentation (#57)

* add "is the babelizer for me?" section

* Minor edits

Co-authored-by: Mark Piper <mark.piper@colorado.edu>

* tests: update tests and generate coverage (#56)

* Generate coverage report

* Include coverage package

* Move language tests to a new directory

* Move language tests next to language examples

* Use a persistent tmpdir to test babelize update

* Remove non-language tests

* Add basic CLI tests

* Make new rule for language tests

* Generate coverage for tests

* Suppress builds of internal PRs

* add refs for CCA and grpc4bmi

* add some initial text about similar previous works

* tests: add Python 3.10 to ci tests, drop Python 3.8 (#65)

* add Python 3.10 to ci tests

* temporarily limit builds for debugging

* temporarily only test on mac

* temporarily build on only linux

* add Python 3.10 back to tests

* add python 3.8 to builds

* require python >= 3.9; test on linux and mac

* add a requirements file for development

* remove unused requirements

* a few more edits

* reformat with new version of black

* Text edits; moved Figure 1 closer to reference

Hopefully moving the figure won't upset the page formatting.

* Fix BibTeX typo

* Move text before page break forced by Fig 2

* Fix citation formatting

* Standardize formatting of tool names

* Complete author list for Hut et al.

Co-authored-by: Mark Piper <mark.piper@colorado.edu>
mcflugen added a commit that referenced this pull request Mar 4, 2022
* add paper.md for JOSS submission

* update to almost a first draft

* Add bibfile; cite Peckham, Hutton

I want to check that these render correctly.

* Editing pass (#38)

* Add DOI for Peckham ref

* Add ESMF and pymt refs

* Editing pass 1

Still need to make figures.

* Minor edits

* add script to make language pie graph

* add target to build joss paper

* docs: add references and figures (#42)

* Edit text

* Add references for component modeling

* Add sample babel.toml file for PRMSSurface

* Fix typo

* Add Syvitski to author list

* Change citation style

* Add ci section to sample babelizer config file

* docs: update figures for JOSS submission (#45)

* Add model repository languages figure

* Add sample config as md, pdf, plus generator script

* Add figure 1 and update figure 2

* Change figure format (#46)

* Change figure format from SVG to PNG

* Label and autoref figures

* Text edit

* Works locally, not in preview service

* update title

* Add text to paper describing similar work (#64)

* Update docs for API changes (#47)

* Update long example for API changes

* Move headings; add acknowledgment

* Spell check

* Update changelog

* Fix minor formatting issues (#49)

* Swallow empty line before sample import statement

* Include docs/conf.py in list of files to format

* Format with black

* Update changelog

* Add conda-forge badge

* Preparing release 0.3.8

* Back to development: 0.3.9

* Complete API documentation (#55)

* Help autodoc find babelizer package

* Use sphinx-click to autodoc babelizer.cli

It works wonderfully. See https://sphinx-click.readthedocs.io.

* Remove unused Submodules and Module contents headings

* Edit docstrings in babelizer.cli module

I tried to make them look good at the CLI and in the docs.

* Add docstrings to exception classes

* Ensure autodoc sees docstring in ctr

* Add docstrings to metadata module

* The wrap module is no longer used

* Add docstrings for render and utils modules

* Make pretty with unforgiving black

* Be sure to blacken conf.py

* Remove single-page API docs

* Switch to multi-page API docs

* Tidying after building and reviewing docs

* Update changelog

* Update and clarify example (#54)

* Add final directory structure image

* Tweak summary in sample babelizer input file

* Update example to use relative paths

* docs: improve the readme documentation (#57)

* add "is the babelizer for me?" section

* Minor edits

Co-authored-by: Mark Piper <mark.piper@colorado.edu>

* tests: update tests and generate coverage (#56)

* Generate coverage report

* Include coverage package

* Move language tests to a new directory

* Move language tests next to language examples

* Use a persistent tmpdir to test babelize update

* Remove non-language tests

* Add basic CLI tests

* Make new rule for language tests

* Generate coverage for tests

* Suppress builds of internal PRs

* add refs for CCA and grpc4bmi

* add some initial text about similar previous works

* tests: add Python 3.10 to ci tests, drop Python 3.8 (#65)

* add Python 3.10 to ci tests

* temporarily limit builds for debugging

* temporarily only test on mac

* temporarily build on only linux

* add Python 3.10 back to tests

* add python 3.8 to builds

* require python >= 3.9; test on linux and mac

* add a requirements file for development

* remove unused requirements

* a few more edits

* reformat with new version of black

* Text edits; moved Figure 1 closer to reference

Hopefully moving the figure won't upset the page formatting.

* Fix BibTeX typo

* Move text before page break forced by Fig 2

* Fix citation formatting

* Standardize formatting of tool names

* Complete author list for Hut et al.

Co-authored-by: Mark Piper <mark.piper@colorado.edu>

* Use Tucker et al. GMD article instead of preprint (#70)

* remove extra comma

Co-authored-by: Mark Piper <mark.piper@colorado.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

JOSS review: suggestion -- test coverage

2 participants