fixes #67

plugins/action/query_graphql.py

@@ -45,6 +45,13 @@ def nautobot_action_graphql(args):
     if not isinstance(ssl_verify, bool):
         raise AnsibleError("validate_certs must be a boolean")
 
+    populate_root = args.get("populate_root", False)
+    Display().vv("Populate root is set to: %s" % populate_root)
+
+    # Verify SSL Verify is of boolean
+    if not isinstance(populate_root, bool):
+        raise AnsibleError("populate_root must be a boolean")
+
     nautobot_api = NautobotApiBase(token=token, url=url, ssl_verify=ssl_verify)
     query = args.get("query")
     Display().v("Query String: %s" % query)
@@ -90,8 +97,14 @@ def nautobot_action_graphql(args):
 
     # Good result, return it
     if isinstance(nautobot_response, pynautobot.core.graphql.GraphQLRecord):
-        # Assign the data of a good result to the response
-        results["data"] = nautobot_response.json.get("data")
+        # If populate_root is set, add to ansible_facts which will set to the root of
+        # the data structure, e.g. hostvars[inventory_hostname]
+        if args.get("populate_root"):
+            results["ansible_facts"] = nautobot_response.json.get("data")
+        else:
+            # Assign the data of a good result to the response to the data key
+            # otherwise, e.g. hostvars[inventory_hostname]['data']
+            results["data"] = nautobot_response.json.get("data")
 
     return results
 

plugins/modules/query_graphql.py

@@ -50,6 +50,14 @@
         required: False
         default: True
         type: bool
+    populate_root:
+        description:
+            - Whether or not to populate data in the in the root (e.g. hostvars[inventory_hostname]) or within the
+              'data' key (e.g. hostvars[inventory_hostname]['data']). Beware, that the root keys provided by the query
+              will overwrite any root keys already present, leverage the GraphQL alias feature to avoid issues.
+        required: False
+        default: False
+        type: bool
 """
 
 EXAMPLES = """
@@ -82,22 +90,23 @@
         site_name: den
       query_string: |
         query ($site_name:String!) {
-            sites (name: $site_name) {
+          sites (name: $site_name) {
             id
             name
             region {
                 name
             }
-            }
+          }
         }
 
-  # Get Response with variables
+  # Get Response with variables and set to root keys
   - name: Obtain list of devices at site in variables from Nautobot
     networktocode.nautobot.query_graphql:
       url: http://nautobot.local
       token: thisIsMyToken
       query: "{{ query_string }}"
       variables: "{{ variables }}"
+      populate_root: "yes"
 """
 
 RETURN = """
@@ -145,6 +154,7 @@ def main():
             token=dict(required=False, type="str", no_log=True, default=None),
             url=dict(required=False, type="str", default=None),
             validate_certs=dict(required=False, type="bool", default=True),
+            populate_root=dict(required=False, type="bool", default=False),
         ),
         # Set to true as this is a read only API, this may need to change or have significant changes when Mutations are
         # added to the GraphQL endpoint of Nautobot

tests/unit/action/test_graphql_query.py

@@ -30,6 +30,14 @@ def test_setup_api_error_incorrect_validate_certs(nautobot_valid_args):
     assert str(exc.value) == "validate_certs must be a boolean"
 
 
+def test_setup_api_error_incorrect_populate_root(nautobot_valid_args):
+    nautobot_valid_args["populate_root"] = "Hi"
+    with pytest.raises(AnsibleError) as exc:
+        test_class = nautobot_action_graphql(args=nautobot_valid_args)
+
+    assert str(exc.value) == "populate_root must be a boolean"
+
+
 def test_query_api_query_error_none(nautobot_valid_args):
     nautobot_valid_args["query"] = None
     with pytest.raises(AnsibleError) as exc:

tests/unit/conftest.py

@@ -58,4 +58,5 @@ def nautobot_valid_args(graphql_test_query):
         "validate_certs": False,
         "query": graphql_test_query,
         "graph_variables": {},
+        "populate_root": False,
     }