Merge branch 'hiddewie-up-to-date'

Author: bnasslahsen

README.md

@@ -56,7 +56,7 @@ Running the task `generateOpenApiDocs` writes the OpenAPI spec into a `openapi.j
 in your project's build dir.
 
 ```bash
-gradle clean generateOpenApiDocs
+gradle generateOpenApiDocs
 ``` 
 
 When you run the gradle task **generateOpenApiDocs**, it starts your spring boot
@@ -132,7 +132,7 @@ openApi {
 
 This allows for you to be able to just send in whatever you need when you generate docs.
 
-`./gradlew clean generateOpenApiDocs -Dspring.profiles.active=special`
+`./gradlew generateOpenApiDocs -Dspring.profiles.active=special`
 
 and as long as the config looks as follows that value will be passed into the forked
 spring boot application.

src/main/kotlin/org/springdoc/openapi/gradle/plugin/OpenApiGradlePlugin.kt

@@ -59,10 +59,13 @@ open class OpenApiGradlePlugin : Plugin<Project> {
 			fork.onlyIf { needToFork(bootRunTask, customBootRun, fork) }
 		}
 
-		// This is my task. Before I can run it, I have to run the dependent tasks
 		val openApiTask =
 			tasks.named(OPEN_API_TASK_NAME, OpenApiGeneratorTask::class.java) {
+				// This is my task. Before I can run it, I have to run the dependent tasks
 				it.dependsOn(forkedSpringBoot)
+
+				// Ensure the task inputs match those of the original application
+				it.inputs.files(bootRunTask.get().inputs.files)
 			}
 
 		// The forked task need to be terminated as soon as my task is finished

src/test/kotlin/org/springdoc/openapi/gradle/plugin/OpenApiGradlePluginTest.kt

@@ -386,6 +386,60 @@ class OpenApiGradlePluginTest {
 		assertTrue(servers!!.any { s -> s.get("url").equals("http://$customHost:$customPort") })
 	}
 
+	@Test
+	fun `running the same build keeps the OpenAPI task up to date`() {
+		buildFile.writeText(
+			"""
+			$baseBuildGradle
+            openApi {}
+			""".trimMargin()
+		)
+
+		// Run the first build to generate the OpenAPI file
+		assertEquals(TaskOutcome.SUCCESS, openApiDocsTask(runTheBuild()).outcome)
+		assertOpenApiJsonFile(1)
+
+		// Rerunning the build does not regenerate the OpenAPI file
+		assertEquals(TaskOutcome.UP_TO_DATE, openApiDocsTask(runTheBuild()).outcome)
+		assertOpenApiJsonFile(1)
+	}
+
+	@Test
+	fun `changing the source code regenerates the OpenAPI`() {
+		buildFile.writeText(
+			"""
+			$baseBuildGradle
+            openApi {}
+			""".trimMargin()
+		)
+
+		// Run the first build to generate the OpenAPI file
+		assertEquals(TaskOutcome.SUCCESS, openApiDocsTask(runTheBuild()).outcome)
+		assertOpenApiJsonFile(1)
+
+		val addedFile = projectTestDir.resolve("src/main/java/com/example/demo/endpoints/AddedController.java")
+		addedFile.createNewFile()
+		addedFile.writeText("""
+			package com.example.demo.endpoints;
+
+			import org.springframework.web.bind.annotation.GetMapping;
+			import org.springframework.web.bind.annotation.RestController;
+
+			@RestController
+			public class AddedController {
+
+				@GetMapping("/added")
+				public String added() {
+					return "Added file";
+				}
+			}
+		""".trimIndent())
+
+		// Run the same build with added source file
+		assertEquals(TaskOutcome.SUCCESS, openApiDocsTask(runTheBuild()).outcome)
+		assertOpenApiJsonFile(2)
+	}
+
 	private fun runTheBuild(vararg additionalArguments: String = emptyArray()) =
 		GradleRunner.create()
 			.withProjectDir(projectTestDir)