Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a test for quality standards and update the quality standard tutorial #777

Merged
merged 14 commits into from
Jul 19, 2022

Conversation

vhirtham
Copy link
Collaborator

@vhirtham vhirtham commented Jun 30, 2022

Changes

Since version 0.5.0 the quality standard tutorial was outdated. The presented standard did not override the schema and the subsequent code didn't produce the exceptions that were mentioned in the text. Due to the fact that it wasn't checked if the exception was actually raised, this wasn't noticed. I added a new test for quality standards and adjusted the tutorial too so that this can't happen again.

Checks

  • updated CHANGELOG.rst
  • updated tests
  • updated doc/
  • update example/tutorial notebooks
  • update manifest file

@vhirtham vhirtham added documentation Improvements or additions to documentation CI tests pytest (and other tests) related quality-standards discussion and implementation of schema standards tutorials tutorials or code examples labels Jun 30, 2022
@vhirtham vhirtham self-assigned this Jun 30, 2022
@vhirtham vhirtham removed documentation Improvements or additions to documentation CI labels Jun 30, 2022
@github-actions
Copy link

github-actions bot commented Jun 30, 2022

Unit Test Results

2 154 tests  +1   2 152 ✔️  - 1   2m 55s ⏱️ -9s
       1 suites ±0          0 💤 ±0 
       1 files   ±0          2 +2 

For more details on these failures, see this check.

Results for commit c4e6221. ± Comparison against base commit 797d0ec.

♻️ This comment has been updated with latest results.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@vhirtham
Copy link
Collaborator Author

Totally forgot about the issue that quality standards affect the whole pytest run. That's why the tests are currently failing. The question is how we want to advance. We can either remove the test and rely on the modified notebook to catch future bugs, or we can exclude the test from the regular pytest run and add a separate run just for this test. What do you think?

@CagtayFabry
Copy link
Member

Totally forgot about the issue that quality standards affect the whole pytest run. That's why the tests are currently failing. The question is how we want to advance. We can either remove the test and rely on the modified notebook to catch future bugs, or we can exclude the test from the regular pytest run and add a separate run just for this test. What do you think?

Ah yes, that is tricky when the whole environment is affected...

I would suggest the following:
Exclude the run from regular pytest run (with the setting in setup.cfg) and run it only after the last "regular" test here (after running test with WeldxFile)

- name: test with WeldxFile
if: matrix.py == '3.8'
run: |
pytest -n 2 --weldx-file-rw-buffer --weldx-file-rw-buffer-disp-header --cov-append ./weldx/tests/asdf_tests
- name: coverage xml (combination is performed by pytest-cov)
if: matrix.py == '3.8'
run: coverage xml

I hope that works

@github-actions
Copy link

github-actions bot commented Jul 14, 2022

Test Results

2 153 tests  ±0   2 153 ✔️ ±0   2m 29s ⏱️ -9s
       1 suites ±0          0 💤 ±0 
       1 files   ±0          0 ±0 

Results for commit 1d9c31f. ± Comparison against base commit 65753d7.

♻️ This comment has been updated with latest results.

@codecov
Copy link

codecov bot commented Jul 14, 2022

Codecov Report

Merging #777 (1d9c31f) into master (65753d7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #777   +/-   ##
=======================================
  Coverage   96.77%   96.77%           
=======================================
  Files          88       88           
  Lines        6017     6017           
=======================================
  Hits         5823     5823           
  Misses        194      194           

@CagtayFabry CagtayFabry self-requested a review July 14, 2022 11:41
@vhirtham vhirtham marked this pull request as ready for review July 19, 2022 11:04
setup.cfg Outdated Show resolved Hide resolved
@vhirtham vhirtham merged commit 0a2d2d6 into BAMWelDX:master Jul 19, 2022
@vhirtham vhirtham deleted the update_quality_standard_tutorial branch July 19, 2022 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
quality-standards discussion and implementation of schema standards tests pytest (and other tests) related tutorials tutorials or code examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants