1// Copyright 2017 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17import (
18	"android/soong/android"
19	"strconv"
20	"strings"
21	"testing"
22)
23
24func TestKotlin(t *testing.T) {
25	ctx, _ := testJava(t, `
26		java_library {
27			name: "foo",
28			srcs: ["a.java", "b.kt"],
29		}
30
31		java_library {
32			name: "bar",
33			srcs: ["b.kt"],
34			libs: ["foo"],
35			static_libs: ["baz"],
36		}
37
38		java_library {
39			name: "baz",
40			srcs: ["c.java"],
41		}
42		`)
43
44	fooKotlinc := ctx.ModuleForTests("foo", "android_common").Rule("kotlinc")
45	fooJavac := ctx.ModuleForTests("foo", "android_common").Rule("javac")
46	fooJar := ctx.ModuleForTests("foo", "android_common").Output("combined/foo.jar")
47
48	if len(fooKotlinc.Inputs) != 2 || fooKotlinc.Inputs[0].String() != "a.java" ||
49		fooKotlinc.Inputs[1].String() != "b.kt" {
50		t.Errorf(`foo kotlinc inputs %v != ["a.java", "b.kt"]`, fooKotlinc.Inputs)
51	}
52
53	if len(fooJavac.Inputs) != 1 || fooJavac.Inputs[0].String() != "a.java" {
54		t.Errorf(`foo inputs %v != ["a.java"]`, fooJavac.Inputs)
55	}
56
57	if !strings.Contains(fooJavac.Args["classpath"], fooKotlinc.Output.String()) {
58		t.Errorf("foo classpath %v does not contain %q",
59			fooJavac.Args["classpath"], fooKotlinc.Output.String())
60	}
61
62	if !inList(fooKotlinc.Output.String(), fooJar.Inputs.Strings()) {
63		t.Errorf("foo jar inputs %v does not contain %q",
64			fooJar.Inputs.Strings(), fooKotlinc.Output.String())
65	}
66
67	fooHeaderJar := ctx.ModuleForTests("foo", "android_common").Output("turbine-combined/foo.jar")
68	bazHeaderJar := ctx.ModuleForTests("baz", "android_common").Output("turbine-combined/baz.jar")
69	barKotlinc := ctx.ModuleForTests("bar", "android_common").Rule("kotlinc")
70
71	if len(barKotlinc.Inputs) != 1 || barKotlinc.Inputs[0].String() != "b.kt" {
72		t.Errorf(`bar kotlinc inputs %v != ["b.kt"]`, barKotlinc.Inputs)
73	}
74
75	if !inList(fooHeaderJar.Output.String(), barKotlinc.Implicits.Strings()) {
76		t.Errorf(`expected %q in bar implicits %v`,
77			fooHeaderJar.Output.String(), barKotlinc.Implicits.Strings())
78	}
79
80	if !inList(bazHeaderJar.Output.String(), barKotlinc.Implicits.Strings()) {
81		t.Errorf(`expected %q in bar implicits %v`,
82			bazHeaderJar.Output.String(), barKotlinc.Implicits.Strings())
83	}
84}
85
86func TestKapt(t *testing.T) {
87	bp := `
88		java_library {
89			name: "foo",
90			srcs: ["a.java", "b.kt"],
91			plugins: ["bar", "baz"],
92			errorprone: {
93				extra_check_modules: ["my_check"],
94			},
95		}
96
97		java_plugin {
98			name: "bar",
99			processor_class: "com.bar",
100			srcs: ["b.java"],
101		}
102
103		java_plugin {
104			name: "baz",
105			processor_class: "com.baz",
106			srcs: ["b.java"],
107		}
108
109		java_plugin {
110			name: "my_check",
111			srcs: ["b.java"],
112		}
113	`
114	t.Run("", func(t *testing.T) {
115		ctx, _ := testJava(t, bp)
116
117		buildOS := android.BuildOs.String()
118
119		kapt := ctx.ModuleForTests("foo", "android_common").Rule("kapt")
120		kotlinc := ctx.ModuleForTests("foo", "android_common").Rule("kotlinc")
121		javac := ctx.ModuleForTests("foo", "android_common").Rule("javac")
122
123		bar := ctx.ModuleForTests("bar", buildOS+"_common").Rule("javac").Output.String()
124		baz := ctx.ModuleForTests("baz", buildOS+"_common").Rule("javac").Output.String()
125
126		// Test that the kotlin and java sources are passed to kapt and kotlinc
127		if len(kapt.Inputs) != 2 || kapt.Inputs[0].String() != "a.java" || kapt.Inputs[1].String() != "b.kt" {
128			t.Errorf(`foo kapt inputs %v != ["a.java", "b.kt"]`, kapt.Inputs)
129		}
130		if len(kotlinc.Inputs) != 2 || kotlinc.Inputs[0].String() != "a.java" || kotlinc.Inputs[1].String() != "b.kt" {
131			t.Errorf(`foo kotlinc inputs %v != ["a.java", "b.kt"]`, kotlinc.Inputs)
132		}
133
134		// Test that only the java sources are passed to javac
135		if len(javac.Inputs) != 1 || javac.Inputs[0].String() != "a.java" {
136			t.Errorf(`foo inputs %v != ["a.java"]`, javac.Inputs)
137		}
138
139		// Test that the kapt srcjar is a dependency of kotlinc and javac rules
140		if !inList(kapt.Output.String(), kotlinc.Implicits.Strings()) {
141			t.Errorf("expected %q in kotlinc implicits %v", kapt.Output.String(), kotlinc.Implicits.Strings())
142		}
143		if !inList(kapt.Output.String(), javac.Implicits.Strings()) {
144			t.Errorf("expected %q in javac implicits %v", kapt.Output.String(), javac.Implicits.Strings())
145		}
146
147		// Test that the kapt srcjar is extracted by the kotlinc and javac rules
148		if kotlinc.Args["srcJars"] != kapt.Output.String() {
149			t.Errorf("expected %q in kotlinc srcjars %v", kapt.Output.String(), kotlinc.Args["srcJars"])
150		}
151		if javac.Args["srcJars"] != kapt.Output.String() {
152			t.Errorf("expected %q in javac srcjars %v", kapt.Output.String(), kotlinc.Args["srcJars"])
153		}
154
155		// Test that the processors are passed to kapt
156		expectedProcessorPath := "-P plugin:org.jetbrains.kotlin.kapt3:apclasspath=" + bar +
157			" -P plugin:org.jetbrains.kotlin.kapt3:apclasspath=" + baz
158		if kapt.Args["kaptProcessorPath"] != expectedProcessorPath {
159			t.Errorf("expected kaptProcessorPath %q, got %q", expectedProcessorPath, kapt.Args["kaptProcessorPath"])
160		}
161		expectedProcessor := "-P plugin:org.jetbrains.kotlin.kapt3:processors=com.bar -P plugin:org.jetbrains.kotlin.kapt3:processors=com.baz"
162		if kapt.Args["kaptProcessor"] != expectedProcessor {
163			t.Errorf("expected kaptProcessor %q, got %q", expectedProcessor, kapt.Args["kaptProcessor"])
164		}
165
166		// Test that the processors are not passed to javac
167		if javac.Args["processorpath"] != "" {
168			t.Errorf("expected processorPath '', got %q", javac.Args["processorpath"])
169		}
170		if javac.Args["processor"] != "-proc:none" {
171			t.Errorf("expected processor '-proc:none', got %q", javac.Args["processor"])
172		}
173	})
174
175	t.Run("errorprone", func(t *testing.T) {
176		env := map[string]string{
177			"RUN_ERROR_PRONE": "true",
178		}
179
180		result := android.GroupFixturePreparers(
181			PrepareForTestWithJavaDefaultModules,
182			android.FixtureMergeEnv(env),
183		).RunTestWithBp(t, bp)
184
185		buildOS := android.BuildOs.String()
186
187		kapt := result.ModuleForTests("foo", "android_common").Rule("kapt")
188		//kotlinc := ctx.ModuleForTests("foo", "android_common").Rule("kotlinc")
189		javac := result.ModuleForTests("foo", "android_common").Description("javac")
190		errorprone := result.ModuleForTests("foo", "android_common").Description("errorprone")
191
192		bar := result.ModuleForTests("bar", buildOS+"_common").Description("javac").Output.String()
193		baz := result.ModuleForTests("baz", buildOS+"_common").Description("javac").Output.String()
194		myCheck := result.ModuleForTests("my_check", buildOS+"_common").Description("javac").Output.String()
195
196		// Test that the errorprone plugins are not passed to kapt
197		expectedProcessorPath := "-P plugin:org.jetbrains.kotlin.kapt3:apclasspath=" + bar +
198			" -P plugin:org.jetbrains.kotlin.kapt3:apclasspath=" + baz
199		if kapt.Args["kaptProcessorPath"] != expectedProcessorPath {
200			t.Errorf("expected kaptProcessorPath %q, got %q", expectedProcessorPath, kapt.Args["kaptProcessorPath"])
201		}
202		expectedProcessor := "-P plugin:org.jetbrains.kotlin.kapt3:processors=com.bar -P plugin:org.jetbrains.kotlin.kapt3:processors=com.baz"
203		if kapt.Args["kaptProcessor"] != expectedProcessor {
204			t.Errorf("expected kaptProcessor %q, got %q", expectedProcessor, kapt.Args["kaptProcessor"])
205		}
206
207		// Test that the errorprone plugins are not passed to javac
208		if javac.Args["processorpath"] != "" {
209			t.Errorf("expected processorPath '', got %q", javac.Args["processorpath"])
210		}
211		if javac.Args["processor"] != "-proc:none" {
212			t.Errorf("expected processor '-proc:none', got %q", javac.Args["processor"])
213		}
214
215		// Test that the errorprone plugins are passed to errorprone
216		expectedProcessorPath = "-processorpath " + myCheck
217		if errorprone.Args["processorpath"] != expectedProcessorPath {
218			t.Errorf("expected processorpath %q, got %q", expectedProcessorPath, errorprone.Args["processorpath"])
219		}
220		if errorprone.Args["processor"] != "-proc:none" {
221			t.Errorf("expected processor '-proc:none', got %q", errorprone.Args["processor"])
222		}
223	})
224}
225
226func TestKaptEncodeFlags(t *testing.T) {
227	// Compares the kaptEncodeFlags against the results of the example implementation at
228	// https://kotlinlang.org/docs/reference/kapt.html#apjavac-options-encoding
229	tests := []struct {
230		in  [][2]string
231		out string
232	}{
233		{
234			// empty input
235			in:  [][2]string{},
236			out: "rO0ABXcEAAAAAA==",
237		},
238		{
239			// common input
240			in: [][2]string{
241				{"-source", "1.8"},
242				{"-target", "1.8"},
243			},
244			out: "rO0ABXcgAAAAAgAHLXNvdXJjZQADMS44AActdGFyZ2V0AAMxLjg=",
245		},
246		{
247			// input that serializes to a 255 byte block
248			in: [][2]string{
249				{"-source", "1.8"},
250				{"-target", "1.8"},
251				{"a", strings.Repeat("b", 218)},
252			},
253			out: "rO0ABXf/AAAAAwAHLXNvdXJjZQADMS44AActdGFyZ2V0AAMxLjgAAWEA2mJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJi",
254		},
255		{
256			// input that serializes to a 256 byte block
257			in: [][2]string{
258				{"-source", "1.8"},
259				{"-target", "1.8"},
260				{"a", strings.Repeat("b", 219)},
261			},
262			out: "rO0ABXoAAAEAAAAAAwAHLXNvdXJjZQADMS44AActdGFyZ2V0AAMxLjgAAWEA22JiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYg==",
263		},
264		{
265			// input that serializes to a 257 byte block
266			in: [][2]string{
267				{"-source", "1.8"},
268				{"-target", "1.8"},
269				{"a", strings.Repeat("b", 220)},
270			},
271			out: "rO0ABXoAAAEBAAAAAwAHLXNvdXJjZQADMS44AActdGFyZ2V0AAMxLjgAAWEA3GJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmJiYmI=",
272		},
273	}
274
275	for i, test := range tests {
276		t.Run(strconv.Itoa(i), func(t *testing.T) {
277			got := kaptEncodeFlags(test.in)
278			if got != test.out {
279				t.Errorf("\nwant %q\n got %q", test.out, got)
280			}
281		})
282	}
283}
284