WIP Test Framework #437

JPercival · 2022-01-24T05:29:19Z

In starting to build the submit-data tests and reviewing the work that's been done so far it became obvious that I hadn't provided quite enough guidance on testing or on building out shared components. This is a PR to fix a few of those things:

Reworked/streamlined utility classes, and guidance on how to create them

Read the documentation in the base README

A concrete example for usage of some of the new classes:

// Old way
private IBundleProvider performCodeSystemSearchByUrl(String rxNormUrl) {
  return this.myDaoRegistry.getResourceDao(CodeSystem.class)
		.search(SearchParameterMap.newSynchronous().add(CodeSystem.SP_URL, new UriParam(rxNormUrl)));
}

// New way
private IBundleProvider performCodeSystemSearchByUrl(String rxNormUrl) {
   return search(CodeSystem.class, Searches.byUrl(rxNormUrl));
}

OperationProvider base class that is set up to provide easy local CRUD
Base classes for Rest (meaning you need to spin the whole server up) and Dao (meaning you only need the database) Integration tests (WIP at the time of this writing, new to share spring properties so they aren't copy and pasted everywhere)
- Dao only tests start about twice as fast, so nice to use them to validate operation provider behavior. They are not sufficient to validate that an operation provider is registered on a server
Reworked/streamlined test case loading
Code demonstrating how to check preconditions on public apis
Usage of the most specific assertion type for tests

// Yes
assertEquals(thisThing, thatThing)

// No
assertTrue(this == that)

Fixes for incorrect assertion ordering

Still to do:

Tests and docs for new code
Fixing broken tests

JPercival · 2022-01-24T05:34:33Z

common/src/main/java/org/opencds/cqf/ruler/common/provider/DaoRegistryOperationProvider.java

+import ca.uhn.fhir.context.FhirContext;
+import ca.uhn.fhir.jpa.api.dao.DaoRegistry;
+
+public class DaoRegistryOperationProvider implements OperationProvider, DaoRegistryUser, FhirContextUser {


This is a new class that provides CRUD helpers out of the box.

JPercival · 2022-01-24T05:35:39Z

common/src/main/java/org/opencds/cqf/ruler/common/utility/Canonicals.java

+
+	public static <CanonicalType extends IPrimitiveType<String>> String getId(CanonicalType theCanonicalType) {
+		checkNotNull(theCanonicalType);
+		checkArgument(theCanonicalType.getValue() != null);


These are examples of validating inputs to public APIs. Validate inputs as the very first step in a function.

JPercival · 2022-01-24T05:37:06Z

common/src/main/java/org/opencds/cqf/ruler/common/utility/DaoRegistryUser.java

+/**
+ * Simulate FhirDal operations until such time as that is fully baked
+ */
+public interface DaoRegistryUser {


We're working through an implementation of a common API for Java FHIR access. This interface approximates that so it's easier to get convergence when that finally happens.

JPercival · 2022-01-24T05:38:52Z

common/src/main/java/org/opencds/cqf/ruler/common/utility/ResourceCreator.java

+
+public interface ResourceCreator extends FhirContextUser {
+	@SuppressWarnings("unchecked")
+	default <T extends IBaseResource, I extends IIdType> T newResource(I theId) {


This is a helper that lets you create a new resource of the correct type and version based only on the id.

JPercival · 2022-01-24T05:40:15Z

common/src/main/java/org/opencds/cqf/ruler/common/utility/Searches.java

+	private Searches() {
+	}
+
+	public static SearchParameterMap all() {


Find all resources (when combined with the Dao API above)

search(Measure.class, Searches.all())

JPercival · 2022-01-24T05:41:10Z

common/src/main/java/org/opencds/cqf/ruler/common/utility/Searches.java

+import ca.uhn.fhir.rest.param.StringParam;
+import ca.uhn.fhir.rest.param.UriParam;
+
+public class Searches {


This is a set of utilities to construct commonly needed search parameter maps.

JPercival · 2022-01-24T05:43:50Z

...porting/src/main/java/org/opencds/cqf/ruler/casereporting/r4/MeasureDataProcessProvider.java

-			for (IBaseResource baseBundle : bundles) {
-				if (baseBundle instanceof Bundle) {
-					Bundle bundle = (Bundle) baseBundle;
+			List<Bundle> bundles = search(Bundle.class, Searches.all()).getAllResourcesTyped();


This line combines the Search API with the new TypedBundleProvider. Compare to the previous code.

JPercival · 2022-01-24T05:44:27Z

...porting/src/main/java/org/opencds/cqf/ruler/casereporting/r4/MeasureDataProcessProvider.java

-			throw new RuntimeException("Could not find Group/" + subjectGroupRef);
-		}
-		Group group = (Group) baseGroup;
+		Group group = read(new IdType(subjectGroupRef));


Here's another example to compare to the previous code.

JPercival · 2022-01-24T05:45:01Z

...porting/src/main/java/org/opencds/cqf/ruler/casereporting/r4/MeasureDataProcessProvider.java

@@ -149,9 +132,9 @@ private void gatherPatientsFromReport(MeasureReport report, Map<String, Referenc
 			logger.debug("No subject results found.");
 			return results;
 		}
-		IBaseResource baseList = myDaoRegistry.getResourceDao(subjectResults.getReferenceElement().getResourceType()).read(subjectResults.getReferenceElement());
+		IBaseResource baseList = read(subjectResults.getReferenceElement());


And one more example to compare to the old code.

JPercival · 2022-01-24T05:45:38Z

...porting/src/main/java/org/opencds/cqf/ruler/casereporting/r4/MeasureDataProcessProvider.java

 		if (baseList == null) {
-			logger.debug(String.format("No subject results found for: %s", subjectResults.getReference()));
+			logger.debug("No subject results found for: {}", subjectResults.getReference());


There was quite a bit of this too. The loggers accept a string format and parameters, so no need to pre-format it.

JPercival · 2022-01-24T05:55:27Z

plugin/cr/src/test/java/org/opencds/cqf/ruler/cr/r4/provider/SubmitDataProviderIT.java

+				"hapi.fhir.enforce_referential_integrity_on_write=false",
+})
+@EnableAutoConfiguration(exclude=QuartzAutoConfiguration.class)
+public class SubmitDataProviderIT extends DaoIntegrationTest implements IdCreator, ResourceCreator {


I'm working on collapsing all the cruft from above into the base classes. Then the body of the tests will become the focus of the code.

JPercival · 2022-01-24T05:56:16Z

plugin/cr/src/test/java/org/opencds/cqf/ruler/cr/r4/provider/SubmitDataProviderIT.java

+	SubmitDataProvider mySubmitDataProvider;
+
+	@Test
+	public void testSubmitData() {


An example of using a few of the utilities to round-trip the database in just a few lines of code.

rob-reynolds

There's a lot here to fully digest. Will adopt patterns in future implementations.

…into feature-plugins-test-framework

…fixes

WIP Test Framework

69c035f

JPercival requested review from rob-reynolds, mdnazmulkarim and jreyno77 January 24, 2022 05:29

JPercival commented Jan 24, 2022

View reviewed changes

WIP Submit Data Provider

9105b7e

JPercival commented Jan 24, 2022

View reviewed changes

JPercival added 5 commits January 24, 2022 08:18

Adds docs, more cleanup

630c86e

Update Readme to not say User since that's overloaded

b361de0

Test framework updates

c618ad1

Update README.md

245d155

Update README.md

43cf554

rob-reynolds approved these changes Jan 24, 2022

View reviewed changes

JPercival added 6 commits January 24, 2022 15:39

Readme cleanup

a5bf435

Merge remote-tracking branch 'origin/feature-plugins-test-framework' …

95fc6f3

…into feature-plugins-test-framework

Fix Versions utility

409ea17

Tests for canonicals, tests for IdCreator, Searches byCanonical, bug …

4de1284

…fixes

Continued refinement of utility classes

1fcbe0d

More cleanup / testing

30c9c4e

JPercival marked this pull request as ready for review January 26, 2022 23:48

JPercival merged commit cda1032 into feature-plugins Jan 26, 2022

JPercival deleted the feature-plugins-test-framework branch January 26, 2022 23:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP Test Framework #437

WIP Test Framework #437

JPercival commented Jan 24, 2022 •

edited

JPercival Jan 24, 2022

JPercival Jan 24, 2022

JPercival Jan 24, 2022

JPercival Jan 24, 2022

JPercival Jan 24, 2022

JPercival Jan 24, 2022

JPercival Jan 24, 2022

JPercival Jan 24, 2022

JPercival Jan 24, 2022

JPercival Jan 24, 2022

JPercival Jan 24, 2022

JPercival Jan 24, 2022

rob-reynolds left a comment

WIP Test Framework #437

WIP Test Framework #437

Conversation

JPercival commented Jan 24, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rob-reynolds left a comment

Choose a reason for hiding this comment

JPercival commented Jan 24, 2022 •

edited