Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Make GAPIC Bazel rules production ready #402

Merged
merged 8 commits into from
May 4, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions BUILD.bazel
Original file line number Diff line number Diff line change
@@ -1,17 +1,43 @@
load("//:gapic_generator_python.bzl", "pandoc_binary", "pandoc_toolchain")
load("@gapic_generator_python_pip_deps//:requirements.bzl", "requirement")

toolchain_type(
name = "pandoc_toolchain_type",
visibility = ["//visibility:public"],
)

pandoc_toolchain(
exec_compatible_with = [
"@bazel_tools//platforms:linux",
"@bazel_tools//platforms:x86_64",
],
platform = "linux",
)

pandoc_toolchain(
exec_compatible_with = [
"@bazel_tools//platforms:osx",
"@bazel_tools//platforms:x86_64",
],
platform = "macOS",
)

pandoc_binary(
name = "pandoc_binary"
)

py_binary(
name = "gapic_plugin",
srcs = glob(["gapic/**/*.py"]),
data = glob(["gapic/**/*.j2"]),
main = "gapic/cli/generate.py",
data = [":pandoc_binary"] + glob(["gapic/**/*.j2"]),
main = "gapic/cli/generate_with_pandoc.py",
visibility = ["//visibility:public"],
deps = [
"@com_google_protobuf//:protobuf_python",
"@com_github_grpc_grpc//src/python/grpcio/grpc:grpcio",
requirement("click"),
requirement("google-api-core"),
requirement("googleapis-common-protos"),
requirement("grpcio"),
requirement("jinja2"),
requirement("MarkupSafe"),
requirement("pypandoc"),
Expand Down
39 changes: 35 additions & 4 deletions WORKSPACE
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@ workspace(name = "gapic_generator_python")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

#
# Import rules_python
#
http_archive(
name = "bazel_skylib",
urls = ["https://github.com/bazelbuild/bazel-skylib/releases/download/0.9.0/bazel_skylib-0.9.0.tar.gz"],
)

http_archive(
name = "rules_python",
strip_prefix = "rules_python-748aa53d7701e71101dfd15d800e100f6ff8e5d1",
Expand All @@ -22,14 +24,43 @@ pip_repositories()
#
# Import gapic-generator-python specific dependencies
#
load("//:repositories.bzl", "gapic_generator_python")
load("//:repositories.bzl",
"gapic_generator_python",
"gapic_generator_register_toolchains"
)

gapic_generator_python()

gapic_generator_register_toolchains()

load("@gapic_generator_python_pip_deps//:requirements.bzl", "pip_install")

pip_install()

load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")

protobuf_deps()

#
# Import grpc as a native bazel dependency. This avoids duplication and also
# spedds up loading phase a lot (otherwise python_rules will be building grpcio
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: speeds

# from sources in a single-core speed, which takes around 5 minutes on a regular
# workstation)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wat? Why is it building single-cored?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont know how exactly it does it, but based on time it takes and the CPU load on the build machine I assumed it must be single core

#
load("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")

grpc_deps()

load("@upb//bazel:repository_defs.bzl", "bazel_version_repository")

bazel_version_repository(
name = "bazel_version",
)

load("@build_bazel_rules_apple//apple:repositories.bzl", "apple_rules_dependencies")

apple_rules_dependencies()

load("@build_bazel_apple_support//lib:repositories.bzl", "apple_support_dependencies")

apple_support_dependencies()
8 changes: 8 additions & 0 deletions gapic/cli/generate_with_pandoc.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import os

from gapic.cli import generate

if __name__ == '__main__':
os.environ['PYPANDOC_PANDOC'] = os.path.join(
os.path.abspath(__file__).rsplit("gapic", 1)[0], "pandoc")
generate.generate()
62 changes: 62 additions & 0 deletions gapic_generator_python.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
def _pandoc_binary_impl(ctx):
toolchain = ctx.toolchains["@gapic_generator_python//:pandoc_toolchain_type"]
output = ctx.actions.declare_file(ctx.attr.binary_name)

script = """
cp {input} {output}
chmod +x {output}
""".format(
input = toolchain.pandoc.files.to_list()[0].path,
output = output.path,
)
ctx.actions.run_shell(
command = script,
inputs = toolchain.pandoc.files,
outputs = [output],
)
return [DefaultInfo(files = depset(direct = [output]), executable = output)]

pandoc_binary = rule(
attrs = {
"binary_name": attr.string(default = "pandoc")
},
executable = True,
toolchains = ["@gapic_generator_python//:pandoc_toolchain_type"],
implementation = _pandoc_binary_impl,
)

#
# Toolchains
#
def _pandoc_toolchain_info_impl(ctx):
return [
platform_common.ToolchainInfo(
pandoc = ctx.attr.pandoc,
),
]

_pandoc_toolchain_info = rule(
attrs = {
"pandoc": attr.label(
allow_single_file = True,
cfg = "host",
executable = True,
),
},
implementation = _pandoc_toolchain_info_impl,
)

def pandoc_toolchain(platform, exec_compatible_with):
toolchain_info_name = "pandoc_toolchain_info_%s" % platform
_pandoc_toolchain_info(
name = toolchain_info_name,
pandoc = "@pandoc_%s//:pandoc" % platform,
visibility = ["//visibility:public"],
)

native.toolchain(
name = "pandoc_toolchain_%s" % platform,
exec_compatible_with = exec_compatible_with,
toolchain = toolchain_info_name,
toolchain_type = ":pandoc_toolchain_type",
)
36 changes: 36 additions & 0 deletions repositories.bzl
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
load("@rules_python//python:pip.bzl", "pip_import")

_PANDOC_BUILD_FILE = """
filegroup(
name = "pandoc",
srcs = ["bin/pandoc"],
visibility = ["//visibility:public"],
)"""

def gapic_generator_python():
_maybe(
pip_import,
Expand All @@ -25,13 +32,42 @@ def gapic_generator_python():
urls = ["https://github.com/bazelbuild/bazel-skylib/archive/2169ae1c374aab4a09aa90e65efe1a3aad4e279b.tar.gz"],
)

_maybe(
http_archive,
name = "com_github_grpc_grpc",
strip_prefix = "grpc-8347f4753568b5b66e49111c60ae2841278d3f33", # this is 1.25.0 with fixes
urls = ["https://github.com/grpc/grpc/archive/8347f4753568b5b66e49111c60ae2841278d3f33.zip"],
)

_maybe(
http_archive,
name = "pandoc_linux",
build_file_content = _PANDOC_BUILD_FILE,
strip_prefix = "pandoc-2.2.1",
url = "https://github.com/jgm/pandoc/releases/download/2.2.1/pandoc-2.2.1-linux.tar.gz",
)

_maybe(
http_archive,
name = "pandoc_macOS",
build_file_content = _PANDOC_BUILD_FILE,
strip_prefix = "pandoc-2.2.1",
url = "https://github.com/jgm/pandoc/releases/download/2.2.1/pandoc-2.2.1-macOS.zip",
)

_maybe(
http_archive,
name = "com_google_api_codegen",
strip_prefix = "gapic-generator-b32c73219d617f90de70bfa6ff0ea0b0dd638dfe",
urls = ["https://github.com/googleapis/gapic-generator/archive/b32c73219d617f90de70bfa6ff0ea0b0dd638dfe.zip"],
)

def gapic_generator_register_toolchains():
native.register_toolchains(
"@gapic_generator_python//:pandoc_toolchain_linux",
"@gapic_generator_python//:pandoc_toolchain_macOS",
)

def _maybe(repo_rule, name, strip_repo_prefix = "", **kwargs):
if not name.startswith(strip_repo_prefix):
return
Expand Down
1 change: 0 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
click==7.1.1
google-api-core==1.17.0
googleapis-common-protos==1.51.0
grpcio==1.28.1
jinja2==2.11.2
MarkupSafe==1.1.1
protobuf==3.11.3
Expand Down
4 changes: 2 additions & 2 deletions rules_python_gapic/py_gapic.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

load("@com_google_api_codegen//rules_gapic:gapic.bzl", "proto_custom_library")

def py_gapic_library(name, srcs, **kwargs):
def py_gapic_library(name, srcs, plugin_args = [], **kwargs):
# srcjar_target_name = "%s_srcjar" % name
srcjar_target_name = name
srcjar_output_suffix = ".srcjar"
Expand All @@ -23,7 +23,7 @@ def py_gapic_library(name, srcs, **kwargs):
name = srcjar_target_name,
deps = srcs,
plugin = Label("@gapic_generator_python//:gapic_plugin"),
plugin_args = [],
plugin_args = plugin_args,
plugin_file_args = {},
output_type = "python_gapic",
output_suffix = srcjar_output_suffix,
Expand Down
70 changes: 70 additions & 0 deletions rules_python_gapic/py_gapic_pkg.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Copyright 2020 Google LLC
#
# 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
#
# https://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.

load("@com_google_api_codegen//rules_gapic:gapic_pkg.bzl", "construct_package_dir_paths")

def _py_gapic_src_pkg_impl(ctx):
srcjar_srcs = []
for dep in ctx.attr.deps:
for f in dep.files.to_list():
if f.extension in ("srcjar", "jar", "zip"):
srcjar_srcs.append(f)
Comment on lines +18 to +22
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does skylark allow list comprehensions? Personal preference, feel free to ignore, but I think

srcjar_srcs = [
    dep_file
    for dep in ctx.attr.deps
    for dep_file in dep.files.to_list()
    if dep_file.extension in ("srcjar", "jar", "zip")
]

is more readable because of the indentation.

Copy link
Contributor Author

@vam-google vam-google May 2, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is a reduced verison of more complicated for loops copied from the other rules. Starlak support list comprehension. For sake of style consistency with the other rules lets keep it like that.


paths = construct_package_dir_paths(ctx.attr.package_dir, ctx.outputs.pkg, ctx.label.name)

script = """
mkdir -p {package_dir_path}
for srcjar_src in {srcjar_srcs}; do
unzip -q -o $srcjar_src -d {package_dir_path}
done
cd {package_dir_path}/..
tar -zchpf {package_dir}/{package_dir}.tar.gz {package_dir}
cd -
mv {package_dir_path}/{package_dir}.tar.gz {pkg}
rm -rf {package_dir_path}
""".format(
srcjar_srcs = " ".join(["'%s'" % f.path for f in srcjar_srcs]),
package_dir_path = paths.package_dir_path,
package_dir = paths.package_dir,
pkg = ctx.outputs.pkg.path,
package_dir_expr = paths.package_dir_expr,
)

ctx.actions.run_shell(
inputs = srcjar_srcs,
command = script,
outputs = [ctx.outputs.pkg],
)

_py_gapic_src_pkg = rule(
attrs = {
"deps": attr.label_list(allow_files = True, mandatory = True),
"package_dir": attr.string(mandatory = True),
},
outputs = {"pkg": "%{name}.tar.gz"},
implementation = _py_gapic_src_pkg_impl,
)

def py_gapic_assembly_pkg(name, deps, assembly_name = None, **kwargs):
package_dir = name
if assembly_name:
package_dir = "%s-%s" % (assembly_name, name)
_py_gapic_src_pkg(
name = name,
deps = deps,
package_dir = package_dir,
**kwargs
)