Merge pull request #131 from opsmill/develop

Pre-release
opsmill · Nov 4, 2024 · f74ade9 · f74ade9
2 parents 3f1e8e3 + 0c83073
commit f74ade9
Show file tree

Hide file tree

Showing 27 changed files with 327 additions and 208 deletions.
diff --git a/.yamllint.yml b/.yamllint.yml
@@ -4,7 +4,7 @@ extends: default
 ignore: |
   /.venv
   /examples
-  /tests/**/output*
+  /tests/**
   changelogs/changelog.yaml
 
 rules:

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,5 +1,4 @@
 ---
-version: "3.4"
 x-args:
   &args
   PYTHON_VER: ${PYTHON_VER}

diff --git a/docs/plugins/artifact_fetch_module.rst b/docs/plugins/artifact_fetch_module.rst
@@ -6,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.13.1
+  :antsibull-docs: 2.15.0
 
 .. Anchors
 
@@ -22,7 +22,7 @@ opsmill.infrahub.artifact_fetch module -- Fetch the content of an artifact from
 .. Collection note
 
 .. note::
-    This module is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/ui/repo/published/opsmill/infrahub/>`_ (version 1.2.0).
+    This module is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/ui/repo/published/opsmill/infrahub/>`_ (version 1.2.2).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

diff --git a/docs/plugins/environment_variables.rst b/docs/plugins/environment_variables.rst
@@ -1,7 +1,7 @@
 :orphan:
 
 .. meta::
-  :antsibull-docs: 2.13.1
+  :antsibull-docs: 2.15.0
 
 .. _list_of_collection_env_vars:
 

diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst
@@ -1,13 +1,13 @@
 .. meta::
-  :antsibull-docs: 2.13.1
+  :antsibull-docs: 2.15.0
 
 
 .. _plugins_in_opsmill.infrahub:
 
 Opsmill.Infrahub
 ================
 
-Collection version 1.2.0
+Collection version 1.2.2
 
 .. contents::
    :local:

diff --git a/docs/plugins/install_role.rst b/docs/plugins/install_role.rst
@@ -6,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.13.1
+  :antsibull-docs: 2.15.0
 
 .. Anchors
 
@@ -20,7 +20,7 @@ opsmill.infrahub.install role -- Install Infrahub
 .. Collection note
 
 .. note::
-    This role is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/ui/repo/published/opsmill/infrahub/>`_ (version 1.2.0).
+    This role is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/ui/repo/published/opsmill/infrahub/>`_ (version 1.2.2).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

diff --git a/docs/plugins/inventory_inventory.rst b/docs/plugins/inventory_inventory.rst
@@ -6,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.13.1
+  :antsibull-docs: 2.15.0
 
 .. Anchors
 
@@ -22,7 +22,7 @@ opsmill.infrahub.inventory inventory -- Infrahub inventory source (using GraphQL
 .. Collection note
 
 .. note::
-    This inventory plugin is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/ui/repo/published/opsmill/infrahub/>`_ (version 1.2.0).
+    This inventory plugin is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/ui/repo/published/opsmill/infrahub/>`_ (version 1.2.2).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -207,7 +207,7 @@ Parameters
 
       - INI entry:
 
-        .. code-block::
+        .. code-block:: ini
 
           [inventory]
           cache = false
@@ -259,14 +259,14 @@ Parameters
 
       - INI entries:
 
-        .. code-block::
+        .. code-block:: ini
 
           [defaults]
           fact_caching_connection = VALUE
 
 
 
-        .. code-block::
+        .. code-block:: ini
 
           [inventory]
           cache_connection = VALUE
@@ -324,14 +324,14 @@ Parameters
 
       - INI entries:
 
-        .. code-block::
+        .. code-block:: ini
 
           [defaults]
           fact_caching = memory
 
 
 
-        .. code-block::
+        .. code-block:: ini
 
           [inventory]
           cache_plugin = memory
@@ -389,14 +389,29 @@ Parameters
 
       - INI entries:
 
-        .. code-block::
+        .. code-block:: ini
+
+          [default]
+          fact_caching_prefix = ansible_inventory_
+
+
+        Removed in: version 2.16 of ansible.builtin
+
+
+        Why: Fixes typing error in INI section name
+
+        Alternative: Use the 'defaults' section instead
+
+
+
+        .. code-block:: ini
 
           [defaults]
           fact_caching_prefix = ansible_inventory_
 
 
 
-        .. code-block::
+        .. code-block:: ini
 
           [inventory]
           cache_prefix = ansible_inventory_
@@ -454,14 +469,14 @@ Parameters
 
       - INI entries:
 
-        .. code-block::
+        .. code-block:: ini
 
           [defaults]
           fact_caching_timeout = 3600
 
 
 
-        .. code-block::
+        .. code-block:: ini
 
           [inventory]
           cache_timeout = 3600
@@ -644,7 +659,7 @@ Parameters
 
       The default value when the host variable's value is an empty string.
 
-      This option is mutually exclusive with :ansopt:`opsmill.infrahub.inventory#inventory:keyed\_groups[].trailing\_separator`.
+      This option is mutually exclusive with :literal:`trailing\_separator`.
 
 
       .. raw:: html
@@ -880,9 +895,9 @@ Parameters
 
         <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
 
-      Set this option to :ansval:`False` to omit the :ansopt:`opsmill.infrahub.inventory#inventory:keyed\_groups[].separator` after the host variable when the value is an empty string.
+      Set this option to :emphasis:`False` to omit the :literal:`separator` after the host variable when the value is an empty string.
 
-      This option is mutually exclusive with :ansopt:`opsmill.infrahub.inventory#inventory:keyed\_groups[].default\_value`.
+      This option is mutually exclusive with :literal:`default\_value`.
 
 
       .. rst-class:: ansible-option-line
@@ -1265,7 +1280,7 @@ Parameters
 
         <div class="ansible-option-cell">
 
-      If :ansval:`yes` make invalid entries a fatal error, otherwise skip and continue.
+      If :literal:`yes` make invalid entries a fatal error, otherwise skip and continue.
 
       Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default.
 
@@ -1417,7 +1432,7 @@ Parameters
 
       - INI entry:
 
-        .. code-block::
+        .. code-block:: ini
 
           [inventory_plugins]
           use_extra_vars = false
@@ -1513,10 +1528,10 @@ Examples
       InfraDevice:
         include:
           - name
-          - platform
-          - primary_address
+          - platform.ansible_network_os
+          - primary_address.address
+          - site.name
           - interfaces
-          - site
 
     compose:
       hostname: name

diff --git a/docs/plugins/lookup_lookup.rst b/docs/plugins/lookup_lookup.rst
@@ -6,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.13.1
+  :antsibull-docs: 2.15.0
 
 .. Anchors
 
@@ -22,7 +22,7 @@ opsmill.infrahub.lookup lookup -- Queries and returns elements from Infrahub (us
 .. Collection note
 
 .. note::
-    This lookup plugin is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/ui/repo/published/opsmill/infrahub/>`_ (version 1.2.0).
+    This lookup plugin is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/ui/repo/published/opsmill/infrahub/>`_ (version 1.2.2).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

diff --git a/docs/plugins/query_graphql_module.rst b/docs/plugins/query_graphql_module.rst
@@ -6,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.13.1
+  :antsibull-docs: 2.15.0
 
 .. Anchors
 
@@ -22,7 +22,7 @@ opsmill.infrahub.query_graphql module -- Queries and returns elements from Infra
 .. Collection note
 
 .. note::
-    This module is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/ui/repo/published/opsmill/infrahub/>`_ (version 1.2.0).
+    This module is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/ui/repo/published/opsmill/infrahub/>`_ (version 1.2.2).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

diff --git a/galaxy.yml b/galaxy.yml
@@ -10,7 +10,7 @@ namespace: opsmill
 name: infrahub
 
 # The version of the collection. Must be compatible with semantic versioning
-version: 1.2.1
+version: 1.2.2
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md

diff --git a/plugins/inventory/inventory.py b/plugins/inventory/inventory.py
@@ -126,10 +126,10 @@
   InfraDevice:
     include:
       - name
-      - platform
-      - primary_address
+      - platform.ansible_network_os
+      - primary_address.address
+      - site.name
       - interfaces
-      - site
 
 compose:
   hostname: name

diff --git a/plugins/module_utils/exception.py b/plugins/module_utils/exception.py
@@ -9,7 +9,6 @@
 
 try:
     from infrahub_sdk.exceptions import (
-        FilterNotFoundError,
         GraphQLError,
         SchemaNotFoundError,
         ServerNotReachableError,
@@ -39,8 +38,6 @@ def wrapper(*args, **kwargs):
             raise Exception(f"An error occurred while executing the GraphQL Query {kwargs}")
         except SchemaNotFoundError:
             raise Exception(f"Unable to find the schema {kwargs}")
-        except FilterNotFoundError:
-            raise Exception(f"Filters not Found {kwargs}")
         except ServerNotReachableError:
             raise Exception("Server not Reacheable")
         except ServerNotResponsiveError:

diff --git a/plugins/module_utils/infrahub_utils.py b/plugins/module_utils/infrahub_utils.py
@@ -58,14 +58,14 @@ def __init__(
         @handle_infrahub_exceptions
         def fetch_single_artifact(
             self,
-            filters: Optional[Dict[str, str]] = None,
+            filters: Dict[str, str],
             branch: Optional[str] = None,
         ) -> List[InfrahubNodeSync]:
             """
             Retrieve all artifact content
 
             Parameters:
-                filters (Optional[Dict[str, str]]): Dict of filters to apply on the query
+                artifact (Optional[Dict[str, str]]): Dict of filters to apply on the query
                 branch (Optional[str]): Name of the branch to query from. Defaults to default_branch.
 
             Returns:
@@ -129,6 +129,8 @@ def fetch_artifacts(
         def fetch_single_node(  # noqa: PLR0917
             self,
             kind: str,
+            id: Optional[str] = None,
+            hfid: Optional[list[str]] = None,
             include: Optional[List[str]] = None,
             exclude: Optional[List[str]] = None,
             filters: Optional[Dict[str, str]] = None,
@@ -140,6 +142,8 @@ def fetch_single_node(  # noqa: PLR0917
 
             Parameters:
                 kind (str): kind of the nodes to query
+                id (Optional[str]): ID of the node to retrieve
+                hfid (Optional[List[str]]): HFID of the node to retrieve
                 include (Optional[List[str]]): list of attributes/relationship to retrieve
                 exclude (Optional[List[str]]): list of attributes/relationship to ignore
                 filters (Optional[Dict[str, str]]): Dict of filters to apply on the query
@@ -149,11 +153,18 @@ def fetch_single_node(  # noqa: PLR0917
             Returns:
                 InfrahubNodeSync: Single Infrahub Node
             """
+            if id:
+                filters["ids"] = [id]
+            if hfid:
+                filters["hfid"] = hfid
+
             if not filters:
                 raise Exception("At least one filter must be provided")
 
             node = self.client.get(
                 kind=kind,
+                id=id,
+                hfid=hfid,
                 include=include,
                 populate_store=True,
                 exclude=exclude,