From 0e2ea0b96852d01c4b1551542e178b85a7565d62 Mon Sep 17 00:00:00 2001
From: Dany LE <xsang.le@gmail.com>
Date: Fri, 11 Apr 2025 13:25:17 +0000
Subject: [PATCH] feat: add example module to collection, and perform sanity
 check

---
 .../coll/test/meta/runtime.yml                |   2 +-
 .../coll/test/plugins/modules/my_module.py    | 112 ++++++++++++++++++
 2 files changed, 113 insertions(+), 1 deletion(-)
 create mode 100644 projet00/collections/ansible_collections/coll/test/plugins/modules/my_module.py

diff --git a/projet00/collections/ansible_collections/coll/test/meta/runtime.yml b/projet00/collections/ansible_collections/coll/test/meta/runtime.yml
index 20f709e..2fe301c 100644
--- a/projet00/collections/ansible_collections/coll/test/meta/runtime.yml
+++ b/projet00/collections/ansible_collections/coll/test/meta/runtime.yml
@@ -1,7 +1,7 @@
 ---
 # Collections must specify a minimum required ansible version to upload
 # to galaxy
-# requires_ansible: '>=2.9.10'
+requires_ansible: '>=2.9.10'
 
 # Content that Ansible needs to load from another location or that has
 # been deprecated/removed
diff --git a/projet00/collections/ansible_collections/coll/test/plugins/modules/my_module.py b/projet00/collections/ansible_collections/coll/test/plugins/modules/my_module.py
new file mode 100644
index 0000000..cb9c70c
--- /dev/null
+++ b/projet00/collections/ansible_collections/coll/test/plugins/modules/my_module.py
@@ -0,0 +1,112 @@
+#!/usr/bin/python
+# Copyright: (c) 2024, Ton Nom <ton@email.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import (absolute_import, division, print_function)
+
+
+DOCUMENTATION = """
+---
+module: my_module
+short_description: Crée un fichier avec un message personnalisé
+description:
+  - Ce module écrit un message de salutation dans un fichier.
+  - Il prend en compte l'idempotence, le mode check, et fournit un diff si le fichier change.
+options:
+  name:
+    description:
+      - Le nom de la personne à saluer.
+    required: true
+    type: str
+  path:
+    description:
+      - Le chemin du fichier à créer ou mettre à jour.
+    required: true
+    type: str
+author:
+  - "Dany (@xsang)"
+"""
+
+EXAMPLES = """
+- name: Créer un message dans un fichier
+  mon_module:
+    name: Alice
+    path: /tmp/bonjour.txt
+"""
+
+RETURN = """
+message:
+  description: Résultat de l'exécution
+  type: str
+  returned: always
+diff:
+  description: Ancien vs nouveau contenu (si applicable)
+  type: dict
+  returned: when changed
+"""
+__metaclass__ = type
+from ansible.module_utils.basic import AnsibleModule
+import os
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec=dict(
+            name=dict(type="str", required=True),
+            path=dict(type="str", required=True),
+        ),
+        supports_check_mode=True
+    )
+
+    name = module.params["name"]
+    path = module.params["path"]
+
+    # Nouveau contenu généré
+    new_content = f"Bonjour {name} ! Passe une excellente journée avec Ansible.\n"
+    old_content = ""
+
+    # Lire l'ancien contenu s'il existe
+    if os.path.exists(path):
+        try:
+            with open(path, "r") as f:
+                old_content = f.read()
+        except Exception as e:
+            module.fail_json(msg=f"Erreur de lecture du fichier : {str(e)}")
+
+    # Vérifier s'il y a une réelle différence
+    content_changed = old_content != new_content
+
+    # Mode check : on affiche le diff mais on ne change rien
+    if module.check_mode:
+        module.exit_json(
+            changed=content_changed,
+            message="Simulation : le fichier serait mis à jour." if content_changed else "Simulation : aucun changement.",
+            diff={"before": old_content, "after": new_content} if content_changed else {}
+        )
+
+    # Si le contenu est déjà identique → rien à faire
+    if not content_changed:
+        module.exit_json(
+            changed=False,
+            message="Aucun changement nécessaire. Le fichier est déjà à jour."
+        )
+
+    # Sinon, on écrit le nouveau contenu
+    try:
+        with open(path, "w") as f:
+            f.write(new_content)
+    except Exception as e:
+        module.fail_json(msg=f"Erreur d'écriture du fichier : {str(e)}")
+
+    # Message visible dans le callback (stdout)
+    module.log(f"Nouveau message pour {name} écrit dans {path}")
+
+    # Fin : on informe Ansible que le contenu a changé
+    module.exit_json(
+        changed=True,
+        message=f"Fichier {path} mis à jour pour {name}.",
+        diff={"before": old_content, "after": new_content}
+    )
+
+
+if __name__ == "__main__":
+    main()