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
|
// Copyright 2014 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.bazel.rules.workspace;
import static com.google.devtools.build.lib.packages.Attribute.attr;
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.syntax.Type;
/**
* Rule definition for the maven_jar rule.
*/
public class MavenJarRule implements RuleDefinition {
public static final String NAME = "maven_jar";
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
/* <!-- #BLAZE_RULE(maven_jar).ATTRIBUTE(artifact) -->
A description of a Maven artifact.
${SYNOPSIS}
<p>These descriptions are of the form <groupId>:<artifactId>:<version>,
see <a href="#maven_jar_examples">the documentation below</a> for an example.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("artifact", Type.STRING))
.add(attr("artifact_id", Type.STRING).undocumented("deprecated"))
.add(attr("group_id", Type.STRING).undocumented("deprecated"))
.add(attr("version", Type.STRING).undocumented("deprecated"))
/* <!-- #BLAZE_RULE(maven_jar).ATTRIBUTE(repository) -->
A URL for a Maven repository to fetch the jar from.
${SYNOPSIS}
<p>Either this or <code>server</code> can be specified. Defaults to Maven Central
("central.maven.org").</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("repository", Type.STRING))
/* <!-- #BLAZE_RULE(maven_jar).ATTRIBUTE(server) -->
A maven_server to use for this artifact.
${SYNOPSIS}
<p>Either this or <code>repository</code> can be specified.</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("server", Type.STRING))
/* <!-- #BLAZE_RULE(maven_jar).ATTRIBUTE(sha1) -->
A SHA-1 hash of the desired jar.
${SYNOPSIS}
<p>If the downloaded jar does not match this hash, Bazel will error out.</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("sha1", Type.STRING))
.setWorkspaceOnly()
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name(MavenJarRule.NAME)
.type(RuleClassType.WORKSPACE)
.ancestors(WorkspaceBaseRule.class)
.factoryClass(WorkspaceConfiguredTargetFactory.class)
.build();
}
}
/*<!-- #BLAZE_RULE (NAME = maven_jar, TYPE = OTHER, FAMILY = Workspace)[GENERIC_RULE] -->
${ATTRIBUTE_SIGNATURE}
<p>Downloads a jar from Maven and makes it available to be used as a Java dependency.</p>
${ATTRIBUTE_DEFINITION}
<h4 id="maven_jar_examples">Examples</h4>
Suppose that the current repostory contains a java_library target that needs to depend on Guava.
Using Maven, this dependency would be defined in the pom.xml file as:
<pre>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>18.0</version>
</dependency>
</pre>
With Bazel, add the following lines to the WORKSPACE file:
<pre>
maven_jar(
name = "guava",
artifact = "com.google.guava:guava:18.0",
sha1 = "cce0823396aa693798f8882e64213b1772032b09",
)
</pre>
<p>Targets can specify <code>@guava//jar</code> as a dependency to depend on this jar.</p>
<!-- #END_BLAZE_RULE -->*/
|
