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
|
// Copyright 2014 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 com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.Action;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.Root;
import com.google.devtools.build.lib.analysis.buildinfo.BuildInfoCollection;
import com.google.devtools.build.lib.analysis.buildinfo.BuildInfoFactory;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.rules.java.WriteBuildInfoPropertiesAction.TimestampFormatter;
import com.google.devtools.build.lib.vfs.PathFragment;
import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.joda.time.format.DateTimeFormat;
import org.joda.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.List;
/**
* Java build info creation - generates properties file that contain the corresponding build-info
* data.
*/
public abstract class JavaBuildInfoFactory implements BuildInfoFactory {
public static final BuildInfoKey KEY = new BuildInfoKey("Java");
static final PathFragment BUILD_INFO_NONVOLATILE_PROPERTIES_NAME =
new PathFragment("build-info-nonvolatile.properties");
static final PathFragment BUILD_INFO_VOLATILE_PROPERTIES_NAME =
new PathFragment("build-info-volatile.properties");
static final PathFragment BUILD_INFO_REDACTED_PROPERTIES_NAME =
new PathFragment("build-info-redacted.properties");
private static final DateTimeFormatter DEFAULT_TIME_FORMAT =
DateTimeFormat.forPattern("EEE MMM d HH:mm:ss yyyy");
// A default formatter that returns a date in UTC format.
private static final TimestampFormatter DEFAULT_FORMATTER = new TimestampFormatter() {
@Override
public String format(long timestamp) {
return new DateTime(timestamp, DateTimeZone.UTC).toString(DEFAULT_TIME_FORMAT) + " ("
+ timestamp / 1000 + ')';
}
};
@Override
public final BuildInfoCollection create(BuildInfoContext context, BuildConfiguration config,
Artifact stableStatus, Artifact volatileStatus) {
WriteBuildInfoPropertiesAction redactedInfo = getHeader(context,
config,
BUILD_INFO_REDACTED_PROPERTIES_NAME,
Artifact.NO_ARTIFACTS,
createRedactedTranslator(),
true,
true);
WriteBuildInfoPropertiesAction nonvolatileInfo = getHeader(context,
config,
BUILD_INFO_NONVOLATILE_PROPERTIES_NAME,
ImmutableList.of(stableStatus),
createNonVolatileTranslator(),
false,
true);
WriteBuildInfoPropertiesAction volatileInfo = getHeader(context,
config,
BUILD_INFO_VOLATILE_PROPERTIES_NAME,
ImmutableList.of(volatileStatus),
createVolatileTranslator(),
true,
false);
List<Action> actions = new ArrayList<>(3);
actions.add(redactedInfo);
actions.add(nonvolatileInfo);
actions.add(volatileInfo);
return new BuildInfoCollection(actions,
ImmutableList.of(nonvolatileInfo.getPrimaryOutput(), volatileInfo.getPrimaryOutput()),
ImmutableList.of(redactedInfo.getPrimaryOutput()));
}
/**
* Creates a {@link BuildInfoPropertiesTranslator} to use for volatile keys.
*/
protected abstract BuildInfoPropertiesTranslator createVolatileTranslator();
/**
* Creates a {@link BuildInfoPropertiesTranslator} to use for non-volatile keys.
*/
protected abstract BuildInfoPropertiesTranslator createNonVolatileTranslator();
/**
* Creates a {@link BuildInfoPropertiesTranslator} to use for redacted version of the build
* informations.
*/
protected abstract BuildInfoPropertiesTranslator createRedactedTranslator();
/**
* Specifies the {@link TimestampFormatter} to use to output dates in the properties file.
*/
protected TimestampFormatter getTimestampFormatter() {
return DEFAULT_FORMATTER;
}
private WriteBuildInfoPropertiesAction getHeader(BuildInfoContext context,
BuildConfiguration config,
PathFragment propertyFileName,
ImmutableList<Artifact> inputs,
BuildInfoPropertiesTranslator translator,
boolean includeVolatile,
boolean includeNonVolatile) {
Root outputPath = config.getIncludeDirectory();
final Artifact output = context.getBuildInfoArtifact(propertyFileName, outputPath,
includeVolatile && !inputs.isEmpty() ? BuildInfoType.NO_REBUILD
: BuildInfoType.FORCE_REBUILD_IF_CHANGED);
return new WriteBuildInfoPropertiesAction(inputs,
output,
translator,
includeVolatile,
includeNonVolatile,
getTimestampFormatter());
}
@Override
public final BuildInfoKey getKey() {
return KEY;
}
@Override
public boolean isEnabled(BuildConfiguration config) {
return config.hasFragment(JavaConfiguration.class);
}
}
|
