Adding junit 5 features sample code

sivaprasadreddy · sivaprasadreddy · commit df6483e0c663 · 2023-03-11T21:41:52.000+05:30
diff --git a/junit5-maven-sample/pom.xml b/junit5-maven-sample/pom.xml
@@ -14,6 +14,7 @@
         <maven.compiler.source>17</maven.compiler.source>
         <maven.compiler.target>17</maven.compiler.target>
         <junit.version>5.9.2</junit.version>
+        <assertj-core.version>3.24.2</assertj-core.version>
     </properties>
 
     <dependencyManagement>
@@ -34,6 +35,12 @@
             <artifactId>junit-jupiter</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>${assertj-core.version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>
diff --git a/junit5-maven-sample/src/main/java/com/sivalabs/jtme/PersonRepository.java b/junit5-maven-sample/src/main/java/com/sivalabs/jtme/PersonRepository.java
@@ -45,4 +45,8 @@ public void deleteById(Long id) {
         }
         PERSON_DB.remove(id);
     }
+
+    public void deleteAll() {
+        PERSON_DB.clear();
+    }
 }
diff --git a/junit5-maven-sample/src/main/java/com/sivalabs/jtme/PersonService.java b/junit5-maven-sample/src/main/java/com/sivalabs/jtme/PersonService.java
@@ -48,4 +48,8 @@ private void checkNotEmpty(String value, String message) {
             throw new RuntimeException(message);
         }
     }
+
+    public void deleteAll() {
+        repo.deleteAll();
+    }
 }
diff --git a/junit5-maven-sample/src/test/java/com/sivalabs/jtme/ConditionalTestExecutionDemoTest.java b/junit5-maven-sample/src/test/java/com/sivalabs/jtme/ConditionalTestExecutionDemoTest.java
@@ -0,0 +1,35 @@
+package com.sivalabs.jtme;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.condition.EnabledOnJre;
+import org.junit.jupiter.api.condition.EnabledOnOs;
+import org.junit.jupiter.api.condition.JRE;
+import org.junit.jupiter.api.condition.OS;
+
+class ConditionalTestExecutionDemoTest {
+
+    @Test
+    @EnabledOnOs(OS.MAC)
+    void shouldRunOnlyOnMacOS() {
+        System.out.println("This is a test running on MacOS");
+    }
+
+    @Test
+    @EnabledOnOs(OS.WINDOWS)
+    void shouldRunOnlyOnWindows() {
+        System.out.println("This is a test running on Windows");
+    }
+
+    @Test
+    @EnabledOnJre(JRE.JAVA_17)
+    void shouldRunOnlyOnJre17() {
+        System.out.println("This is a test running on Java 17");
+    }
+
+    @Test
+    @EnabledOnJre(JRE.JAVA_21)
+    void shouldRunOnlyOnJre21() {
+        System.out.println("This is a test running on Java 21");
+    }
+
+}
diff --git a/junit5-maven-sample/src/test/java/com/sivalabs/jtme/LifecycleCallbacksDemoTest.java b/junit5-maven-sample/src/test/java/com/sivalabs/jtme/LifecycleCallbacksDemoTest.java
@@ -0,0 +1,40 @@
+package com.sivalabs.jtme;
+
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+class LifecycleCallbacksDemoTest {
+
+    @BeforeAll
+    static void beforeAll() {
+        System.out.println("--------beforeAll()---------");
+    }
+
+    @AfterAll
+    static void afterAll() {
+        System.out.println("--------afterAll()---------");
+    }
+
+    @BeforeEach
+    void setUp() {
+        System.out.println("--------setUp()---------");
+    }
+
+    @AfterEach
+    void tearDown() {
+        System.out.println("--------tearDown()---------");
+    }
+
+    @Test
+    void test1() {
+        System.out.println("------------test1------------");
+    }
+
+    @Test
+    void test2() {
+        System.out.println("------------test2------------");
+    }
+}
diff --git a/junit5-maven-sample/src/test/java/com/sivalabs/jtme/PersonServiceParameterizedTests.java b/junit5-maven-sample/src/test/java/com/sivalabs/jtme/PersonServiceParameterizedTests.java
@@ -0,0 +1,68 @@
+package com.sivalabs.jtme;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.CsvSource;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import java.util.stream.Stream;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.params.provider.Arguments.arguments;
+
+class PersonServiceParameterizedTests {
+    PersonService personService;
+
+    @BeforeEach
+    void setUp() {
+        PersonRepository repo = new PersonRepository();
+        personService = new PersonService(repo);
+    }
+
+    @ParameterizedTest
+    @CsvSource({
+            "Siva1,siva1@gmail.com",
+            "Siva2,siva2@gmail.com",
+            "Siva3,siva3@gmail.com",
+    })
+    void shouldCreatePersonUsingCSVSuccessfully(String name, String email) {
+        Person person = personService.create(new Person(null, name, email));
+        assertNotNull(person.getId());
+        assertEquals(name, person.getName());
+        assertEquals(email, person.getEmail());
+    }
+
+    @ParameterizedTest
+    @MethodSource("personPropsProvider")
+    void shouldCreatePersonSuccessfully(String name, String email) {
+        Person person = personService.create(new Person(null, name, email));
+        assertNotNull(person.getId());
+        assertEquals(name, person.getName());
+        assertEquals(email, person.getEmail());
+    }
+
+    static Stream<Arguments> personPropsProvider() {
+        return Stream.of(
+                arguments("Siva", "siva@gmail.com"),
+                arguments("Prasad", "prasad@gmail.com")
+        );
+    }
+
+    @ParameterizedTest
+    @MethodSource("personObjectsProvider")
+    void shouldCreatePersonWithObjectInputSuccessfully(Person personInput) {
+        Person person = personService.create(personInput);
+        assertNotNull(person.getId());
+        assertEquals(personInput.getName(), person.getName());
+        assertEquals(personInput.getEmail(), person.getEmail());
+    }
+
+    static Stream<Arguments> personObjectsProvider() {
+        return Stream.of(
+                arguments(new Person(null, "Neha", "neha@gmail.com")),
+                arguments(new Person(null, "Yuvaan", "yuvaan@gmail.com"))
+        );
+    }
+}
diff --git a/junit5-maven-sample/src/test/java/com/sivalabs/jtme/PersonServiceTest.java b/junit5-maven-sample/src/test/java/com/sivalabs/jtme/PersonServiceTest.java
@@ -1,8 +1,15 @@
 package com.sivalabs.jtme;
 
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 
+import java.util.Optional;
+import java.util.UUID;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.junit.jupiter.api.Assertions.*;
 
 class PersonServiceTest {
@@ -15,11 +22,52 @@ void setUp() {
         personService = new PersonService(repo);
     }
 
-    @Test
-    void shouldCreatePerson() {
-        Person person = personService.create(new Person(null, "Siva", "siva@gmail.com"));
-        assertNotNull(person.getId());
-        assertEquals("Siva", person.getName());
-        assertEquals("siva@gmail.com", person.getEmail());
+    @AfterEach
+    void tearDown() {
+        personService.deleteAll();
+    }
+
+    @Nested
+    class CreatePersonTests {
+        @Test
+        void shouldCreatePersonSuccessfully() {
+            Person person = personService.create(new Person(null, "Siva", "siva@gmail.com"));
+            assertNotNull(person.getId());
+            assertEquals("Siva", person.getName());
+            assertEquals("siva@gmail.com", person.getEmail());
+        }
+
+        @Test
+        void shouldFailToCreatePersonWithExistingEmail() {
+            String email = UUID.randomUUID() +"@gmail.com";
+            personService.create(new Person(null, "Siva", email));
+
+            assertThatThrownBy(()-> personService.create(new Person(null, "Siva", email)))
+                    .isInstanceOf(RuntimeException.class)
+                    .hasMessage("Person with email '"+email+"' already exists");
+        }
+    }
+
+    @Nested
+    class FindPersonByEmailTests {
+        String email;
+
+        @BeforeEach
+        void setUp() {
+            email = UUID.randomUUID() +"@gmail.com";
+            personService.create(new Person(null, "Siva", email));
+        }
+
+        @Test
+        void shouldGetPersonByEmailWhenExists() {
+            Optional<Person> optionalPerson = personService.findByEmail(email);
+            assertThat(optionalPerson).isPresent();
+        }
+
+        @Test
+        void shouldGetEmptyWhenPersonByEmailNotExists() {
+            Optional<Person> optionalPerson = personService.findByEmail("random@mail.com");
+            assertThat(optionalPerson).isEmpty();
+        }
     }
 }
diff --git a/junit5-maven-sample/src/test/java/com/sivalabs/jtme/TestInstanceLifecycleDemoTest.java b/junit5-maven-sample/src/test/java/com/sivalabs/jtme/TestInstanceLifecycleDemoTest.java
@@ -0,0 +1,31 @@
+package com.sivalabs.jtme;
+
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Tag;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInstance;
+import org.junit.jupiter.api.Timeout;
+
+import java.util.concurrent.TimeUnit;
+
+@TestInstance(value = TestInstance.Lifecycle.PER_CLASS)
+class TestInstanceLifecycleDemoTest {
+
+    @Test
+    @DisplayName("Given a person to save with existing email then ti should throw Exception")
+    @Tag("unit")
+    @Timeout(value = 5, unit = TimeUnit.SECONDS)
+    void test1() throws InterruptedException {
+        System.out.println("test1:"+this.hashCode());
+        Thread.sleep(3000);
+    }
+
+    @Test
+    @Tag("integration")
+    @Disabled
+    void test2() {
+        System.out.println("test2:"+this.hashCode());
+    }
+
+}
diff --git a/junit5-maven-sample/src/test/resources/junit-platform.properties b/junit5-maven-sample/src/test/resources/junit-platform.properties
@@ -0,0 +1,11 @@
+#junit.jupiter.testinstance.lifecycle.default=per_class
+
+# To execute top-level classes in parallel but methods in same thread
+#junit.jupiter.execution.parallel.enabled = true
+#junit.jupiter.execution.parallel.mode.default = same_thread
+#junit.jupiter.execution.parallel.mode.classes.default = concurrent
+
+# To execute top-level classes sequentially but their methods in parallel
+#junit.jupiter.execution.parallel.enabled = true
+#junit.jupiter.execution.parallel.mode.default = concurrent
+#junit.jupiter.execution.parallel.mode.classes.default = same_thread

Original file line number	Diff line number	Diff line change
`@@ -45,4 +45,8 @@ public void deleteById(Long id) {`
`45`	`45`	`}`
`46`	`46`	`PERSON_DB.remove(id);`
`47`	`47`	`}`
	`48`	`+`
	`49`	`+ public void deleteAll() {`
	`50`	`+ PERSON_DB.clear();`
	`51`	`+ }`
`48`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,4 +48,8 @@ private void checkNotEmpty(String value, String message) {`
`48`	`48`	`throw new RuntimeException(message);`
`49`	`49`	`}`
`50`	`50`	`}`
	`51`	`+`
	`52`	`+ public void deleteAll() {`
	`53`	`+ repo.deleteAll();`
	`54`	`+ }`
`51`	`55`	`}`