betterutime_status_page :: arg for id (#14)

* betteruptime_status_page :: allow passing id

* bump versions

* small fixes on build

* fix

* fix tests

* restore exit

* update doc

* use ansible-core

Author: evantissot

Makefile

@@ -9,7 +9,7 @@ ANSIBLE_COLLECTION_VERSION=`cat galaxy.yml | grep -oP 'version: \K(\d.\d.\d)$$'`
 
 BUILD_PATH="build"
 
-DOCKER_BUILD_IMAGE="python:3.10.5-alpine3.16"
+DOCKER_BUILD_IMAGE="python:3.11.6-alpine3.18"
 DOCKER_CMD=docker run --rm -v `pwd`:/data --workdir /data ${DOCKER_BUILD_IMAGE} sh -c
 
 build: set-env
@@ -19,7 +19,7 @@ clean:
 	@rm -rf ${BUILD_PATH}
 
 docker-build:
-	@${DOCKER_CMD} "python -m pip install -r ${DEPLOY_REQ_FILE} && ln -s /usr/local/bin/python /usr/bin/python3 && ansible-galaxy collection build --force --output-path ${BUILD_PATH} && chown -R `id -u`:`id -g` ${BUILD_PATH}"
+	@${DOCKER_CMD} "python -m pip install -r ${DEPLOY_REQ_FILE} && ansible-galaxy collection build --force --output-path ${BUILD_PATH} && chown -R `id -u`:`id -g` ${BUILD_PATH}"
 
 docker-test:
 	@${DOCKER_CMD} "python -m pip install -r ${DEPLOY_REQ_FILE} && PYTHONPATH="${PYTHONPATH}:${pwd}" pytest"

ansible-python-requirements.txt

@@ -1,4 +1,4 @@
-ansible==2.9.27
-requests==2.21.0
-pytest==7.1.2
-mock==4.0.3
+ansible-core==2.15.5
+requests==2.31.0
+pytest==7.4.3
+mock==5.1.0

docs/toucantoco.toucantoco.betteruptime_status_page.md

@@ -10,6 +10,7 @@ Manage BetterUptime status pages
 | state                           | True       | str    | present/absent    |             |
 | subdomain                       | True       | str    |                   |             |
 | scope                           | True       | str    |                   |             |
+| id                              | False      | str    |                   |             |
 | sections                        | False      | list   |                   | See below   |
 | company_name                    | False      | str    |                   |             |
 | company_url                     | False      | str    |                   |             |

galaxy.yml

@@ -17,3 +17,13 @@ license:
 dependencies: {}
 
 repository: https://github.com/ToucanToco/ansible-collection
+
+build_ignore:
+  - .ansible-venv*
+  - scripts
+  - .pytest_cache
+  - .gitignore
+  - Jenkinsfile
+  - build
+  - tests
+  - docs

plugins/modules/betteruptime_status_page.py

@@ -32,6 +32,7 @@
     "state":                         {"required": True, "type": "str", "choices": ["present", "absent"]},
     "subdomain":                     {"required": True, "type": "str"},
     "scope":                         {"required": True, "type": "str"},
+    "id":                            {"required": False, "type": "str"},
     "sections":                      {"required": False, "type": "list", "elements": "dict", "options": STATUS_PAGES_SECTION_FIELDS},
     "company_name":                  {"required": False, "type": "str"},
     "company_url":                   {"required": False, "type": "str"},
@@ -169,7 +170,11 @@ def __init__(self, module):
         self.scope    = self.payload.pop("scope")
         self.headers  = {"Authorization": f"Bearer {self.payload.pop('api_key')}"}
 
-        self.id                   = None
+        if "id" in self.payload and self.payload["id"] != "":
+            self.id = self.payload.pop("id")
+        else:
+            self.id = None
+
         self.retrieved_attributes = None
 
         self.sectionList  = []
@@ -242,6 +247,15 @@ def manage_resources(self):
             resource.delete()
             self.changed = True
 
+    def get(self):
+        """ Get a status page from the id """
+        resp = requests.get(f"{API_STATUS_PAGES_BASE_URL}/{self.id}", headers=self.headers)
+        if resp.status_code == HTTPStatus.OK:
+            json_object = resp.json()
+            self.retrieved_attributes = json_object["data"]["attributes"]
+        else:
+            self.module.fail_json(msg=resp.content)
+
     def create(self):
         """ Create a new status page """
         resp = requests.post(API_STATUS_PAGES_BASE_URL, headers=self.headers, json=self.payload)
@@ -272,7 +286,11 @@ def delete(self):
 
     def manage_status_page(self):
         """ Manage state of a status page """
-        self.retrieve_id(API_STATUS_PAGES_BASE_URL)
+
+        if self.id is None:
+            self.retrieve_id(API_STATUS_PAGES_BASE_URL)
+        else:
+            self.get()
 
         if self.state == "present":
             if not self.id:
@@ -290,7 +308,7 @@ def manage_status_page(self):
             else:
                 self.delete()
 
-        self.module.exit_json(changed=self.changed)
+        self.module.exit_json(changed=self.changed, id=self.id)
 
 
 def main():

tests/unit/plugins/modules/test_betteruptime_status_page.py

@@ -99,10 +99,11 @@ def test_manage_sections(mock_module, mock_betteruptime_page_create, mock_better
     assert mock_betteruptime_page_create.call_count == expected_create
     assert mock_betteruptime_page_delete.call_count == expected_delete
 
+
 @mock.patch('plugins.modules.betteruptime_status_page.BetterUptimeStatusPage.retrieve_id')
 @mock.patch('plugins.modules.betteruptime_status_page.BetterUptimeStatusPage.create')
 @mock.patch('plugins.modules.betteruptime_status_page.AnsibleModule')
-def test_manage_status_page_create(mock_module, mock_create, mock_retrieve_id):
+def test_manage_status_page_create(mock_module, mock_create, _):
     status_page_object = betteruptime_status_page.BetterUptimeStatusPage(mock_module)
     status_page_object.state = "present"
     status_page_object.sections = None
@@ -111,10 +112,11 @@ def test_manage_status_page_create(mock_module, mock_create, mock_retrieve_id):
 
     assert mock_create.call_count == 1
 
+
 @mock.patch('plugins.modules.betteruptime_status_page.BetterUptimeStatusPage.retrieve_id')
 @mock.patch('plugins.modules.betteruptime_status_page.BetterUptimeStatusPage.update')
 @mock.patch('plugins.modules.betteruptime_status_page.AnsibleModule')
-def test_manage_status_page_update(mock_module, mock_update, mock_retrieve_id):
+def test_manage_status_page_update(mock_module, mock_update, _):
     status_page_object = betteruptime_status_page.BetterUptimeStatusPage(mock_module)
     status_page_object.state = "present"
     status_page_object.id = "1234"
@@ -124,10 +126,11 @@ def test_manage_status_page_update(mock_module, mock_update, mock_retrieve_id):
 
     assert mock_update.call_count == 1
 
+
 @mock.patch('plugins.modules.betteruptime_status_page.BetterUptimeStatusPage.retrieve_id')
 @mock.patch('plugins.modules.betteruptime_status_page.BetterUptimeStatusPage.delete')
 @mock.patch('plugins.modules.betteruptime_status_page.AnsibleModule')
-def test_manage_status_page_delete(mock_module, mock_delete, mock_retrieve_id):
+def test_manage_status_page_delete(mock_module, mock_delete, _):
     status_page_object = betteruptime_status_page.BetterUptimeStatusPage(mock_module)
     status_page_object.state = "absent"
     status_page_object.id = "1234"