Use pytest for test_loaddata.py
#179
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #179 +/- ##
==========================================
+ Coverage 99.17% 99.56% +0.39%
==========================================
Files 7 7
Lines 242 230 -12
==========================================
- Hits 240 229 -11
+ Misses 2 1 -1
|
| d2c = np.array([[3, 31], [4, 32], [5, 33]]) | ||
|
|
||
| with pytest.raises(IOError): | ||
| loadData("doesnotexist") |
There was a problem hiding this comment.
do we want to test a preferred error message here?
There was a problem hiding this comment.
Seems like we use the default error message that comes along with IOError, I have also assert assert "No such file or directory" in str(err.value) shown below:
with pytest.raises(IOError) as err:
loadData("doesnotexist")
assert "No such file or directory" in str(err.value)
There was a problem hiding this comment.
Remember that the tests always test what "want" to happen, i.e., desired behavior, not what we actually do..... (of course the test will then fail and we have to modify the code, but then the point is that the code then does what we want it to.....). If I were a user, especially a not very programming savvy one, and got a stack dump with IOError, a more useful message might be something like File doesnotexist cannot be found. Please rerun the program specifying a valid filename or something like that?
| assert len(hdata) == 14 | ||
|
|
||
| # Check the following are floats | ||
| vfloats = ["wavelength", "qmaxinst", "qmin", "qmax", "bgscale"] |
There was a problem hiding this comment.
These tests seem a bit weak. Don't we want to actually test that the correct dictionary was loaded?
There was a problem hiding this comment.
Right, in the updated code, we compare against the expected output.
expected = {
"wavelength": 0.1,
"dataformat": "Qnm",
"inputfile": "darkSub_rh20_C_01.chi",
"mode": "xray",
"bgscale": 1.2998929285,
"composition": "0.800.20",
"outputtype": "gr",
"qmaxinst": 25.0,
"qmin": 0.1,
"qmax": 25.0,
"rmax": "100.0r",
"rmin": "0.0r",
"rstep": "0.01r",
"rpoly": "0.9r",
}
|
@sbillinge ready for review. Thank you. |
| d2c = np.array([[3, 31], [4, 32], [5, 33]]) | ||
|
|
||
| with pytest.raises(IOError): | ||
| loadData("doesnotexist") |
There was a problem hiding this comment.
Remember that the tests always test what "want" to happen, i.e., desired behavior, not what we actually do..... (of course the test will then fail and we have to modify the code, but then the point is that the code then does what we want it to.....). If I were a user, especially a not very programming savvy one, and got a stack dump with IOError, a more useful message might be something like File doesnotexist cannot be found. Please rerun the program specifying a valid filename or something like that?
|
nicely done there! |
Closes #161 - since we may deprecate
loadDatatoload_dataor so, spent 5-10 mins to refactor this code.