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
|
// Copyright 2017 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.repository;
import com.google.common.base.Function;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.packages.BuildFileContainsErrorsException;
import com.google.devtools.build.lib.packages.Package;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.skyframe.PackageLookupValue;
import com.google.devtools.build.lib.skyframe.WorkspaceFileValue;
import com.google.devtools.build.lib.vfs.RootedPath;
import com.google.devtools.build.skyframe.SkyFunction.Environment;
import com.google.devtools.build.skyframe.SkyFunctionException.Transience;
import com.google.devtools.build.skyframe.SkyKey;
import java.util.List;
import javax.annotation.Nullable;
/** Utility class to centralize looking up rules from the external package. */
public class ExternalPackageUtil {
/**
* Loads the external package and then calls the selector to find matching rules.
*
* @param env the environment to use for lookups
* @param returnFirst whether to return only the first rule found
* @param selector the function to call to load rules
*/
@Nullable
private static List<Rule> getRules(
Environment env, boolean returnFirst, Function<Package, Iterable<Rule>> selector)
throws ExternalPackageException, InterruptedException {
SkyKey packageLookupKey = PackageLookupValue.key(Label.EXTERNAL_PACKAGE_IDENTIFIER);
PackageLookupValue packageLookupValue = (PackageLookupValue) env.getValue(packageLookupKey);
if (packageLookupValue == null) {
return null;
}
RootedPath workspacePath = packageLookupValue.getRootedPath(Label.EXTERNAL_PACKAGE_IDENTIFIER);
List<Rule> rules = ImmutableList.of();
SkyKey workspaceKey = WorkspaceFileValue.key(workspacePath);
do {
WorkspaceFileValue value = (WorkspaceFileValue) env.getValue(workspaceKey);
if (value == null) {
return null;
}
Package externalPackage = value.getPackage();
if (externalPackage.containsErrors()) {
Event.replayEventsOn(env.getListener(), externalPackage.getEvents());
throw new ExternalPackageException(
new BuildFileContainsErrorsException(
Label.EXTERNAL_PACKAGE_IDENTIFIER, "Could not load //external package"),
Transience.PERSISTENT);
}
Iterable<Rule> results = selector.apply(externalPackage);
if (results != null) {
rules = ImmutableList.copyOf(results);
if (returnFirst && !rules.isEmpty()) {
return ImmutableList.of(Iterables.getFirst(results, null));
}
}
workspaceKey = value.next();
} while (workspaceKey != null);
return rules;
}
/** Uses a rule name to fetch the corresponding Rule from the external package. */
@Nullable
public static Rule getRuleByName(final String ruleName, Environment env)
throws ExternalPackageException, InterruptedException {
List<Rule> rules =
getRules(
env,
true,
new Function<Package, Iterable<Rule>>() {
@Nullable
@Override
public Iterable<Rule> apply(Package externalPackage) {
Rule rule = externalPackage.getRule(ruleName);
if (rule == null) {
return null;
}
return ImmutableList.of(rule);
}
});
if (env.valuesMissing()) {
return null;
}
if (rules == null || rules.isEmpty()) {
throw new ExternalRuleNotFoundException(ruleName);
}
return Iterables.getFirst(rules, null);
}
}
|
