update(jenkins_inbound_agent): bump container version to 3309.v27b_9314fd1a_4-5

README.md

@@ -2,8 +2,15 @@
 
 ## Overview
 
+This collection contains roles focused on various components around CI/CD, including
+automation servers like Jenkins, its agents or vaguely related components like caching
+proxies and artifact registries.
+
 ## Roles
 
-- [jenkins](roles/jenkins/README.md): Deploy [jenkins](https://jenkins.io), the self-proclaimed 'leading open source automation server'.
+- [`jenkins`](roles/jenkins/README.md): Deploy [jenkins](https://jenkins.io), the self-proclaimed 'leading open source automation server'.
+- [`jenkins_inbound_agent`](roles/jenkins_inbound_agent/README.md): Deploy Jenkins 'inbound agent', formerly known as 'JNLP agent'.
 
 ## License
+
+[CNPLv7+](LICENSE.md): Cooperative Nonviolent Public License

galaxy.yml

@@ -12,4 +12,7 @@ build_ignore:
   - '*.tar.gz'
 repository: https://git.finally.coffee/finallycoffee/cicd
 issues: https://codeberg.org/finallycoffee/ansible-collection-cicd/issues
-tags: []
+tags:
+  - cicd
+  - ci
+  - cd

plugins/module_utils/Jenkins.py

@@ -17,8 +17,9 @@ class Jenkins:
         internal_dir: PathSpec
         server_url: str
 
-    def __init__(self, server_url, api_token):
+    def __init__(self, server_url, username, api_token):
         self.server_url = server_url
+        self.username = username
         self.api_token = api_token
 
     def _log_in(self, username: str, password: str) -> (str, str):
@@ -29,7 +30,8 @@ class Jenkins:
 
     def get_node_jnlp(self, node_name) -> str:
         response = requests.get(
-            f"{self.server_url}/manage/computer/{node_name}/slave-agent.jnlp"
+            f"{self.server_url}/manage/computer/{node_name}/slave-agent.jnlp",
+            auth=(self.username, self.api_token),
         )
         response.raise_for_status()
         return response.text
@@ -39,6 +41,6 @@ class Jenkins:
         tree = ET.ElementTree(ET.fromstring(jnlp_info_raw))
         arguments = tree.findall("./application-desc/")
         (node_secret, node_name, _, work_dir, _, internal_dir, _, url) = [
-            arg.text for arg in arguments[:7]
+            arg.text for arg in arguments[:8]
         ]
         return Jenkins.NodeInfo(url, node_name, node_secret, work_dir, internal_dir)

plugins/module_utils/docs/jenkins_node_info.py

@@ -0,0 +1,65 @@
+DOCUMENTATION = r"""
+---
+module: jenkins_node
+
+short_description: Retrieve Jenkins node information
+# If this is part of a collection, you need to use semantic versioning,
+# i.e. the version is of the form "2.5.0" and not "2.4".
+version_added: "0.0.1"
+
+description: This is my longer description explaining my test module.
+
+options:
+    name:
+        description: The name of the jenkins node.
+        required: true
+        type: str
+        aliases:
+        - agent
+    server:
+        description: URL of the jenkins instance
+        required: true
+        type: str
+        aliases:
+        - server_url
+    username:
+        description: Username to use for authentication to jenkins
+        required: true
+        type: str
+        aliases:
+        - user
+    api_token:
+        description: Jenkins API token for the user
+        required: true
+        type: str
+author:
+    - transcaffeine (@transcaffeine)
+"""
+
+EXAMPLES = r"""
+# Pass in a message
+- name: Retrieve information about the jenkins node named 'my_jenkins_node_name'
+  finallycoffee.cicd.jenkins_node_info:
+    name: my_jenkins_node_name
+    server: https://jenkins.example.org
+    username: admin
+    api_token: yoursecretapitokenhere
+"""
+
+RETURN = r"""
+# These are examples of possible return values, and in general should use other names for return values.
+name:
+    description: The name of the jenkins node
+    type: str
+    returned: always
+    sample: 'jenkins-agent-jdk21-alpine'
+secret:
+    description: The secret of the agent
+    type: str
+    returned: always
+    sample: 'secretverylongstringwith64chars'
+work_dir:
+    description: The local working directory of the jenkins agent
+    type: str
+    returned: always
+"""

plugins/modules/jenkins_node_info.py

@@ -9,85 +9,29 @@ from typing import TYPE_CHECKING
 from ansible.module_utils.basic import AnsibleModule
 
 from ansible_collections.finallycoffee.cicd.plugins.module_utils.Jenkins import Jenkins
+from ansible_collections.finallycoffee.cicd.plugins.module_utils.docs.jenkins_node_info import (
+    DOCUMENTATION,
+    EXAMPLES,
+    RETURN,
+)
 
 if TYPE_CHECKING:
     from typing import Optional, Dict, Any
 
-DOCUMENTATION = r"""
----
-module: jenkins_node
-
-short_description: Retrieve Jenkins node information
-# If this is part of a collection, you need to use semantic versioning,
-# i.e. the version is of the form "2.5.0" and not "2.4".
-version_added: "0.0.1"
-
-description: This is my longer description explaining my test module.
-
-options:
-    name:
-        description: The name of the jenkins node.
-        required: true
-        type: str
-    server:
-        description: URL of the jenkins instance
-        required: true
-        type: str
-    api_token:
-        description: Jenkins API token
-        required: true
-        type: str
-author:
-    - transcaffeine (@transcaffeine)
-"""
-
-EXAMPLES = r"""
-# Pass in a message
-- name: Test with a message
-  my_namespace.my_collection.my_test:
-    name: hello world
-
-# pass in a message and have changed true
-- name: Test with a message and changed output
-  my_namespace.my_collection.my_test:
-    name: hello world
-    new: true
-
-# fail the module
-- name: Test failure of the module
-  my_namespace.my_collection.my_test:
-    name: fail me
-"""
-
-RETURN = r"""
-# These are examples of possible return values, and in general should use other names for return values.
-name:
-    description: The name of the jenkins node
-    type: str
-    returned: always
-    sample: 'jenkins-agent-jdk21-alpine'
-secret:
-    description: The secret of the agent
-    type: str
-    returned: always
-    sample: 'secretverylongstringwith64chars'
-work_dir:
-    description: The local working directory of the jenkins agent
-    type: str
-    returned: always
-"""
-
 
 def run_module():
     module_args = dict(
-        name=dict(type="str", required=True),
-        server=dict(type="str", required=True),
-        api_token=dict(type="str", required=True),
+        name=dict(type="str", required=True, aliases=["node", "node_name"]),
+        server=dict(type="str", required=True, aliases=["server_url", "url"]),
+        username=dict(type="str", required=True, aliases=["user"]),
+        api_token=dict(type="str", required=True, aliases=["password", "pass"]),
     )
-    result = dict(changed=False, original_message="", message="")
+    result = dict(changed=False)
     module = AnsibleModule(argument_spec=module_args, supports_check_mode=True)
 
-    jenkins = Jenkins(module.params["server"], module.params["api_token"])
+    jenkins = Jenkins(
+        module.params["server"], module.params["username"], module.params["api_token"]
+    )
     node = jenkins.get_node_info(module.params["name"])
 
     result["name"] = node.name

roles/jenkins/defaults/main/main.yml

@@ -3,8 +3,8 @@ jenkins_user: "jenkins"
 jenkins_user_is_system: true
 jenkins_user_create_home: false
 jenkins_versions:
-  lts: "2.479.3"
-  weekly: "2.496"
+  lts: "2.504.2"
+  weekly: "2.515"
 jenkins_version_channel: "lts"
 jenkins_version: "{{ jenkins_versions[jenkins_version_channel] }}"
 

roles/jenkins_inbound_agent/defaults/main/main.yml

@@ -5,7 +5,7 @@ jenkins_agent_user_is_system: false
 jenkins_agent_user_uid: "{{ jenkins_agent_user_info.uid }}"
 jenkins_agent_user_gid: "{{ jenkins_agent_user_info.group }}"
 
-jenkins_agent_version: "3283.v92c105e0f819-8"
+jenkins_agent_version: "3309.v27b_9314fd1a_4-5"
 
 jenkins_agent_state: "present"
 jenkins_agent_deployment_method: "docker"