1. Remove sanity ignore files

2. Fix import issues with requests
3. Remove Beta from readme
4. Addding argument documention
5. Add missing GPLv3 License header

Author: hcherukuri

.github/workflows/ci.yml

@@ -35,7 +35,7 @@ jobs:
           if [ -f ansible_collections/middleware_automation/common/requirements.txt ]; then
             pip install -r ansible_collections/middleware_automation/common/requirements.txt
           fi
-
+  
       - name: Create default collection path
         run: |
           mkdir -p /home/runner/.ansible/

README.md

@@ -47,7 +47,7 @@ To install all the dependencies via galaxy:
 
 ## Support
 
-The common collection is a Beta release and for [Technical Preview](https://access.redhat.com/support/offerings/techpreview). If you have any issues or questions related to collection, please don't hesitate to contact us on <Ansible-middleware-core@redhat.com> or open an issue on <https://github.com/ansible-middleware/common/issues>
+The common collection is for [Technical Preview](https://access.redhat.com/support/offerings/techpreview). If you have any issues or questions related to collection, please don't hesitate to contact us on <Ansible-middleware-core@redhat.com> or open an issue on <https://github.com/ansible-middleware/common/issues>
 
 ## License
 

galaxy.yml

@@ -1,7 +1,7 @@
 ---
 namespace: middleware_automation
 name: common
-version: "1.0.0"
+version: "1.0.1"
 readme: README.md
 authors:
   - Andrew Block <ablock@redhat.com>

plugins/doc_fragments/jbossnetwork_connection_options.py

@@ -12,29 +12,50 @@ class ModuleDocFragment(object):
           - Address of the JBoss Network API.
       type: str
       required: false
+      default: 'https://jbossnetwork.api.redhat.com'
   client_id:
       description:
           - Client ID associated with to download a product from the JBoss Network API.
           - If value not set, will try environment variable C(REDHAT_PRODUCT_DOWNLOAD_CLIENT_ID)
       type: str
-      required: true
+      required: false
   client_secret:
       description:
           - Client Secret associated with to download a product from the JBoss Network API.
           - If value not set, will try environment variable C(REDHAT_PRODUCT_DOWNLOAD_CLIENT_SECRET)
       type: str
-      required: true
+      required: false
   sso_url:
       description:
           - Address of the Red Hat SSO Server.
       type: str
       required: false
+      default: 'https://sso.redhat.com'
   validate_certs:
       description:
       - If C(false), SSL certificates will not be validated.
       type: bool
       default: yes
       required: false
-
+  product_category:
+      description:
+          - Type of the Product Category
+      type: str
+      required: false
+  product_id:
+      description:
+      - Product Id for the Redhat customer portal
+      type: str
+      required: false
+  product_type:
+      description:
+          - Type of the Product
+      type: str
+      required: false
+  product_version:
+      description:
+      - Product Version to be downloaded.
+      type: str
+      required: false
 
 """

plugins/module_utils/args_common.py

@@ -26,7 +26,7 @@
     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(

plugins/module_utils/jbossnetwork.py

@@ -16,7 +16,11 @@
 
 __metaclass__ = type
 
-import requests
+try:
+    import requests
+    HAS_REQUESTS = True
+except ImportError:
+    HAS_REQUESTS = False
 
 from ansible_collections.middleware_automation.common.plugins.module_utils.constants import (
     QUERY_PAGE_SIZE,
@@ -45,9 +49,10 @@ def get_authenticated_session(module, sso_url, validate_certs, client_id, client
     }
 
     # Obtain Access Token
-    token_request = requests.post(
-        f"{sso_url}/auth/realms/redhat-external/protocol/openid-connect/token",
-        data=token_request_data, verify=validate_certs)
+    if HAS_REQUESTS:
+        token_request = requests.post(
+            f"{sso_url}/auth/realms/redhat-external/protocol/openid-connect/token",
+            data=token_request_data, verify=validate_certs)
 
     try:
         token_request.raise_for_status()
@@ -57,11 +62,12 @@ def get_authenticated_session(module, sso_url, validate_certs, client_id, client
     access_token = token_request.json()["access_token"]
 
     # Setup Session
-    session = requests.Session()
-    session.headers = {
-        "Authorization": f"Bearer {access_token}",
-        "Content-Type": "application/json",
-    }
+    if HAS_REQUESTS:
+        session = requests.Session()
+        session.headers = {
+            "Authorization": f"Bearer {access_token}",
+            "Content-Type": "application/json",
+        }
 
     return session
 

plugins/modules/product_download.py

@@ -12,6 +12,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
 from __future__ import absolute_import, division, print_function
 
 __metaclass__ = type
@@ -32,13 +47,15 @@
     dest:
         description:
             - Absolute  .
-        type: path
+        type: str
         required: true
     force:
         description:
         - If C(true) and C(dest) is not a directory, will download the file every
             time and replace the file if the contents change. If C(false), the file
             will only be downloaded if the destination does not exist.
+        default: False
+        type: bool
 """
 
 
@@ -149,7 +166,7 @@ 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
 

plugins/modules/product_search.py

@@ -12,6 +12,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
 from __future__ import absolute_import, division, print_function
 
 __metaclass__ = type
@@ -143,7 +158,7 @@ def argspec():
 def main():
     module = AnsibleModule(
         argument_spec=argspec(),
-        add_file_common_args=True
+        add_file_common_args=False
     )
 
     if not HAS_REQUESTS: