CARDS-2154: cards-utils tests #1418

sofi2002sofi · 2023-03-10T15:12:32Z

No description provided.

sdumitriu · 2023-03-13T21:22:48Z

modules/utils/src/test/java/io/uhndata/cards/serialize/ResourceToCSVAdapterFactoryTest.java

+ * @version $Id $
+ */
+@RunWith(MockitoJUnitRunner.class)
+public class ResourceToCSVAdapterFactoryTest


More tests:

getAdapterWithNoProcessorsReturnsResourcePath - has an empty list of processors

getAdapterUsesFirstProcessorThatCanProcess - has 3 processors, first cannot process, check second's output is used, verify first's and third's serialize is never invoked

sdumitriu · 2023-03-13T21:23:32Z

modules/utils/src/test/java/io/uhndata/cards/serialize/ResourceToCSVAdapterFactoryTest.java

+    }
+
+    @Test
+    public void getAdapterForResourceAdaptableObjectReturnsResourcePath()


Suggested change

public void getAdapterForResourceAdaptableObjectReturnsResourcePath()

public void getAdapterForUnsupportedResourceReturnsResourcePath()

sdumitriu · 2023-03-13T21:26:49Z

modules/utils/src/test/java/io/uhndata/cards/serialize/ResourceToJsonAdapterFactoryTest.java

+        when(processor.isEnabledByDefault(adaptable)).thenReturn(true);
+        when(processor.getName()).thenReturn("name");
+        when(processor.canProcess(adaptable)).thenReturn(true);


These lines are the same in all 3 tests, they should be moved in a mockWorkingProcessor method.

sdumitriu · 2023-03-13T21:34:16Z

modules/utils/src/test/java/io/uhndata/cards/serialize/ResourceToJsonAdapterFactoryTest.java

+        ResourceMetadata resourceMetadata = mock(ResourceMetadata.class);
+        when(adaptable.getResourceMetadata()).thenReturn(resourceMetadata);


This code seems useless to me; the fact that it is actually needed here suggests that the actual code can be improved. Try moving the adaptTo(Node.class) line earlier in the method, and add a check for null.

Normally, in test-driven development, the tests are supposed to influence the code, not the other way around, so you should feel free to also change the code being tested when you feel that it can be improved, not just write tests that perfectly match the existing code.

sdumitriu · 2023-03-13T21:55:22Z

modules/utils/src/test/java/io/uhndata/cards/serialize/ResourceToJsonAdapterFactoryTest.java

+ * @version $Id $
+ */
+@RunWith(MockitoJUnitRunner.class)
+public class ResourceToJsonAdapterFactoryTest


More tests:

getAdapterUsesAllSupportedAndEnabledProcessors - receives a list of processors that either support or not the resource, and that are either enabled or disabled by default

getAdapterSortsProcessors - receives a list of processors in the wrong order; to make the order validation easier to check, write a simple class that receives a priority and 2 integers a and b in its constructor, and implements ResourceJsonProcessor.processProperty as return Json.createValue(input == null ? b : ((JsonNumber) input).intValue() * a + b);; instantiate 4 such processors with different prime values for a and b, and serialize a number; make sure the output matches the expected result

getAdapterWithNoProcessorsReturnsEmptyJsonObject - uses an empty list of processors

getAdapterWithNoSupportedProcessorsReturnsEmptyJsonObject - uses one processor that cannot process the resource

getAdapterWithRecursiveReferencesUsesResourcePathForNestedReferences

getAdapterUsesResourceSelectorsToDisableDefaultProcessors

getAdapterUsesResourceSelectorsToEnableProcessors

getAdapterWithBothEnableAndDisableSelectorsPrioritizesEnable

sdumitriu · 2023-03-15T14:10:30Z

modules/utils/src/test/java/io/uhndata/cards/serialize/internal/DereferenceProcessorTest.java

+    }
+
+    @Test
+    public void isEnabledByDefaultTest()


