Corrections to failing tests

Signed-off-by: Andrew Block <andy.block@gmail.com>

Author: sabre1041

plugins/doc_fragments/jbossnetwork_search_options.py

@@ -1,3 +1,17 @@
+# Copyright [2023] [Red Hat, Inc.]
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 from __future__ import absolute_import, division, print_function
 
 __metaclass__ = type
@@ -12,12 +26,12 @@
     client_secret=dict(no_log=True, required=False),
     api_url=dict(required=False, default=JBOSS_NETWORK_API_URL),
     sso_url=dict(required=False, default=REDHAT_SSO_URL),
-    validate_certs=dict(required=False,default=True, type=bool)
+    validate_certs=dict(required=False, default=True, type=bool)
 )
 
 JBOSS_NETWORK_SEARCH_ARGS_SPEC = dict(
     product_id=dict(required=False),
     product_category=dict(required=False),
     product_type=dict(required=False),
     product_version=dict(required=False)
-)
+)

plugins/module_utils/args_common.py

@@ -1,3 +1,17 @@
+# Copyright [2023] [Red Hat, Inc.]
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 from __future__ import absolute_import, division, print_function
 
 __metaclass__ = type
@@ -7,10 +21,9 @@
 REDHAT_PRODUCT_DOWNLOAD_CLIENT_ID_ENV_VAR = "REDHAT_PRODUCT_DOWNLOAD_CLIENT_ID"
 REDHAT_PRODUCT_DOWNLOAD_CLIENT_SECRET_ENV_VAR = "REDHAT_PRODUCT_DOWNLOAD_CLIENT_SECRET"
 
-
 API_SERVICE_PATH = "/v1/middleware"
 LIST_PRODUCT_CATEGORIES_ENDPOINT = "/list/categories"
-SEARCH_ENDPOINT = "/search" 
+SEARCH_ENDPOINT = "/search"
 
 QUERY_PAGE_SIZE = 100
 
@@ -24,4 +37,4 @@
 SEARCH_PARAM_NAME = "name"
 SEARCH_PARAM_VERSION = "version"
 SEARCH_PARAM_CATEGORY = "category"
-SEARCH_PARAM_TYPE = "type"
+SEARCH_PARAM_TYPE = "type"

plugins/module_utils/constants.py

@@ -1,3 +1,17 @@
+# Copyright [2023] [Red Hat, Inc.]
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 from __future__ import absolute_import, division, print_function
 
 __metaclass__ = type
@@ -30,7 +44,6 @@ def get_authenticated_session(module, sso_url, validate_certs, client_id, client
         "grant_type": "client_credentials",
     }
 
