[PR #6524/0c96d229 backport][stable-7] gitlab modules: added instance variable (#6597)

gitlab modules: added instance variable (#6524)

* gitlab modules: added instance variable

* fixup

* first review

* renamed to variables (groups->instance)
* added 'version_added'

* better disscription of 'updated' return value

* removed unneccessary import error check

* removed environment scope

* added vars_to_variables import

* added maintainer to .github/BOTMETA.yml

* second review

* removed vars

* readded postprocessing

* added integration test

---------

Co-authored-by: Benedikt Braunger <bebr@adm.ku.dk>
(cherry picked from commit 0c96d22994)

Co-authored-by: Benibr <benibr@users.noreply.github.com>

.github/BOTMETA.yml

@@ -534,6 +534,8 @@ files:
     maintainers: paytroff
   $modules/gitlab_project_variable.py:
     maintainers: markuman
+  $modules/gitlab_instance_variable.py:
+    maintainers: benibr
   $modules/gitlab_runner.py:
     maintainers: SamyCoenen
   $modules/gitlab_user.py:

plugins/modules/gitlab_instance_variable.py

@@ -0,0 +1,367 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2023, Benedikt Braunger (bebr@adm.ku.dk)
+# Based on code:
+# Copyright (c) 2020, Florent Madiot (scodeman@scode.io)
+# Copyright (c) 2019, Markus Bergholz (markuman@gmail.com)
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+DOCUMENTATION = r'''
+module: gitlab_instance_variable
+short_description: Creates, updates, or deletes GitLab instance variables
+version_added: 7.1.0
+description:
+  - Creates a instance variable if it does not exist.
+  - When a instance variable does exist, its value will be updated if the values are different.
+  - Support for instance variables requires GitLab >= 13.0.
+  - Variables which are not mentioned in the modules options, but are present on the GitLab instance,
+    will either stay (I(purge=false)) or will be deleted (I(purge=true)).
+author:
+  - Benedikt Braunger (@benibr)
+requirements:
+  - python >= 2.7
+  - python-gitlab python module
+extends_documentation_fragment:
+  - community.general.auth_basic
+  - community.general.gitlab
+  - community.general.attributes
+
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
+
+options:
+  state:
+    description:
+      - Create or delete instance variable.
+    default: present
+    type: str
+    choices: ["present", "absent"]
+  purge:
+    description:
+      - When set to C(true), delete all variables which are not mentioned in the task.
+    default: false
+    type: bool
+  variables:
+    description:
+      - A list of dictionaries that represents CI/CD variables.
+    default: []
+    type: list
+    elements: dict
+    suboptions:
+      name:
+        description:
+          - The name of the variable.
+        type: str
+        required: true
+      value:
+        description:
+          - The variable value.
+          - Required when I(state=present).
+        type: str
+      masked:
+        description:
+          - Wether variable value is masked or not.
+        type: bool
+        default: false
+      protected:
+        description:
+          - Wether variable value is protected or not.
+        type: bool
+        default: false
+      variable_type:
+        description:
+          - Wether a variable is an environment variable (C(env_var)) or a file (C(file)).
+        type: str
+        choices: [ "env_var", "file" ]
+        default: env_var
+'''
+
+
+EXAMPLES = r'''
+- name: Set or update some CI/CD variables
+  community.general.gitlab_instance_variable:
+    api_url: https://gitlab.com
+    api_token: secret_access_token
+    purge: false
+    variables:
+      - name: ACCESS_KEY_ID
+        value: abc1312cba
+      - name: SECRET_ACCESS_KEY
+        value: 1337
+        masked: true
+        protected: true
+        variable_type: env_var
+
+- name: Delete one variable
+  community.general.gitlab_instance_variable:
+    api_url: https://gitlab.com
+    api_token: secret_access_token
+    state: absent
+    variables:
+      - name: ACCESS_KEY_ID
+'''
+
+RETURN = r'''
+instance_variable:
+  description: Four lists of the variablenames which were added, updated, removed or exist.
+  returned: always
+  type: dict
+  contains:
+    added:
+      description: A list of variables which were created.
+      returned: always
+      type: list
+      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+    untouched:
+      description: A list of variables which exist.
+      returned: always
+      type: list
+      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+    removed:
+      description: A list of variables which were deleted.
+      returned: always
+      type: list
+      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+    updated:
+      description: A list pre-existing variables whose values have been set.
+      returned: always
+      type: list
+      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.api import basic_auth_argument_spec
+from ansible_collections.community.general.plugins.module_utils.gitlab import (
+    auth_argument_spec, gitlab_authentication, ensure_gitlab_package, filter_returned_variables
+)
+
+
+class GitlabInstanceVariables(object):
+
+    def __init__(self, module, gitlab_instance):
+        self.instance = gitlab_instance
+        self._module = module
+
+    def list_all_instance_variables(self):
+        page_nb = 1
+        variables = []
+        gl_varibales_page = self.instance.variables.list(page=page_nb)
+        while len(gl_varibales_page) > 0:
+            variables += gl_varibales_page
+            page_nb += 1
+            gl_varibales_page = self.instance.variables.list(page=page_nb)
+        return variables
+
+    def create_variable(self, var_obj):
+        if self._module.check_mode:
+            return True
+        var = {
+            "key": var_obj.get('key'),
+            "value": var_obj.get('value'),
+            "masked": var_obj.get('masked'),
+            "protected": var_obj.get('protected'),
+            "variable_type": var_obj.get('variable_type'),
+        }
+
+        self.instance.variables.create(var)
+        return True
+
+    def update_variable(self, var_obj):
+        if self._module.check_mode:
+            return True
+        self.delete_variable(var_obj)
+        self.create_variable(var_obj)
+        return True
+
+    def delete_variable(self, var_obj):
+        if self._module.check_mode:
+            return True
+        self.instance.variables.delete(var_obj.get('key'))
+        return True
+
+
+def compare(requested_variables, existing_variables, state):
+    # we need to do this, because it was determined in a previous version - more or less buggy
+    # basically it is not necessary and might results in more/other bugs!
+    # but it is required and only relevant for check mode!!
+    # logic represents state 'present' when not purge. all other can be derived from that
+    # untouched => equal in both
+    # updated => name and scope are equal
+    # added => name and scope does not exist
+    untouched = list()
+    updated = list()
+    added = list()
+
+    if state == 'present':
+        existing_key_scope_vars = list()
+        for item in existing_variables:
+            existing_key_scope_vars.append({'key': item.get('key')})
+
+        for var in requested_variables:
+            if var in existing_variables:
+                untouched.append(var)
+            else:
+                compare_item = {'key': var.get('name')}
+                if compare_item in existing_key_scope_vars:
+                    updated.append(var)
+                else:
+                    added.append(var)
+
+    return untouched, updated, added
+
+
+def native_python_main(this_gitlab, purge, requested_variables, state, module):
+
+    change = False
+    return_value = dict(added=list(), updated=list(), removed=list(), untouched=list())
+
+    gitlab_keys = this_gitlab.list_all_instance_variables()
+    before = [x.attributes for x in gitlab_keys]
+
+    existing_variables = filter_returned_variables(gitlab_keys)
+
+    for item in requested_variables:
+        item['key'] = item.pop('name')
+        item['value'] = str(item.get('value'))
+        if item.get('protected') is None:
+            item['protected'] = False
+        if item.get('masked') is None:
+            item['masked'] = False
+        if item.get('variable_type') is None:
+            item['variable_type'] = 'env_var'
+
+    if module.check_mode:
+        untouched, updated, added = compare(requested_variables, existing_variables, state)
+
+    if state == 'present':
+        add_or_update = [x for x in requested_variables if x not in existing_variables]
+        for item in add_or_update:
+            try:
+                if this_gitlab.create_variable(item):
+                    return_value['added'].append(item)
+
+            except Exception:
+                if this_gitlab.update_variable(item):
+                    return_value['updated'].append(item)
+
+        if purge:
+            # refetch and filter
+            gitlab_keys = this_gitlab.list_all_instance_variables()
+            existing_variables = filter_returned_variables(gitlab_keys)
+
+            remove = [x for x in existing_variables if x not in requested_variables]
+            for item in remove:
+                if this_gitlab.delete_variable(item):
+                    return_value['removed'].append(item)
+
+    elif state == 'absent':
+        # value does not matter on removing variables.
+        # key and environment scope are sufficient
+        for item in existing_variables:
+            item.pop('value')
+            item.pop('variable_type')
+        for item in requested_variables:
+            item.pop('value')
+            item.pop('variable_type')
+
+        if not purge:
+            remove_requested = [x for x in requested_variables if x in existing_variables]
+            for item in remove_requested:
+                if this_gitlab.delete_variable(item):
+                    return_value['removed'].append(item)
+
+        else:
+            for item in existing_variables:
+                if this_gitlab.delete_variable(item):
+                    return_value['removed'].append(item)
+
+    if module.check_mode:
+        return_value = dict(added=added, updated=updated, removed=return_value['removed'], untouched=untouched)
+
+    if len(return_value['added'] + return_value['removed'] + return_value['updated']) > 0:
+        change = True
+
+    gitlab_keys = this_gitlab.list_all_instance_variables()
+    after = [x.attributes for x in gitlab_keys]
+
+    return change, return_value, before, after
+
+
+def main():
+    argument_spec = basic_auth_argument_spec()
+    argument_spec.update(auth_argument_spec())
+    argument_spec.update(
+        purge=dict(type='bool', required=False, default=False),
+        variables=dict(type='list', elements='dict', required=False, default=list(), options=dict(
+            name=dict(type='str', required=True),
+            value=dict(type='str', no_log=True),
+            masked=dict(type='bool', default=False),
+            protected=dict(type='bool', default=False),
+            variable_type=dict(type='str', default='env_var', choices=["env_var", "file"])
+        )),
+        state=dict(type='str', default="present", choices=["absent", "present"]),
+    )
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        mutually_exclusive=[
+            ['api_username', 'api_token'],
+            ['api_username', 'api_oauth_token'],
+            ['api_username', 'api_job_token'],
+            ['api_token', 'api_oauth_token'],
+            ['api_token', 'api_job_token'],
+        ],
+        required_together=[
+            ['api_username', 'api_password'],
+        ],
+        required_one_of=[
+            ['api_username', 'api_token', 'api_oauth_token', 'api_job_token']
+        ],
+        supports_check_mode=True
+    )
+    ensure_gitlab_package(module)
+
+    purge = module.params['purge']
+    state = module.params['state']
+
+    variables = module.params['variables']
+
+    if state == 'present':
+        if any(x['value'] is None for x in variables):
+            module.fail_json(msg='value parameter is required in state present')
+
+    gitlab_instance = gitlab_authentication(module)
+
+    this_gitlab = GitlabInstanceVariables(module=module, gitlab_instance=gitlab_instance)
+
+    changed, raw_return_value, before, after = native_python_main(this_gitlab, purge, variables, state, module)
+
+    # postprocessing
+    for item in after:
+        item['name'] = item.pop('key')
+    for item in before:
+        item['name'] = item.pop('key')
+
+    untouched_key_name = 'key'
+    if not module.check_mode:
+        untouched_key_name = 'name'
+        raw_return_value['untouched'] = [x for x in before if x in after]
+
+    added = [x.get('key') for x in raw_return_value['added']]
+    updated = [x.get('key') for x in raw_return_value['updated']]
+    removed = [x.get('key') for x in raw_return_value['removed']]
+    untouched = [x.get(untouched_key_name) for x in raw_return_value['untouched']]
+    return_value = dict(added=added, updated=updated, removed=removed, untouched=untouched)
+
+    module.exit_json(changed=changed, instance_variable=return_value)
+
+
+if __name__ == '__main__':
+    main()

tests/integration/targets/gitlab_instance_variable/aliases

@@ -0,0 +1,5 @@
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+unsupported

tests/integration/targets/gitlab_instance_variable/tasks/main.yml

@@ -0,0 +1,606 @@
+---
+####################################################################
+# WARNING: These are designed specifically for Ansible tests       #
+# and should not be used as examples of how to write Ansible roles #
+####################################################################
+
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- name: Install required libs
+  pip:
+    name: python-gitlab
+    state: present
+
+- name: purge all variables for check_mode test
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    purge: true
+
+- name: add a variable value in check_mode
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: checkmode
+  check_mode: true
+  register: gitlab_instance_variable_state
+
+- name: check_mode state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is changed
+
+- name: apply add value from check_mode test
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: checkmode
+  register: gitlab_instance_variable_state
+
+- name: state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is changed
+
+- name: apply same value again again
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: checkmode
+  register: gitlab_instance_variable_state
+
+- name: state must be not changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is not changed
+
+- name: change protected attribute
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: checkmode
+        protected: true
+  register: gitlab_instance_variable_state
+
+- name: state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is changed
+
+- name: revert protected attribute
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: checkmode
+        protected: false
+  register: gitlab_instance_variable_state
+
+- name: state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is changed
+
+- name: change masked attribute
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: checkmode
+        masked: true
+  register: gitlab_instance_variable_state
+
+- name: state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is changed
+
+- name: revert masked attribute by not mention it
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: checkmode
+        masked: false
+  register: gitlab_instance_variable_state
+
+- name: state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is changed
+
+- name: revert again masked attribute by not mention it (idempotent)
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: checkmode
+  register: gitlab_instance_variable_state
+
+- name: state must be not changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is not changed
+
+- name: set all attributes
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: checkmode
+        masked: true
+        protected: true
+        variable_type: env_var
+  register: gitlab_instance_variable_state
+
+- name: state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is changed
+
+- name: set again all attributes (idempotent)
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: checkmode
+        masked: true
+        protected: true
+        variable_type: env_var
+  register: gitlab_instance_variable_state
+
+- name: state must not be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is not changed
+
+- name: revert both (masked and protected) attribute
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: checkmode
+        protected: false
+  register: gitlab_instance_variable_state
+
+- name: state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is changed
+
+- name: change a variable value in check_mode again
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: checkmode
+  check_mode: true
+  register: gitlab_instance_variable_state
+
+- name: check_mode state must not be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is not changed
+
+- name: apply again the value change from check_mode test
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: checkmode
+  register: gitlab_instance_variable_state
+
+- name: state must not be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is not changed
+
+- name: purge all variables again
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    purge: true
+
+- name: set two test variables
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: abc123
+      - name: SECRET_ACCESS_KEY
+        value: 321cba
+  register: gitlab_instance_variable_state
+
+- name: set two test variables state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 2
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 0
+      - gitlab_instance_variable_state.instance_variable.removed|length == 0
+      - gitlab_instance_variable_state.instance_variable.updated|length == 0
+
+- name: re-set two test variables
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: abc123
+      - name: SECRET_ACCESS_KEY
+        value: 321cba
+  register: gitlab_instance_variable_state
+
+- name: re-set two test variables state must not be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is not changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 0
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 2
+      - gitlab_instance_variable_state.instance_variable.removed|length == 0
+      - gitlab_instance_variable_state.instance_variable.updated|length == 0
+
+- name: edit one variable
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: changed
+    purge: false
+  register: gitlab_instance_variable_state
+
+- name: edit one variable state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state.changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 0
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 1
+      - gitlab_instance_variable_state.instance_variable.removed|length == 0
+      - gitlab_instance_variable_state.instance_variable.updated|length == 1
+      - gitlab_instance_variable_state.instance_variable.updated[0] == "ACCESS_KEY_ID"
+
+- name: append one variable
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: some
+        value: value
+    purge: false
+  register: gitlab_instance_variable_state
+
+- name: append one variable state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state.changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 1
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 2
+      - gitlab_instance_variable_state.instance_variable.removed|length == 0
+      - gitlab_instance_variable_state.instance_variable.updated|length == 0
+      - gitlab_instance_variable_state.instance_variable.added[0] == "some"
+
+- name: re-set all variables
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: ACCESS_KEY_ID
+        value: changed
+      - name: SECRET_ACCESS_KEY
+        value: 321cba
+      - name: some
+        value: value
+  register: gitlab_instance_variable_state
+
+- name: re-set all variables state must not be changed
+  assert:
+    that:
+      - not gitlab_instance_variable_state.changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 0
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 3
+      - gitlab_instance_variable_state.instance_variable.removed|length == 0
+      - gitlab_instance_variable_state.instance_variable.updated|length == 0
+
+- name: set one variables and purge all others
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: some
+        value: value
+    purge: true
+  register: gitlab_instance_variable_state
+
+- name: set one variables and purge all others state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state.changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 0
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 1
+      - gitlab_instance_variable_state.instance_variable.removed|length == 2
+      - gitlab_instance_variable_state.instance_variable.updated|length == 0
+
+- name: only one variable is left
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: some
+        value: value
+    purge: false
+  register: gitlab_instance_variable_state
+
+- name: only one variable is left state must not be changed
+  assert:
+    that:
+      - not gitlab_instance_variable_state.changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 0
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 1
+      - gitlab_instance_variable_state.instance_variable.removed|length == 0
+      - gitlab_instance_variable_state.instance_variable.updated|length == 0
+      - gitlab_instance_variable_state.instance_variable.untouched[0] == "some"
+
+- name: test integer values
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: some
+        value: 42
+    purge: false
+  register: gitlab_instance_variable_state
+
+- name: only one variable is left state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state.changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 0
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 0
+      - gitlab_instance_variable_state.instance_variable.removed|length == 0
+      - gitlab_instance_variable_state.instance_variable.updated|length == 1
+
+- name: test float values
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: some
+        value: 42.23
+    purge: false
+  register: gitlab_instance_variable_state
+
+- name: only one variable is left state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state.changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 0
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 0
+      - gitlab_instance_variable_state.instance_variable.removed|length == 0
+      - gitlab_instance_variable_state.instance_variable.updated|length == 1
+
+- name: delete the last left variable
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    state: absent
+    variables:
+      - name: some
+  register: gitlab_instance_variable_state
+
+- name: no variable is left state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state.changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 0
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 0
+      - gitlab_instance_variable_state.instance_variable.removed|length == 1
+      - gitlab_instance_variable_state.instance_variable.updated|length == 0
+      - gitlab_instance_variable_state.instance_variable.removed[0] == "some"
+
+- name: add one variable with variable_type file
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: my_test_var
+        value: my_test_value
+        variable_type: file
+    purge: false
+  register: gitlab_instance_variable_state
+
+- name: append one variable state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state.changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 1
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 0
+      - gitlab_instance_variable_state.instance_variable.removed|length == 0
+      - gitlab_instance_variable_state.instance_variable.updated|length == 0
+      # VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
+      #- gitlab_instance_variable_state.instance_variable.added[0] == "my_test_var"
+
+- name: change variable_type attribute
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: my_test_var
+        value: my_test_value
+        variable_type: env_var
+  register: gitlab_instance_variable_state
+
+- name: state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is changed
+
+- name: revert variable_type attribute
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: my_test_var
+        value: my_test_value
+        variable_type: file
+  register: gitlab_instance_variable_state
+
+- name: state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is changed
+
+- name: delete the variable_type file variable
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    state: absent
+    variables:
+      - name: my_test_var
+  register: gitlab_instance_variable_state
+
+- name: no variable is left state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state.changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 0
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 0
+      - gitlab_instance_variable_state.instance_variable.removed|length == 1
+      - gitlab_instance_variable_state.instance_variable.updated|length == 0
+      - gitlab_instance_variable_state.instance_variable.removed[0] == "my_test_var"
+
+- name: set complete page and purge existing ones
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: page1_var01
+        value: value
+      - name: page1_var02
+        value: value
+      - name: page1_var03
+        value: value
+      - name: page1_var04
+        value: value
+      - name: page1_var05
+        value: value
+      - name: page1_var06
+        value: value
+      - name: page1_var07
+        value: value
+      - name: page1_var08
+        value: value
+      - name: page1_var09
+        value: value
+      - name: page1_var10
+        value: value
+      - name: page1_var11
+        value: value
+      - name: page1_var12
+        value: value
+      - name: page1_var13
+        value: value
+      - name: page1_var14
+        value: value
+      - name: page1_var15
+        value: value
+      - name: page1_var16
+        value: value
+      - name: page1_var17
+        value: value
+      - name: page1_var18
+        value: value
+      - name: page1_var19
+        value: value
+      - name: page1_var20
+        value: value
+    purge: true
+  register: gitlab_instance_variable_state
+
+- name: complete page added state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state is changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 20
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 0
+
+- name: check that no variables are left
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    purge: true
+  register: gitlab_instance_variable_state
+
+- name: check that no variables are untouched state must be changed
+  assert:
+    that:
+      - gitlab_instance_variable_state.changed
+      - gitlab_instance_variable_state.instance_variable.added|length == 0
+      - gitlab_instance_variable_state.instance_variable.untouched|length == 0
+      - gitlab_instance_variable_state.instance_variable.removed|length == 20
+      - gitlab_instance_variable_state.instance_variable.updated|length == 0
+
+- name: throw error when state is present but no value is given
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    variables:
+      - name: no_value
+  register: gitlab_instance_variable_state
+  ignore_errors: true
+
+- name: verify fail
+  assert:
+    that:
+      - gitlab_instance_variable_state.failed
+      - gitlab_instance_variable_state is not changed
+
+- name: set a new variable to delete it later
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    purge: true
+    variables:
+      - name: delete_me
+        value: ansible
+  register: gitlab_instance_variable_state
+
+- name: verify the change
+  assert:
+    that:
+      - gitlab_instance_variable_state.changed
+
+- name: delete variable without referencing its value
+  gitlab_instance_variable:
+    api_url: "{{ gitlab_host }}"
+    api_token: "{{ gitlab_login_token }}"
+    state: absent
+    variables:
+      - name: delete_me
+  register: gitlab_instance_variable_state
+
+- name: verify deletion
+  assert:
+    that:
+      - gitlab_instance_variable_state.changed
+      - gitlab_instance_variable_state.instance_variable.removed|length == 1