Skip to content

Update modules #763

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thekad wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update modules #763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
beb6e20
Updated modules to match new gcp_v2 utils package
thekad Jun 5, 2026
a45883d
Trying to fix dependency links
thekad Jun 10, 2026
a46925e
Update as per latest mmv1
thekad Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
212 changes: 131 additions & 81 deletions plugins/modules/gcp_alloydb_backup.py
View file
Open in desktop

Large diffs are not rendered by default.

760 changes: 420 additions & 340 deletions plugins/modules/gcp_alloydb_cluster.py
View file
Open in desktop

Large diffs are not rendered by default.

412 changes: 221 additions & 191 deletions plugins/modules/gcp_alloydb_instance.py
View file
Open in desktop

Large diffs are not rendered by default.

192 changes: 122 additions & 70 deletions plugins/modules/gcp_alloydb_user.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Copyright (C) 2017-2025 Google
# Copyright (C) 2017-2026 Google
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# ----------------------------------------------------------------------------
#
Expand Down Expand Up @@ -49,6 +49,7 @@
- This field is a reference to a Cluster resource in GCP.
- 'It can be specified in two ways: First, you can place a dictionary with key ''name'' matching your resource.'
- 'Alternatively, you can add `register: name-of-resource` to a Cluster task and then set this field to `{{ name-of-resource }}`.'
- This property is immutable, to change it, you must delete and recreate the resource.
required: true
type: dict
database_roles:
Expand All @@ -71,6 +72,7 @@
user_id:
description:
- The database role name of the user.
- This property is immutable, to change it, you must delete and recreate the resource.
required: true
type: str
user_type:
Expand All @@ -79,14 +81,15 @@
- ALLOYDB_IAM_USER
description:
- The type of this user.
- This property is immutable, to change it, you must delete and recreate the resource.
required: true
type: str
requirements:
- python >= 3.8
- requests >= 2.18.4
- google-auth >= 2.25.1
short_description: Creates a GCP Alloydb.User resource
"""
""" # noqa: E501

EXAMPLES = r"""
- name: Create user for cluster
Expand All @@ -99,7 +102,7 @@
- alloydbsuperuser
cluster:
name: projects/my-project/locations/us-central1/clusters/my-cluster
"""
""" # noqa: E501

RETURN = r"""
changed:
Expand All @@ -115,27 +118,16 @@
description: The current state of the resource.
returned: always
type: str
"""
""" # noqa: E501

################################################################################
# Imports
################################################################################

from ansible_collections.google.cloud.plugins.module_utils import gcp_utils as gcp
from ansible_collections.google.cloud.plugins.module_utils import gcp_v2

# BEGIN Custom imports
# noop
# END Custom imports


def build_link(module, uri):
params = module.params.copy()
params["cluster"] = gcp.replace_resource_dict(module.params["cluster"], "name")

return "https://alloydb.googleapis.com/v1/" + uri.format(**params)


