Add some basic testing for the Material class #220
Conversation
This is just adding a little framework for testing the Material class, through which we can add more tests. Signed-off-by: Patrick Avery <[email protected]>
| return all(are_close(first, lparms[i], tol) for i in indices[1:]) | ||
|
|
||
|
|
||
| def test_sgnum_setter(default_material): |
There was a problem hiding this comment.
Just to explain what is going on here, pytest does a few things automatically based upon how you name things.
If you start a function name with test_, pytest assumes it is a test and tries to run it.
Arguments that you put in the test_ function can be pytest fixtures. In this case, the argument is named default_material, which, via name matching, pytest automatically associates with the fixture function defined above named default_material. It automatically calls that function and passes the returned value as the argument to this test function.
| def test_sgnum_setter(default_material): | ||
| # Just in case we change the default... | ||
| default_material.sgnum = 225 | ||
|
|
||
| # Should have a == b == c and alpha == beta == gamma == 90 | ||
| lparms = default_material.latticeParameters | ||
| assert lparms_are_close(lparms, [0, 1, 2]) | ||
| assert lparms_are_close(lparms, [3, 4, 5]) | ||
| assert are_close(lparms[5], 90) | ||
|
|
||
| default_material.sgnum = 165 | ||
| lparms = default_material.latticeParameters | ||
|
|
||
| # Gamma should be 120, the other angles should be 90 | ||
| assert not lparms_are_close(lparms, [3, 4, 5]) | ||
| assert lparms_are_close(lparms, [3, 4]) | ||
| assert are_close(lparms[3], 90) | ||
| assert are_close(lparms[5], 120) |
There was a problem hiding this comment.
So, this is what is actually being tested here right now. You can see it being tested here.
Signed-off-by: Patrick Avery <[email protected]>
| def test_load_materials(test_materials_file): | ||
| materials = load_materials_hdf5(test_materials_file) | ||
|
|
||
| with h5py.File(test_materials_file, 'r') as f: | ||
| # Check that it loaded all of the materials | ||
| mat_names = list(f.keys()) | ||
| assert all(x in materials for x in mat_names) | ||
|
|
||
| # Check that the values for ruby match | ||
| ruby = materials['ruby'] | ||
| params = f['ruby']['LatticeParameters'][()] | ||
|
|
||
| # Convert to angstroms... | ||
| for i in range(3): | ||
| params[i] *= 10 | ||
|
|
||
| for i in range(6): | ||
| assert are_close(params[i], ruby.latticeParameters[i]) |
There was a problem hiding this comment.
And here is loading a materials file and checking that the lattice parameters for ruby match.
|
If you want to run the tests locally, you just need to make sure you have also cloned the examples repo, and set this environment variable to the path on your file system: export HEXRD_EXAMPLE_REPO_PATH=/path/to/examplesThen, in the hexrd repo, you can pip install the requirements and run the tests like pip install -r tests/requirements-dev.txt
pytest -s testsOr, specifically only run the materials test: pytest -s tests/test_material.pyThat will skip the fit grains and find orientations tests, and only run the materials tests. |
|
I'll add a bit to this then merge. |
joelvbernier
added
documentation
|
I need to pass along some commits for this... or should we merge this and add additional testing in a later commit? |
|
@joelvbernier I'm good with merging this and adding extra testing later if that's good with you. |
This is just adding a little framework for testing the Material class,
through which we can add more tests.
For: #214