Oh, I think each processor needs this test, even if the method is not overridden in a class, just to check that it is indeed false.

sdumitriu · 2023-03-15T14:26:16Z

modules/utils/src/test/java/io/uhndata/cards/serialize/internal/DereferenceProcessorTest.java

+        Property property = node.getProperty("jcr:baseVersion");
+        JsonValue json = Json.createValue(FORM_TYPE);
+        JsonValue jsonValue = this.dereferenceProcessor.processProperty(node, property, json, this::serializeNode);
+        assertNotNull(jsonValue);


This needs an assertEquals check as well.

assertEquals(property.getNode().getPath(), ((JsonString) jsonValue).getString());

sdumitriu · 2023-03-15T15:05:29Z

...les/utils/src/test/java/io/uhndata/cards/serialize/internal/IdentificationProcessorTest.java

+        assertTrue(jsonObject.containsKey("@path"));
+        assertEquals(Json.createValue(TEST_FORM_PATH), jsonObject.getJsonString("@path"));
+        assertTrue(jsonObject.containsKey("@name"));
+        assertEquals(Json.createValue("f1"), jsonObject.getJsonString("@name"));


Why not the simpler:

assertEquals("f1", jsonObject.getString("@name"));

sdumitriu · 2023-03-15T15:07:53Z

...les/utils/src/test/java/io/uhndata/cards/serialize/internal/IdentificationProcessorTest.java

+    }
+
+    @Test
+    public void leaveAddsPathAndNameAndReferencedParameters() throws RepositoryException


I would split this into 2 methods:

leaveAddsPathAndNameParameters

leaveAddsReferencedParameter

Also, I would test the reference for 2 different nodes, the form (for false) and the questionnaire (for true).

sdumitriu · 2023-03-15T15:11:50Z

modules/utils/src/test/java/io/uhndata/cards/serialize/internal/SimpleProcessorTest.java

+ * @version $Id $
+ */
+@RunWith(MockitoJUnitRunner.class)
+public class SimpleProcessorTest


This is missing a positive test: processPropertyReturnsInput.

veronikaslc · 2023-06-16T21:49:24Z

ResourceToJsonAdapterFactoryTest: Lines 267-208 not covered from ResourceToJsonAdapterFactory
BareProcessorTest not covered cases of lines 141 and 206-209 of BareProcessor
DereferenceProcessorTest: not covered line 127 of DereferenceProcessor
SimpleProcessorTest: not covered line 101 of SimpleProcessor

veronikaslc · 2023-06-16T21:50:10Z

jacoco.zip
jacoco:report html file attached

tests for DenyScriptsSlingPostProcessor

tests for ContentTypeSetter and StatusCodeSetter

tests for ResourceToCSVAdapterFactory

tests for ResourceToJsonAdapterFactory, ResourceToMarkdownAdspterFactory, ResourceToTextAdapterFactory

tests for BareProcessor

tests for DeepProcessor, DereferenceProcessor, IdentificationProcessor, PropertiesProcessor, SimpleProcessor

fixes for ResourceToCSVAdapterFactory

fixes for ResourceToMarkdownAdapterFactory

fixes for ResourceToTextAdapterFactory

tests for CSVString

fixes for DenyScriptsSlingPostProcessorTest

fixes for BareProcessorTest

fixes for DeepProcessorTest, DeferenceProcessorTest, PropertiesProcessorTest, PropertiesProcessorTest

fixes for IdentificationProcessorTest

fixes for SimpleProcessorTest

fixes for ResourceToJsonAdapterFactoryTest

… SimpleProcessor, and DereferenceProcessor

@reference

Adjusted test coverage wrt current codeabse volume Removed 2 outdated tests due to CARDS-2353: Move the @reference JSON processor in its own module and disable it by default Adjusted some outdated tests Added missing pom dependencies

marta- added the test-coverage label Mar 14, 2023

