ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-27 23:21:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

New sysrc module for managing rc files on FreeBSD (#1460)

Browse source 
* New sysrc module for managing rc files on FreeBSD

* Updated sysrc module, docs and tests per reviews

* Refactored the check_mode to be in the methods and not main

Also updated tests

* Fixed a duplicate "name" key in the sysrc test

* Remove debugging output

* Add changelog fragment

* Remove changelog fragment

* Make sure tests actually run in CI.

* Update failing test due to bad path to jail

* Create and remove testjail for tests

* Fix and cleanup tests

* Set the correct path to the testjail

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
David Lundgren 2021-01-16 07:14:23 -06:00 • committed by GitHub
commit aa33ac349c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 637 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
tests/integration/targets/sysrc/aliases Normal file
View file

@ -0,0 +1,5 @@
shippable/posix/group1
needs/root
skip/docker
skip/osx
skip/rhel

318
tests/integration/targets/sysrc/tasks/main.yml Normal file
View file

@ -0,0 +1,318 @@
---
- name: Test on FreeBSD VMs
when:
- ansible_facts.virtualization_type != 'docker'
- ansible_facts.distribution == 'FreeBSD'
block:
- name: Cache original contents of /etc/rc.conf
shell: "cat /etc/rc.conf"
register: sysrc_original_content
##
## sysrc - example - set mysqlpidfile
##
- name: Configure mysql pid file
sysrc:
name: mysql_pidfile
value: /tmp/mysql.pid
register: sysrc_example1
- name: Configure mysql pid file (checkmode)
sysrc:
name: mysql_pidfile
value: checkmode
check_mode: yes
register: sysrc_example1_checkmode
- name: Configure mysql pid file (idempotent)
sysrc:
name: mysql_pidfile
value: /tmp/mysql.pid
register: sysrc_example1_idempotent
- name: Get file content
shell: "cat /etc/rc.conf | egrep -v ^\\#"
register: sysrc_example1_content
- name: Ensure sysrc updates rc.conf properly
assert:
that:
- sysrc_example1.changed
- sysrc_example1_checkmode.changed
- not sysrc_example1_idempotent.changed
- "'mysql_pidfile=\"/tmp/mysql.pid\"' in sysrc_example1_content.stdout_lines"
- "'mysql_pidfile=\"checkmode\"' not in sysrc_example1_content.stdout_lines"
##
## sysrc - example - Enable accf_http kld in /boot/loader.conf
##
- name: Enable accf_http kld in /boot/loader.conf
sysrc:
name: accf_http_load
state: present
value: "YES"
path: /boot/loader.conf
register: sysrc_example2
- name: Enable accf_http kld in /boot/loader.conf (checkmode)
sysrc:
name: accf_http_load
state: present
value: "NO"
path: /boot/loader.conf
check_mode: yes
register: sysrc_example2_checkmode
- name: Enable accf_http kld in /boot/loader.conf (idempotent)
sysrc:
name: accf_http_load
state: present
value: "YES"
path: /boot/loader.conf
register: sysrc_example2_idempotent
- name: Get file content
shell: "cat /boot/loader.conf | egrep -v ^\\#"
register: sysrc_example2_content
- name: Ensure sysrc did not change the file, but marked as changed
assert:
that:
- sysrc_example2.changed
- sysrc_example2_checkmode.changed
- not sysrc_example2_idempotent.changed
- "'accf_http_load=\"YES\"' in sysrc_example2_content.stdout_lines"
- "'accf_http_load=\"NO\"' not in sysrc_example2_content.stdout_lines"
##
## sysrc - example - Add gif0 interface
##
- name: Set cloned_interfaces
sysrc:
name: cloned_interfaces
value: "lo0"
- name: Add gif0 interface
sysrc:
name: cloned_interfaces
state: value_present
value: "gif0"
register: sysrc_example3
- name: Add gif1 interface (checkmode)
sysrc:
name: cloned_interfaces
state: value_present
value: "gif1"
check_mode: yes
register: sysrc_example3_checkmode
- name: Add gif0 interface (idempotent)
sysrc:
name: cloned_interfaces
state: value_present
value: "gif0"
register: sysrc_example3_idempotent
- name: Get file content
shell: "cat /etc/rc.conf | egrep -v ^\\#"
register: sysrc_example3_content
- name: Ensure sysrc did not change the file, but marked as changed
assert:
that:
- sysrc_example3.changed
- sysrc_example3_checkmode.changed
- not sysrc_example3_idempotent.changed
- "'cloned_interfaces=\"lo0 gif0\"' in sysrc_example3_content.stdout_lines"
##
## sysrc - example - Enable nginx in testjail
##
- name: Test within jail
block:
- name: Setup testjail
include: setup-testjail.yml
- name: Enable nginx in test jail
sysrc:
name: nginx_enable
value: "YES"
jail: testjail
register: sysrc_example4
- name: Enable nginx in test jail (checkmode)
sysrc:
name: nginx_enable
value: "NO"
jail: testjail
check_mode: yes
register: sysrc_example4_checkmode
- name: Enable nginx in test jail (idempotent)
sysrc:
name: nginx_enable
value: "YES"
jail: testjail
register: sysrc_example4_idempotent
- name: Get file content
shell: "cat /usr/jails/testjail/etc/rc.conf | grep nginx_enable"
register: sysrc_example4_content
- name: Ensure sysrc worked in testjail
assert:
that:
- sysrc_example4.changed
- sysrc_example4_checkmode.changed
- not sysrc_example4_idempotent.changed
- "'nginx_enable=\"YES\"' in sysrc_example4_content.stdout_lines"
always:
- name: Stop and remove testjail
failed_when: false
changed_when: false
command: "ezjail-admin delete -wf testjail"
##
## sysrc - Test Absent
##
- name: Set sysrc_absent to test removal
sysrc:
name: sysrc_absent
value: test
- name: Remove sysrc_absent (checkmode)
sysrc:
name: sysrc_absent
state: absent
check_mode: yes
register: sysrc_absent_checkmode
- name: Remove sysrc_absent
sysrc:
name: sysrc_absent
state: absent
register: sysrc_absent
- name: Remove sysrc_absent (idempotent)
sysrc:
name: sysrc_absent
state: absent
register: sysrc_absent_idempotent
- name: Get file content
shell: "cat /etc/rc.conf | egrep -v ^\\#"
register: sysrc_absent_content
- name: Ensure sysrc did as intended
assert:
that:
- sysrc_absent_checkmode.changed
- sysrc_absent.changed
- not sysrc_absent_idempotent.changed
- "'sysrc_absent=\"test\"' not in sysrc_absent_content.stdout_lines"
##
## sysrc - Test alternate delimiter
##
- name: Set sysrc_delim to known value
sysrc:
name: sysrc_delim
value: "t1,t2"
- name: Add to value with delimiter (not-exists)
sysrc:
name: sysrc_delim_create
state: value_present
delim: ","
value: t3
register: sysrc_delim_create
- name: Add to value with delimiter
sysrc:
name: sysrc_delim
state: value_present
delim: ","
value: t3
register: sysrc_delim
- name: Add to value with delimiter (checkmode)
sysrc:
name: sysrc_delim
state: value_present
delim: ","
value: t4
check_mode: yes
register: sysrc_delim_checkmode
- name: Add to value with delimiter (idempotent)
sysrc:
name: sysrc_delim
state: value_present
delim: ","
value: t3
register: sysrc_delim_idempotent
- name: Get file content
shell: "cat /etc/rc.conf | egrep -v ^\\#"
register: sysrc_delim_content
- name: Ensure sysrc did as intended
assert:
that:
- sysrc_delim_create.changed
- sysrc_delim.changed
- sysrc_delim_checkmode.changed
- not sysrc_delim_idempotent.changed
- "'sysrc_delim=\"t1,t2,t3\"' in sysrc_delim_content.stdout_lines"
- "'sysrc_delim_create=\"t3\"' in sysrc_delim_content.stdout_lines"
##
## sysrc - value_absent
##
- name: Remove value (when not exists)
sysrc:
name: sysrc_value_absent_delete
state: value_absent
delim: ","
value: t3
register: sysrc_value_absent_ignored
- name: Remove value from sysrc_delim
sysrc:
name: sysrc_delim
state: value_absent
value: t3
delim: ","
register: sysrc_value_absent
- name: Remove value from sysrc_delim (checkmode)
sysrc:
name: sysrc_delim
state: value_absent
value: t2
delim: ","
check_mode: yes
register: sysrc_value_absent_checkmode
- name: Remove value from sysrc_delim (idempotent
sysrc:
name: sysrc_delim
state: value_absent
value: t3
delim: ","
register: sysrc_value_absent_idempotent
- name: Get file content
shell: "cat /etc/rc.conf | egrep -v ^\\#"
register: sysrc_delim_content
- name: Ensure sysrc did as intended with value_absent
assert:
that:
- not sysrc_value_absent_ignored.changed
- sysrc_value_absent.changed
- sysrc_value_absent_checkmode.changed
- not sysrc_value_absent_idempotent.changed
- "'sysrc_delim=\"t1,t2\"' in sysrc_delim_content.stdout_lines"
- "'sysrc_delim_delete' not in sysrc_delim_content.stdout_lines"

62
tests/integration/targets/sysrc/tasks/setup-testjail.yml Normal file
View file

@ -0,0 +1,62 @@
---
#
# Instructions for setting up a jail
# https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/jails-ezjail.html
#
- name: Setup cloned interfaces
lineinfile:
dest: /etc/rc.conf
regexp: ^cloned_interfaces=lo1
line: cloned_interfaces=lo1
- name: Activate cloned interfaces
command: "service netif cloneup"
changed_when: false
- name: Install ezjail
pkgng:
name: ezjail
- name: Configure ezjail to use archive for old freebsd releases
when: ansible_distribution_version is version('11.01', '<=')
lineinfile:
dest: /usr/local/etc/ezjail.conf
regexp: ^ezjail_ftphost
line: ezjail_ftphost=ftp-archive.freebsd.org
- name: Start ezjail
ignore_errors: yes
service:
name: ezjail
state: started
enabled: yes
- name: Has ezjail
register: ezjail_base_jail
stat:
path: /usr/jails/basejail
- name: Setup ezjail base
when: not ezjail_base_jail.stat.exists
shell: "ezjail-admin install >> /tmp/ezjail.log"
changed_when: false
- name: Has testjail
register: ezjail_test_jail
stat:
path: /usr/jails/testjail
- name: Create testjail
when: not ezjail_test_jail.stat.exists
shell: "ezjail-admin create testjail 'lo1|127.0.1.1' >> /tmp/ezjail.log"
changed_when: false
- name: Is testjail running
shell: "jls | grep testjail"
changed_when: false
failed_when: false
register: is_testjail_up
- name: Start testjail
when: is_testjail_up.rc == 1
command: "ezjail-admin start testjail"