From bdcf1290774db9487bcfcb46be1c8a412851ec72 Mon Sep 17 00:00:00 2001 From: Thomas Bechtold Date: Mon, 5 Oct 2015 08:40:44 +0200 Subject: [PATCH] Initial version of renderspec Change-Id: I7a0098740107168836e09f69dc5099db38eead62 --- LICENSE | 176 +++++++++++++++++++++++++++++++++++++++++ README.rst | 35 ++++++++ renderspec/__init__.py | 120 ++++++++++++++++++++++++++++ 3 files changed, 331 insertions(+) create mode 100644 LICENSE create mode 100644 README.rst create mode 100644 renderspec/__init__.py diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..68c771a --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + + 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. + diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..73cc8b9 --- /dev/null +++ b/README.rst @@ -0,0 +1,35 @@ +renderspec +========== + +renderspec is a tool to convert a .spec.j2 Jinja2 template to +a rpm .spec file which is usable for different distributions +and follow their policies and processes. + +For more information about the OpenStack rpm packaging initiative, please +follow the link to the wiki page: + + https://wiki.openstack.org/wiki/Rpm-packaging + +In the unfortunate event that bugs are discovered, they should +be reported to the appropriate bug tracker. If you obtained +the software from a 3rd party operating system vendor, it is +often wise to use their own bug tracker for reporting problems. +In all other cases use the master OpenStack bug tracker, +available at: + + https://bugs.launchpad.net/renderspec + +Developers wishing to work on renderspec should always base +their work on the latest code, available from the master GIT +repository at: + + https://git.openstack.org/cgit/openstack/renderspec + +Developers should also join the discussion on the mailing list, +at: + + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev + +or join the IRC channel on + + http://webchat.freenode.net/?channels=openstack-rpm-packaging diff --git a/renderspec/__init__.py b/renderspec/__init__.py new file mode 100644 index 0000000..34febed --- /dev/null +++ b/renderspec/__init__.py @@ -0,0 +1,120 @@ +#!/usr/bin/python +# Copyright (c) 2015 SUSE Linux GmbH +# +# 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. + +from __future__ import print_function + +import argparse +import os +import platform +from jinja2 import Environment, FileSystemLoader + + +############### +# jinja2 filter +############### +def _filter_noop(value): + """do nothing filter""" + return value + + +def _filter_license_spdx2fedora(value): + """convert a given known spdx license to another one""" + # more values can be taken from from https://github.com/hughsie/\ + # appstream-glib/blob/master/libappstream-builder/asb-package-rpm.c#L76 + mapping = { + "Apache-1.1": "ASL 1.1", + "Apache-2.0": "ASL 2.0", + "BSD-3-Clause": "BSD", + "GPL-1.0+": "GPL+", + "GPL-2.0": "GPLv2", + "GPL-2.0+": "GPLv2+", + "GPL-3.0": "GPLv3", + "GPL-3.0+": "GPLv3+", + "LGPL-2.1": "LGPLv2.1", + "LGPL-2.1+": "LGPLv2+", + "LGPL-2.0": "LGPLv2 with exceptions", + "LGPL-2.0+": "LGPLv2+ with exceptions", + "LGPL-3.0": "LGPLv3", + "LGPL-3.0+": "LGPLv3+", + "MIT": "MIT with advertising", + "MPL-1.0": "MPLv1.0", + "MPL-1.1": "MPLv1.1", + "MPL-2.0": "MPLv2.0", + "Python-2.0": "Python", + } + return mapping[value] + + +def _filter_pypackname(value): + # FIXME(toabctl): use pymod2pkg when it supports SUSE and Fedora + return "python-%s" % (value) + + +def generate_spec(spec_style, input_template_path): + """generate a spec file with the given style and the given template""" + env = Environment(loader=FileSystemLoader( + os.path.dirname(input_template_path))) + + # register dist specific filter + if spec_style == 'suse': + env.filters['license_normalize'] = _filter_noop + elif spec_style == 'fedora': + env.filters['license_normalize'] = _filter_license_spdx2fedora + else: + raise Exception("Unknown spec style '%s' given" % (spec_style)) + # common filters + env.filters['pypackname_normalize'] = _filter_pypackname + + template = env.get_template(os.path.basename(input_template_path)) + return template.render() + + +def _get_default_distro(): + distname, version, id_ = platform.linux_distribution() + if "suse" in distname.lower(): + return "suse" + elif "fedora" in distname.lower(): + return "fedora" + else: + return "unknown" + + +def process_args(): + distro = _get_default_distro() + parser = argparse.ArgumentParser( + description="Convert a .spec.j2 template into a .spec") + parser.add_argument("-o", "--output", + help="output filename instead of stdout") + parser.add_argument("--spec-style", help="distro style you want to use. " + "default: %s" % (distro), default=distro, + choices=['suse', 'fedora']) + parser.add_argument("input-template", + help="specfile jinja2 template to use") + return vars(parser.parse_args()) + + +def main(): + args = process_args() + spec = generate_spec(args['spec_style'], args['input-template']) + if args['output']: + with open(args['output'], "w") as o: + o.write(spec) + else: + print(spec) + + +if __name__ == '__main__': + main()