Merge pull request #2 from merizrizal/improve-logic-of-create-vm-or-net

Add handling import error; and ansible-test into Makefile

Author: merizrizal

.github/workflows/ansible-sanity-test-lint.yml

@@ -0,0 +1,34 @@
+name: Run ansible test for lint sanity
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install ansible
+
+    - name: Run Ansible test
+      run: |
+        source envrc.github
+        make ansible-sanity-test-lint

Makefile

@@ -5,3 +5,9 @@ install:
 	@version=`(yq '.version' merizrizal/idcloudhost/galaxy.yml)`; \
 	ansible-galaxy collection install -f merizrizal-idcloudhost-$$version.tar.gz; \
 	rm merizrizal-idcloudhost-$$version.tar.gz
+
+ansible-sanity-test-lint: install
+	@dir=`(ansible-doc -F merizrizal.idcloudhost | head -n 1 | awk '//{print $$2}' | sed 's/merizrizal/ /g' | awk '//{print $$1}')`; \
+	cd $$dir/merizrizal/idcloudhost; \
+	python=`(which python3)`; \
+	ansible-test sanity --python-interpreter $$python --lint;

envrc

@@ -1 +1,6 @@
-export ROOT_DIR=`(pwd)`
+rootdir=`dirname ${BASH_SOURCE[0]-$0}`
+rootdir=`cd $rootdir && pwd`
+
+cp -f ${rootdir}/githooks/* ${rootdir}/.git/hooks/
+
+export ROOT_DIR=${rootdir}

envrc.github

@@ -0,0 +1,4 @@
+rootdir=`dirname ${BASH_SOURCE[0]-$0}`
+rootdir=`cd $rootdir && pwd`
+
+export ROOT_DIR=${rootdir}

githooks/pre-commit

@@ -0,0 +1,10 @@
+#!/bin/bash
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+BASE_DIR=$SCRIPT_DIR/../..
+
+cd ${BASE_DIR}
+make ansible-sanity-test-lint
+if [[ $? -gt 0 ]]; then
+    echo "We have sanity test failed. Commit is aborted. Please fix it first"
+    exit 1
+fi

merizrizal/idcloudhost/plugins/module_utils/__init__.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2025, Mei Rizal (@merizrizal) <meriz.rizal@gmail.com>
+# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
+from ansible.module_utils.basic import AnsibleModule
+
+
+def ensure_requests(module: AnsibleModule):
+    try:
+        import requests
+        HAS_REQUESTS = True
+    except ImportError:
+        HAS_REQUESTS = False
+
+    if HAS_REQUESTS:
+        return requests
+
+    module.fail_json(
+        msg='Could not import the requests Python module',
+        results=[]
+    )

merizrizal/idcloudhost/plugins/module_utils/ensure_packages.py

@@ -63,8 +63,11 @@
     returned: success
 '''
 
-import requests
 from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.merizrizal.idcloudhost.plugins.module_utils.ensure_packages import \
+    ensure_requests
+
+requests = None
 
 
 class CreateNetwork():
@@ -77,7 +80,7 @@ def __init__(self):
 
     def main(self):
         argument_spec = dict(
-            api_key=dict(type='str', required=True),
+            api_key=dict(type='str', required=True, no_log=True),
             name=dict(type='str', required=True),
             location=dict(type='str', required=True, choices=['jkt01', 'jkt02', 'jkt03', 'sgp01'])
         )
@@ -87,6 +90,8 @@ def main(self):
             supports_check_mode=True,
         )
 
+        requests = ensure_requests(module)
+
         self.name = module.params['name']
         self.api_key = module.params['api_key']
         self.location = module.params['location']

merizrizal/idcloudhost/plugins/modules/create_network.py

@@ -58,7 +58,8 @@
             - If windows [ 2019 ]
         required: true
         type: str
-        choices: [ ... ]
+        choices: [ '8.x', '8.4', '9.x', '32', '24.04-lts', 'linux_8.4', 'server_7.9', '11', '2019', '34', '7.9',
+            'freebsd_12.2', '15.3', 'server_8.4', '12', '21.04', '36', '22.04-lts', '20.04-lts' ]
     disks:
         description: Size of main storage in GB.
         required: true
@@ -123,8 +124,11 @@
     returned: success
 '''
 
-import requests
 from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.merizrizal.idcloudhost.plugins.module_utils.ensure_packages import \
+    ensure_requests
+
+requests = None
 
 
 class CreateVM():
@@ -159,7 +163,7 @@ def main(self):
         all_os_version_choices = list(set(all_os_version_choices))
 
         argument_spec = dict(
-            api_key=dict(type='str', required=True),
+            api_key=dict(type='str', required=True, no_log=True),
             location=dict(type='str', required=True, choices=['jkt01', 'jkt02', 'jkt03', 'sgp01']),
             network_uuid=dict(type='str', required=True),
             name=dict(type='str', required=True),
@@ -177,6 +181,8 @@ def main(self):
             supports_check_mode=True,
         )
 
+        requests = ensure_requests(module)
+
         self.api_key = module.params['api_key']
         self.location = module.params['location']
 

merizrizal/idcloudhost/plugins/modules/create_vm.py

@@ -54,8 +54,11 @@
     returned: success
 '''
 
-import requests
 from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.merizrizal.idcloudhost.plugins.module_utils.ensure_packages import \
+    ensure_requests
+
+requests = None
 
 
 class GetNetwork():
@@ -67,7 +70,7 @@ def __init__(self):
 
     def main(self):
         argument_spec = dict(
-            api_key=dict(type='str', required=True),
+            api_key=dict(type='str', required=True, no_log=True),
             location=dict(type='str', required=True, choices=['jkt01', 'jkt02', 'jkt03', 'sgp01'])
         )
 
@@ -76,6 +79,8 @@ def main(self):
             supports_check_mode=True,
         )
 
+        requests = ensure_requests(module)
+
         self.api_key = module.params['api_key']
         self.location = module.params['location']