commit 0cbe0f230b75705ab16608e29228c9940281907f Author: Emmanuel Garette Date: Wed Nov 27 17:19:30 2024 +0100 fix: first commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..65c5ca8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9a33de1 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# rougail-output-ansible + diff --git a/locale/fr/LC_MESSAGES/rougail_output_ansible.po b/locale/fr/LC_MESSAGES/rougail_output_ansible.po new file mode 100644 index 0000000..b53c2f8 --- /dev/null +++ b/locale/fr/LC_MESSAGES/rougail_output_ansible.po @@ -0,0 +1,57 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) YEAR ORGANIZATION +# FIRST AUTHOR , YEAR. +# +msgid "" +msgstr "" +"Project-Id-Version: \n" +"POT-Creation-Date: 2024-11-01 11:03+0100\n" +"PO-Revision-Date: 2024-11-01 11:04+0100\n" +"Last-Translator: \n" +"Language-Team: \n" +"Language: fr\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: pygettext.py 1.5\n" +"X-Generator: Poedit 3.5\n" + +#: src/rougail/output_exporter/__init__.py:73 +msgid "The following variables are mandatory but have no value:" +msgstr "Les variables suiveuses sont obligatoire mais n'ont pas de valeur :" + +#: src/rougail/output_exporter/__init__.py:84 +msgid "The following variables are inaccessible but are empty and mandatory :" +msgstr "Les variables suiveuses sont inaccessibles mais sont vides et obligatoires :" + +#: src/rougail/output_exporter/output/console.py:53 +msgid "Undocumented variable" +msgstr "Variable non documentée" + +#: src/rougail/output_exporter/output/console.py:54 +msgid "Undocumented but modified variable" +msgstr "Variable non documentée mais modifiée" + +#: src/rougail/output_exporter/output/console.py:57 +msgid "Unmodifiable variable" +msgstr "Variable non modifiable" + +#: src/rougail/output_exporter/output/console.py:61 +msgid "Default value" +msgstr "Valeur par défaut" + +#: src/rougail/output_exporter/output/console.py:62 +msgid "Modified value" +msgstr "Valeur modifiée" + +#: src/rougail/output_exporter/output/console.py:63 +msgid "Original default value" +msgstr "Valeur par défaut d'origine" + +#: src/rougail/output_exporter/output/console.py:67 +msgid "Caption" +msgstr "Légende" + +#: src/rougail/output_exporter/output/console.py:92 +msgid "Variables:" +msgstr "Variables :" diff --git a/locale/rougail_output_ansible.pot b/locale/rougail_output_ansible.pot new file mode 100644 index 0000000..6fd3c0a --- /dev/null +++ b/locale/rougail_output_ansible.pot @@ -0,0 +1,57 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) YEAR ORGANIZATION +# FIRST AUTHOR , YEAR. +# +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"POT-Creation-Date: 2024-11-01 11:03+0100\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: pygettext.py 1.5\n" + + +#: src/rougail/output_exporter/__init__.py:73 +msgid "The following variables are mandatory but have no value:" +msgstr "" + +#: src/rougail/output_exporter/__init__.py:84 +msgid "The following variables are inaccessible but are empty and mandatory :" +msgstr "" + +#: src/rougail/output_exporter/output/console.py:53 +msgid "Undocumented variable" +msgstr "" + +#: src/rougail/output_exporter/output/console.py:54 +msgid "Undocumented but modified variable" +msgstr "" + +#: src/rougail/output_exporter/output/console.py:57 +msgid "Unmodifiable variable" +msgstr "" + +#: src/rougail/output_exporter/output/console.py:61 +msgid "Default value" +msgstr "" + +#: src/rougail/output_exporter/output/console.py:62 +msgid "Modified value" +msgstr "" + +#: src/rougail/output_exporter/output/console.py:63 +msgid "Original default value" +msgstr "" + +#: src/rougail/output_exporter/output/console.py:67 +msgid "Caption" +msgstr "" + +#: src/rougail/output_exporter/output/console.py:92 +msgid "Variables:" +msgstr "" + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..139a281 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,41 @@ +[build-system] +build-backend = "flit_core.buildapi" +requires = ["flit_core >=3.8.0,<4"] + +[project] +name = "rougail.output_ansible" +version = "0.1.0" +authors = [{name = "Emmanuel Garette", email = "gnunux@gnunux.info"}] +readme = "README.md" +description = "Rougail output ansible" +requires-python = ">=3.8" +license = {file = "LICENSE"} +classifiers = [ + "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)", + "Programming Language :: Python", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3", + "Operating System :: OS Independent", + "Natural Language :: English", + "Natural Language :: French", + +] +dependencies = [ + "rougail >= 1.1,<2", + "rougail-output-json >= 0.1", +] + +[project.urls] +Home = "https://forge.cloud.silique.fr/stove/rougail-output-ansible" + +[tool.commitizen] +name = "cz_conventional_commits" +tag_format = "$version" +version_scheme = "pep440" +version_provider = "pep621" +update_changelog_on_bump = true +changelog_merge_prerelease = true diff --git a/src/rougail/output_ansible/__init__.py b/src/rougail/output_ansible/__init__.py new file mode 100644 index 0000000..0117855 --- /dev/null +++ b/src/rougail/output_ansible/__init__.py @@ -0,0 +1,84 @@ +""" +Silique (https://www.silique.fr) +Copyright (C) 2022-2024 + +This program is free software: you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as published by the +Free Software Foundation, either version 3 of the License, or (at your +option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more +details. + +You should have received a copy of the GNU Lesser General Public License +along with this program. If not, see . +""" + +from typing import Optional +from json import dumps + +from ..output_json import RougailOutputJson + + +class RougailOutputAnsible(RougailOutputJson): + def __init__( + self, + config: "Config", + rougailconfig: "RougailConfig" = None, + user_data_errors: Optional[list] = None, + user_data_warnings: Optional[list] = None, + ) -> None: + if rougailconfig is None: + from rougail import RougailConfig + + rougailconfig = RougailConfig + self.rougailconfig = rougailconfig + self.host_namespace = self.rougailconfig["ansible.host_namespace"] + self.config = config + self.read_write = False + self.is_mandatory = True + self.dico = {} + self.errors = [] + self.warnings = [] + + def run(self) -> None: + self.exporter() + print(dumps(self.json_to_ansible(), ensure_ascii=False, indent=2)) + + def json_to_ansible(self): + if self.host_namespace not in self.dico: + self.errors.append(_('cannot find hosts namespace "{0}"').format(self.host_namespace)) + if 'hostnames' not in self.dico[self.host_namespace]: + self.errors.append(_('malformated hosts namespace "{0}", should has "hostnames"').format(self.host_namespace)) + ret = {"_meta": {"hostvars": {}}, "all": {"children": ["ungrouped"]}} +# if self.errors: +# ret["_meta"]["hostvars"]["localhost"] = {'_errors': self.errors} +# ret["ungrouped"] = {"hosts": ["localhost"]} +# else: + hostnames = self.dico[self.host_namespace]['hostnames'] + ret_hosts = {} + for name, hosts in hostnames.items(): + if 'hosts' in hosts: + for idx, host in enumerate(hosts['hosts']): + index = str(idx + 1) + if idx < 9: + index = '0' + index + host_name = hosts['prefix_name'] + index + ret_hosts.setdefault(name, {})[host_name] = host + ret.setdefault(name, {}).setdefault('hosts', []).append(host_name) + else: + ret["all"]["children"].append(name) + ret[name] = hosts + for hosts in ret_hosts.values(): + for host, domain_name in hosts.items(): + ret['_meta']['hostvars'][host] = {'ansible_host': domain_name} + ret['_meta']['hostvars'][host].update(self.dico) + return ret + + +RougailOutput = RougailOutputAnsible + + +__all__ = ("RougailOutputAnsible",) diff --git a/src/rougail/output_ansible/config.py b/src/rougail/output_ansible/config.py new file mode 100644 index 0000000..4beb67c --- /dev/null +++ b/src/rougail/output_ansible/config.py @@ -0,0 +1,54 @@ +""" +Silique (https://www.silique.fr) +Copyright (C) 2024 + +This program is free software: you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as published by the +Free Software Foundation, either version 3 of the License, or (at your +option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more +details. + +You should have received a copy of the GNU Lesser General Public License +along with this program. If not, see . +""" + +from pathlib import Path + + +def get_rougail_config( + *, + backward_compatibility=True, +) -> dict: + options = """ +ansible: + description: Configuration of output Ansible + disabled: + type: jinja + jinja: | + {% if step.output != 'ansible' %} + disabled + {% endif %} + + host_namespace: + description: Namespace with host values + default: "hosts" + disabled: + type: jinja + jinja: | + {% if step.output != 'ansible' %} + disabled + {% endif %} +""" + return { + "name": "ansible", + "process": "output", + "options": options, + "level": 60, + } + + +__all__ = ("get_rougail_config",) diff --git a/src/rougail/output_ansible/i18n.py b/src/rougail/output_ansible/i18n.py new file mode 100644 index 0000000..78393c0 --- /dev/null +++ b/src/rougail/output_ansible/i18n.py @@ -0,0 +1,24 @@ +"""Internationalisation utilities +Silique (https://www.silique.fr) +Copyright (C) 2024 + +This program is free software: you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as published by the +Free Software Foundation, either version 3 of the License, or (at your +option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more +details. + +You should have received a copy of the GNU Lesser General Public License +along with this program. If not, see . +""" + +from gettext import translation +from pathlib import Path + +t = translation("rougail_output_ansible", str(Path(__file__).parent / "locale"), fallback=True) + +_ = t.gettext diff --git a/src/rougail/output_ansible/locale/fr/LC_MESSAGES/rougail_output_ansible.mo b/src/rougail/output_ansible/locale/fr/LC_MESSAGES/rougail_output_ansible.mo new file mode 100644 index 0000000..fb7e0ae Binary files /dev/null and b/src/rougail/output_ansible/locale/fr/LC_MESSAGES/rougail_output_ansible.mo differ