sdumitriu requested changes Mar 15, 2023

View reviewed changes

sofi2002sofi requested a review from sdumitriu March 22, 2023 16:14

sofi2002sofi force-pushed the CARDS-2154-utils-test branch from 3bb94da to fa83ebe Compare July 5, 2023 07:47

marta- assigned veronikaslc Nov 13, 2025

sofi2002sofi added 17 commits December 4, 2025 16:15

CARDS-2154: Increase test coverage cards-utils

777f3f8

tests for DenyScriptsSlingPostProcessor

CARDS-2154: Increase test coverage cards-utils

40d7e75

tests for ContentTypeSetter and StatusCodeSetter

CARDS-2154: Increase test coverage cards-utils

41c2ee9

tests for ResourceToCSVAdapterFactory

CARDS-2154: Increase test coverage cards-utils

e523d9c

tests for ResourceToJsonAdapterFactory, ResourceToMarkdownAdspterFactory, ResourceToTextAdapterFactory

CARDS-2154: Increase test coverage cards-utils

b527a43

tests for BareProcessor

CARDS-2154: Increase test coverage cards-utils

96add58

tests for DeepProcessor, DereferenceProcessor, IdentificationProcessor, PropertiesProcessor, SimpleProcessor

CARDS-2154: Increase test coverage cards-utils

1ee381f

fixes for ResourceToCSVAdapterFactory

CARDS-2154: Increase test coverage cards-utils

fcfbd37

fixes for ResourceToMarkdownAdapterFactory

CARDS-2154: Increase test coverage cards-utils

e76b2aa

fixes for ResourceToTextAdapterFactory

CARDS-2154: Increase test coverage cards-utils

5aac1b7

tests for CSVString

CARDS-2154: Increase test coverage cards-utils

7dbd394

fixes for DenyScriptsSlingPostProcessorTest

CARDS-2154: Increase test coverage cards-utils

0e487d4

fixes for BareProcessorTest

CARDS-2154: Increase test coverage cards-utils

0a02467

fixes for DeepProcessorTest, DeferenceProcessorTest, PropertiesProcessorTest, PropertiesProcessorTest

CARDS-2154: Increase test coverage cards-utils

f07978d

fixes for IdentificationProcessorTest

CARDS-2154: Increase test coverage cards-utils

05eb08a

fixes for SimpleProcessorTest

CARDS-2154: Increase test coverage cards-utils

62ad757

fixes for ResourceToJsonAdapterFactoryTest

added new test cases for ResourceToJsonAdapterFactory, BareProcessor,…

ba1b114

… SimpleProcessor, and DereferenceProcessor

veronikaslc force-pushed the CARDS-2154-utils-test branch from fa83ebe to d08ad09 Compare December 5, 2025 05:45

veronikaslc marked this pull request as ready for review December 5, 2025 05:48

CARDS-2154: Increase test coverage cards-utils

4c9df54

Adjusted test coverage wrt current codeabse volume Removed 2 outdated tests due to CARDS-2353: Move the @reference JSON processor in its own module and disable it by default Adjusted some outdated tests Added missing pom dependencies

veronikaslc force-pushed the CARDS-2154-utils-test branch from d08ad09 to 4c9df54 Compare December 6, 2025 06:36

	public void getAdapterForResourceAdaptableObjectReturnsResourcePath()
	public void getAdapterForUnsupportedResourceReturnsResourcePath()

		ResourceMetadata resourceMetadata = mock(ResourceMetadata.class);
		when(adaptable.getResourceMetadata()).thenReturn(resourceMetadata);

CARDS-2154: cards-utils tests #1418

Are you sure you want to change the base?

CARDS-2154: cards-utils tests #1418

Uh oh!

Conversation

sofi2002sofi commented Mar 10, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

veronikaslc commented Jun 16, 2023

Uh oh!

veronikaslc commented Jun 16, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants