20 - Test Fixtures

Author: jjohannes

.github/workflows/build.yaml

@@ -14,126 +14,132 @@ jobs:
       - name: 01
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 01_The_Settings_File/my-project
           arguments: :build
       - name: 02
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 02_The_Build_Files/my-project
           arguments: :build
       - name: 03
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 03_Plugins/my-project
           arguments: :build
       - name: 04
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 04_Tasks/my-project
           arguments: :build
       - name: 05
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 05_Lifecycle_Tasks/my-project
           arguments: :build
       - name: 06
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 06_Configuring_Task_Inputs_And_Outputs/my-project
           arguments: :build
       - name: 07
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 07_Implementing_Tasks_and_Extensions/my-project
           arguments: :build
       - name: 08
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 08_Declaring_Dependencis/my-project
           arguments: :build
       - name: 09A
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 09_Centralizing_Dependency_Versions/A_Dependency_Constrains_in_Convention_Plugin/my-project
           arguments: :build
       - name: 09B
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 09_Centralizing_Dependency_Versions/B_Platform_Project/my-project
           arguments: :build
       - name: 09C
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 09_Centralizing_Dependency_Versions/C_Version_Catalog/my-project
           arguments: :build
       - name: 09D
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 09_Centralizing_Dependency_Versions/D_Dependency_Locking/my-project
           arguments: :build
       - name: 10
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 10_Dependency_Version_Conflicts/my-project
           arguments: :build
       - name: 11
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 11_Capability_Conflicts/my-project
           arguments: :build
       - name: 12
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 12_Publishing_Libraries/my-project
           arguments: :build
       - name: 13
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 13_Aggregating_Custom_Artifacts/my-project
           arguments: :build
       - name: 14
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 14_Settings_Plugins/my-project
           arguments: :build
       - name: 16
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 16_Source_Sets/my-project
           arguments: :build
       - name: 17
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 17_Feature_Variants/my-project
           arguments: :build
       - name: 18
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 18_Configuring_Testing/my-project
           arguments: :build
       - name: 19
         uses: gradle/[email protected]
         with:
-          gradle-version: 7.2
+          gradle-version: 7.5.1
           build-root-directory: 19_The_Test_Task/my-project
+          arguments: :build
+      - name: 20
+        uses: gradle/[email protected]
+        with:
+          gradle-version: 7.5.1
+          build-root-directory: 20_Test_Fixtures/my-project
           arguments: :build

20_Test_Fixtures/README.MD

