bump: version 0.1.0a4 → 0.1.0a5

CHANGELOG.md

@@ -0,0 +1,65 @@
+## 0.1.0a5 (2025-11-21)
+
+### Fix
+
+- ExtentionError => ExtensionError
+
+## 0.1.0a4 (2025-11-06)
+
+### Fix
+
+- disable config if ansible is not selected
+
+## 0.1.0a3 (2025-05-02)
+
+### Fix
+
+- do not force use_data usage
+
+## 0.1.0a2 (2025-04-09)
+
+### Fix
+
+- version
+
+## 0.1.0a1 (2025-03-30)
+
+### Fix
+
+- i18n
+
+## 0.1.0a0 (2025-02-10)
+
+### Feat
+
+- add new parameter ansible.file_with_secrets
+
+## 0.0.1a4 (2025-01-02)
+
+### Fix
+
+- output ansible is loaded after
+
+## 0.0.1a3 (2024-12-11)
+
+### Fix
+
+- user-data file is now user-data yaml
+
+## 0.0.1a2 (2024-12-11)
+
+### Fix
+
+- specialize error
+
+## 0.0.1a1 (2024-11-27)
+
+### Fix
+
+- support user data ansible with output ansible
+
+## 0.0.1a0 (2024-11-25)
+
+### Fix
+
+- new ansible plugin loader

locale/fr/LC_MESSAGES/rougail_user_data_ansible.po

@@ -0,0 +1,39 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR ORGANIZATION
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"POT-Creation-Date: 2025-02-10 09:15+0100\n"
+"PO-Revision-Date: 2025-02-10 09:15+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/user_data_ansible/__init__.py:47
+msgid "ansible is not set in step.user_data"
+msgstr "ansible n'est pas définit dans step.user_data"
+
+#: src/rougail/user_data_ansible/config.py:30
+msgid "Configuration of user data Ansible"
+msgstr "Configuration des données utilisateurs Ansible"
+
+#: src/rougail/user_data_ansible/config.py:39
+msgid "Ansible filename inventory"
+msgstr "Nom du fichier d'inventaire Ansible"
+
+#: src/rougail/user_data_ansible/config.py:55
+msgid "Secret to decrypt file"
+msgstr "Secret pour déchiffrer le fichier"
+
+#: src/rougail/user_data_ansible/config.py:65
+#, fuzzy
+#| msgid "Ansible file that may contain passwords"
+msgid "Ansible file that may contain secrets"
+msgstr "Fichier Ansible qui peuvent contenir des secrets"

locale/rougail_user_data_ansible.pot

@@ -0,0 +1,37 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR ORGANIZATION
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 2025-10-10 08:05+0200\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\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/user_data_ansible/__init__.py:48
+msgid "ansible is not set in step.user_data"
+msgstr ""
+
+#: src/rougail/user_data_ansible/config.py:30
+msgid "Configuration of user data Ansible"
+msgstr ""
+
+#: src/rougail/user_data_ansible/config.py:39
+msgid "Ansible filename inventory"
+msgstr ""
+
+#: src/rougail/user_data_ansible/config.py:55
+msgid "Secret to decrypt file"
+msgstr ""
+
+#: src/rougail/user_data_ansible/config.py:65
+msgid "Ansible file that may contain secrets"
+msgstr ""
+

pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+build-backend = "flit_core.buildapi"
+requires = ["flit_core >=3.8.0,<4"]
+
+[project]
+name = "rougail.user_data_ansible"
+version = "0.1.0a5"
+authors = [{name = "Emmanuel Garette", email = "gnunux@gnunux.info"}]
+readme = "README.md"
+description = "Rougail user_data 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.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Natural Language :: English",
+    "Natural Language :: French",
+
+]
+dependencies = [
+    "rougail-user-data-yaml >= 0.1,<2",
+    "ansible",
+]
+
+[project.urls]
+Home = "https://forge.cloud.silique.fr/stove/rougail-user-data-file"
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+tag_format = "$version"
+version_scheme = "pep440"
+version_provider = "pep621"
+version_files = [
+    "src/rougail/user_data_ansible/__version__.py",
+    "pyproject.toml:version"
+]
+update_changelog_on_bump = true
+changelog_merge_prerelease = true

src/rougail/user_data_ansible/__init__.py

