From 49d6fbbc58ac05fa407ab4e62583067655dd371e Mon Sep 17 00:00:00 2001 From: Georg Pfuetzenreuter Date: Sun, 27 Aug 2023 21:39:42 +0200 Subject: [PATCH] Initialize Signed-off-by: Georg Pfuetzenreuter --- LICENSE | 287 ++++++++++++++++++++++++++++++++++++++++ README.md | 3 + opam2rpm.py | 136 +++++++++++++++++++ templates/service | 16 +++ templates/ultimate.spec | 84 ++++++++++++ 5 files changed, 526 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100755 opam2rpm.py create mode 100644 templates/service create mode 100644 templates/ultimate.spec diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4153cd3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,287 @@ + EUROPEAN UNION PUBLIC LICENCE v. 1.2 + EUPL © the European Union 2007, 2016 + +This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined +below) which is provided under the terms of this Licence. Any use of the Work, +other than as authorised under this Licence is prohibited (to the extent such +use is covered by a right of the copyright holder of the Work). + +The Work is provided under the terms of this Licence when the Licensor (as +defined below) has placed the following notice immediately following the +copyright notice for the Work: + + Licensed under the EUPL + +or has expressed by any other means his willingness to license under the EUPL. + +1. Definitions + +In this Licence, the following terms have the following meaning: + +- ‘The Licence’: this Licence. + +- ‘The Original Work’: the work or software distributed or communicated by the + Licensor under this Licence, available as Source Code and also as Executable + Code as the case may be. + +- ‘Derivative Works’: the works or software that could be created by the + Licensee, based upon the Original Work or modifications thereof. This Licence + does not define the extent of modification or dependence on the Original Work + required in order to classify a work as a Derivative Work; this extent is + determined by copyright law applicable in the country mentioned in Article 15. + +- ‘The Work’: the Original Work or its Derivative Works. + +- ‘The Source Code’: the human-readable form of the Work which is the most + convenient for people to study and modify. + +- ‘The Executable Code’: any code which has generally been compiled and which is + meant to be interpreted by a computer as a program. + +- ‘The Licensor’: the natural or legal person that distributes or communicates + the Work under the Licence. + +- ‘Contributor(s)’: any natural or legal person who modifies the Work under the + Licence, or otherwise contributes to the creation of a Derivative Work. + +- ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of + the Work under the terms of the Licence. + +- ‘Distribution’ or ‘Communication’: any act of selling, giving, lending, + renting, distributing, communicating, transmitting, or otherwise making + available, online or offline, copies of the Work or providing access to its + essential functionalities at the disposal of any other natural or legal + person. + +2. Scope of the rights granted by the Licence + +The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, +sublicensable licence to do the following, for the duration of copyright vested +in the Original Work: + +- use the Work in any circumstance and for all usage, +- reproduce the Work, +- modify the Work, and make Derivative Works based upon the Work, +- communicate to the public, including the right to make available or display + the Work or copies thereof to the public and perform publicly, as the case may + be, the Work, +- distribute the Work or copies thereof, +- lend and rent the Work or copies thereof, +- sublicense rights in the Work or copies thereof. + +Those rights can be exercised on any media, supports and formats, whether now +known or later invented, as far as the applicable law permits so. + +In the countries where moral rights apply, the Licensor waives his right to +exercise his moral right to the extent allowed by law in order to make effective +the licence of the economic rights here above listed. + +The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to +any patents held by the Licensor, to the extent necessary to make use of the +rights granted on the Work under this Licence. + +3. Communication of the Source Code + +The Licensor may provide the Work either in its Source Code form, or as +Executable Code. If the Work is provided as Executable Code, the Licensor +provides in addition a machine-readable copy of the Source Code of the Work +along with each copy of the Work that the Licensor distributes or indicates, in +a notice following the copyright notice attached to the Work, a repository where +the Source Code is easily and freely accessible for as long as the Licensor +continues to distribute or communicate the Work. + +4. Limitations on copyright + +Nothing in this Licence is intended to deprive the Licensee of the benefits from +any exception or limitation to the exclusive rights of the rights owners in the +Work, of the exhaustion of those rights or of other applicable limitations +thereto. + +5. Obligations of the Licensee + +The grant of the rights mentioned above is subject to some restrictions and +obligations imposed on the Licensee. Those obligations are the following: + +Attribution right: The Licensee shall keep intact all copyright, patent or +trademarks notices and all notices that refer to the Licence and to the +disclaimer of warranties. The Licensee must include a copy of such notices and a +copy of the Licence with every copy of the Work he/she distributes or +communicates. The Licensee must cause any Derivative Work to carry prominent +notices stating that the Work has been modified and the date of modification. + +Copyleft clause: If the Licensee distributes or communicates copies of the +Original Works or Derivative Works, this Distribution or Communication will be +done under the terms of this Licence or of a later version of this Licence +unless the Original Work is expressly distributed only under this version of the +Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee +(becoming Licensor) cannot offer or impose any additional terms or conditions on +the Work or Derivative Work that alter or restrict the terms of the Licence. + +Compatibility clause: If the Licensee Distributes or Communicates Derivative +Works or copies thereof based upon both the Work and another work licensed under +a Compatible Licence, this Distribution or Communication can be done under the +terms of this Compatible Licence. For the sake of this clause, ‘Compatible +Licence’ refers to the licences listed in the appendix attached to this Licence. +Should the Licensee's obligations under the Compatible Licence conflict with +his/her obligations under this Licence, the obligations of the Compatible +Licence shall prevail. + +Provision of Source Code: When distributing or communicating copies of the Work, +the Licensee will provide a machine-readable copy of the Source Code or indicate +a repository where this Source will be easily and freely available for as long +as the Licensee continues to distribute or communicate the Work. + +Legal Protection: This Licence does not grant permission to use the trade names, +trademarks, service marks, or 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 copyright notice. + +6. Chain of Authorship + +The original Licensor warrants that the copyright in the Original Work granted +hereunder is owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each Contributor warrants that the copyright in the modifications he/she brings +to the Work are owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each time You accept the Licence, the original Licensor and subsequent +Contributors grant You a licence to their contributions to the Work, under the +terms of this Licence. + +7. Disclaimer of Warranty + +The Work is a work in progress, which is continuously improved by numerous +Contributors. It is not a finished work and may therefore contain defects or +‘bugs’ inherent to this type of development. + +For the above reason, the Work is provided under the Licence on an ‘as is’ basis +and without warranties of any kind concerning the Work, including without +limitation merchantability, fitness for a particular purpose, absence of defects +or errors, accuracy, non-infringement of intellectual property rights other than +copyright as stated in Article 6 of this Licence. + +This disclaimer of warranty is an essential part of the Licence and a condition +for the grant of any rights to the Work. + +8. Disclaimer of Liability + +Except in the cases of wilful misconduct or damages directly caused to natural +persons, the Licensor will in no event be liable for any direct or indirect, +material or moral, damages of any kind, arising out of the Licence or of the use +of the Work, including without limitation, damages for loss of goodwill, work +stoppage, computer failure or malfunction, loss of data or any commercial +damage, even if the Licensor has been advised of the possibility of such damage. +However, the Licensor will be liable under statutory product liability laws as +far such laws apply to the Work. + +9. Additional agreements + +While distributing the Work, You may choose to conclude an additional agreement, +defining obligations or services consistent with this Licence. However, if +accepting obligations, You may act only on your own behalf and on your sole +responsibility, not on behalf of the original Licensor or 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 +the fact You have accepted any warranty or additional liability. + +10. Acceptance of the Licence + +The provisions of this Licence can be accepted by clicking on an icon ‘I agree’ +placed under the bottom of a window displaying the text of this Licence or by +affirming consent in any other similar way, in accordance with the rules of +applicable law. Clicking on that icon indicates your clear and irrevocable +acceptance of this Licence and all of its terms and conditions. + +Similarly, you irrevocably accept this Licence and all of its terms and +conditions by exercising any rights granted to You by Article 2 of this Licence, +such as the use of the Work, the creation by You of a Derivative Work or the +Distribution or Communication by You of the Work or copies thereof. + +11. Information to the public + +In case of any Distribution or Communication of the Work by means of electronic +communication by You (for example, by offering to download the Work from a +remote location) the distribution channel or media (for example, a website) must +at least provide to the public the information requested by the applicable law +regarding the Licensor, the Licence and the way it may be accessible, concluded, +stored and reproduced by the Licensee. + +12. Termination of the Licence + +The Licence and the rights granted hereunder will terminate automatically upon +any breach by the Licensee of the terms of the Licence. + +Such a termination will not terminate the licences of any person who has +received the Work from the Licensee under the Licence, provided such persons +remain in full compliance with the Licence. + +13. Miscellaneous + +Without prejudice of Article 9 above, the Licence represents the complete +agreement between the Parties as to the Work. + +If any provision of the Licence is invalid or unenforceable under applicable +law, this will not affect the validity or enforceability of the Licence as a +whole. Such provision will be construed or reformed so as necessary to make it +valid and enforceable. + +The European Commission may publish other linguistic versions or new versions of +this Licence or updated versions of the Appendix, so far this is required and +reasonable, without reducing the scope of the rights granted by the Licence. New +versions of the Licence will be published with a unique version number. + +All linguistic versions of this Licence, approved by the European Commission, +have identical value. Parties can take advantage of the linguistic version of +their choice. + +14. Jurisdiction + +Without prejudice to specific agreement between parties, + +- any litigation resulting from the interpretation of this License, arising + between the European Union institutions, bodies, offices or agencies, as a + Licensor, and any Licensee, will be subject to the jurisdiction of the Court + of Justice of the European Union, as laid down in article 272 of the Treaty on + the Functioning of the European Union, + +- any litigation arising between other parties and resulting from the + interpretation of this License, will be subject to the exclusive jurisdiction + of the competent court where the Licensor resides or conducts its primary + business. + +15. Applicable Law + +Without prejudice to specific agreement between parties, + +- this Licence shall be governed by the law of the European Union Member State + where the Licensor has his seat, resides or has his registered office, + +- this licence shall be governed by Belgian law if the Licensor has no seat, + residence or registered office inside a European Union Member State. + +Appendix + +‘Compatible Licences’ according to Article 5 EUPL are: + +- GNU General Public License (GPL) v. 2, v. 3 +- GNU Affero General Public License (AGPL) v. 3 +- Open Software License (OSL) v. 2.1, v. 3.0 +- Eclipse Public License (EPL) v. 1.0 +- CeCILL v. 2.0, v. 2.1 +- Mozilla Public Licence (MPL) v. 2 +- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3 +- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for + works other than software +- European Union Public Licence (EUPL) v. 1.1, v. 1.2 +- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong + Reciprocity (LiLiQ-R+). + +The European Commission may update this Appendix to later versions of the above +licences without producing a new version of the EUPL, as long as they provide +the rights granted in Article 2 of this Licence and protect the covered Source +Code from exclusive appropriation. + +All other changes or additions to this Appendix require the production of a new +EUPL version. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c7a6f3d --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# opam2rpm + +Tool to generate openSUSE RPM packages from OCAML packages on opam.ocaml.org. diff --git a/opam2rpm.py b/opam2rpm.py new file mode 100755 index 0000000..2eccb58 --- /dev/null +++ b/opam2rpm.py @@ -0,0 +1,136 @@ +#!/usr/bin/python3.11 +""" +Copyright 2023, Georg Pfuetzenreuter + +Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European Commission - subsequent versions of the EUPL (the "Licence"). +You may not use this work except in compliance with the Licence. +An English copy of the Licence is shipped in a file called LICENSE along with this applications source code. +You may obtain copies of the Licence in any of the official languages at https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12. + +--- + +opam2rpm - a tool to generate openSUSE RPM packages from OCAML packages on opam.ocaml.org. +""" + +from argparse import ArgumentParser +import logging +import requests +from bs4 import BeautifulSoup +import re +import jinja2 +import sys + +argparser = ArgumentParser() +argparser.add_argument('--debug', help='Print verbose output', action='store_const', dest='loglevel', const=logging.DEBUG, default=logging.INFO) +argparser.add_argument('--package', help='Name of the OPAM package', required=True) +argparser.add_argument('--prefixed', help='Create package with "ocaml-" prefix', action='store_true', default=True) +argparser.add_argument('--opam-web', help='URL pointing to the OPAM web interface', default='https://opam.ocaml.org/') + +args = argparser.parse_args() +downstream_prefixed = args.prefixed + +def _fail(msg): + log.error(msg) + sys.exit(1) + +def query_opam(package): + url = f'{args.opam_web}/packages/{package}' + result = requests.get(url) + status = result.status_code + log.debug(f'{url} returned {status}') + if status != 200: + _fail(f'{url} returned {status}') + return result.content + +class parse_opam(): + def __init__(self, content): + log.debug(f'Parsing {content}') + self.soup = BeautifulSoup(content, 'html.parser') + self.table = self.soup.find('table', attrs={'class': 'package-info'}) + self.info = { element.find('th').text: [entry.find('span', {'class': 'formula-package'}).text for entry in element.findAll('li')] or element.find('td').text for element in self.table.findAll('tr') } + + def get_title(self): + log.debug(f'Returning title') + return self.soup.title + + def get_info(self): + log.debug(f'Returning info dict: {self.info}') + return self.info + +def parse_homepage(homepage): + if 'github.com' in homepage: + repository_url = f'{homepage}.git' + log.debug(f'Set repository URL to {repository_url}') + repository_name = homepage.rsplit('/')[-1] + log.debug(f'Set repository name to {repository_name}') + # add parsing for other common homepages here + else: + _fail(f'Unsupported homepage: {homepage}') + + if repository_name.startswith('ocaml-'): + is_prefixed = True + else: + is_prefixed = False + + return repository_url, repository_name, is_prefixed + +def evaluate_prefixing(upstream_prefixed): + if upstream_prefixed and downstream_prefixed: + # RPM package name == upstream repository name + return False + if upstream_prefixed and not downstream_prefixed: + # RPM package name = upstream repository name w/ stripped "ocaml-" prefix + _fail('Unsupported casting from upstream "ocaml-" prefixed package') + if not upstream_prefixed and downstream_prefixed: + # RPM package name = "ocaml-" + upstream repository name + return True + +def parse_dependencies(dependencies): + buildrequires = [] + for dependency in dependencies: + log.debug(f'Parsing dependency: {dependency}') + ocamldep = re.search('^\w+', dependency).group(0) + log.debug(f'Captured dependency: {ocamldep}') + if not ocamldep: + log.warning(f'Unable to parse upstream dependency {dependency}') + elif not ocamldep in ['ocaml', 'dune']: + buildrequires.append(f'ocamlfind({ocamldep})') + + log.debug(f'Constructed OCAML build dependencies: {buildrequires}') + return buildrequires + +def render(name, url, license, buildrequires, prefixed, vcs_url=None): + if not vcs_url: + vcs_url = url + templenv = jinja2.Environment(loader=jinja2.FileSystemLoader(searchpath='/home/georg/Work/templates')) + template_service = templenv.get_template('service') + template_spec = templenv.get_template('ultimate.spec') + log.debug(f'Rendering {template_spec}') + #if downstream_prefixing: + # name = f'ocaml-{name}' + rendered_service = template_service.render(pkgname=name, url=vcs_url) + if name.startswith('ocaml-') and prefixed: + name = name.lstrip('ocaml-') + rendered_spec = template_spec.render(pkgname=name, url=url, buildrequires=buildrequires, license=license, mode='dune', do_prefix=prefixed) + + log.debug(f'Service: {rendered_service}') + log.debug(f'Spec: {rendered_spec}') + return rendered_service, rendered_spec + +def main(): + opam_package = parse_opam(query_opam(args.package)) + info = opam_package.get_info() + repository_url, repository_name, is_prefixed = parse_homepage(info['Homepage']) + add_prefix = evaluate_prefixing(is_prefixed) + dependencies = parse_dependencies(info['Dependencies']) + render(repository_name, info['Homepage'], info['License'], dependencies, add_prefix, repository_url) + +logging.basicConfig(format='%(asctime)s %(levelname)s - %(funcName)s: %(message)s', datefmt='%H:%M:%S') +log = logging.getLogger(__name__) + +if __name__ == '__main__': + log.setLevel(args.loglevel) + log.debug(args) + main() + + diff --git a/templates/service b/templates/service new file mode 100644 index 0000000..6b8883d --- /dev/null +++ b/templates/service @@ -0,0 +1,16 @@ + + + {{ url }} + git + @PARENT_TAG@ + @PARENT_TAG@ + enable + + + + + {{ pkgname }}*.tar + gz + + + diff --git a/templates/ultimate.spec b/templates/ultimate.spec new file mode 100644 index 0000000..36c5a8c --- /dev/null +++ b/templates/ultimate.spec @@ -0,0 +1,84 @@ +{%- if do_prefix %} +{%- set srcname = pkgname %} +{%- set pkgname = 'ocaml-' ~ pkgname %} +{%- endif %} +# +# spec file for package {{ pkgname }} +# +# Copyright (c) 2023 Georg Pfuetzenreuter +# +# All modifications and additions to the file contributed by third parties +# remain the property of their copyright owners, unless otherwise agreed +# upon. The license for this file, and modifications and additions to the +# file, is the same license as for the pristine package itself (unless the +# license for the pristine package is not an Open Source License, in which +# case the license is the MIT License). An "Open Source License" is a +# license that conforms to the Open Source Definition (Version 1.9) +# published by the Open Source Initiative. + +# Please submit bugfixes or comments via https://bugs.opensuse.org/ +# + +{%- if do_prefix %} +%define sourcename {{ srcname }} +%define sourcetop %{sourcename}-%{version} +Name: ocaml-%{sourcename} +{%- else %} +Name: {{ pkgname }} +{%- endif %} +Version: 0 +Release: 0 +Summary: __SUMMARY__ +License: {{ license }} +Group: Development/Languages/OCaml +URL: {{ url }} +{%- if do_prefix %} +Source: %{sourcetop}.tar.gz +{%- else %} +Source: %{name}-%{version}.tar.gz +{%- endif %} +{%- if mode == 'dune' %} +BuildRequires: ocaml-dune +{%- endif %} +BuildRequires: ocaml-rpm-macros +{%- for require in buildrequires %} +BuildRequires: {{ require }} +{%- endfor %} + +%description +__DESCRIPTION__ + +%package devel +Summary: Development files for %{name} +Group: Development/Languages/OCaml +Requires: %{name} = %{version} + +%description devel +The %{name}-devel package contains files required for development with %{name}. + +%prep +%autosetup{%- if do_prefix -%}-n %{sourcetop}{%- endif %} + +%build +{%- if mode == 'dune' %} +%{ocaml_dune_setup} +%{ocaml_dune_build} +{%- endif %} + +%install +{%- if mode == 'dune' %} +%{ocaml_dune_install} +{%- endif %} +%{ocaml_create_file_list} + +{%- if mode == 'dune' %} +%check +%{ocaml_dune_test} +{%- endif %} + +%files -f %{name}.files +%doc README.md + +%files devel -f %{name}.files.devel + +%changelog