New idoverridegroup management module.

There is a new idoverridegroup management module placed in the plugins
folder:

    plugins/modules/ipaidoverridegroup.py

The idoverridegroup module allows to ensure presence and absence of
idoverrides for groups.

Here is the documentation for the module:

    README-idoverridegroup.md

New example playbooks have been added:

    playbooks/idoverridegroup/idoverridegroup-absent.yml
    playbooks/idoverridegroup/idoverridegroup-present.yml

New tests for the module can be found at:

    tests/idoverridegroup/test_idoverridegroup.yml
    tests/idoverridegroup/test_idoverridegroup_client_context.yml
This commit is contained in:
Thomas Woerner
2023-09-13 17:53:00 +02:00
parent e5b2c122ce
commit 6f5bb9eebf
7 changed files with 858 additions and 0 deletions

View File

@@ -0,0 +1,205 @@
---
- name: Test idoverridegroup
hosts: "{{ ipa_test_host | default('ipaserver') }}"
become: false
gather_facts: false
module_defaults:
ipaidoverridegroup:
ipaadmin_password: SomeADMINpassword
ipaapi_context: "{{ ipa_context | default(omit) }}"
ipaidview:
ipaadmin_password: SomeADMINpassword
ipaapi_context: "{{ ipa_context | default(omit) }}"
ipagroup:
ipaadmin_password: SomeADMINpassword
ipaapi_context: "{{ ipa_context | default(omit) }}"
tasks:
# CLEANUP TEST ITEMS
- name: Ensure test group test_group does not exist
ipagroup:
name: test_group
state: absent
- name: Ensure test group test_group is absent in idview test_idview
ipaidoverridegroup:
idview: test_idview
anchor: test_group
continue: true
state: absent
- name: Ensure test idview test_idview does not exist
ipaidview:
name: test_idview
state: absent
# CREATE TEST ITEMS
- name: Ensure test group test_group exists
ipagroup:
name: test_group
- name: Ensure test idview test_idview exists
ipaidview:
name: test_idview
# TESTS
- name: Ensure test group test_group is present in idview test_idview
ipaidoverridegroup:
idview: test_idview
anchor: test_group
register: result
failed_when: not result.changed or result.failed
- name: Ensure test group test_group is present in idview test_idview, again
ipaidoverridegroup:
idview: test_idview
anchor: test_group
register: result
failed_when: result.changed or result.failed
# description
- name: Ensure test group test_group is present in idview test_idview with description
ipaidoverridegroup:
idview: test_idview
anchor: test_group
description: "test_group description"
register: result
failed_when: not result.changed or result.failed
- name: Ensure test group test_group is present in idview test_idview with description, again
ipaidoverridegroup:
idview: test_idview
anchor: test_group
description: "test_group description"
register: result
failed_when: result.changed or result.failed
- name: Ensure test group test_group is present in idview test_idview without description
ipaidoverridegroup:
idview: test_idview
anchor: test_group
description: ""
register: result
failed_when: not result.changed or result.failed
- name: Ensure test group test_group is present in idview test_idview without description, again
ipaidoverridegroup:
idview: test_idview
anchor: test_group
description: ""
register: result
failed_when: result.changed or result.failed
# name
- name: Ensure test group test_group is present in idview test_idview with internal name test_123_group
ipaidoverridegroup:
idview: test_idview
anchor: test_group
name: test_123_group
register: result
failed_when: not result.changed or result.failed
- name: Ensure test group test_group is present in idview test_idview with internal name test_123_group, again
ipaidoverridegroup:
idview: test_idview
anchor: test_group
name: test_123_group
register: result
failed_when: result.changed or result.failed
- name: Ensure test group test_group is present in idview test_idview without internal name
ipaidoverridegroup:
idview: test_idview
anchor: test_group
name: ""
register: result
failed_when: not result.changed or result.failed
- name: Ensure test group test_group is present in idview test_idview without internal name, again
ipaidoverridegroup:
idview: test_idview
anchor: test_group
name: ""
register: result
failed_when: result.changed or result.failed
# gid
- name: Ensure test group test_group is present in idview test_idview with gid 20001
ipaidoverridegroup:
idview: test_idview
anchor: test_group
gid: 20001
register: result
failed_when: not result.changed or result.failed
- name: Ensure test group test_group is present in idview test_idview with gid 20001, again
ipaidoverridegroup:
idview: test_idview
anchor: test_group
gid: 20001
register: result
failed_when: result.changed or result.failed
- name: Ensure test group test_group is present in idview test_idview without gid
ipaidoverridegroup:
idview: test_idview
anchor: test_group
gid: ""
register: result
failed_when: not result.changed or result.failed
- name: Ensure test group test_group is present in idview test_idview without gid, again
ipaidoverridegroup:
idview: test_idview
anchor: test_group
gid: ""
register: result
failed_when: result.changed or result.failed
# no fallback_to_ldap tests
# absent
- name: Ensure test group test_group is absent in idview test_idview
ipaidoverridegroup:
idview: test_idview
anchor: test_group
continue: true
state: absent
register: result
failed_when: not result.changed or result.failed
- name: Ensure test group test_group is absent in idview test_idview, again
ipaidoverridegroup:
idview: test_idview
anchor: test_group
continue: true
state: absent
register: result
failed_when: result.changed or result.failed
# CLEANUP TEST ITEMS
- name: Ensure test group test_group does not exist
ipagroup:
name: test_group
state: absent
- name: Ensure test group test_group is absent in idview test_idview
ipaidoverridegroup:
idview: test_idview
anchor: test_group
continue: true
state: absent
- name: Ensure test idview test_idview does not exist
ipaidview:
name: test_idview
state: absent

View File

@@ -0,0 +1,40 @@
---
- name: Test idoverridegroup
hosts: ipaclients, ipaserver
# It is normally not needed to set "become" to "true" for a module test.
# Only set it to true if it is needed to execute commands as root.
become: false
# Enable "gather_facts" only if "ansible_facts" variable needs to be used.
gather_facts: false
tasks:
- name: Include FreeIPA facts.
ansible.builtin.include_tasks: ../env_freeipa_facts.yml
# Test will only be executed if host is not a server.
- name: Execute with server context in the client.
ipaidoverridegroup:
ipaadmin_password: SomeADMINpassword
ipaapi_context: server
name: ThisShouldNotWork
register: result
failed_when: not (result.failed and result.msg is regex("No module named '*ipaserver'*"))
when: ipa_host_is_client
# Import basic module tests, and execute with ipa_context set to 'client'.
# If ipaclients is set, it will be executed using the client, if not,
# ipaserver will be used.
#
# With this setup, tests can be executed against an IPA client, against
# an IPA server using "client" context, and ensure that tests are executed
# in upstream CI.
- name: Test idoverridegroup using client context, in client host.
import_playbook: test_idoverridegroup.yml
when: groups['ipaclients']
vars:
ipa_test_host: ipaclients
- name: Test idoverridegroup using client context, in server host.
import_playbook: test_idoverridegroup.yml
when: groups['ipaclients'] is not defined or not groups['ipaclients']