Skip to content

Commit

Permalink
Add more Gradle test coverage for issue #3136.
Browse files Browse the repository at this point in the history 
This CL adds tests for @BINDS usages with scopes and qualifiers.

RELNOTES=N/A
PiperOrigin-RevId: 422618557
  • Loading branch information
@bcorso
bcorso authored and Dagger Team committed Jan 18, 2022
1 parent 5502cd7 commit 505afed
Show file tree
Hide file tree
Showing 2 changed files with 454 additions and 0 deletions.
226 changes: 226 additions & 0 deletions ...s/artifacts/dagger/build-tests/src/test/java/buildtests/TransitiveBindsQualifierTest.java
View file
@@ -0,0 +1,226 @@
/*
* Copyright (C) 2022 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 static org.gradle.testkit.runner.TaskOutcome.SUCCESS;

import java.io.File;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collection;
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.Parameterized;
import org.junit.runners.Parameterized.Parameters;

// This is a regression test for https://github.com/google/dagger/issues/3136
@RunWith(Parameterized.class)
public class TransitiveBindsQualifierTest {
@Parameters(name = "{0}")
public static Collection<Object[]> parameters() {
return Arrays.asList(new Object[][] {{ "implementation" }, { "api" }});
}

@Rule public TemporaryFolder folder = new TemporaryFolder();

private final String transitiveDependencyType;

public TransitiveBindsQualifierTest(String transitiveDependencyType) {
this.transitiveDependencyType = transitiveDependencyType;
}

@Test
public void testQualifierOnBindsMethod() throws IOException {
BuildResult result = setupBuildWith();
switch (transitiveDependencyType) {
case "implementation":
// TODO(bcorso): This is a repro of https://github.com/google/dagger/issues/3136, where
// a qualifier will be missing if the it is not in the classpath during compilation.
// Once the issue is fixed, this test case should fail to build.
assertThat(result.task(":app:assemble").getOutcome()).isEqualTo(SUCCESS);
assertThat(result.getOutput())
.contains("BINDINGS: ["
+ "java.lang.Object, "
+ "java.lang.Number, "
+ "java.lang.Integer"
+ "]");
break;
case "api":
assertThat(result.task(":app:assemble").getOutcome()).isEqualTo(SUCCESS);
assertThat(result.getOutput())
.contains("BINDINGS: ["
+ "@library2.MyQualifier java.lang.Object, "
+ "@library2.MyQualifier java.lang.Number, "
+ "java.lang.Integer"
+ "]");
break;
}
}

private BuildResult setupBuildWith() throws IOException {
File projectDir = folder.getRoot();
GradleModule.create(projectDir)
.addSettingsFile(
"include 'app'",
"include 'library1'",
"include 'library2'",
"include 'spi-plugin'")
.addBuildFile(
"buildscript {",
" ext {",
String.format("dagger_version = \"%s\"", System.getProperty("dagger_version")),
" }",
"}",
"",
"allprojects {",
" repositories {",
" mavenCentral()",
" mavenLocal()",
" }",
"}");

GradleModule.create(projectDir, "app")
.addBuildFile(
"plugins {",
" id 'java'",
" id 'application'",
"}",
"compileJava {",
" options.compilerArgs << '-Adagger.pluginsVisitFullBindingGraphs=ENABLED'",
"}",
"dependencies {",
" implementation project(':library1')",
" annotationProcessor project(':spi-plugin')",
" implementation \"com.google.dagger:dagger:$dagger_version\"",
" annotationProcessor \"com.google.dagger:dagger-compiler:$dagger_version\"",
"}")
.addSrcFile(
"MyComponent.java",
"package app;",
"",
"import dagger.BindsInstance;",
"import dagger.Component;",
"import library1.MyModule;",
"",
"@Component(modules = MyModule.class)",
"public interface MyComponent {",
" @Component.Factory",
" interface Factory {",
" MyComponent create(@BindsInstance int i);",
" }",
"}");

GradleModule.create(projectDir, "library1")
.addBuildFile(
"plugins {",
" id 'java'",
" id 'java-library'",
"}",
"dependencies {",
transitiveDependencyType + " project(':library2')",
" implementation \"com.google.dagger:dagger:$dagger_version\"",
" annotationProcessor \"com.google.dagger:dagger-compiler:$dagger_version\"",
"}")
.addSrcFile(
"MyModule.java",
"package library1;",
"",
"import dagger.Binds;",
"import dagger.Module;",
"import dagger.Provides;",
"import library2.MyQualifier;",
"",
"@Module",
"public interface MyModule {",
" @Binds",
" @MyQualifier",
" Object bindObject(@MyQualifier Number number);",
"",
" @Binds",
" @MyQualifier",
" Number bindNumber(int i);",
"}");

GradleModule.create(projectDir, "library2")
.addBuildFile(
"plugins {",
" id 'java'",
" id 'java-library'",
"}",
"dependencies {",
" implementation 'javax.inject:javax.inject:1'",
"}")
.addSrcFile(
"MyQualifier.java",
"package library2;",
"",
"import javax.inject.Qualifier;",
"",
"@Qualifier",
"public @interface MyQualifier {}");

// This plugin is used to print output about bindings that we can assert on in tests.
GradleModule.create(projectDir, "spi-plugin")
.addBuildFile(
"plugins {",
" id 'java'",
"}",
"dependencies {",
" implementation \"com.google.dagger:dagger-spi:$dagger_version\"",
" implementation 'com.google.auto.service:auto-service-annotations:1.0.1'",
" annotationProcessor 'com.google.auto.service:auto-service:1.0.1'",
"}")
.addSrcFile(
"TestBindingGraphPlugin.java",
"package spiplugin;",
"",
"import com.google.auto.service.AutoService;",
"import dagger.model.Binding;",
"import dagger.model.BindingGraph;",
"import dagger.model.BindingGraph.DependencyEdge;",
"import dagger.model.DependencyRequest;",
"import dagger.spi.BindingGraphPlugin;",
"import dagger.spi.DiagnosticReporter;",
"import java.util.stream.Collectors;",
"",
"@AutoService(BindingGraphPlugin.class)",
"public class TestBindingGraphPlugin implements BindingGraphPlugin {",
" @Override",
" public void visitGraph(",
" BindingGraph bindingGraph, DiagnosticReporter diagnosticReporter) {",
" if (!bindingGraph.isFullBindingGraph() || bindingGraph.isModuleBindingGraph()) {",
" return;",
" }",
" System.out.print(",
" \"BINDINGS: \"",
" + bindingGraph.bindings().stream()",
" .map(Binding::key)",
" .collect(Collectors.toList()));",
" }",
"}");

return GradleRunner.create()
.withArguments("--stacktrace", "build")
.withProjectDir(projectDir)
.build();
}
}

0 comments on commit 505afed

Please sign in to comment.