@@ -0,0 +1,30 @@
+# Understanding Gradle #20 – Test Fixtures
+
+**👇 click thumbnail to watch video**
+
+[<img src="https://onepiecesoftware.github.io/img/videos/20.png" width="640">](https://www.youtube.com/watch?v=fSRN6YKa5B0&list=PLWQK2ZdV4Yl2k2OmC_gsjDpdIBTN0qqkE)
+
+How to share code among tests in different projects or builds?
+
+## Explore this sample
+
+This sample is best explored in [IntelliJ IDEA](https://www.jetbrains.com/idea/download).
+Open **`20_Test_Fixtures/my-project`** in IDEA and confirm with _Trust Project_.
+
+## Gradle User Manual references
+
+Each video only scratches the surfaces of the features shown.
+This is on purpose to give you a general understanding of how things work in Gradle.
+This understanding enables you to structure your project in a readable and maintainable way.
+
+More details on each feature covered in this video can be found in the Gradle User Manual.
+The Manual, however, is very detailed on all kinds of topics and also contains information on legacy features (it's not always clear which these are).
+
+To help you find the right places, here are some deep links into the Manual on the topics discussed in the video:
+
+* [Test Fixtures](https://docs.gradle.org/current/userguide/java_testing.html#sec:java_test_fixtures)
+* [Feature Variants and Capabilities](https://docs.gradle.org/current/userguide/feature_variants.html)
+
+## Need Gradle support?
+
+Contact me, if you need help with Gradle: [onepiece.Software](http://onepiece.software).

20_Test_Fixtures/my-build-logic/java-plugins/build.gradle.kts

@@ -0,0 +1,3 @@
+plugins {
+    `kotlin-dsl`
+}

20_Test_Fixtures/my-build-logic/java-plugins/src/main/kotlin/my-java-application.gradle.kts

@@ -0,0 +1,4 @@
+plugins {
+    id("my-java-base")
+    id("application")
+}

20_Test_Fixtures/my-build-logic/java-plugins/src/main/kotlin/my-java-base.gradle.kts

@@ -0,0 +1,27 @@
+plugins {
+    id("java")
+}
+
+group = "org.example.my-app"
+version = "1.0"
+
+java {
+    toolchain.languageVersion.set(JavaLanguageVersion.of(11))
+}
+
+tasks.test {
+    useJUnitPlatform() // JUnit5
+}
+
+dependencies {
+    testImplementation("org.junit.jupiter:junit-jupiter-api")
+    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
+}
+
+// Centralized versions
+dependencies {
+    testImplementation(platform("org.junit:junit-bom:5.8.2"))
+}
+dependencies.constraints {
+    implementation("org.apache.commons:commons-lang3:3.9")
+}

20_Test_Fixtures/my-build-logic/java-plugins/src/main/kotlin/my-java-library.gradle.kts

@@ -0,0 +1,10 @@
+plugins {
+    id("my-java-base")
+    id("java-library")
+    id("java-test-fixtures")
+}
+
+val test = sourceSets.test.get()
+java.registerFeature(test.name) {
+    usingSourceSet(test)
+}

20_Test_Fixtures/my-build-logic/settings.gradle.kts

@@ -0,0 +1,8 @@
+dependencyResolutionManagement {
+    repositories.gradlePluginPortal()
+}
+
+include("structure-plugins")
+include("java-plugins")
+include("android-plugins")
+include("kotlin-plugins")

20_Test_Fixtures/my-build-logic/structure-plugins/build.gradle.kts

@@ -0,0 +1,3 @@
+plugins {
+    `kotlin-dsl`
+}

20_Test_Fixtures/my-build-logic/structure-plugins/src/main/kotlin/my-project-structure.settings.gradle.kts

@@ -0,0 +1,20 @@
+// Locations of Gradle plugins
+pluginManagement {
+    repositories.gradlePluginPortal()
+}
+
+// Location of other components
+dependencyResolutionManagement {
+    repositories.mavenCentral()
+    rootDir.parentFile.listFiles()?.filter {
+        File(it, "settings.gradle.kts").exists()
+    }?.forEach {
+        includeBuild(it.path)
+    }
+}
+
+rootDir.listFiles()?.filter {
+    File(it, "build.gradle.kts").exists()
+}?.forEach {
+    include(it.name)
+}

20_Test_Fixtures/my-project/app/build.gradle.kts

@@ -0,0 +1,11 @@
+plugins {
+    id("my-java-application")
+}
+
+application {
+    mainClass.set("myproject.MyApplication")
+}
+
+dependencies {
+    implementation("org.example.my-app:business-logic")
+}

20_Test_Fixtures/my-project/app/data/message.json

@@ -0,0 +1 @@
+{"message":"Hello there :) (this was JSON)"}

20_Test_Fixtures/my-project/app/data/message.xml

@@ -0,0 +1 @@
+<MessageModel><message>Hello there :) (this was XML)</message></MessageModel>

20_Test_Fixtures/my-project/app/src/main/java/myproject/MyApplication.java

@@ -0,0 +1,11 @@
+package myproject;
+
+import myproject.data.MessageModel;
+import myproject.services.Service;
+
+public final class MyApplication {
+
+    public static void main(final String[] args) {
+        Service.printMessage(new MessageModel("Hello there :)"));
+    }
+}

20_Test_Fixtures/my-project/business-logic/build.gradle.kts

@@ -0,0 +1,14 @@
+plugins {
+    id("my-java-library")
+}
+
+dependencies {
+    implementation("org.apache.commons:commons-lang3")
+
+    api("org.example.my-app:data-model") // alternative: project(":data-model")
+
+    testImplementation(testFixtures("org.example.my-app:data-model")) // short notation for ↓
+    // testImplementation("org.example.my-app:data-model") {
+    //     capabilities { requireCapability("org.example.my-app:data-model-test-fixtures") }
+    // }
+}

20_Test_Fixtures/my-project/business-logic/src/main/java/myproject/services/Service.java

@@ -0,0 +1,18 @@
+package myproject.services;
+
+import myproject.data.MessageModel;
+import org.apache.commons.lang3.StringUtils;
+
+public final class Service {
+
+    public static String printMessage(MessageModel message) {
+        String trimmedMessage = StringUtils.trimToEmpty(message.getMessage());
+        String encodedMessage = encode(trimmedMessage);
+        System.out.println(encodedMessage);
+        return encodedMessage;
+    }
+
+    public static String encode(String s) {
+        return s.replace(":)", "\uD83D\uDE03");
+    }
+}

20_Test_Fixtures/my-project/business-logic/src/test/java/myproject/services/ServiceTest.java

@@ -0,0 +1,17 @@
+package myproject.services;
+
+import myproject.data.test.MessageModelFixture;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class ServiceTest {
+
+    @Test
+    void emoji_in_message_is_encoded() {
+        assertEquals(
+                "Hi \uD83D\uDE03",
+                Service.printMessage(MessageModelFixture.newMessage())
+        );
+    }
+}

20_Test_Fixtures/my-project/data-model/build.gradle.kts

@@ -0,0 +1,3 @@
+plugins {
+    id("my-java-library")
+}

20_Test_Fixtures/my-project/data-model/src/main/java/myproject/data/MessageModel.java

@@ -0,0 +1,14 @@
+package myproject.data;
+
+public final class MessageModel {
+
+    private final String message;
+
+    public MessageModel(String message) {
+        this.message = message;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+}

20_Test_Fixtures/my-project/data-model/src/test/java/myproject/data/test/MessageModelTest.java

@@ -0,0 +1,15 @@
+package myproject.data.test;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class MessageModelTest {
+
+    @Test
+    void model_contains_message_text_it_was_created_with() {
+        assertEquals(
+                "Hi :)",
+                MessageModelFixture.newMessage().getMessage());
+    }
+}

20_Test_Fixtures/my-project/data-model/src/testFixtures/java/myproject/data/test/MessageModelFixture.java

@@ -0,0 +1,10 @@
+package myproject.data.test;
+
+import myproject.data.MessageModel;
+
+public class MessageModelFixture {
+
+    public static MessageModel newMessage() {
+        return new MessageModel("Hi :)");
+    }
+}