List all sets: new get_set endpoint and test reductions #86
Conversation
…redundancy from the tests. Move tests to more sensible places. Generally tidy things up.
| funcdef get_set_v1(GetSetV1Params params) | ||
| returns (GetGenericSetV1Result result) authentication optional; |
There was a problem hiding this comment.
exciting new function
| the DifferentialExpressionMatrixSet. | ||
| ref_path is optionally returned by get_differential_expression_matrix_set_v1() | ||
| when its input parameter 'include_set_item_ref_paths' is set to 1. | ||
| You should never set 'info'; it is generated by the workspace. |
There was a problem hiding this comment.
edited this generic blurb to be a bit more coherent
| typedef structure { | ||
| string description; | ||
| list<DifferentialExpressionMatrixSetItem> items; | ||
| } DifferentialExpressionMatrixSet; | ||
|
|
||
| /* | ||
| ref - workspace reference to DifferentialExpressionMatrixSet object. |
There was a problem hiding this comment.
this description is up at the top of the file - no need to repeat it
| def _get_set_v1( | ||
| self: "SetAPI", ctx: dict[str, Any], params: dict[str, Any] | ||
| ) -> dict[str, Any]: | ||
| ws = Workspace(self.workspace_url, token=ctx["token"]) | ||
| set_interface = SetInterfaceV1(ws) | ||
| return set_interface.get_set(params) |
There was a problem hiding this comment.
all the get_***_set_v1 queries now use this method under the hood
| # END_CONSTRUCTOR | ||
| pass | ||
|
|
||
|
|
||
| def get_differential_expression_matrix_set_v1(self, ctx, params): | ||
| def get_set_v1(self, ctx, params): |
There was a problem hiding this comment.
I just love the way that git has done the diff here.
| # ctx is the context object | ||
| # return variables are: result | ||
| # BEGIN get_differential_expression_matrix_set_v1 | ||
| result = self._get_set_v1(ctx, params) |
There was a problem hiding this comment.
all the get_***_set_v1 queries now look like this
| [("default_ws_id", data_fixture) for data_fixture in SET_FIXTURE_MAP], | ||
| indirect=["ws_id", "data_fixture"], | ||
| ) | ||
| def test_save_set(ws_id: int, data_fixture: dict[str, Any]) -> None: |
There was a problem hiding this comment.
Moved this over from common_test.py
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## list_all_sets_begone_foul_redundant_classes #86 +/- ##
===============================================================================
- Coverage 65.21% 65.03% -0.19%
===============================================================================
Files 12 12
Lines 1124 1121 -3
===============================================================================
- Hits 733 729 -4
- Misses 391 392 +1 ☔ View full report in Codecov by Sentry. |
|
|
||
| @pytest.mark.parametrize("ws_id", ["default_ws_id"], indirect=["ws_id"]) | ||
| @pytest.mark.parametrize("set_name", list(SET_FIXTURE_MAP)) | ||
| def test_get_set_all_set_types( |
There was a problem hiding this comment.
this is a new test - runs through all the different set types and makes sure they can all be fetched.
| """Test set retrieval for with a variety of parameter configurations. | ||
|
|
||
| This uses `random_fixture` to pick one of the set types and run through the different combinations of | ||
| parameters that can be used for a `get_set_v1` query. |
There was a problem hiding this comment.
This test was in SetInterface_test.py but moved it here after adding the generic get_set endpoint to the API.
The core tests for this codebase are now:
- test a save query for each set type
- test get_set with a random set and every combination of input params
- test get_***_set for each set type and one combination of input params
The two different get_set tests should ensure that get_set is thoroughly tested without requiring seven hundred zillion individual tests.
| from SetAPI.generic.SetInterfaceV1 import SetInterfaceV1 | ||
|
|
||
| STANDARD_VALUES = [None, 0, 1] |
There was a problem hiding this comment.
moved to SetAPI_test.py
| @@ -1,5 +1,4 @@ | |||
| """General tests to be performed on most or all classes.""" | |||
| from test.conftest import SET_FIXTURE_MAP | |||
| """Sets of assertions for testing the saving and retrieval of sets.""" | |||
There was a problem hiding this comment.
This is now just functions to check that the output of save and get queries is as expected -- no actual tests.
Highlights from this PR:
get_set_v1generic set retrieval endpoint.