forked from square/dagger
-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix Dagger's incremental processing for KSP.
This change should be temporary until we can get a more robust fix in KSP (google/ksp#1555). Fixes #4063 Fixes #4054 RELNOTES=N/A PiperOrigin-RevId: 569608460
- Loading branch information
Showing
5 changed files
with
226 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
144 changes: 144 additions & 0 deletions
144
...ests/artifacts/dagger/build-tests/src/test/java/buildtests/IncrementalProcessingTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| /* | ||
| * Copyright (C) 2023 The Dagger Authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package buildtests; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.util.Set; | ||
| import java.util.stream.Collectors; | ||
| import org.gradle.testkit.runner.BuildResult; | ||
| import org.gradle.testkit.runner.GradleRunner; | ||
| import org.junit.Rule; | ||
| import org.junit.Test; | ||
| import org.junit.rules.TemporaryFolder; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| // This is a regression test for https://github.com/google/dagger/issues/4054 | ||
| @RunWith(JUnit4.class) | ||
| public class IncrementalProcessingTest { | ||
| @Rule public TemporaryFolder tmpFolder = new TemporaryFolder(); | ||
|
|
||
| @Test | ||
| public void testIncrementalProcessing() throws IOException { | ||
| File projectDir = tmpFolder.getRoot(); | ||
| GradleModule.create(projectDir) | ||
| .addSettingsFile("include 'app'") | ||
| .addBuildFile( | ||
| "buildscript {", | ||
| " ext {", | ||
| String.format("dagger_version = \"%s\"", System.getProperty("dagger_version")), | ||
| String.format("kotlin_version = \"%s\"", System.getProperty("kotlin_version")), | ||
| String.format("ksp_version = \"%s\"", System.getProperty("ksp_version")), | ||
| " }", | ||
| "}", | ||
| "", | ||
| "allprojects {", | ||
| " repositories {", | ||
| " mavenCentral()", | ||
| " mavenLocal()", | ||
| " }", | ||
| "}"); | ||
|
|
||
| GradleModule appModule = | ||
| GradleModule.create(projectDir, "app") | ||
| .addBuildFile( | ||
| "plugins {", | ||
| " id 'application'", | ||
| " id 'org.jetbrains.kotlin.jvm' version \"$kotlin_version\"", | ||
| " id 'com.google.devtools.ksp' version \"$ksp_version\"", | ||
| "}", | ||
| "dependencies {", | ||
| " implementation \"org.jetbrains.kotlin:kotlin-stdlib\"", | ||
| " implementation \"com.google.dagger:dagger:$dagger_version\"", | ||
| " ksp \"com.google.dagger:dagger-compiler:$dagger_version\"", | ||
| "}") | ||
| // Note: both A and AFactory need to be in the same source file for this to test the | ||
| // regression in https://github.com/google/dagger/issues/4054. | ||
| .addSrcFile( | ||
| "A.kt", | ||
| "package app", | ||
| "", | ||
| "import dagger.assisted.AssistedFactory", | ||
| "import dagger.assisted.AssistedInject", | ||
| "", | ||
| "class A @AssistedInject constructor()", | ||
| "", | ||
| "@AssistedFactory", | ||
| "interface AFactory {", | ||
| " fun create(): A", | ||
| "}"); | ||
|
|
||
| // We'll be changing the contents of MyComponent between builds, so store it in a variable. | ||
| String myComponentContent = | ||
| String.join( | ||
| "\n", | ||
| "package app", | ||
| "", | ||
| "import dagger.Component", | ||
| "", | ||
| "@Component", | ||
| "interface MyComponent {", | ||
| " fun factory(): AFactory", | ||
| "}"); | ||
| appModule.addSrcFile("MyComponent.kt", myComponentContent); | ||
|
|
||
| // Build #1 | ||
| build(projectDir); | ||
| assertThat(getAllKspGeneratedFileNames(appModule.getDir())) | ||
| .containsExactly( | ||
| "A_Factory.java", | ||
| "AFactory_Impl.java", | ||
| "DaggerMyComponent.java"); | ||
|
|
||
| // Change method name in MyComponent.kt to trigger incremental processing of only MyComponent. | ||
| appModule.addSrcFile("MyComponent.kt", myComponentContent.replace("factory()", "factory2()")); | ||
|
|
||
| // Build #2 | ||
| build(projectDir); | ||
| assertThat(getAllKspGeneratedFileNames(appModule.getDir())) | ||
| .containsExactly( | ||
| "A_Factory.java", | ||
| "AFactory_Impl.java", | ||
| "DaggerMyComponent.java"); | ||
| } | ||
|
|
||
| private static BuildResult build(File projectDir) { | ||
| return GradleRunner.create() | ||
| .withArguments("--stacktrace", "build") | ||
| .withProjectDir(projectDir) | ||
| .build(); | ||
| } | ||
|
|
||
| private static Set<String> getAllKspGeneratedFileNames(Path moduleDir) throws IOException { | ||
| return getAllFileNames(moduleDir.resolve("build/generated/ksp/main/java/")); | ||
| } | ||
|
|
||
| private static Set<String> getAllFileNames(Path dir) throws IOException { | ||
| if (!Files.isDirectory(dir)) { | ||
| throw new IllegalArgumentException("Expected directory: " + dir); | ||
| } | ||
| return Files.walk(dir) | ||
| .filter(Files::isRegularFile) | ||
| .map(file -> file.getFileName().toString()) | ||
| .collect(Collectors.toSet()); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters