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
|
// Copyright 2015 Google Inc. 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.objc;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.FileProvider;
import com.google.devtools.build.lib.analysis.PrerequisiteArtifacts;
import com.google.devtools.build.lib.analysis.RuleConfiguredTarget.Mode;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.analysis.Runfiles;
import com.google.devtools.build.lib.analysis.RunfilesProvider;
import com.google.devtools.build.lib.analysis.actions.TemplateExpansionAction;
import com.google.devtools.build.lib.analysis.actions.TemplateExpansionAction.Substitution;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.util.FileType;
/**
* Support for running XcTests.
*/
class TestSupport {
private final RuleContext ruleContext;
TestSupport(RuleContext ruleContext) {
this.ruleContext = ruleContext;
}
/**
* Registers actions to create all files needed in order to actually run the test.
*/
TestSupport registerTestRunnerActionsForSimulator() {
registerTestScriptSubstitutionAction();
return this;
}
/**
* Returns the script which should be run in order to actually run the tests.
*/
Artifact generatedTestScript() {
return ObjcRuleClasses.artifactByAppendingToBaseName(ruleContext, "_test_script");
}
private void registerTestScriptSubstitutionAction() {
// testIpa is the app actually containing the XcTests
Artifact testIpa = testIpa();
// xctestIpa is the app bundle being tested
Artifact xctestIpa = xctestIpa();
ImmutableList.Builder<Substitution> substitutions = new ImmutableList.Builder<Substitution>()
.add(Substitution.of("%(test_app_ipa)s", testIpa.getRootRelativePathString()))
.add(Substitution.of("%(test_app_name)s", baseNameWithoutIpa(testIpa)))
.add(Substitution.of("%(xctest_app_ipa)s", xctestIpa.getRootRelativePathString()))
.add(Substitution.of("%(xctest_app_name)s", baseNameWithoutIpa(xctestIpa)))
.add(Substitution.of("%(iossim_path)s", iossim().getRootRelativePath().getPathString()))
.add(Substitution.of("%(plugin_jars)s", Artifact.joinRootRelativePaths(":", plugins())))
.addAll(deviceSubstitutions().getSubstitutionsForTestRunnerScript());
Optional<Artifact> testRunner = testRunner();
if (testRunner.isPresent()) {
substitutions.add(
Substitution.of("%(testrunner_binary)s", testRunner.get().getRootRelativePathString()));
}
Artifact template = ruleContext.getPrerequisiteArtifact("$test_template", Mode.TARGET);
ruleContext.registerAction(new TemplateExpansionAction(ruleContext.getActionOwner(),
template, generatedTestScript(), substitutions.build(), /*executable=*/true));
}
private IosTestSubstitutionProvider deviceSubstitutions() {
return ruleContext.getPrerequisite(
"target_device", Mode.TARGET, IosTestSubstitutionProvider.class);
}
private Artifact testIpa() {
return ruleContext.getImplicitOutputArtifact(ReleaseBundlingSupport.IPA);
}
private Artifact xctestIpa() {
FileProvider fileProvider =
ruleContext.getPrerequisite("xctest_app", Mode.TARGET, FileProvider.class);
return Iterables.getOnlyElement(
Artifact.filterFiles(fileProvider.getFilesToBuild(), FileType.of(".ipa")));
}
private Artifact iossim() {
return ruleContext.getPrerequisiteArtifact("$iossim", Mode.HOST);
}
/**
* Gets the binary of the testrunner attribute, if there is one.
*/
private Optional<Artifact> testRunner() {
return Optional.fromNullable(ruleContext.getPrerequisiteArtifact("$test_runner", Mode.TARGET));
}
/**
* Adds all files needed to run this test to the passed Runfiles builder.
*/
TestSupport addRunfiles(Runfiles.Builder runfilesBuilder) {
runfilesBuilder
.addArtifact(testIpa())
.addArtifact(xctestIpa())
.addArtifact(generatedTestScript())
.addArtifact(iossim())
.addTransitiveArtifacts(deviceRunfiles())
.addTransitiveArtifacts(plugins())
.addArtifacts(testRunner().asSet());
return this;
}
/**
* Jar files for plugins to the test runner. May be empty.
*/
private NestedSet<Artifact> plugins() {
return PrerequisiteArtifacts.nestedSet(ruleContext, "plugins", Mode.TARGET);
}
/**
* Runfiles required in order to use the specified target device.
*/
private NestedSet<Artifact> deviceRunfiles() {
return ruleContext.getPrerequisite("target_device", Mode.TARGET, RunfilesProvider.class)
.getDefaultRunfiles().getAllArtifacts();
}
/**
* Adds files which must be built in order to run this test to builder.
*/
TestSupport addFilesToBuild(NestedSetBuilder<Artifact> builder) {
builder.add(testIpa()).add(xctestIpa());
return this;
}
/**
* Returns the base name of the artifact, with the .ipa stuffix stripped.
*/
private static String baseNameWithoutIpa(Artifact artifact) {
String baseName = artifact.getExecPath().getBaseName();
Preconditions.checkState(baseName.endsWith(".ipa"),
"%s should end in .ipa but doesn't", baseName);
return baseName.substring(0, baseName.length() - 4);
}
}
|
