1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
/*
* 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 dagger.internal.codegen;
import static com.google.testing.compile.CompilationSubject.assertThat;
import static dagger.internal.codegen.Compilers.compilerWithOptions;
import com.google.common.collect.ImmutableList;
import com.google.testing.compile.Compilation;
import com.google.testing.compile.JavaFileObjects;
import dagger.testing.golden.GoldenFileRule;
import java.util.Collection;
import javax.tools.JavaFileObject;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;
@RunWith(Parameterized.class)
public class InaccessibleTypeBindsTest {
@Parameters(name = "{0}")
public static Collection<Object[]> parameters() {
return ImmutableList.copyOf(
new Object[][] {
{CompilerMode.DEFAULT_MODE},
{CompilerMode.DEFAULT_JAVA7_MODE},
{CompilerMode.FAST_INIT_MODE},
// FastInit with Java7 is the mode that motivated this test, but do the other
// modes anyway for completeness.
{CompilerMode.FAST_INIT_JAVA7_MODE}
});
}
@Rule public GoldenFileRule goldenFileRule = new GoldenFileRule();
private final CompilerMode compilerMode;
public InaccessibleTypeBindsTest(CompilerMode compilerMode) {
this.compilerMode = compilerMode;
}
// Interface is accessible, but the impl is not. Use with a scoped binds to make sure type issues
// are handled from doing an assignment to the Provider<Foo> from DoubleCheck.provider(fooImpl).
@Test
public void scopedInaccessibleTypeBound() throws Exception {
JavaFileObject foo =
JavaFileObjects.forSourceLines(
"test.Foo",
"package test;",
"",
"public interface Foo {",
"}");
JavaFileObject fooImpl =
JavaFileObjects.forSourceLines(
"other.FooImpl",
"package other;",
"",
"import javax.inject.Inject;",
"import test.Foo;",
"",
"final class FooImpl implements Foo {",
" @Inject FooImpl() {}",
"}");
JavaFileObject module =
JavaFileObjects.forSourceLines(
"other.TestModule",
"package other;",
"",
"import dagger.Module;",
"import dagger.Binds;",
"import javax.inject.Singleton;",
"import test.Foo;",
"",
"@Module",
"public interface TestModule {",
" @Binds",
" @Singleton",
" Foo bind(FooImpl impl);",
"}");
JavaFileObject component =
JavaFileObjects.forSourceLines(
"test.TestComponent",
"package test;",
"",
"import dagger.Component;",
"import javax.inject.Provider;",
"import javax.inject.Singleton;",
"import other.TestModule;",
"",
"@Singleton",
"@Component(modules = TestModule.class)",
"interface TestComponent {",
" Foo getFoo();",
"}");
Compilation compilation =
compilerWithOptions(compilerMode)
.compile(foo, fooImpl, module, component);
assertThat(compilation).succeeded();
assertThat(compilation)
.generatedSourceFile("test.DaggerTestComponent")
.hasSourceEquivalentTo(goldenFileRule.goldenFile("test.DaggerTestComponent"));
}
// Interface is accessible, but the impl is not. Used with a binds in a loop to see if there are
// type issues from doing an assignment to the delegate factory e.g.
// DelegateFactory.setDelegate(provider, new SwitchingProvider<FooImpl>(...));
@Test
public void inaccessibleTypeBoundInALoop() throws Exception {
JavaFileObject foo =
JavaFileObjects.forSourceLines(
"test.Foo",
"package test;",
"",
"public interface Foo {",
"}");
JavaFileObject fooImpl =
JavaFileObjects.forSourceLines(
"other.FooImpl",
"package other;",
"",
"import javax.inject.Inject;",
"import javax.inject.Provider;",
"import test.Foo;",
"",
"final class FooImpl implements Foo {",
" @Inject FooImpl(Provider<Foo> fooProvider) {}",
"}");
// Use another entry point to make FooImpl be the first requested class, that way FooImpl's
// provider is the one that is delegated.
JavaFileObject otherEntryPoint =
JavaFileObjects.forSourceLines(
"other.OtherEntryPoint",
"package other;",
"",
"import javax.inject.Inject;",
"",
"public final class OtherEntryPoint {",
" @Inject OtherEntryPoint(FooImpl impl) {}",
"}");
JavaFileObject module =
JavaFileObjects.forSourceLines(
"other.TestModule",
"package other;",
"",
"import dagger.Module;",
"import dagger.Binds;",
"import test.Foo;",
"",
"@Module",
"public interface TestModule {",
" @Binds",
" Foo bind(FooImpl impl);",
"}");
JavaFileObject component =
JavaFileObjects.forSourceLines(
"test.TestComponent",
"package test;",
"",
"import dagger.Component;",
"import other.OtherEntryPoint;",
"import other.TestModule;",
"",
"@Component(modules = TestModule.class)",
"interface TestComponent {",
" OtherEntryPoint getOtherEntryPoint();",
"}");
Compilation compilation =
compilerWithOptions(compilerMode)
.compile(foo, fooImpl, otherEntryPoint, module, component);
assertThat(compilation).succeeded();
assertThat(compilation)
.generatedSourceFile("test.DaggerTestComponent")
.hasSourceEquivalentTo(goldenFileRule.goldenFile("test.DaggerTestComponent"));
}
// Same as above but with the binding scoped.
@Test
public void inaccessibleTypeBoundInALoopScoped() throws Exception {
JavaFileObject foo =
JavaFileObjects.forSourceLines(
"test.Foo",
"package test;",
"",
"public interface Foo {",
"}");
JavaFileObject fooImpl =
JavaFileObjects.forSourceLines(
"other.FooImpl",
"package other;",
"",
"import javax.inject.Inject;",
"import javax.inject.Provider;",
"import test.Foo;",
"",
"final class FooImpl implements Foo {",
" @Inject FooImpl(Provider<Foo> fooProvider) {}",
"}");
// Use another entry point to make FooImpl be the first requested class, that way FooImpl's
// provider is the one that is delegated.
JavaFileObject otherEntryPoint =
JavaFileObjects.forSourceLines(
"other.OtherEntryPoint",
"package other;",
"",
"import javax.inject.Inject;",
"",
"public final class OtherEntryPoint {",
" @Inject OtherEntryPoint(FooImpl impl) {}",
"}");
JavaFileObject module =
JavaFileObjects.forSourceLines(
"other.TestModule",
"package other;",
"",
"import dagger.Module;",
"import dagger.Binds;",
"import javax.inject.Singleton;",
"import test.Foo;",
"",
"@Module",
"public interface TestModule {",
" @Binds",
" @Singleton",
" Foo bind(FooImpl impl);",
"}");
JavaFileObject component =
JavaFileObjects.forSourceLines(
"test.TestComponent",
"package test;",
"",
"import dagger.Component;",
"import javax.inject.Singleton;",
"import other.OtherEntryPoint;",
"import other.TestModule;",
"",
"@Singleton",
"@Component(modules = TestModule.class)",
"interface TestComponent {",
" OtherEntryPoint getOtherEntryPoint();",
"}");
Compilation compilation =
compilerWithOptions(compilerMode)
.compile(foo, fooImpl, otherEntryPoint, module, component);
assertThat(compilation).succeeded();
assertThat(compilation)
.generatedSourceFile("test.DaggerTestComponent")
.hasSourceEquivalentTo(goldenFileRule.goldenFile("test.DaggerTestComponent"));
}
}
|
