Merge pull request #101 from salsadigitalauorg/feature/DEVOPS-623_fix…

…-token-plugin [DEVOPS-623] Renamed token plugin to fetch_token.
salsadigitalauorg · Dec 3, 2024 · 86f0652 · 86f0652
2 parents c4bf3b8 + 446fbe1
commit 86f0652
Show file tree

Hide file tree

Showing 13 changed files with 15 additions and 15 deletions.
diff --git a/api/playbooks/deploy_branch.yml b/api/playbooks/deploy_branch.yml
@@ -7,7 +7,7 @@
     - lagoon.api.common
   tasks:
     - include_role:
-        name: lagoon.api.token
+        name: lagoon.api.fetch_token
 
     - name: Trigger staggered deployment.
       lagoon.api.deploy:

diff --git a/api/playbooks/environment.yml b/api/playbooks/environment.yml
@@ -7,7 +7,7 @@
     - lagoon.api.common
   tasks:
     - include_role:
-        name: lagoon.api.token
+        name: lagoon.api.fetch_token
 
     - name: Retrieve all environments.
       set_fact:

diff --git a/api/playbooks/project.yml b/api/playbooks/project.yml
@@ -7,7 +7,7 @@
     - lagoon.api.common
   tasks:
     - include_role:
-        name: lagoon.api.token
+        name: lagoon.api.fetch_token
 
     - name: Retrieve all projects.
       set_fact:

diff --git a/api/playbooks/project_metadata.yml b/api/playbooks/project_metadata.yml
@@ -7,7 +7,7 @@
     - lagoon.api.common
   tasks:
     - include_role:
-        name: lagoon.api.token
+        name: lagoon.api.fetch_token
 
     - name: Retrieve project metadata.
       debug: msg="{{ lookup('lagoon.api.metadata', project=project_name) }}"
diff --git a/api/playbooks/query.yml b/api/playbooks/query.yml
@@ -7,7 +7,7 @@
     - lagoon.api.common
   tasks:
     - include_role:
-        name: lagoon.api.token
+        name: lagoon.api.fetch_token
 
     - name: Query specific fields for all projects.
       lagoon.api.query:

diff --git a/api/plugins/action/token.py → api/plugins/action/fetch_token.py b/api/plugins/action/token.py → api/plugins/action/fetch_token.py
diff --git a/api/plugins/modules/token.py → api/plugins/modules/fetch_token.py b/api/plugins/modules/token.py → api/plugins/modules/fetch_token.py
@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 DOCUMENTATION = r'''
-module: token
+module: fetch_token
 description: Fetches a Lagoon token using ssh
 short_description: Fetches a Lagoon token using ssh
 options:
@@ -15,7 +15,7 @@
 
 EXAMPLES = r'''
 - name: Fetch a Lagoon token.
-  lagoon.api.token:
+  lagoon.api.fetch_token:
     ssh_options: "-q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"
   register: token
   vars:

diff --git a/api/roles/README.md b/api/roles/README.md
@@ -12,7 +12,7 @@ The following play can be used to fetch a token:
     - lagoon.api.common
   tasks:
     - include_role:
-        name: lagoon.api.token
+        name: lagoon.api.fetch_token
 ```
 
 The token will now be available in the `lagoon_api_token` localhost variable. Default Lagoon variables are also exported from the `lagoon.api.common` role.
@@ -46,7 +46,7 @@ To reuse the token in another play, the following can be done:
     - lagoon.api.common
   tasks:
     - include_role:
-        name: lagoon.api.token
+        name: lagoon.api.fetch_token
 
     - name: Retrieve all projects.
       set_fact:
@@ -64,7 +64,7 @@ To reuse the token in another play, the following can be done:
     - lagoon.api.common
   tasks:
     - include_role:
-        name: lagoon.api.token
+        name: lagoon.api.fetch_token
 
     - name: Retrieve project by name.
       set_fact:

diff --git a/api/roles/token/tasks/main.yml b/api/roles/token/tasks/main.yml
@@ -1,7 +1,7 @@
 ### Fetch a Lagoon token.
 
 - name: Fetch token.
-  lagoon.api.token:
+  lagoon.api.fetch_token:
     ssh_options: "-q -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"
   register: fetched_token
   when: lagoon_api_token is not defined

diff --git a/api/tests/playbooks/environment_vars.yml b/api/tests/playbooks/environment_vars.yml
@@ -7,7 +7,7 @@
     - lagoon.api.common
   tasks:
     - include_role:
-        name: lagoon.api.token
+        name: lagoon.api.fetch_token
 
     - name: Fetch environment vars.
       lagoon.api.variables:

diff --git a/api/tests/playbooks/lookup_vars.yml b/api/tests/playbooks/lookup_vars.yml
@@ -7,7 +7,7 @@
   - lagoon.api.common
   tasks:
   - include_role:
-      name: lagoon.api.token
+      name: lagoon.api.fetch_token
 
   - name: lookup a project's variables
     debug: msg="{{ item }}"

diff --git a/api/tests/playbooks/project_vars.yml b/api/tests/playbooks/project_vars.yml
@@ -7,7 +7,7 @@
     - lagoon.api.common
   tasks:
     - include_role:
-        name: lagoon.api.token
+        name: lagoon.api.fetch_token
 
     - name: Fetch project vars.
       lagoon.api.variables:

diff --git a/api/tests/playbooks/task_definitions.yml b/api/tests/playbooks/task_definitions.yml
@@ -8,7 +8,7 @@
   tasks:
     - name: Create a token.
       ansible.builtin.include_role:
-        name: lagoon.api.token
+        name: lagoon.api.fetch_token
 
     - name: Ensure task definitions exist
       lagoon.api.task_definition: