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
|
// 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.bazel.rules.workspace;
import static com.google.devtools.build.lib.packages.Attribute.attr;
import static com.google.devtools.build.lib.syntax.Type.BOOLEAN;
import static com.google.devtools.build.lib.syntax.Type.STRING;
import com.google.devtools.build.lib.analysis.RuleDefinition;
import com.google.devtools.build.lib.analysis.RuleDefinitionEnvironment;
import com.google.devtools.build.lib.packages.RuleClass;
import com.google.devtools.build.lib.packages.RuleClass.Builder;
import com.google.devtools.build.lib.packages.RuleClass.Builder.RuleClassType;
import com.google.devtools.build.lib.rules.repository.WorkspaceBaseRule;
import com.google.devtools.build.lib.rules.repository.WorkspaceConfiguredTargetFactory;
/**
* Rule definition for the http_file rule.
*/
public class HttpFileRule implements RuleDefinition {
public static final String NAME = "http_file";
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
/* <!-- #BLAZE_RULE(http_file).ATTRIBUTE(url) -->
A URL to a file that will be made available to Bazel.
<p>This must be an http or https URL. Authentication is not support.
Redirections are followed.</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("url", STRING).mandatory())
/* <!-- #BLAZE_RULE(http_file).ATTRIBUTE(sha256) -->
The expected SHA-256 of the file downloaded.
<p>This must match the SHA-256 of the file downloaded. <em>It is a security risk to
omit the SHA-256 as remote files can change.</em> At best omitting this field will make
your build non-hermetic. It is optional to make development easier but should be set
before shipping.</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("sha256", STRING))
/* <!-- #BLAZE_RULE(http_file).ATTRIBUTE(executable) -->
If the downloaded file should be made executable. Defaults to False.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("executable", BOOLEAN))
.setWorkspaceOnly()
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name(HttpFileRule.NAME)
.type(RuleClassType.WORKSPACE)
.ancestors(WorkspaceBaseRule.class)
.factoryClass(WorkspaceConfiguredTargetFactory.class)
.build();
}
}
/*<!-- #BLAZE_RULE (NAME = http_file, TYPE = OTHER, FAMILY = Workspace)[GENERIC_RULE] -->
<p>Downloads a file from a URL and makes it available to be used as a file group.</p>
<h4 id="http_file_examples">Examples</h4>
<p>Suppose you need to have a debian package for your custom rules. This package is available from
<i>http://example.com/package.deb</i>. Then you can add to your WORKSPACE file:</p>
<pre class="code">
http_file(
name = "my-deb",
url = "http://example.com/package.deb",
sha256 = "03a58ac630e59778f328af4bcc4acb4f80208ed4",
)
</pre>
<p>Targets would specify <code>@my-deb//file</code> as a dependency to depend on this file.</p>
<!-- #END_BLAZE_RULE -->*/
|
