aboutsummaryrefslogtreecommitdiff
path: root/javatests/dagger/internal/codegen/MissingBindingSuggestionsTest.java
blob: 5e64c12a78752d1e64b1900e1cd7038aaee499ba (plain)
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
/*
 * Copyright (C) 2015 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 androidx.room.compiler.processing.util.Source;
import com.google.common.collect.ImmutableList;
import dagger.testing.compile.CompilerTests;
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 MissingBindingSuggestionsTest {
  @Parameters(name = "{0}")
  public static ImmutableList<Object[]> parameters() {
    return CompilerMode.TEST_PARAMETERS;
  }

  private final CompilerMode compilerMode;

  public MissingBindingSuggestionsTest(CompilerMode compilerMode) {
    this.compilerMode = compilerMode;
  }

  private static Source injectable(String className, String constructorParams) {
    return CompilerTests.javaSource(
        "test." + className,
        "package test;",
        "",
        "import javax.inject.Inject;",
        "",
        "class " + className + " {",
        "  @Inject " + className + "(" + constructorParams + ") {}",
        "}");
  }

  private static Source emptyInterface(String interfaceName) {
    return CompilerTests.javaSource(
        "test." + interfaceName,
        "package test;",
        "",
        "import javax.inject.Inject;",
        "",
        "interface " + interfaceName + " {}");
  }

  @Test public void suggestsBindingInSeparateComponent() {
    Source fooComponent =
        CompilerTests.javaSource(
            "test.FooComponent",
            "package test;",
            "",
            "import dagger.Subcomponent;",
            "",
            "@Subcomponent",
            "interface FooComponent {",
            "  Foo getFoo();",
            "}");
    Source barModule =
        CompilerTests.javaSource(
            "test.BarModule",
            "package test;",
            "",
            "import dagger.Provides;",
            "import javax.inject.Inject;",
            "",
            "@dagger.Module",
            "final class BarModule {",
            "  @Provides Bar provideBar() {return null;}",
            "}");
    Source barComponent =
        CompilerTests.javaSource(
            "test.BarComponent",
            "package test;",
            "",
            "import dagger.Subcomponent;",
            "",
            "@Subcomponent(modules = {BarModule.class})",
            "interface BarComponent {",
            "  Bar getBar();",
            "}");
    Source foo = injectable("Foo", "Bar bar");
    Source bar = emptyInterface("Bar");

    Source topComponent =
        CompilerTests.javaSource(
            "test.TopComponent",
            "package test;",
            "",
            "import dagger.Component;",
            "",
            "@Component",
            "interface TopComponent {",
            "  FooComponent getFoo();",
            "  BarComponent getBar(BarModule barModule);",
            "}");

    CompilerTests.daggerCompiler(fooComponent, barComponent, topComponent, foo, bar, barModule)
        .withProcessingOptions(compilerMode.processorOptions())
        .compile(
            subject -> {
              subject.hasErrorCount(1);
              subject.hasErrorContaining("A binding for Bar exists in BarComponent:");
            });
  }

  @Test public void suggestsBindingInNestedSubcomponent() {
    Source fooComponent =
        CompilerTests.javaSource(
            "test.FooComponent",
            "package test;",
            "",
            "import dagger.Subcomponent;",
            "",
            "@Subcomponent",
            "interface FooComponent {",
            "  Foo getFoo();",
            "}");
    Source barComponent =
        CompilerTests.javaSource(
            "test.BarComponent",
            "package test;",
            "",
            "import dagger.Subcomponent;",
            "",
            "@Subcomponent()",
            "interface BarComponent {",
            "  BazComponent getBaz();",
            "}");
    Source bazModule =
        CompilerTests.javaSource(
            "test.BazModule",
            "package test;",
            "",
            "import dagger.Provides;",
            "import javax.inject.Inject;",
            "",
            "@dagger.Module",
            "final class BazModule {",
            "  @Provides Baz provideBaz() {return null;}",
            "}");
    Source bazComponent =
        CompilerTests.javaSource(
            "test.BazComponent",
            "package test;",
            "",
            "import dagger.Subcomponent;",
            "",
            "@Subcomponent(modules = {BazModule.class})",
            "interface BazComponent {",
            "  Baz getBaz();",
            "}");
    Source foo = injectable("Foo", "Baz baz");
    Source baz = emptyInterface("Baz");

    Source topComponent =
        CompilerTests.javaSource(
            "test.TopComponent",
            "package test;",
            "",
            "import dagger.Component;",
            "",
            "@Component",
            "interface TopComponent {",
            "  FooComponent getFoo();",
            "  BarComponent getBar();",
            "}");

    CompilerTests.daggerCompiler(
            fooComponent, barComponent, bazComponent, topComponent, foo, baz, bazModule)
        .withProcessingOptions(compilerMode.processorOptions())
        .compile(
            subject -> {
              subject.hasErrorCount(1);
              subject.hasErrorContaining("A binding for Baz exists in BazComponent:");
            });
  }

  @Test
  public void missingBindingInParentComponent() {
    Source parent =
        CompilerTests.javaSource(
            "Parent",
            "import dagger.Component;",
            "",
            "@Component",
            "interface Parent {",
            "  Foo foo();",
            "  Bar bar();",
            "  Child child();",
            "}");
    Source child =
        CompilerTests.javaSource(
            "Child",
            "import dagger.Subcomponent;",
            "",
            "@Subcomponent(modules=BazModule.class)",
            "interface Child {",
            "  Foo foo();",
            "  Baz baz();",
            "}");
    Source foo =
        CompilerTests.javaSource(
            "Foo",
            "import javax.inject.Inject;",
            "",
            "class Foo {",
            "  @Inject Foo(Bar bar) {}",
            "}");
    Source bar =
        CompilerTests.javaSource(
            "Bar",
            "import javax.inject.Inject;",
            "",
            "class Bar {",
            "  @Inject Bar(Baz baz) {}",
            "}");
    Source baz = CompilerTests.javaSource("Baz", "class Baz {}");
    Source bazModule =
        CompilerTests.javaSource(
        "BazModule",
        "import dagger.Module;",
        "import dagger.Provides;",
        "import javax.inject.Inject;",
        "",
        "@Module",
        "final class BazModule {",
        "  @Provides Baz provideBaz() {return new Baz();}",
        "}");

    CompilerTests.daggerCompiler(parent, child, foo, bar, baz, bazModule)
        .withProcessingOptions(compilerMode.processorOptions())
        .compile(
            subject -> {
              subject.hasErrorCount(1);
              subject.hasErrorContaining(
                  "\033[1;31m[Dagger/MissingBinding]\033[0m Baz cannot be provided without an "
                    + "@Inject constructor or an @Provides-annotated method.");
              subject.hasErrorContaining("A binding for Baz exists in Child:");
              subject.hasErrorContaining("    Baz is injected at");
              subject.hasErrorContaining("        [Parent] Bar(baz)");
              subject.hasErrorContaining("    Bar is requested at");
              subject.hasErrorContaining("        [Parent] Parent.bar()");
              subject.hasErrorContaining("The following other entry points also depend on it:");
              subject.hasErrorContaining("    Parent.foo()");
              subject.hasErrorContaining("    Child.foo() [Parent → Child]")
                  .onSource(parent)
                  .onLineContaining("interface Parent");
            });
  }

  @Test
  public void missingBindingInSiblingComponent() {
    Source parent =
        CompilerTests.javaSource(
            "Parent",
            "import dagger.Component;",
            "",
            "@Component",
            "interface Parent {",
            "  Foo foo();",
            "  Bar bar();",
            "  Child1 child1();",
            "  Child2 child2();",
            "}");
    Source child1 =
        CompilerTests.javaSource(
            "Child1",
            "import dagger.Subcomponent;",
            "",
            "@Subcomponent",
            "interface Child1 {",
            "  Foo foo();",
            "  Baz baz();",
            "}");
    Source child2 =
        CompilerTests.javaSource(
            "Child2",
            "import dagger.Subcomponent;",
            "",
            "@Subcomponent(modules = BazModule.class)",
            "interface Child2 {",
            "  Foo foo();",
            "  Baz baz();",
            "}");
    Source foo =
        CompilerTests.javaSource(
            "Foo",
            "import javax.inject.Inject;",
            "",
            "class Foo {",
            "  @Inject Foo(Bar bar) {}",
            "}");
    Source bar =
        CompilerTests.javaSource(
            "Bar",
            "import javax.inject.Inject;",
            "",
            "class Bar {",
            "  @Inject Bar(Baz baz) {}",
            "}");
    Source baz = CompilerTests.javaSource("Baz", "class Baz {}");
    Source bazModule =
        CompilerTests.javaSource(
        "BazModule",
        "import dagger.Module;",
        "import dagger.Provides;",
        "import javax.inject.Inject;",
        "",
        "@Module",
        "final class BazModule {",
        "  @Provides Baz provideBaz() {return new Baz();}",
        "}");

    CompilerTests.daggerCompiler(parent, child1, child2, foo, bar, baz, bazModule)
        .withProcessingOptions(compilerMode.processorOptions())
        .compile(
            subject -> {
              subject.hasErrorCount(1);
              subject.hasErrorContaining(
                  "\033[1;31m[Dagger/MissingBinding]\033[0m Baz cannot be provided without an "
                      + "@Inject constructor or an @Provides-annotated method.");
              subject.hasErrorContaining("A binding for Baz exists in Child2:");
              subject.hasErrorContaining("    Baz is injected at");
              subject.hasErrorContaining("        [Parent] Bar(baz)");
              subject.hasErrorContaining("    Bar is requested at");
              subject.hasErrorContaining("        [Parent] Parent.bar()");
              subject.hasErrorContaining("The following other entry points also depend on it:");
              subject.hasErrorContaining("    Parent.foo()");
              subject.hasErrorContaining("    Child1.foo() [Parent → Child1]");
              subject.hasErrorContaining("    Child2.foo() [Parent → Child2]");
              subject.hasErrorContaining("    Child1.baz() [Parent → Child1]")
                  .onSource(parent)
                  .onLineContaining("interface Parent");
            });
  }
}