blob: 3a26a668cbcdd770ef8bb9d1541964555b613847 [file] [log] [blame]
# Copyright (C) 2013 The Android Open Source Project
#
# 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.
#
# Fetch artifacts from Maven repository
#
# name: (required) The name of the rule.
# id: (required) Maven group id, artifact id and version in the form: g:a:v
# exclude: (defaults to []) Rules to exlude from resulting maven JAR
# exclude_java_sources: (default to False) should java source be included
# unsign: (default to False): should this archive be unsigned
# deps: (defaults to []) Rules (usually other java_library rules) that are
# included as transitive dependency of this Maven JAR
# exported_deps: (defaults to []) Whether or not depending on this rule should
# also transitively pull in all of its dependencies.
# sha1: SHA-1 of binary artifact
# bin_sha1: SHA-1 of binary artifact
# src_sha1: SHA-1 of src artifact
# repository: (default to MAVEN_CENTRAL) repository name
# attach_source: (default to True): should the sources be fetched
# visibility (defaults to ['PUBLIC']) List of build target patterns that
# identify the build rules that can include this rule in its deps.
#
# Example:
#
# maven_jar(
# name = 'guava',
# id = 'com.google.guava:guava:16.0',
# sha1 = 'aca09d2e5e8416bf91550e72281958e35460be52',
# )
#
# @See: https://github.com/facebook/buck/issues/64
#
GERRIT = 'GERRIT:'
GERRIT_API = 'GERRIT_API:'
MAVEN_CENTRAL = 'MAVEN_CENTRAL:'
MAVEN_LOCAL = 'MAVEN_LOCAL:'
def define_license(name):
n = 'LICENSE-' + name
genrule(
name = n,
cmd = 'ln -s $SRCS $OUT',
srcs = [n],
out = n,
visibility = ['PUBLIC'],
)
def maven_jar(
name,
id,
license = '',
exclude = [],
exclude_java_sources = False,
unsign = False,
deps = [],
exported_deps = [],
sha1 = '', bin_sha1 = '', src_sha1 = '',
repository = MAVEN_CENTRAL,
attach_source = True,
visibility = ['PUBLIC'],
local_license = False):
from os import path
parts = id.split(':')
if len(parts) not in [3, 4]:
raise NameError('%s:\nexpected id="groupId:artifactId:version[:classifier]"'
% id)
if len(parts) == 4:
group, artifact, version, classifier = parts
else:
group, artifact, version = parts
classifier = None
# SNAPSHOT artifacts are handled differently on Google storage bucket:
# 'SNAPSHOT' is discarded from the directory name. However on other
# Maven repositories, most notable local repository located in
# ~/.m2/repository (and is supported through MAVEN_LOCAL repository)
# it must be preserved, otherwise the artifact wouldn't be found.
# Atm the SNAPSHOT part is only discarded for Google storage bucket.
if 'SNAPSHOT' in version and repository.startswith(GERRIT):
file_version = version.replace('-SNAPSHOT', '')
version = version.split('-SNAPSHOT')[0] + '-SNAPSHOT'
else:
file_version = version
if classifier is not None:
file_version += '-' + classifier
jar = path.join(name, artifact.lower() + '-' + file_version)
url = '/'.join([
repository,
group.replace('.', '/'), artifact, version,
artifact + '-' + file_version])
binjar = jar + '.jar'
binurl = url + '.jar'
srcjar = jar + '-src.jar'
srcurl = url + '-sources.jar'
cmd = ['$(exe //bucklets/tools:download_file)', '-o', '$OUT', '-u', binurl]
if sha1:
cmd.extend(['-v', sha1])
elif bin_sha1:
cmd.extend(['-v', bin_sha1])
for x in exclude:
cmd.extend(['-x', x])
if exclude_java_sources:
cmd.append('--exclude_java_sources')
if unsign:
cmd.append('--unsign')
genrule(
name = '%s__download_bin' % name,
cmd = ' '.join(cmd),
out = binjar,
)
license = ':LICENSE-' + license
if not local_license:
license = '//lib' + license
license = [license]
if src_sha1 or attach_source:
cmd = ['$(exe //bucklets/tools:download_file)', '-o', '$OUT', '-u', srcurl]
if src_sha1:
cmd.extend(['-v', src_sha1])
genrule(
name = '%s__download_src' % name,
cmd = ' '.join(cmd),
out = srcjar,
)
prebuilt_jar(
name = '%s_src' % name,
binary_jar = ':%s__download_src' % name,
visibility = visibility,
)
else:
srcjar = None
genrule(
name = '%s_src' % name,
cmd = ':>$OUT',
out = '__%s__no_src' % name,
)
if exported_deps:
prebuilt_jar(
name = '%s__jar' % name,
deps = deps,
binary_jar = ':%s__download_bin' % name,
source_jar = ':%s__download_src' % name if srcjar else None,
visibility = visibility,
)
java_library(
name = name,
exported_deps = exported_deps + [':' + name + '__jar'],
visibility = visibility,
)
else:
prebuilt_jar(
name = name,
deps = deps,
binary_jar = ':%s__download_bin' % name,
source_jar = ':%s__download_src' % name if srcjar else None,
visibility = visibility,
)