ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

gitlab_project_variable: added support for variable_type (#181)

Browse source 
* gitlab_project_variable: added support for variable_type

* gitlab_project_variable: Added integration tests for variable_type file.

* Changed test case variable name, ansible was masking the output.
This commit is contained in:
Alvaro A 2020-05-25 12:18:19 +02:00 committed by GitHub
parent 1774352313
commit ece18b756b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 92 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/gitlab-project-variable-variable-type.yml Normal file
View file

@ -0,0 +1,2 @@
minor_changes:
- gitlab_project_variable - implemented variable_type attribute.

22
plugins/modules/source_control/gitlab/gitlab_project_variable.py
View file

@ -53,6 +53,7 @@ options:
- Support for protected values requires GitLab >= 9.3.
- Support for masked values requires GitLab >= 11.10.
- A I(value) must be a string or a number.
- Field I(variable_type) must be a string with either C(env_var), which is the default, or C(file).
- When a value is masked, it must be in Base64 and have a length of at least 8 characters.
See GitLab documentation on acceptable values for a masked variable (https://docs.gitlab.com/ce/ci/variables/#masked-variables).
default: {}
@ -83,6 +84,7 @@ EXAMPLES = '''
value: 3214cbad
masked: true
protected: true
variable_type: env_var
- name: Delete one variable
gitlab_project_variable:
@ -155,26 +157,27 @@ class GitlabProjectVariables(object):
def list_all_project_variables(self):
return self.project.variables.list()
def create_variable(self, key, value, masked, protected):
def create_variable(self, key, value, masked, protected, variable_type):
if self._module.check_mode:
return
return self.project.variables.create({"key": key, "value": value,
"masked": masked, "protected": protected})
"masked": masked, "protected": protected,
"variable_type": variable_type})
def update_variable(self, key, var, value, masked, protected):
if var.value == value and var.protected == protected and var.masked == masked:
def update_variable(self, key, var, value, masked, protected, variable_type):
if var.value == value and var.protected == protected and var.masked == masked and var.variable_type == variable_type:
return False
if self._module.check_mode:
return True
if var.protected == protected and var.masked == masked:
if var.protected == protected and var.masked == masked and var.variable_type == variable_type:
var.value = value
var.save()
return True
self.delete_variable(key)
self.create_variable(key, value, masked, protected)
self.create_variable(key, value, masked, protected, variable_type)
return True
def delete_variable(self, key):
@ -197,10 +200,12 @@ def native_python_main(this_gitlab, purge, var_list, state, module):
value = var_list[key]
masked = False
protected = False
variable_type = 'env_var'
elif isinstance(var_list[key], dict):
value = var_list[key].get('value')
masked = var_list[key].get('masked', False)
protected = var_list[key].get('protected', False)
variable_type = var_list[key].get('variable_type', 'env_var')
else:
module.fail_json(msg="value must be of type string, integer or dict")
@ -212,7 +217,8 @@ def native_python_main(this_gitlab, purge, var_list, state, module):
single_change = this_gitlab.update_variable(key,
gitlab_keys[index],
value, masked,
protected)
protected,
variable_type)
change = single_change or change
if single_change:
return_value['updated'].append(key)
@ -225,7 +231,7 @@ def native_python_main(this_gitlab, purge, var_list, state, module):
return_value['removed'].append(key)
elif key not in existing_variables and state == 'present':
this_gitlab.create_variable(key, value, masked, protected)
this_gitlab.create_variable(key, value, masked, protected, variable_type)
change = True
return_value['added'].append(key)

76
tests/integration/targets/gitlab_project_variable/tasks/main.yml
View file

@ -142,6 +142,7 @@
value: checkmode
masked: True
protected: True
variable_type: env_var
register: gitlab_project_variable_state
- name: state must be changed
@ -159,6 +160,7 @@
value: checkmode
masked: True
protected: True
variable_type: env_var
register: gitlab_project_variable_state
- name: state must not be changed
@ -413,6 +415,80 @@
- gitlab_project_variable_state.project_variable.updated|length == 0
- gitlab_project_variable_state.project_variable.removed[0] == "some"
- name: add one variable with variable_type file
gitlab_project_variable:
api_url: "{{ gitlab_host }}"
api_token: "{{ gitlab_login_token }}"
project: "{{ gitlab_project_name }}"
vars:
my_test_var:
value: my_test_value
variable_type: file
purge: False
register: gitlab_project_variable_state
- name: append one variable state must be changed
assert:
that:
- gitlab_project_variable_state.changed
- gitlab_project_variable_state.project_variable.added|length == 1
- gitlab_project_variable_state.project_variable.untouched|length == 0
- gitlab_project_variable_state.project_variable.removed|length == 0
- gitlab_project_variable_state.project_variable.updated|length == 0
- gitlab_project_variable_state.project_variable.added[0] == "my_test_var"
- name: change variable_type attribute
gitlab_project_variable:
api_url: "{{ gitlab_host }}"
api_token: "{{ gitlab_login_token }}"
project: "{{ gitlab_project_name }}"
vars:
my_test_var:
value: my_test_value
variable_type: env_var
register: gitlab_project_variable_state
- name: state must be changed
assert:
that:
- gitlab_project_variable_state is changed
- name: revert variable_type attribute
gitlab_project_variable:
api_url: "{{ gitlab_host }}"
api_token: "{{ gitlab_login_token }}"
project: "{{ gitlab_project_name }}"
vars:
my_test_var:
value: my_test_value
variable_type: file
register: gitlab_project_variable_state
- name: state must be changed
assert:
that:
- gitlab_project_variable_state is changed
- name: delete the variable_type file variable
gitlab_project_variable:
api_url: "{{ gitlab_host }}"
api_token: "{{ gitlab_login_token }}"
project: "{{ gitlab_project_name }}"
state: absent
vars:
my_test_var: my_test_value
register: gitlab_project_variable_state
- name: no variable is left state must be changed
assert:
that:
- gitlab_project_variable_state.changed
- gitlab_project_variable_state.project_variable.added|length == 0
- gitlab_project_variable_state.project_variable.untouched|length == 0
- gitlab_project_variable_state.project_variable.removed|length == 1
- gitlab_project_variable_state.project_variable.updated|length == 0
- gitlab_project_variable_state.project_variable.removed[0] == "my_test_var"
- name: check that no variables are left
gitlab_project_variable:
api_url: "{{ gitlab_host }}"