From ef4681bf2c2922afc0694b3d0d81ecdf8b0e93ba Mon Sep 17 00:00:00 2001 From: Sergey Morgunov Date: Fri, 16 Jun 2023 16:59:09 +0300 Subject: [PATCH] Enable Java Format check for Gradle Plugin --- gradle-twirl/build.gradle.kts | 7 ++ .../gradle/TwirlPluginFunctionalTest.java | 69 +++++++++---------- .../java/play/twirl/gradle/TwirlPlugin.java | 22 +++--- .../play/twirl/gradle/TwirlPluginTest.java | 19 +++-- 4 files changed, 60 insertions(+), 57 deletions(-) diff --git a/gradle-twirl/build.gradle.kts b/gradle-twirl/build.gradle.kts index 28bc4607..eb72964b 100644 --- a/gradle-twirl/build.gradle.kts +++ b/gradle-twirl/build.gradle.kts @@ -10,6 +10,7 @@ plugins { // Apply the Java Gradle plugin development plugin to add support for developing Gradle plugins `java-gradle-plugin` + id("com.diffplug.spotless") version "6.19.0" } repositories { @@ -52,6 +53,12 @@ gradlePlugin { gradlePlugin.testSourceSets.add(sourceSets["functionalTest"]) +spotless { + java { + googleJavaFormat() + } +} + tasks.named("check") { // Include functionalTest as part of the check lifecycle dependsOn(testing.suites.named("functionalTest")) diff --git a/gradle-twirl/src/functionalTest/java/play/twirl/gradle/TwirlPluginFunctionalTest.java b/gradle-twirl/src/functionalTest/java/play/twirl/gradle/TwirlPluginFunctionalTest.java index 5b74c7b6..a68926cb 100644 --- a/gradle-twirl/src/functionalTest/java/play/twirl/gradle/TwirlPluginFunctionalTest.java +++ b/gradle-twirl/src/functionalTest/java/play/twirl/gradle/TwirlPluginFunctionalTest.java @@ -14,43 +14,38 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.api.io.TempDir; -/** - * A simple functional test for the 'com.playframework.twirl' plugin. - */ +/** A simple functional test for the 'com.playframework.twirl' plugin. */ class TwirlPluginFunctionalTest { - @TempDir - File projectDir; - - private File getBuildFile() { - return new File(projectDir, "build.gradle"); - } - - private File getSettingsFile() { - return new File(projectDir, "settings.gradle"); - } - - @Test void canRunTask() throws IOException { - writeString(getSettingsFile(), ""); - writeString(getBuildFile(), - "plugins {" + - " id('com.playframework.twirl')" + - "}"); - - // Run the build - GradleRunner runner = GradleRunner.create(); - runner.forwardOutput(); - runner.withPluginClasspath(); - runner.withArguments("greeting"); - runner.withProjectDir(projectDir); - BuildResult result = runner.build(); - - // Verify the result - assertTrue(result.getOutput().contains("Hello from plugin 'com.playframework.twirl'")); - } - - private void writeString(File file, String string) throws IOException { - try (Writer writer = new FileWriter(file)) { - writer.write(string); - } + @TempDir File projectDir; + + private File getBuildFile() { + return new File(projectDir, "build.gradle"); + } + + private File getSettingsFile() { + return new File(projectDir, "settings.gradle"); + } + + @Test + void canRunTask() throws IOException { + writeString(getSettingsFile(), ""); + writeString(getBuildFile(), "plugins {" + " id('com.playframework.twirl')" + "}"); + + // Run the build + GradleRunner runner = GradleRunner.create(); + runner.forwardOutput(); + runner.withPluginClasspath(); + runner.withArguments("greeting"); + runner.withProjectDir(projectDir); + BuildResult result = runner.build(); + + // Verify the result + assertTrue(result.getOutput().contains("Hello from plugin 'com.playframework.twirl'")); + } + + private void writeString(File file, String string) throws IOException { + try (Writer writer = new FileWriter(file)) { + writer.write(string); } + } } diff --git a/gradle-twirl/src/main/java/play/twirl/gradle/TwirlPlugin.java b/gradle-twirl/src/main/java/play/twirl/gradle/TwirlPlugin.java index e2d9acb7..c6062ce4 100644 --- a/gradle-twirl/src/main/java/play/twirl/gradle/TwirlPlugin.java +++ b/gradle-twirl/src/main/java/play/twirl/gradle/TwirlPlugin.java @@ -3,17 +3,19 @@ */ package play.twirl.gradle; -import org.gradle.api.Project; import org.gradle.api.Plugin; +import org.gradle.api.Project; -/** - * A simple 'hello world' plugin. - */ +/** A simple 'hello world' plugin. */ public class TwirlPlugin implements Plugin { - public void apply(Project project) { - // Register a task - project.getTasks().register("greeting", task -> { - task.doLast(s -> System.out.println("Hello from plugin 'com.playframework.twirl'")); - }); - } + public void apply(Project project) { + // Register a task + project + .getTasks() + .register( + "greeting", + task -> { + task.doLast(s -> System.out.println("Hello from plugin 'com.playframework.twirl'")); + }); + } } diff --git a/gradle-twirl/src/test/java/play/twirl/gradle/TwirlPluginTest.java b/gradle-twirl/src/test/java/play/twirl/gradle/TwirlPluginTest.java index 2ccb605d..adf1ca20 100644 --- a/gradle-twirl/src/test/java/play/twirl/gradle/TwirlPluginTest.java +++ b/gradle-twirl/src/test/java/play/twirl/gradle/TwirlPluginTest.java @@ -9,16 +9,15 @@ import org.gradle.testfixtures.ProjectBuilder; import org.junit.jupiter.api.Test; -/** - * A simple unit test for the 'com.playframework.twirl' plugin. - */ +/** A simple unit test for the 'com.playframework.twirl' plugin. */ class TwirlPluginTest { - @Test void pluginRegistersATask() { - // Create a test project and apply the plugin - Project project = ProjectBuilder.builder().build(); - project.getPlugins().apply("com.playframework.twirl"); + @Test + void pluginRegistersATask() { + // Create a test project and apply the plugin + Project project = ProjectBuilder.builder().build(); + project.getPlugins().apply("com.playframework.twirl"); - // Verify the result - assertNotNull(project.getTasks().findByName("greeting")); - } + // Verify the result + assertNotNull(project.getTasks().findByName("greeting")); + } }