TST: Clean warnings by aburrell · Pull Request #1129 · pysat/pysat

aburrell · 2023-07-05T20:29:53Z

Description

Addresses #1009 by adding a general test triggered by an optional testing variable to the standard set of Instrument tests. Adapted the clean method in the test instruments to run all potential iterations of the allowed behaviour, which includes:

logging messages
warnings
errors
changing the clean level

Updated the documentation to describe how this testing should be done.

Type of change

Please delete options that are not relevant.

New feature (non-breaking change which adds functionality)
This change requires a documentation update

How Has This Been Tested?

Added unit tests. Also added this line to ace_epam.py in pysatSpaceWeather and ran the local unit tests.

# Set clean warning tests
_clean_warn = {'': {'': {'dusty': [('logger', 'WARN',
                         "unused clean level 'dusty', reverting to 'clean'",
                         'clean')]}}}

Test Configuration:

Operating system: OS X Big Sur
Version number: Python 3.9
Any details about your local setup that are relevant: See also:

Checklist:

If this is a release PR, replace the first item of the above checklist with the release
checklist on the wiki: https://github.com/pysat/pysat/wiki/Checklist-for-Release

Added a test for logging messages, warnings, and errors that may occur in Instrument `clean` methods. Also tests to see if the clean level has been reset correctly.

Added level resetting, logging messages, warnings, and errors as potential outputs to the clean method for test instruments. Also added a unit test for each of these elements.

Updated the new instrument instructions for the clean method and `_clean_warn` test variable.

Updated the changelog with a description of this pull request.

Updated the reference style in the docs.

Fixing bug in reference format.

Fixed logic in clean method, allowing key search only if input is a dict.

aburrell · 2023-07-06T14:21:54Z

_clean_warn needs inst_id and tag incorporated.

Updated example for `_clean_warn` in docs to include inst_id and tag.

Removed lines that cannot be reached, as the clean method doesn't run if the clean level is 'none'.

Updated the `_clean_warn` format to accept a list of tuples.

Moved the discussion of the new clean_warn test attribute to its own section and updated the reference.

Added a missing quotation mark.

Fixed the dict access for the expected clean warnings.

Ensure the strict time flag is not raising a ValueError when testing the clean warning messages.

Cannot assess other warnings when an error is raised, only test multiple non-fatal warnings.

Improved the logging error message in the clean warning test to be more useful.

jklenzing

Looks good. I would suggest restructuring so that tests where nothing is run are skipped to be consistent with similar tests elsewhere.

Fixed spelling and line length in the docs.

Improved the clean warning test by: - Creating a function for testing/setting the strict time flag, - Removing 'none' from the clean level parametrization, - Fixing the docstrings, - Adding more comments, and - Adding pytest skip statements.

aburrell · 2023-07-11T15:09:11Z

The decrease in coverage is consistent with tests not being skipped and edge cases for ecosystem packages not being triggered.

jklenzing

The generalized function as written will cause a change in test_load

Fixed comments to be accurate. Co-authored-by: Jeff Klenzing <19592220+jklenzing@users.noreply.github.com>

Allow the strict flag function to run with or without the clean method.

Rename the test function as per discussion. Co-authored-by: Jeff Klenzing <19592220+jklenzing@users.noreply.github.com>

aburrell added 6 commits July 5, 2023 16:23

TST: added a test for warnings in clean

066a0e9

Added a test for logging messages, warnings, and errors that may occur in Instrument `clean` methods. Also tests to see if the clean level has been reset correctly.

TST: expanded test Instrument cleaning

71f6d9d

Added level resetting, logging messages, warnings, and errors as potential outputs to the clean method for test instruments. Also added a unit test for each of these elements.

DOC: updated new instrument instructions

6227fc9

Updated the new instrument instructions for the clean method and `_clean_warn` test variable.

DOC: updated changelog

665ab42

Updated the changelog with a description of this pull request.

STY: updated reference style

b84e005

Updated the reference style in the docs.

BUG: fixing reference

67c1d8c

Fixing bug in reference format.

aburrell added this to the 3.2.0 Release milestone Jul 5, 2023

aburrell added the testing label Jul 5, 2023

aburrell linked an issue Jul 5, 2023 that may be closed by this pull request

Standards for Instruments without cleaning. #1009

Closed

aburrell requested a review from rstoneback July 5, 2023 20:45

aburrell mentioned this pull request Jul 5, 2023

TST: updated ACE test attributes pysat/pysatSpaceWeather#125

Merged

10 tasks

BUG: fixed dict evalutation

ac2eb50

Fixed logic in clean method, allowing key search only if input is a dict.

aburrell commented Jul 6, 2023

