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
|
// 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.testutil;
import com.google.common.base.Function;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.collect.Sets;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.packages.NoSuchPackageException;
import com.google.devtools.build.lib.packages.Package;
import com.google.devtools.build.lib.packages.RuleClassProvider;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.skyframe.PackageFunction;
import com.google.devtools.build.lib.skyframe.packages.BazelPackageLoader;
import com.google.devtools.build.lib.skyframe.packages.PackageLoader;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.vfs.PathFragment;
/**
* A Package.Builder.Helper for use in tests that a sanity check with {@link BazelPackageLoader} for
* each loaded package, for the sake of getting pretty nice test coverage.
*/
public class BazelPackageBuilderHelperForTesting implements Package.Builder.Helper {
private final RuleClassProvider ruleClassProvider;
public BazelPackageBuilderHelperForTesting(RuleClassProvider ruleClassProvider) {
this.ruleClassProvider = ruleClassProvider;
}
@Override
public Package createFreshPackage(PackageIdentifier packageId, String runfilesPrefix) {
return Package.Builder.DefaultHelper.INSTANCE.createFreshPackage(packageId, runfilesPrefix);
}
@Override
public void onLoadingComplete(Package pkg) {
sanityCheckBazelPackageLoader(pkg, ruleClassProvider);
}
private static final Function<Target, Label> TARGET_TO_LABEL =
new Function<Target, Label>() {
@Override
public Label apply(Target input) {
return input.getLabel();
}
};
// This is synchronized because some Skylark internals aren't thread safe.
private synchronized void sanityCheckBazelPackageLoader(
Package pkg,
RuleClassProvider ruleClassProvider) {
PackageIdentifier pkgId = pkg.getPackageIdentifier();
if (pkgId.equals(Label.EXTERNAL_PACKAGE_IDENTIFIER)
|| !pkg.getPackageIdentifier().getRepository().isMain()
|| PackageFunction.isDefaultsPackage(pkg.getPackageIdentifier())) {
// TODO(nharmata): Support these packages.
return;
}
int numNameSegments = pkg.getNameFragment().segmentCount();
PathFragment fullFilenameFragment = pkg.getFilename().asFragment();
int numFullFilenameFragmentSegments = fullFilenameFragment.segmentCount();
Path workspaceRoot = pkg.getFilename().getFileSystem().getPath(
fullFilenameFragment.subFragment(
0,
numFullFilenameFragmentSegments - (numNameSegments + 1)));
PackageLoader packageLoader = BazelPackageLoader.builder(workspaceRoot)
.setRuleClassProvider(ruleClassProvider)
.build();
Package newlyLoadedPkg;
try {
newlyLoadedPkg = packageLoader.loadPackage(pkg.getPackageIdentifier());
} catch (InterruptedException e) {
return;
} catch (NoSuchPackageException e) {
throw new IllegalStateException(e);
}
ImmutableSet<Label> targetsInPkg =
ImmutableSet.copyOf(Iterables.transform(pkg.getTargets().values(), TARGET_TO_LABEL));
ImmutableSet<Label> targetsInNewlyLoadedPkg =
ImmutableSet.copyOf(
Iterables.transform(newlyLoadedPkg.getTargets().values(), TARGET_TO_LABEL));
if (!targetsInPkg.equals(targetsInNewlyLoadedPkg)) {
throw new IllegalStateException(String.format(
"The Package for %s had a different set of targets (<targetsInPkg> - "
+ "<targetsInNewlyLoadedPkg> = %s, <targetsInNewlyLoadedPkg> - <targetsInPkg> = %s) when "
+ "loaded normally during execution of the current test than it did when loaded via "
+ "BazelPackageLoader (done automatically by the BazelPackageBuilderHelperForTesting "
+ "hook). This either means: (i) Skyframe package loading semantics have diverged from "
+ "BazelPackageLoader semantics (ii) The test in question is doing something that "
+ "confuses BazelPackageBuilderHelperForTesting.",
pkgId,
Sets.difference(targetsInPkg, targetsInNewlyLoadedPkg),
Sets.difference(targetsInNewlyLoadedPkg, targetsInPkg)));
}
}
}
|