@@ -0,0 +1,71 @@
+"""
+Silique (https://www.silique.fr)
+Copyright (C) 2024-2025
+
+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 <http://www.gnu.org/licenses/>.
+"""
+
+from pathlib import Path
+from ansible.parsing.vault import VaultLib, PromptVaultSecret
+from ansible.module_utils._text import to_bytes
+
+from rougail.user_data_yaml import RougailUserDataYaml
+from rougail.error import ExtensionError
+
+from .i18n import _
+from .__version__ import __version__
+
+
+class RougailUserDataAnsible(RougailUserDataYaml):
+    """Load Ansible data from encrypted file
+    """
+    def __init__(
+        self,
+        config,
+        *,
+        rougailconfig=None,
+    ) -> None:
+        if rougailconfig is None:
+            from rougail import RougailConfig
+            rougailconfig = RougailConfig
+            user_data = rougailconfig["step.user_data"]
+            if "ansible" not in user_data:
+                user_data.append("ansible")
+                rougailconfig["step.user_data"] = user_data
+        user_data = rougailconfig["step.user_data"]
+        if "ansible" not in user_data:
+            raise ExtensionError(_("ansible is not set in step.user_data"))
+        self.rougailconfig = rougailconfig
+        self.filenames = self.rougailconfig["ansible.filename"]
+        self.secret = self.rougailconfig["ansible.secret"]
+        self.file_with_secrets = self.rougailconfig["ansible.file_with_secrets"]
+        self.config = config
+        self.errors = []
+        self.warnings = []
+
+    def open(self, filename: str) -> dict:
+        """Open file
+        """
+        prompt = PromptVaultSecret(
+            to_bytes(self.secret), "default", ["Vault password: "]
+        )
+        vault = VaultLib([("default", prompt)])
+        with Path(filename).open("rb") as fh:
+            return self.yaml.load(vault.decrypt(fh.read()))
+
+
+RougailUserData = RougailUserDataAnsible
+
+
+__all__ = ("RougailUserDataAnsible",)

src/rougail/user_data_ansible/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0a5"

src/rougail/user_data_ansible/config.py

@@ -0,0 +1,87 @@
+"""
+Silique (https://www.silique.fr)
+Copyright (C) 2024-2025
+
+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 <http://www.gnu.org/licenses/>.
+"""
+from .i18n import _
+
+
+def get_rougail_config(
+    *,
+    backward_compatibility: bool = True,  # pylint: disable=unused-argument
+) -> dict:
+    """get rougail config for ansible"""
+    # redefine ansible family if already exists (for output)
+    # or create a new only only for user data
+    options = f"""
+ansible:
+  description: {_("Configuration of user data Ansible")}
+  disabled:
+    type: jinja
+    jinja: |
+      {{% if step.user_data is propertyerror or 'ansible' not in step.user_data %}}
+      disabled
+      {{% endif %}}
+
+  filename:
+    description: {_("Ansible filename inventory")}
+    type: unix_filename
+    multi: true
+    params:
+       allow_relative: True
+       test_existence: True
+       types:
+         - file
+    disabled:
+      type: jinja
+      jinja: |
+        {{% if step.user_data is propertyerror or 'ansible' not in step.user_data %}}
+        disabled
+        {{% endif %}}
+
+  secret:
+    description: {_("Secret to decrypt file")}
+    type: secret
+    disabled:
+      type: jinja
+      jinja: |
+        {{% if step.user_data is propertyerror or 'ansible' not in step.user_data %}}
+        disabled
+        {{% endif %}}
+
+  file_with_secrets:
+    description: {_("Ansible file that may contain secrets")}
+    default: all
+    choices:
+      - all
+      - first
+      - last
+      - none
+    disabled:
+      type: jinja
+      jinja: |
+        {{% if step.user_data is propertyerror or 'ansible' not in step.user_data %}}
+        disabled
+        {{% endif %}}
+"""
+    return {
+        "name": "ansible",
+        "process": "user data",
+        "options": options,
+        "level": 60,
+    }
+
+
+__all__ = ("get_rougail_config",)

src/rougail/user_data_ansible/i18n.py

@@ -0,0 +1,26 @@
+"""Internationalisation utilities
+Silique (https://www.silique.fr)
+Copyright (C) 2024-2025
+
+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 <http://www.gnu.org/licenses/>.
+"""
+
+from gettext import translation
+from pathlib import Path
+
+t = translation(
+    "rougail_user_data_ansible", str(Path(__file__).parent / "locale"), fallback=True
+)
+
+_ = t.gettext