View reviewed changes

Comment thread docs/new_instrument.rst Outdated

DOC: Update docs/new_instrument.rst

2b5ae2e

Updated example for `_clean_warn` in docs to include inst_id and tag.

aburrell commented Jul 6, 2023

View reviewed changes

Comment thread pysat/tests/classes/cls_instrument_library.py Outdated

aburrell and others added 2 commits July 6, 2023 11:47

ENH: removed unreachable lines

56dadc7

Removed lines that cannot be reached, as the clean method doesn't run if the clean level is 'none'.

MAINT: updated _clean_warn format

cd75aee

Updated the `_clean_warn` format to accept a list of tuples.

This was referenced Jul 6, 2023

Clean warning update pysat/pysatModels#129

Open

Clean warn update pysat/pysatMadrigal#93

Merged

DOC: improved documentation flow

cf273b5

Moved the discussion of the new clean_warn test attribute to its own section and updated the reference.

aburrell commented Jul 6, 2023

View reviewed changes

Comment thread docs/new_instrument.rst Outdated

MAINT: added missing quotation

728153b

Added a missing quotation mark.

aburrell requested a review from jklenzing July 6, 2023 17:29

aburrell added 4 commits July 6, 2023 16:33

BUG: fixed dict access

150e691

Fixed the dict access for the expected clean warnings.

BUG: handle strict time flag before messages

78e85aa

Ensure the strict time flag is not raising a ValueError when testing the clean warning messages.

BUG: remove error from mult

0d2c069

Cannot assess other warnings when an error is raised, only test multiple non-fatal warnings.

TST: improved error message

0c3798a

Improved the logging error message in the clean warning test to be more useful.

jklenzing reviewed Jul 10, 2023

View reviewed changes

Comment thread docs/new_instrument.rst Outdated

MAINT: fixed spelling

c769ba8

Fixed spelling and line length in the docs.

ENH: improved clean warning test

1eadc88

Improved the clean warning test by: - Creating a function for testing/setting the strict time flag, - Removing 'none' from the clean level parametrization, - Fixing the docstrings, - Adding more comments, and - Adding pytest skip statements.

aburrell requested a review from jklenzing July 10, 2023 19:50

jklenzing reviewed Jul 11, 2023

View reviewed changes

Comment thread pysat/tests/classes/cls_instrument_library.py Outdated

Comment thread pysat/tests/classes/cls_instrument_library.py Outdated

Comment thread pysat/tests/classes/cls_instrument_library.py Outdated

DOC: Update pysat/tests/classes/cls_instrument_library.py

35fdc51

Fixed comments to be accurate. Co-authored-by: Jeff Klenzing <19592220+jklenzing@users.noreply.github.com>

aburrell requested a review from jklenzing July 11, 2023 16:25

jklenzing reviewed Jul 11, 2023

View reviewed changes

Comment thread pysat/tests/classes/cls_instrument_library.py

TST: added clean_level input

3131341

Allow the strict flag function to run with or without the clean method.

aburrell requested review from jklenzing July 11, 2023 18:09

jklenzing requested changes Jul 12, 2023

View reviewed changes

Comment thread pysat/tests/classes/cls_instrument_library.py Outdated

Comment thread pysat/tests/classes/cls_instrument_library.py Outdated

Comment thread pysat/tests/classes/cls_instrument_library.py Outdated

Comment thread pysat/tests/classes/cls_instrument_library.py Outdated

aburrell and others added 2 commits July 12, 2023 13:26

STY: rename function

a356931

Rename the test function as per discussion. Co-authored-by: Jeff Klenzing <19592220+jklenzing@users.noreply.github.com>

STY: pep8

3bacdef

jklenzing mentioned this pull request Jul 13, 2023

TST: clean warnings pysat/pysatNASA#194

Merged

11 tasks

jklenzing approved these changes Jul 13, 2023

View reviewed changes

aburrell merged commit 09673ae into develop Jul 13, 2023

aburrell deleted the clean_warnings branch July 13, 2023 13:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TST: Clean warnings#1129

TST: Clean warnings#1129
aburrell merged 22 commits intodevelopfrom
clean_warnings

aburrell commented Jul 5, 2023 •

edited

Loading

Uh oh!

aburrell commented Jul 6, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jklenzing left a comment

Uh oh!

Uh oh!

aburrell commented Jul 11, 2023

Uh oh!

jklenzing left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

aburrell commented Jul 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

How Has This Been Tested?

Checklist:

Uh oh!

aburrell commented Jul 6, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jklenzing left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aburrell commented Jul 11, 2023

Uh oh!

jklenzing left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

aburrell commented Jul 5, 2023 •

edited

Loading