test(core): Improve test quality of core module

Author: Martin7-1

embedding-stores/langchain4j-community-memfile/pom.xml

@@ -9,7 +9,7 @@
     </parent>
 
     <artifactId>langchain4j-community-memfile</artifactId>
-    <name>LangChain4j :: Community :: memfile</name>
+    <name>LangChain4j :: Community :: Integration :: MemFile</name>
 
     <dependencies>
         <dependency>

langchain4j-community-core/src/test/java/dev/langchain4j/community/chain/RetrievalQAChainTest.java

@@ -63,7 +63,7 @@ void beforeEach() {
     }
 
     @Test
-    void should_inject_retrieved_segments() {
+    void should_inject_retrieved_segments_when_content_available() {
 
         // given
         when(contentRetriever.retrieve(any())).thenReturn(asList(Content.from("Segment 1"), Content.from("Segment 2")));
@@ -87,7 +87,7 @@ void should_inject_retrieved_segments() {
     }
 
     @Test
-    void should_inject_retrieved_segments_using_custom_prompt_template() {
+    void should_inject_retrieved_segments_when_custom_prompt_template_used() {
 
         // given
         when(contentRetriever.retrieve(any())).thenReturn(asList(Content.from("Segment 1"), Content.from("Segment 2")));
@@ -151,7 +151,7 @@ void should_inject_retrieved_segments_using_custom_prompt_template() {
     }
 
     @Test
-    void should_inject_retrieved_segments_using_custom_prompt_template_and_metadata() {
+    void should_inject_retrieved_segments_when_custom_prompt_template_and_metadata_used() {
         final List<Content> list1 = List.of(
                 Content.from(TextSegment.from("Segment 1 with meta")),
                 Content.from(TextSegment.from("Segment 2  with meta")));
@@ -198,7 +198,7 @@ void should_inject_retrieved_segments_using_custom_prompt_template_and_metadata(
     }
 
     @Test
-    void should_throws_exception_if_neither_retriever_nor_retrieval_augmentor_is_defined() {
+    void should_throw_exception_when_neither_retriever_nor_retrieval_augmentor_defined() {
         try {
             RetrievalQAChain.builder().chatModel(chatModel).build();
             fail("Should fail due to missing builder configurations");
@@ -208,7 +208,7 @@ void should_throws_exception_if_neither_retriever_nor_retrieval_augmentor_is_def
     }
 
     @Test
-    void should_throws_exception_if_retriever_is_null() {
+    void should_throw_exception_when_retriever_is_null() {
         try {
             RetrievalQAChain.builder()
                     .chatModel(chatModel)

langchain4j-community-core/src/test/java/dev/langchain4j/community/data/document/graph/GraphDocumentTest.java

@@ -12,7 +12,7 @@
 class GraphDocumentTest {
 
     @Test
-    void test_equals_hash_code() {
+    void should_return_true_when_documents_are_equal_and_false_when_not_equal() {
 
         // given
         Document source = mock(Document.class);
@@ -38,7 +38,7 @@ void test_equals_hash_code() {
     }
 
     @Test
-    void test_from_all_attributes() {
+    void should_create_graph_document_with_all_attributes_when_provided() {
 
         // given
         GraphNode node = mock(GraphNode.class);
@@ -57,7 +57,7 @@ void test_from_all_attributes() {
     }
 
     @Test
-    void test_from_only_source() {
+    void should_create_graph_document_with_empty_collections_when_only_source_provided() {
 
         // given
         Document source = mock(Document.class);
@@ -72,15 +72,15 @@ void test_from_only_source() {
     }
 
     @Test
-    void test_failed_on_empty_source() {
+    void should_throw_exception_when_source_is_null() {
 
         assertThatThrownBy(() -> new GraphDocument(Set.of(), Set.of(), null))
                 .isInstanceOf(IllegalArgumentException.class)
                 .hasMessage("source cannot be null");
     }
 
     @Test
-    void test_to_string() {
+    void should_return_string_representation_when_toString_called() {
 
         // given
         Document source = mock(Document.class);

langchain4j-community-core/src/test/java/dev/langchain4j/community/data/document/graph/GraphEdgeTest.java

@@ -9,7 +9,7 @@
 class GraphEdgeTest {
 
     @Test
-    void test_constructor_and_getters() {
+    void should_initialize_edge_with_all_attributes_when_constructed() {
         // given
         GraphNode source = mock(GraphNode.class);
         GraphNode target = mock(GraphNode.class);
@@ -27,7 +27,7 @@ void test_constructor_and_getters() {
     }
 
     @Test
-    void test_copyIfNotNull_behavior_in_constructor() {
+    void should_create_empty_properties_map_when_properties_are_null() {
         // given
         GraphNode source = mock(GraphNode.class);
         GraphNode target = mock(GraphNode.class);
@@ -41,7 +41,7 @@ void test_copyIfNotNull_behavior_in_constructor() {
     }
 
     @Test
-    void test_from_with_properties() {
+    void should_create_edge_with_properties_when_using_from_method() {
         // given
         GraphNode source = mock(GraphNode.class);
         GraphNode target = mock(GraphNode.class);
@@ -59,7 +59,7 @@ void test_from_with_properties() {
     }
 
     @Test
-    void test_from_without_properties() {
+    void should_create_edge_with_empty_properties_when_using_from_method_without_properties() {
         // given
         GraphNode source = mock(GraphNode.class);
         GraphNode target = mock(GraphNode.class);
@@ -76,7 +76,7 @@ void test_from_without_properties() {
     }
 
     @Test
-    void test_equals_and_hashcode() {
+    void should_return_true_when_edges_are_equal_and_false_when_not_equal() {
         // given
         GraphNode source = mock(GraphNode.class);
         GraphNode target = mock(GraphNode.class);
@@ -94,7 +94,7 @@ void test_equals_and_hashcode() {
     }
 
     @Test
-    void test_to_string_contains_all_fields() {
+    void should_return_string_representation_containing_all_fields_when_toString_called() {
         // given
         GraphNode source = mock(GraphNode.class);
         GraphNode target = mock(GraphNode.class);

langchain4j-community-core/src/test/java/dev/langchain4j/community/data/document/graph/GraphNodeTest.java

@@ -8,7 +8,7 @@
 class GraphNodeTest {
 
     @Test
-    void test_constructor_and_getters() {
+    void should_initialize_node_with_all_attributes_when_constructed() {
         // given
         String id = "node1";
         String type = "Person";
@@ -24,7 +24,7 @@ void test_constructor_and_getters() {
     }
 
     @Test
-    void test_constructor_with_null_type_and_properties() {
+    void should_use_default_values_when_type_and_properties_are_null() {
         // given
         String id = "node2";
 
@@ -38,7 +38,7 @@ void test_constructor_with_null_type_and_properties() {
     }
 
     @Test
-    void test_static_factory_method_with_all_fields() {
+    void should_create_node_with_all_fields_when_using_from_method() {
         // given
         String id = "node3";
         String type = "City";
@@ -54,7 +54,7 @@ void test_static_factory_method_with_all_fields() {
     }
 
     @Test
-    void test_static_factory_method_with_only_id() {
+    void should_create_node_with_default_type_and_empty_properties_when_using_from_method_with_only_id() {
         // given
         String id = "node4";
 
@@ -68,7 +68,7 @@ void test_static_factory_method_with_only_id() {
     }
 
     @Test
-    void test_equals_and_hashcode() {
+    void should_return_true_when_nodes_are_equal_and_false_when_not_equal() {
         // given
         Map<String, String> props = Map.of("k", "v");
 
@@ -88,7 +88,7 @@ void test_equals_and_hashcode() {
     }
 
     @Test
-    void test_to_string_contains_all_fields() {
+    void should_return_string_representation_containing_all_fields_when_toString_called() {
         // given
         GraphNode node = new GraphNode("id123", "Label", Map.of("x", "y"));
 

langchain4j-community-core/src/test/java/dev/langchain4j/community/data/document/transformer/graph/GraphTransformerTest.java

@@ -25,7 +25,7 @@ public GraphDocument transform(Document document) {
     }
 
     @Test
-    void should_return_empty_when_null() {
+    void should_return_empty_list_when_input_is_null() {
         GraphTransformer graphTransformer = new MockGraphTransformer();
 
         // when
@@ -36,7 +36,7 @@ void should_return_empty_when_null() {
     }
 
     @Test
-    void should_return_empty_when_empty() {
+    void should_return_empty_list_when_input_is_empty() {
         GraphTransformer graphTransformer = new MockGraphTransformer();
 
         // when
@@ -47,7 +47,7 @@ void should_return_empty_when_empty() {
     }
 
     @Test
-    void should_return_transformed_documents() {
+    void should_return_transformed_documents_when_input_provided() {
         GraphTransformer graphTransformer = new MockGraphTransformer();
 
         // given

langchain4j-community-core/src/test/java/dev/langchain4j/community/embedding/ParentChildEmbeddingStoreIngestorTest.java

@@ -27,10 +27,10 @@
 import java.util.stream.Stream;
 import org.junit.jupiter.api.Test;
 
-public class ParentChildEmbeddingStoreIngestorTest {
+class ParentChildEmbeddingStoreIngestorTest {
 
     @Test
-    void should_extract_text_then_split_into_segments_then_embed_them_and_store_in_embedding_store() {
+    void should_extract_text_split_into_segments_embed_them_and_store_in_embedding_store() {
 
         Document firstDocument = Document.from("First sentence.");
         Document secondDocument = Document.from("Second sentence. Third sentence.");
@@ -217,7 +217,7 @@ void should_extract_text_then_split_into_segments_then_embed_them_and_store_in_e
     }
 
     @Test
-    void should_not_split_when_no_splitter_is_specified() {
+    void should_not_split_when_no_splitter_specified() {
 
         // given
         String text = "Some text";