class Alloydb(gcp.Resource):
class Alloydb(gcp_v2.Resource):
def _request(self):
return {
"databaseRoles": [str(item) for item in (self.request.get("database_roles") or [])],
Expand All @@ -145,10 +137,7 @@

def _response(self):
return {
"databaseRoles": [str(item) for item in (self.response.get("databaseRoles") or [])],
"name": self.response.get("name"),
"password": self.response.get("password"),
"userType": self.response.get("userType"),
}


Expand All @@ -160,7 +149,7 @@
def main():
"""Main function"""

module = gcp.Module(
module = gcp_v2.Module(
argument_spec=dict(
state=dict(
type="str",
Expand Down Expand Up @@ -196,89 +185,152 @@

state = module.params["state"]
changed = False

op_configs = gcp.ResourceOpConfigs(
{
"create": gcp.ResourceOpConfig(
op_configs = gcp_v2.ResourceOpConfigs(
base_url="https://alloydb.googleapis.com/v1/",
base_uri="{cluster}/users",
configs={
"create": gcp_v2.ResourceOpConfig(
**{"uri": "{cluster}/users?userId={user_id}", "async_uri": "", "verb": "POST", "timeout_minutes": 20}
),
"delete": gcp.ResourceOpConfig(
"delete": gcp_v2.ResourceOpConfig(
**{"uri": "{cluster}/users/{user_id}", "async_uri": "", "verb": "DELETE", "timeout_minutes": 20}

Check failure on line 196 in plugins/modules/gcp_alloydb_user.py

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Define a constant instead of duplicating this literal "{cluster}/users/{user_id}" 3 times. 


See more on https://sonarcloud.io/project/issues?id=ansible-collections_google.cloud&issues=AZ6Ycg2TABAgom4Z3m1O&open=AZ6Ycg2TABAgom4Z3m1O&pullRequest=763
),
"read": gcp.ResourceOpConfig(
"read": gcp_v2.ResourceOpConfig(
**{"uri": "{cluster}/users/{user_id}", "async_uri": "", "verb": "GET", "timeout_minutes": 0}
),
"update": gcp.ResourceOpConfig(
**{"uri": "{cluster}/users?userId={user_id}", "async_uri": "", "verb": "POST", "timeout_minutes": 20}
"update": gcp_v2.ResourceOpConfig(
**{"uri": "{cluster}/users/{user_id}", "async_uri": "", "verb": "PATCH", "timeout_minutes": 20}
),
}
},
)

params = gcp.remove_nones_from_dict(module.params)
resource = Alloydb(params, module=module, product="Alloydb", kind="alloydb#user")
existing_obj = resource.get(build_link(module, op_configs.read.uri), allow_not_found=True)
request = gcp_v2.remove_nones(module.params)
resource = Alloydb(request, module=module, product="Alloydb", kind="alloydb#user", op_configs=op_configs)

resource._state = state # store the state in the resource object

# Set this variable in one of the pre steps to implement custom diff logic
custom_diff = None

# BEGIN massaging ResourceRef properties
resource.url_params["cluster"] = gcp_v2.resource_ref(module.params["cluster"], "name")
# END massaging ResourceRef properties

read_link: str = "" # give it a chance for pre-read to overload

if read_link == "":
read_link = resource.build_link("read")
existing_obj = resource.from_response(resource.get(read_link, allow_not_found=True) or {})
new_obj = {}
gcp_v2.debug(module, request=gcp_v2.remove_empties(resource.to_request()), existing=existing_obj, post=False)

if existing_obj is None:
if custom_diff is not None:

Check failure on line 227 in plugins/modules/gcp_alloydb_user.py

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Remove this identity check; it will always be False. 


See more on https://sonarcloud.io/project/issues?id=ansible-collections_google.cloud&issues=AZ6Ycg2TABAgom4Z3m1T&open=AZ6Ycg2TABAgom4Z3m1T&pullRequest=763
is_different = custom_diff
else:
is_different = resource.diff(gcp_v2.remove_empties(existing_obj))

gcp_v2.debug(
module,
request=gcp_v2.remove_empties(resource.to_request()),
existing=existing_obj,
post=True,
is_different=is_different,
)

if gcp_v2.empty(existing_obj):
if state == "present":
is_async = op_configs.create.async_uri != ""
create_link = build_link(module, op_configs.create.uri)
create_retries = op_configs.create.timeout
create_func = getattr(resource, op_configs.create.verb)
async_create_func = getattr(resource, op_configs.create.verb + "_async")
async_create_link = build_link(module, "") + op_configs.create.async_uri
# --------- BEGIN custom pre-create code ---------
# --------- END custom pre-create code ---------
gcp_v2.debug(module, action="create")
try:
if is_async:
new_obj = async_create_func(create_link, async_link=async_create_link, retries=create_retries)
# --------- BEGIN create code ---------
create_link: str = "" # give it a chance for pre-create to overload
if create_link == "":
create_link = resource.build_link("create")
create_retries = op_configs.create.timeout
create_func = getattr(resource, op_configs.create.verb)
create_async_uri = op_configs.create.async_uri
create_async_func = getattr(resource, op_configs.create.verb + "_async")
gcp_v2.debug(module, msg="Creating resource", create_link=create_link, async_uri=create_async_uri)

if create_async_uri != "":
new_obj = create_async_func(create_link, async_uri=create_async_uri, retries=create_retries)
else:
new_obj = create_func(create_link)
changed = True
new_obj = resource.with_kind(resource.from_response(new_obj))
gcp_v2.debug(module, new=new_obj, action="create", post=False)
gcp_v2.debug(module, new=new_obj, action="create", post=True)
# --------- END create code ---------
except Exception as e:
module.fail_json(msg=str(e))

changed = True
else:
pass # nothing to do
else:
if state == "absent":
is_async = op_configs.delete.async_uri != ""
delete_link = build_link(module, op_configs.delete.uri)
delete_retries = op_configs.delete.timeout
delete_func = getattr(resource, op_configs.delete.verb)
async_delete_func = getattr(resource, op_configs.delete.verb + "_async")
async_delete_link = build_link(module, "") + op_configs.delete.async_uri
# --------- BEGIN custom pre-delete code ---------
# --------- END custom pre-delete code ---------
gcp_v2.debug(module, action="delete")
try:
if is_async:
new_obj = async_delete_func(delete_link, async_link=async_delete_link, retries=delete_retries)
# --------- BEGIN delete code ---------
delete_link: str = "" # give it a chance for pre-delete to overload
if delete_link == "":
delete_link = resource.build_link("delete")
delete_retries = op_configs.delete.timeout
delete_func = getattr(resource, op_configs.delete.verb)
delete_async_uri = op_configs.delete.async_uri
delete_async_func = getattr(resource, op_configs.delete.verb + "_async")
gcp_v2.debug(
module,
msg="Destroying resource",
delete_link=delete_link,
async_uri=delete_async_uri,
)

if delete_async_uri != "":
new_obj = delete_async_func(delete_link, async_uri=delete_async_uri, retries=delete_retries)
else:
new_obj = delete_func(delete_link)
changed = True
new_obj = resource.from_response(new_obj)
gcp_v2.debug(module, new=new_obj, action="delete", post=False)
gcp_v2.debug(module, new=new_obj, action="delete", post=True)
# --------- END delete code ---------
except Exception as e:
module.fail_json(msg=str(e))

changed = True
else:
if resource.diff(existing_obj):
is_async = op_configs.update.async_uri != ""
update_link = build_link(module, op_configs.update.uri)
update_retries = op_configs.update.timeout
update_func = getattr(resource, op_configs.update.verb)
async_update_func = getattr(resource, op_configs.update.verb + "_async")
async_update_link = build_link(module, "") + op_configs.update.async_uri
# --------- BEGIN custom pre-update code ---------
# --------- END custom pre-update code ---------
if is_different:
gcp_v2.debug(module, action="update")
try:
if is_async:
new_obj = async_update_func(update_link, async_link=async_update_link, retries=update_retries)
# --------- BEGIN update code ---------
update_link: str = "" # give it a chance for pre-update to overload
if update_link == "":
update_link = resource.build_link("update")
update_retries = op_configs.update.timeout
update_func = getattr(resource, op_configs.update.verb)
update_async_uri = op_configs.update.async_uri
update_async_func = getattr(resource, op_configs.update.verb + "_async")
gcp_v2.debug(
module,
msg="Updating resource",
update_link=update_link,
async_uri=update_async_uri,
)
if update_async_uri != "":
new_obj = update_async_func(update_link, async_uri=update_async_uri, retries=update_retries)
else:
new_obj = update_func(update_link)
new_obj = resource.with_kind(resource.from_response(new_obj))
gcp_v2.debug(module, new=new_obj, action="update", post=False)
gcp_v2.debug(module, new=new_obj, action="update", post=True)
# --------- END update code ---------
except Exception as e:
module.fail_json(msg=str(e))
changed = resource.diff(new_obj)

new_obj = resource.get(build_link(module, op_configs.read.uri), allow_not_found=True)
new_obj = resource.from_response(new_obj or {})
changed = True
else:
new_obj = existing_obj

new_obj.update({"changed": changed})
gcp_v2.debug(module, final_obj=new_obj, changed=changed)
module.exit_json(**new_obj)


Expand Down
Loading
Loading