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
|
// Copyright 2015 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.generatedprojecttest.util;
import com.google.devtools.build.lib.testutil.BuildRuleBuilder;
import com.google.devtools.build.lib.testutil.Scratch;
import java.io.IOException;
/**
* A builder that generates whole test projects in a scratch file system.
*/
// TODO(blaze-team): (2012) generate valid parameterized BUILD rules.
// TODO(blaze-team): (2012) generate any required src or data or other files.
public final class TestProjectBuilder {
// Default workspace name.
private static final String WORKSPACE = "workspace";
// The directory name to use for the workspace.
private final String workspace;
/**
* Provides functionality to create and manipulate a scratch file system.
*/
private final Scratch scratch = new Scratch();
/**
* Creates a builder that will use the default workspace name as the directory.
*/
public TestProjectBuilder() {
this(WORKSPACE);
}
/**
* Creates a builder that will use the given workspace name as the directory.
*/
public TestProjectBuilder(String workspace) {
this.workspace = workspace;
}
/**
* Creates a file in the specified directory with the given content.
*
* @param dirName directory to create a new file within
* @param fileName file Name of the new file (must be unique within the directory)
* @param generator FileContentsGenerator implementation
* @throws IOException if the input dirName was not valid, or the file already existed
*/
public void createFileInDir(String dirName, String fileName, FileContentsGenerator generator)
throws IOException {
scratch.file(
String.format("/%s/%s/%s", workspace, dirName, fileName), generator.getContents());
}
/**
* Returns the {@link Scratch} containing the Test Project that has been built.
*/
public Scratch getScratch() {
return this.scratch;
}
/**
* Creates a dummy file with 'dummy' as content in the given package with the given name.
* @throws IOException
*/
public void createDummyFileInDir(String pkg, String fileName) throws IOException {
scratch.file(String.format("%s/%s", pkg, fileName), "dummy");
}
/**
* Generates the files necessary for the rule.
*/
public void createFilesToGenerate(BuildRuleBuilder ruleBuilder) throws IOException {
for (String file : ruleBuilder.getFilesToGenerate()) {
scratch.file(file, "dummy");
}
}
}
|