-
     # Obtain Access Token
     token_request = requests.post(
         f"{sso_url}/auth/realms/redhat-external/protocol/openid-connect/token",
@@ -52,8 +65,8 @@ def get_authenticated_session(module, sso_url, validate_certs, client_id, client
 
     return session
 
-def generate_search_params(product_category, product_id, product_type, product_version):
 
+def generate_search_params(product_category, product_id, product_type, product_version):
     search_params = {
         SEARCH_PARAM_CATEGORY: product_category,
         SEARCH_PARAM_TYPE: product_type,
@@ -65,11 +78,15 @@ def generate_search_params(product_category, product_id, product_type, product_v
 
     return search_params
 
-def perform_search(session, url, validate_certs, params={}):
+
+def perform_search(session, url, validate_certs, params=None):
 
     nextCursor = None
     results = []
 
+    if params is None:
+        params = {}
+
     while True:
 
         pagination_params = {}
@@ -91,7 +108,7 @@ def perform_search(session, url, validate_certs, params={}):
 
         results.extend(
             query_result_json[RESULTS_FIELD])
-        
+
         if NEXT_CURSOR_FIELD not in query_result_json or query_result_json[NEXT_CURSOR_FIELD] is None:
             break
 

plugins/module_utils/jbossnetwork.py

@@ -28,7 +28,6 @@
 extends_documentation_fragment:
     - files
     - middleware_automation.common.jbossnetwork_connection_options
-    - middleware_automation.common.jbossnetwork_search_options
 options:
     dest:
         description:
@@ -136,23 +135,25 @@
     LIST_PRODUCT_CATEGORIES_ENDPOINT
 )
 
-
 try:
     import requests
     HAS_REQUESTS = True
 except ImportError:
     HAS_REQUESTS = False
     REQUESTS_IMP_ERR = traceback.format_exc()
+else:
+    REQUESTS_IMP_ERR = None
 
 
 def argspec():
     argument_spec = copy.deepcopy(JBOSS_NETWORK_COMMON_ARGS_SPEC)
     argument_spec.update(copy.deepcopy(JBOSS_NETWORK_SEARCH_ARGS_SPEC))
     argument_spec["dest"] = dict(required=True)
-    argument_spec["force"] = dict(required=False,default=False, type=bool)
+    argument_spec["force"] = dict(required=False, default=False, type=bool)
 
     return argument_spec
 
+
 def main():
     module = AnsibleModule(
         argument_spec=argspec(),
@@ -161,7 +162,7 @@ def main():
 
     if not HAS_REQUESTS:
         module.fail_json(msg=missing_required_lib("requests"), exception=REQUESTS_IMP_ERR)
-    
+
     client_id = module.params.get('client_id')
     client_secret = module.params.get('client_secret')
     api_url = module.params.get('api_url')
@@ -178,28 +179,29 @@ def main():
         client_id = os.environ.get(REDHAT_PRODUCT_DOWNLOAD_CLIENT_ID_ENV_VAR)
 
     if not client_id:
-        module.fail_json(msg=str(f"Client ID not specified and unable to determine Client ID from '{REDHAT_PRODUCT_DOWNLOAD_CLIENT_ID_ENV_VAR}' environment variable."))
+        module.fail_json(msg=str("Client ID not specified and unable to determine Client ID "
+                                 f"from '{REDHAT_PRODUCT_DOWNLOAD_CLIENT_ID_ENV_VAR}' environment variable."))
 
     if not client_secret:
         client_secret = os.environ.get(REDHAT_PRODUCT_DOWNLOAD_CLIENT_SECRET_ENV_VAR)
 
     if not client_secret:
-        module.fail_json(msg=str(f"Client Secret not specified and unable to determine Client Secret from '{REDHAT_PRODUCT_DOWNLOAD_CLIENT_SECRET_ENV_VAR}' environment variable."))
+        module.fail_json(msg=str("Client Secret not specified and unable to determine Client Secret "
+                                 f"from '{REDHAT_PRODUCT_DOWNLOAD_CLIENT_SECRET_ENV_VAR}' environment variable."))
 
     if not dest:
         module.fail_json(msg=str("Destination path not provided"))
-    
+
     session = get_authenticated_session(module, sso_url, validate_certs, client_id, client_secret)
 
     api_base_url = f"{api_url}{API_SERVICE_PATH}"
 
-
     if product_category is not None:
         # List Product Categories
         product_categories = []
 
         try:
-            product_categories = perform_search(session, f"{api_base_url}{LIST_PRODUCT_CATEGORIES_ENDPOINT}",validate_certs)
+            product_categories = perform_search(session, f"{api_base_url}{LIST_PRODUCT_CATEGORIES_ENDPOINT}", validate_certs)
         except Exception as err:
             module.fail_json(msg="Error Listing Available Product Categories: %s" % (to_native(err)))
 
@@ -212,7 +214,7 @@ def main():
     search_params = generate_search_params(product_category, product_id, product_type, product_version)
 
     try:
-        search_results = perform_search(session, f"{api_base_url}{SEARCH_ENDPOINT}", validate_certs,search_params)
+        search_results = perform_search(session, f"{api_base_url}{SEARCH_ENDPOINT}", validate_certs, search_params)
     except Exception as err:
         module.fail_json(msg="Error Searching for Products: %s" % (to_native(err)))
 
@@ -225,10 +227,10 @@ def main():
         ]
 
         for productIdx, product in enumerate(search_results):
-            msg.append(f"{productIdx+1} - ({search_results[productIdx]['id']}) {search_results[productIdx]['title']}.")
-        
+            msg.append(f"{productIdx+1} - ({product['id']}) {product['title']}.")
+
         module.fail_json(msg=" ".join(msg))
-    
+
     file_name = search_results[0]['file_path'].rsplit('/')[-1]
 
     dest_is_dir = os.path.isdir(dest)
@@ -241,11 +243,10 @@ def main():
         dest=dest
     )
 
-
     if os.path.exists(dest) and not force:
         file_args = module.load_file_common_arguments(module.params, path=dest)
         result['changed'] = module.set_fs_attributes_if_different(file_args, False)
-         
+
         if result['changed']:
             module.exit_json(msg="file already exists but file attributes changed", **result)
         module.exit_json(msg="file already exists", **result)
@@ -265,12 +266,13 @@ def main():
             module.fail_json(msg="Destination %s is not writable" % (os.path.dirname(dest)), **result)
 
     try:
-        with session.get(search_results[0]["download_path"], verify=validate_certs, stream=True, allow_redirects=True, headers={"User-Agent": "product_download"}) as r:
+        with session.get(search_results[0]["download_path"], verify=validate_certs,
+                         stream=True, allow_redirects=True, headers={"User-Agent": "product_download"}) as r:
             r.raise_for_status()
             with open(dest, 'wb') as f:
                 for chunk in r.iter_content(chunk_size=8192):
                     f.write(chunk)
-        
+
         result['changed'] = True
     except Exception as err:
         module.fail_json(msg="Error Downloading %s: %s" % (search_results[0]['title'], to_native(err)))
@@ -282,7 +284,7 @@ def main():
         result['md5sum'] = module.md5(dest)
     except ValueError:
         result['md5sum'] = None
-    
+
     module.exit_json(msg="", **result)