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
|
// Copyright 2016 The Bazel Authors. All rights reserved.
//
// 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 com.google.devtools.build.lib.rules.java;
import static java.util.Objects.requireNonNull;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.CommandLine;
import com.google.devtools.build.lib.actions.CommandLineItem;
import com.google.devtools.build.lib.actions.ExecutionRequirements;
import com.google.devtools.build.lib.actions.ParamFileInfo;
import com.google.devtools.build.lib.actions.ParameterFile.ParameterFileType;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.analysis.actions.CustomCommandLine;
import com.google.devtools.build.lib.analysis.actions.CustomCommandLine.VectorArg;
import com.google.devtools.build.lib.analysis.actions.SpawnAction;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import java.util.function.Consumer;
/**
* Helper class to create singlejar actions - singlejar can merge multiple zip files without
* uncompressing all the entries, making it much faster than uncompressing and then recompressing
* the files.
*/
@Immutable
public final class SingleJarActionBuilder {
private static final ImmutableList<String> SOURCE_JAR_COMMAND_LINE_ARGS = ImmutableList.of(
"--compression",
"--normalize",
"--exclude_build_data",
"--warn_duplicate_resources");
/** Constructs the base spawn for a singlejar action. */
private static SpawnAction.Builder singleJarActionBuilder(
JavaToolchainProvider provider, JavaRuntimeInfo hostJavabase) {
Artifact singleJar = provider.getSingleJar();
SpawnAction.Builder builder = new SpawnAction.Builder();
// If singlejar's name ends with .jar, it is Java application, otherwise it is native.
// TODO(asmundak): once https://github.com/bazelbuild/bazel/issues/2241 is fixed (that is,
// the native singlejar is used on windows) remove support for the Java implementation
if (singleJar.getFilename().endsWith(".jar")) {
builder
.addTransitiveInputs(hostJavabase.javaBaseInputsMiddleman())
.setJarExecutable(
hostJavabase.javaBinaryExecPath(),
singleJar,
provider.getJvmOptions())
.setExecutionInfo(ExecutionRequirements.WORKER_MODE_ENABLED);
} else {
builder.setExecutable(singleJar);
}
return builder;
}
/**
* Creates an Action that packages files into a Jar file.
*
* @param resources the resources to put into the Jar.
* @param resourceJars the resource jars to merge into the jar
* @param outputJar the Jar to create
*/
public static void createSourceJarAction(
RuleContext ruleContext,
JavaSemantics semantics,
ImmutableCollection<Artifact> resources,
NestedSet<Artifact> resourceJars,
Artifact outputJar) {
createSourceJarAction(
ruleContext,
semantics,
resources,
resourceJars,
outputJar,
JavaToolchainProvider.from(ruleContext),
JavaRuntimeInfo.forHost(ruleContext));
}
/**
* Creates an Action that packages files into a Jar file.
*
* @param resources the resources to put into the Jar.
* @param resourceJars the resource jars to merge into the jar
* @param outputJar the Jar to create
* @param toolchainProvider is used to retrieve jvm options
* @param hostJavabase the Java runtime to run the tools under
*/
public static void createSourceJarAction(
RuleContext ruleContext,
JavaSemantics semantics,
ImmutableCollection<Artifact> resources,
NestedSet<Artifact> resourceJars,
Artifact outputJar,
JavaToolchainProvider toolchainProvider,
JavaRuntimeInfo hostJavabase) {
requireNonNull(ruleContext);
requireNonNull(resourceJars);
requireNonNull(outputJar);
if (!resources.isEmpty()) {
requireNonNull(semantics);
}
SpawnAction.Builder builder = singleJarActionBuilder(
toolchainProvider, hostJavabase)
.addOutput(outputJar)
.addInputs(resources)
.addTransitiveInputs(resourceJars)
.addCommandLine(
sourceJarCommandLine(outputJar, semantics, resources, resourceJars),
ParamFileInfo.builder(ParameterFileType.SHELL_QUOTED).setUseAlways(true).build())
.setProgressMessage("Building source jar %s", outputJar.prettyPrint())
.setMnemonic("JavaSourceJar");
ruleContext.registerAction(builder.build(ruleContext));
}
/**
* Creates an Action that merges jars into a single archive.
*
* @param jars the jars to merge.
* @param output the output jar to create
*/
public static void createSingleJarAction(
RuleContext ruleContext, NestedSet<Artifact> jars, Artifact output) {
requireNonNull(ruleContext);
requireNonNull(jars);
requireNonNull(output);
SpawnAction.Builder builder =
singleJarActionBuilder(
JavaToolchainProvider.from(ruleContext), JavaRuntimeInfo.forHost(ruleContext))
.addOutput(output)
.addInputs(jars)
.addCommandLine(
sourceJarCommandLine(
output, /* semantics= */ null, /* resources= */ ImmutableList.of(), jars),
ParamFileInfo.builder(ParameterFileType.SHELL_QUOTED).setUseAlways(true).build())
.setProgressMessage("Building singlejar jar %s", output.prettyPrint())
.setMnemonic("JavaSingleJar");
ruleContext.registerAction(builder.build(ruleContext));
}
private static CommandLine sourceJarCommandLine(
Artifact outputJar,
JavaSemantics semantics,
ImmutableCollection<Artifact> resources,
NestedSet<Artifact> resourceJars) {
CustomCommandLine.Builder args = CustomCommandLine.builder();
args.addExecPath("--output", outputJar);
args.addAll(SOURCE_JAR_COMMAND_LINE_ARGS);
args.addExecPaths("--sources", resourceJars);
if (!resources.isEmpty()) {
args.add("--resources");
args.addAll(VectorArg.of(resources).mapped(new ResourceArgMapFn(semantics)));
}
return args.build();
}
private static class ResourceArgMapFn extends CommandLineItem.ParametrizedMapFn<Artifact> {
private final JavaSemantics semantics;
ResourceArgMapFn(JavaSemantics semantics) {
this.semantics = Preconditions.checkNotNull(semantics);
}
@Override
public void expandToCommandLine(Artifact resource, Consumer<String> args) {
String execPath = resource.getExecPathString();
String resourcePath =
semantics.getDefaultJavaResourcePath(resource.getRootRelativePath()).getPathString();
StringBuilder sb = new StringBuilder(execPath.length() + resourcePath.length() + 1);
sb.append(execPath).append(":").append(resourcePath);
args.accept(sb.toString());
}
@Override
public int maxInstancesAllowed() {
// Expect only one semantics object.
return 1;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ResourceArgMapFn that = (ResourceArgMapFn) o;
return semantics.equals(that.semantics);
}
@Override
public int hashCode() {
return semantics.hashCode();
}
}
}
|
