aboutsummaryrefslogtreecommitdiff
path: root/javatests/dagger/hilt/android/processor/internal/androidentrypoint/AndroidEntryPointProcessorTest.java
blob: 0c11f6eb5b326022b058a23e853c50c4fc016015 (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
/*
 * Copyright (C) 2020 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.hilt.android.processor.internal.androidentrypoint;

import androidx.room.compiler.processing.XProcessingEnv;
import androidx.room.compiler.processing.XProcessingEnv.Backend;
import androidx.room.compiler.processing.util.CompilationResultSubject;
import androidx.room.compiler.processing.util.Source;
import com.google.common.collect.ImmutableMap;
import dagger.hilt.android.testing.compile.HiltCompilerTests;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

@RunWith(JUnit4.class)
public class AndroidEntryPointProcessorTest {
  @Test
  public void testAndroidEntryPoint() {
    Source testActivity =
        HiltCompilerTests.javaSource(
            "test.MyActivity",
            "package test;",
            "",
            "import androidx.activity.ComponentActivity;",
            "import dagger.hilt.android.AndroidEntryPoint;",
            "",
            "@AndroidEntryPoint(ComponentActivity.class)",
            "public class MyActivity extends Hilt_MyActivity {}");

    HiltCompilerTests.hiltCompiler(testActivity)
        .compile(
            (CompilationResultSubject subject) -> {
              subject.hasErrorCount(0);
              subject.generatedSourceFileWithPath("test/Hilt_MyActivity.java");
            });
  }

  @Test
  public void missingBaseClass() {
    Source testActivity =
        HiltCompilerTests.javaSource(
            "test.MyActivity",
            "package test;",
            "",
            "import androidx.activity.ComponentActivity;",
            "import dagger.hilt.android.AndroidEntryPoint;",
            "",
            "@AndroidEntryPoint",
            "public class MyActivity extends ComponentActivity { }");
    HiltCompilerTests.hiltCompiler(testActivity)
        .compile(
            (CompilationResultSubject subject) -> {
              subject.hasErrorCount(1);
              subject
                  .hasErrorContaining("Expected @AndroidEntryPoint to have a value.")
                  ;
            });
  }

  @Test
  public void incorrectSuperclass() {
    Source testActivity =
        HiltCompilerTests.javaSource(
            "test.MyActivity",
            "package test;",
            "",
            "import androidx.activity.ComponentActivity;",
            "import dagger.hilt.android.AndroidEntryPoint;",
            "",
            "@AndroidEntryPoint(ComponentActivity.class)",
            "public class MyActivity extends ComponentActivity { }");
    HiltCompilerTests.hiltCompiler(testActivity)
        .compile(
            (CompilationResultSubject subject) -> {
              // TODO(b/288210593): Add this check back to KSP once this bug is fixed.
              if (HiltCompilerTests.backend(subject) == XProcessingEnv.Backend.KSP) {
                subject.hasErrorCount(0);
              } else {
                subject.hasErrorCount(1);
                subject
                    .hasErrorContaining(
                        "@AndroidEntryPoint class expected to extend Hilt_MyActivity. "
                            + "Found: ComponentActivity")
                    ;
              }
            });
  }

  @Test
  public void disableSuperclassValidation_activity() {
    Source testActivity =
        HiltCompilerTests.javaSource(
            "test.MyActivity",
            "package test;",
            "",
            "import androidx.activity.ComponentActivity;",
            "import dagger.hilt.android.AndroidEntryPoint;",
            "",
            "@AndroidEntryPoint",
            "public class MyActivity extends ComponentActivity { }");
    HiltCompilerTests.hiltCompiler(testActivity)
        .withProcessorOptions(
            ImmutableMap.of(
                "dagger.hilt.android.internal.disableAndroidSuperclassValidation", "true"))
        .compile(subject -> subject.hasErrorCount(0));
  }

  @Test
  public void disableSuperclassValidation_application() {
    Source testApplication =
        HiltCompilerTests.javaSource(
            "test.MyApp",
            "package test;",
            "",
            "import android.app.Application;",
            "import dagger.hilt.android.HiltAndroidApp;",
            "",
            "@HiltAndroidApp",
            "public class MyApp extends Application { }");
    HiltCompilerTests.hiltCompiler(testApplication)
        .withProcessorOptions(
            ImmutableMap.of(
                "dagger.hilt.android.internal.disableAndroidSuperclassValidation", "true"))
        .compile(subject -> subject.hasErrorCount(0));
  }

  @Test
  public void checkBaseActivityExtendsComponentActivity() {
    Source testActivity =
        HiltCompilerTests.javaSource(
            "test.MyActivity",
            "package test;",
            "",
            "import android.app.Activity;",
            "import dagger.hilt.android.AndroidEntryPoint;",
            "",
            "@AndroidEntryPoint(Activity.class)",
            "public class MyActivity extends Hilt_MyActivity { }");
    HiltCompilerTests.hiltCompiler(testActivity).compile(subject -> {
        subject.compilationDidFail();
        subject.hasErrorContaining(
            "Activities annotated with @AndroidEntryPoint must be a subclass of "
                + "androidx.activity.ComponentActivity. (e.g. FragmentActivity, AppCompatActivity, "
                + "etc.)"); });
  }

  @Test
  public void checkBaseActivityWithTypeParameters() {
    Source testActivity =
        HiltCompilerTests.javaSource(
            "test.BaseActivity",
            "package test;",
            "",
            "import androidx.activity.ComponentActivity;",
            "import dagger.hilt.android.AndroidEntryPoint;",
            "",
            "@AndroidEntryPoint(ComponentActivity.class)",
            "public class BaseActivity<T> extends Hilt_BaseActivity {}");
    HiltCompilerTests.hiltCompiler(testActivity)
        .compile(
            subject -> {
              subject.compilationDidFail();
              if (HiltCompilerTests.backend(subject) == Backend.JAVAC) {
                subject.hasErrorCount(2);
              } else {
                subject.hasErrorCount(1);
              }
              subject.hasErrorContaining(
                  "@AndroidEntryPoint-annotated classes cannot have type parameters.");
            });
  }

  @Test
  public void checkAndroidEntryPointOnApplicationRecommendsHiltAndroidApp() {
    Source testActivity =
        HiltCompilerTests.javaSource(
            "test.MyApplication",
            "package test;",
            "",
            "import android.app.Application;",
            "import dagger.hilt.android.AndroidEntryPoint;",
            "",
            "@AndroidEntryPoint(Application.class)",
            "public class MyApplication extends Hilt_MyApplication { }");
    HiltCompilerTests.hiltCompiler(testActivity)
        .compile(
            (CompilationResultSubject subject) -> {
              if (HiltCompilerTests.backend(subject) == XProcessingEnv.Backend.KSP) {
                subject.hasErrorCount(1);
              } else {
                // Javac has an extra error due to the missing symbol.
                subject.hasErrorCount(2);
                subject.hasErrorContaining(
                    "cannot find symbol\n      symbol: class Hilt_MyApplication");
              }
              subject.hasErrorContaining(
                  "@AndroidEntryPoint cannot be used on an Application. "
                      + "Use @HiltAndroidApp instead.");
            });
  }
}