From 5c69b80aba1e79e222f395c671cae6bff30fa5f2 Mon Sep 17 00:00:00 2001 From: mrmeku Date: Mon, 21 Oct 2019 11:05:51 -0600 Subject: [PATCH] Initial release of openapi_tools_generator_bazel --- .gitignore | 1 + BUILD.bazel | 17 +++ LICENSE | 202 +++++++++++++++++++++++++++++++++ README.md | 40 +++++++ WORKSPACE | 5 + defs.bzl | 9 ++ internal/BUILD.bazel | 6 + internal/openapi_generator.bzl | 147 ++++++++++++++++++++++++ internal/test/BUILD.bazel | 41 +++++++ internal/test/petstore.yaml | 101 +++++++++++++++++ 10 files changed, 569 insertions(+) create mode 100644 .gitignore create mode 100644 BUILD.bazel create mode 100644 LICENSE create mode 100644 README.md create mode 100644 WORKSPACE create mode 100644 defs.bzl create mode 100644 internal/BUILD.bazel create mode 100644 internal/openapi_generator.bzl create mode 100644 internal/test/BUILD.bazel create mode 100644 internal/test/petstore.yaml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ac51a05 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +bazel-* diff --git a/BUILD.bazel b/BUILD.bazel new file mode 100644 index 0000000..0a72b67 --- /dev/null +++ b/BUILD.bazel @@ -0,0 +1,17 @@ +load("@bazel_tools//tools/build_defs/pkg:pkg.bzl", "pkg_tar") + +package(default_visibility = ["//visibility:public"]) + +pkg_tar( + name = "release", + srcs = [ + "BUILD.bazel", + "LICENSE", + "defs.bzl", + "//internal:BUILD.bazel", + "//internal:openapi_generator.bzl", + ], + extension = "tar.gz", + strip_prefix = "./openapi_tools_generator_bazel", + tags = ["manual"], +) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c806b7a --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech) + Copyright 2018 SmartBear Software + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c5469f1 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# OpenAPI Generator Bazel + +This repo was created to integrate the OpenAPI code generation CLI with Bazel. + +## Quickstart + +To use the Bazel bindings provided by this repo within a Bazel workspace, +you must do the following steps: + +1. Add the following code to your WORKSPACE file at the root of your repository + + ``` + load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") + + http_archive( + name = "openapi_tools_generator_bazel", + sha256 = "bdec4feb06144a1dc0a6f9955de9f0079a98b7442275bc84a4fd00452437c945", + urls = ["https://github.com/OpenAPITools/openapi-generator-bazel/releases/download/0.1.0/openapi-tools-generator-bazel-0.1.0.tar.gz"], + ) + + load("@openapi_tools_generator_bazel//:defs.bzl", "openapi_tools_generator_bazel_repositories") + + # You can provide any version of the CLI that has been uploaded to Maven + openapi_tools_generator_bazel_repositories( + openapi_generator_cli_version = "4.1.0", + ) + ``` + +2. Create a BUILD.bazel file next to the .yaml file you wish to generate code from. + The below example generates a go library within a generated directory named `petstore_go` + +``` +load("@openapi_tools_generator_bazel//:defs.bzl", "openapi_generator") + +openapi_generator( + name = "petstore_go", + generator = "go", + spec = "petstore.yaml", +) +``` diff --git a/WORKSPACE b/WORKSPACE new file mode 100644 index 0000000..8abc8c1 --- /dev/null +++ b/WORKSPACE @@ -0,0 +1,5 @@ +workspace(name = "openapi_tools_generator_bazel") + +load("//:defs.bzl", "openapi_tools_generator_bazel_repositories") + +openapi_tools_generator_bazel_repositories() diff --git a/defs.bzl b/defs.bzl new file mode 100644 index 0000000..8439975 --- /dev/null +++ b/defs.bzl @@ -0,0 +1,9 @@ +load( + "//internal:openapi_generator.bzl", + _openapi_generator = "openapi_generator", + _openapi_tools_generator_bazel_repositories = "openapi_tools_generator_bazel_repositories", +) + +openapi_generator = _openapi_generator + +openapi_tools_generator_bazel_repositories = _openapi_tools_generator_bazel_repositories diff --git a/internal/BUILD.bazel b/internal/BUILD.bazel new file mode 100644 index 0000000..d16d68f --- /dev/null +++ b/internal/BUILD.bazel @@ -0,0 +1,6 @@ +package(default_visibility = ["//visibility:public"]) + +exports_files([ + "BUILD.bazel", + "openapi_generator.bzl", +]) diff --git a/internal/openapi_generator.bzl b/internal/openapi_generator.bzl new file mode 100644 index 0000000..597d579 --- /dev/null +++ b/internal/openapi_generator.bzl @@ -0,0 +1,147 @@ +def openapi_tools_generator_bazel_repositories(openapi_generator_cli_version = "4.1.0", prefix = "openapi_tools_generator_bazel"): + native.maven_jar( + name = prefix + "_cli", + artifact = "org.openapitools:openapi-generator-cli:" + openapi_generator_cli_version, + ) + native.bind( + name = prefix + "/dependency/openapi-generator-cli", + actual = "@" + prefix + "_cli//jar", + ) + +def _comma_separated_pairs(pairs): + return ",".join([ + "{}={}".format(k, v) + for k, v in pairs.items() + ]) + +def _new_generator_command(ctx, declared_dir, rjars): + java_path = ctx.attr._jdk[java_common.JavaRuntimeInfo].java_executable_exec_path + gen_cmd = str(java_path) + + gen_cmd += " -cp {cli_jar}:{jars} org.openapitools.codegen.OpenAPIGenerator generate -i {spec} -g {generator} -o {output}".format( + java = java_path, + cli_jar = ctx.file.openapi_generator_cli.path, + jars = ":".join([j.path for j in rjars.to_list()]), + spec = ctx.file.spec.path, + generator = ctx.attr.generator, + output = declared_dir.path, + ) + + gen_cmd += ' -p "{properties}"'.format( + properties = _comma_separated_pairs(ctx.attr.system_properties), + ) + + additional_properties = dict(ctx.attr.additional_properties) + + # This is needed to ensure reproducible Java output + if ctx.attr.generator == "java" and \ + "hideGenerationTimestamp" not in ctx.attr.additional_properties: + additional_properties["hideGenerationTimestamp"] = "true" + + gen_cmd += ' --additional-properties "{properties}"'.format( + properties = _comma_separated_pairs(additional_properties), + ) + + gen_cmd += ' --type-mappings "{mappings}"'.format( + mappings = _comma_separated_pairs(ctx.attr.type_mappings), + ) + + if ctx.attr.api_package: + gen_cmd += " --api-package {package}".format( + package = ctx.attr.api_package, + ) + if ctx.attr.invoker_package: + gen_cmd += " --invoker-package {package}".format( + package = ctx.attr.invoker_package, + ) + if ctx.attr.model_package: + gen_cmd += " --model-package {package}".format( + package = ctx.attr.model_package, + ) + + # fixme: by default, openapi-generator is rather verbose. this helps with that but can also mask useful error messages + # when it fails. look into log configuration options. it's a java app so perhaps just a log4j.properties or something + gen_cmd += " 1>/dev/null" + return gen_cmd + +def _impl(ctx): + jars = _collect_jars(ctx.attr.deps) + (cjars, rjars) = (jars.compiletime, jars.runtime) + + declared_dir = ctx.actions.declare_directory("%s" % (ctx.attr.name)) + + inputs = [ + ctx.file.openapi_generator_cli, + ctx.file.spec, + ] + cjars.to_list() + rjars.to_list() + + # TODO: Convert to run + ctx.actions.run_shell( + inputs = inputs, + command = "mkdir -p {gen_dir}".format( + gen_dir = declared_dir.path, + ) + " && " + _new_generator_command(ctx, declared_dir, rjars), + outputs = [declared_dir], + tools = ctx.files._jdk, + ) + + srcs = declared_dir.path + + return DefaultInfo(files = depset([ + declared_dir, + ])) + +def _collect_jars(targets): + """Compute the runtime and compile-time dependencies from the given targets""" # noqa + compile_jars = depset() + runtime_jars = depset() + for target in targets: + found = False + if hasattr(target, "scala"): + if hasattr(target.scala.outputs, "ijar"): + compile_jars = depset(transitive = [compile_jars, [target.scala.outputs.ijar]]) + compile_jars = depset(transitive = [compile_jars, target.scala.transitive_compile_exports]) + runtime_jars = depset(transitive = [runtime_jars, target.scala.transitive_runtime_deps]) + runtime_jars = depset(transitive = [runtime_jars, target.scala.transitive_runtime_exports]) + found = True + if hasattr(target, "java"): + compile_jars = depset(transitive = [compile_jars, target.java.transitive_deps]) + runtime_jars = depset(transitive = [runtime_jars, target.java.transitive_runtime_deps]) + found = True + if not found: + runtime_jars = depset(transitive = [runtime_jars, target.files]) + compile_jars = depset(transitive = [compile_jars, target.files]) + + return struct(compiletime = compile_jars, runtime = runtime_jars) + +openapi_generator = rule( + attrs = { + # downstream dependencies + "deps": attr.label_list(), + # openapi spec file + "spec": attr.label( + mandatory = True, + allow_single_file = [ + ".json", + ".yaml", + ], + ), + "generator": attr.string(mandatory = True), + "api_package": attr.string(), + "invoker_package": attr.string(), + "model_package": attr.string(), + "additional_properties": attr.string_dict(), + "system_properties": attr.string_dict(), + "type_mappings": attr.string_dict(), + "_jdk": attr.label( + default = Label("@bazel_tools//tools/jdk:current_java_runtime"), + providers = [java_common.JavaRuntimeInfo], + ), + "openapi_generator_cli": attr.label( + cfg = "host", + default = Label("//external:openapi_tools_generator_bazel/dependency/openapi-generator-cli"), + allow_single_file = True, + ), + }, + implementation = _impl, +) diff --git a/internal/test/BUILD.bazel b/internal/test/BUILD.bazel new file mode 100644 index 0000000..cd3b825 --- /dev/null +++ b/internal/test/BUILD.bazel @@ -0,0 +1,41 @@ +load("@openapi_tools_generator_bazel//:defs.bzl", "openapi_generator") + +openapi_generator( + name = "petstore", + generator = "go", + spec = "petstore.yaml", +) + +openapi_generator( + name = "petstore_java", + generator = "java", + spec = "petstore.yaml", +) + +openapi_generator( + name = "petstore_java_feign", + additional_properties = { + "library": "feign", + }, + generator = "java", + spec = "petstore.yaml", +) + +openapi_generator( + name = "petstore_java_no_tests", + generator = "java", + spec = "petstore.yaml", + system_properties = { + "apiTests": "false", + "modelTests": "false", + }, +) + +openapi_generator( + name = "petstore_java_bigdecimal", + generator = "java", + spec = "petstore.yaml", + type_mappings = { + "Integer": "java.math.BigDecimal", + }, +) diff --git a/internal/test/petstore.yaml b/internal/test/petstore.yaml new file mode 100644 index 0000000..8d9872b --- /dev/null +++ b/internal/test/petstore.yaml @@ -0,0 +1,101 @@ +swagger: "2.0" +info: + version: 1.0.0 + title: Swagger Petstore + license: + name: MIT +host: petstore.swagger.io +basePath: /v1 +schemes: + - http +consumes: + - application/json +produces: + - application/json +paths: + /pets: + get: + summary: List all pets + operationId: listPets + tags: + - pets + parameters: + - name: limit + in: query + description: How many items to return at one time (max 100) + required: false + type: integer + format: int32 + responses: + "200": + description: An paged array of pets + headers: + x-next: + type: string + description: A link to the next page of responses + schema: + $ref: "#/definitions/Pets" + default: + description: unexpected error + schema: + $ref: "#/definitions/Error" + post: + summary: Create a pet + operationId: createPets + tags: + - pets + responses: + "201": + description: Null response + default: + description: unexpected error + schema: + $ref: "#/definitions/Error" + /pets/{petId}: + get: + summary: Info for a specific pet + operationId: showPetById + tags: + - pets + parameters: + - name: petId + in: path + required: true + description: The id of the pet to retrieve + type: string + responses: + "200": + description: Expected response to a valid request + schema: + $ref: "#/definitions/Pets" + default: + description: unexpected error + schema: + $ref: "#/definitions/Error" +definitions: + Pet: + required: + - id + - name + properties: + id: + type: integer + format: int64 + name: + type: string + tag: + type: string + Pets: + type: array + items: + $ref: "#/definitions/Pet" + Error: + required: + - code + - message + properties: + code: + type: integer + format: int32 + message: + type: string