From 998cb50b07b2056acbcedb618430fa68717fdce6 Mon Sep 17 00:00:00 2001 From: Lee Goolsbee Date: Wed, 3 Feb 2021 17:18:02 -0600 Subject: [PATCH 1/4] ITPLAT-476 cast atl_startup_restart to bool --- roles/product_startup/defaults/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/product_startup/defaults/main.yml b/roles/product_startup/defaults/main.yml index 70b7708..02d2b65 100644 --- a/roles/product_startup/defaults/main.yml +++ b/roles/product_startup/defaults/main.yml @@ -2,7 +2,7 @@ # Mostly for molecule testing, as skip-tags doesn't work with handlers. atl_startup_enable: true -atl_startup_restart: "{{ lookup('env', 'ATL_STARTUP_RESTART') or true }}" +atl_startup_restart: "{{ lookup('env', 'ATL_STARTUP_RESTART') or true | bool }}" atl_startup_script_map: jira: "bin/start-jira.sh" From a879291f500f45c6ebbb79b9da7b076803ac39d0 Mon Sep 17 00:00:00 2001 From: Lee Goolsbee Date: Wed, 3 Feb 2021 17:40:11 -0600 Subject: [PATCH 2/4] try casting env var to bool before falling back to default(true) --- roles/product_startup/defaults/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/product_startup/defaults/main.yml b/roles/product_startup/defaults/main.yml index 02d2b65..b109384 100644 --- a/roles/product_startup/defaults/main.yml +++ b/roles/product_startup/defaults/main.yml @@ -2,7 +2,7 @@ # Mostly for molecule testing, as skip-tags doesn't work with handlers. atl_startup_enable: true -atl_startup_restart: "{{ lookup('env', 'ATL_STARTUP_RESTART') or true | bool }}" +atl_startup_restart: "{{ lookup('env', 'ATL_STARTUP_RESTART') | bool | default(true) }}" atl_startup_script_map: jira: "bin/start-jira.sh" From 1278cc6cf51ee6e75c2663dc59ba363726827be6 Mon Sep 17 00:00:00 2001 From: Lee Goolsbee Date: Fri, 5 Feb 2021 12:00:41 -0600 Subject: [PATCH 3/4] allow default filter to treat empty string as "false", cast to bool at end --- roles/product_startup/defaults/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/product_startup/defaults/main.yml b/roles/product_startup/defaults/main.yml index b109384..8a3695d 100644 --- a/roles/product_startup/defaults/main.yml +++ b/roles/product_startup/defaults/main.yml @@ -2,7 +2,7 @@ # Mostly for molecule testing, as skip-tags doesn't work with handlers. atl_startup_enable: true -atl_startup_restart: "{{ lookup('env', 'ATL_STARTUP_RESTART') | bool | default(true) }}" +atl_startup_restart: "{{ lookup('env', 'ATL_STARTUP_RESTART') | default(true, true) | bool }}" atl_startup_script_map: jira: "bin/start-jira.sh" From 520a881310728de60edb8657f626467632406b80 Mon Sep 17 00:00:00 2001 From: Lee Goolsbee Date: Fri, 5 Feb 2021 15:44:15 -0600 Subject: [PATCH 4/4] add tests to ensure expression for atl_startup_restart var in defaults is evaluated to boolean --- bitbucket-pipelines.yml | 10 ++++++- roles/product_startup/handlers/main.yml | 8 +++-- .../molecule/default/converge.yml | 20 +++++++++++-- .../molecule/default/tests/test_default.py | 6 ++++ .../startup_restart_false/Dockerfile.j2 | 14 +++++++++ .../startup_restart_false/converge.yml | 27 +++++++++++++++++ .../startup_restart_false/molecule.yml | 29 +++++++++++++++++++ .../tests/test_default.py | 12 ++++++++ 8 files changed, 121 insertions(+), 5 deletions(-) create mode 100644 roles/product_startup/molecule/startup_restart_false/Dockerfile.j2 create mode 100644 roles/product_startup/molecule/startup_restart_false/converge.yml create mode 100644 roles/product_startup/molecule/startup_restart_false/molecule.yml create mode 100644 roles/product_startup/molecule/startup_restart_false/tests/test_default.py diff --git a/bitbucket-pipelines.yml b/bitbucket-pipelines.yml index 06a83de..078d341 100644 --- a/bitbucket-pipelines.yml +++ b/bitbucket-pipelines.yml @@ -18,7 +18,7 @@ pipelines: - step: name: Pre Parallelization stage script: - - echo "Running tests in 37 batches" + - echo "Running tests in 38 batches" - step: name: Check if the template is up-to-date @@ -97,6 +97,14 @@ pipelines: - ./bin/install-ansible --dev - cd roles/product_startup - pipenv run molecule test -s bitbucket + - step: + name: product_startup/startup_restart_false + services: + - docker + script: + - ./bin/install-ansible --dev + - cd roles/product_startup + - pipenv run molecule test -s startup_restart_false - step: name: product_common/default services: diff --git a/roles/product_startup/handlers/main.yml b/roles/product_startup/handlers/main.yml index 6e9e1d8..57275c9 100644 --- a/roles/product_startup/handlers/main.yml +++ b/roles/product_startup/handlers/main.yml @@ -4,12 +4,16 @@ service: name: "{{ atl_systemd_service_name }}" state: restarted - when: atl_startup_restart + when: + - atl_startup_restart + - molecule_yml is not defined no_log: true - name: Enable Product service: name: "{{ atl_systemd_service_name }}" enabled: true - when: atl_startup_enable + when: + - atl_startup_enable + - molecule_yml is not defined no_log: true diff --git a/roles/product_startup/molecule/default/converge.yml b/roles/product_startup/molecule/default/converge.yml index 5cff089..9a232fc 100644 --- a/roles/product_startup/molecule/default/converge.yml +++ b/roles/product_startup/molecule/default/converge.yml @@ -6,8 +6,7 @@ atl_product_family: "jira" atl_product_edition: "jira-software" - atl_startup_enable: false - atl_startup_restart: false + ansible_vars_dump_location: "/tmp/ansible-vars.yml" pre_tasks: - name: Create systemd dir if necessary @@ -20,3 +19,20 @@ roles: - role: product_startup + + post_tasks: + - include_vars: ../../defaults/main.yml + + # workaround Molecule idempotence check + # normal pattern of setting changed_when allows file to be written twice, which takes extra time + - name: Check if vars have already been dumped + stat: + path: "{{ ansible_vars_dump_location }}" + register: ansible_vars_stat_result + + - name: Dump vars to file for inspection + copy: + content: | + {{ vars | to_nice_yaml }} + dest: "{{ ansible_vars_dump_location }}" + when: not ansible_vars_stat_result.stat.exists diff --git a/roles/product_startup/molecule/default/tests/test_default.py b/roles/product_startup/molecule/default/tests/test_default.py index d3b1994..b02bda9 100644 --- a/roles/product_startup/molecule/default/tests/test_default.py +++ b/roles/product_startup/molecule/default/tests/test_default.py @@ -13,3 +13,9 @@ def test_service_file(host): assert f.user == 'root' assert f.group == 'root' assert f.mode == 0o0640 + + +def test_atl_startup_restart(host): + f = host.file('/tmp/ansible-vars.yml') + # value should appear as YAML boolean true (i.e., string 'true' will fail) + assert f.contains(r'^\s*atl_startup_restart: true$') diff --git a/roles/product_startup/molecule/startup_restart_false/Dockerfile.j2 b/roles/product_startup/molecule/startup_restart_false/Dockerfile.j2 new file mode 100644 index 0000000..e6aa95d --- /dev/null +++ b/roles/product_startup/molecule/startup_restart_false/Dockerfile.j2 @@ -0,0 +1,14 @@ +# Molecule managed + +{% if item.registry is defined %} +FROM {{ item.registry.url }}/{{ item.image }} +{% else %} +FROM {{ item.image }} +{% endif %} + +RUN if [ $(command -v apt-get) ]; then apt-get update && apt-get install -y python sudo bash ca-certificates && apt-get clean; \ + elif [ $(command -v dnf) ]; then dnf makecache && dnf --assumeyes install python sudo python-devel python*-dnf bash && dnf clean all; \ + elif [ $(command -v yum) ]; then yum makecache fast && yum install -y python sudo yum-plugin-ovl bash && sed -i 's/plugins=0/plugins=1/g' /etc/yum.conf && yum clean all; \ + elif [ $(command -v zypper) ]; then zypper refresh && zypper install -y python sudo bash python-xml && zypper clean -a; \ + elif [ $(command -v apk) ]; then apk update && apk add --no-cache python sudo bash ca-certificates; \ + elif [ $(command -v xbps-install) ]; then xbps-install -Syu && xbps-install -y python sudo bash ca-certificates && xbps-remove -O; fi diff --git a/roles/product_startup/molecule/startup_restart_false/converge.yml b/roles/product_startup/molecule/startup_restart_false/converge.yml new file mode 100644 index 0000000..1943cb3 --- /dev/null +++ b/roles/product_startup/molecule/startup_restart_false/converge.yml @@ -0,0 +1,27 @@ +--- +- name: Converge + hosts: all + vars: + atl_product_user: "jira" + atl_product_family: "jira" + atl_product_edition: "jira-software" + atl_startup_enable: false + + ansible_vars_dump_location: "/tmp/ansible-vars.yml" + + tasks: + - include_vars: ../../defaults/main.yml + + # workaround Molecule idempotence check + # normal pattern of setting changed_when allows file to be written twice, which takes extra time + - name: Check if vars have already been dumped + stat: + path: "{{ ansible_vars_dump_location }}" + register: ansible_vars_stat_result + + - name: Dump vars to file for inspection + copy: + content: | + {{ vars | to_nice_yaml }} + dest: "{{ ansible_vars_dump_location }}" + when: not ansible_vars_stat_result.stat.exists diff --git a/roles/product_startup/molecule/startup_restart_false/molecule.yml b/roles/product_startup/molecule/startup_restart_false/molecule.yml new file mode 100644 index 0000000..85b7cb3 --- /dev/null +++ b/roles/product_startup/molecule/startup_restart_false/molecule.yml @@ -0,0 +1,29 @@ +--- +dependency: + name: galaxy +driver: + name: docker +platforms: + - name: amazon_linux2 + image: amazonlinux:2 + groups: + - aws_node_local + ulimits: + - nofile:262144:262144 + - name: ubuntu_lts + image: ubuntu:bionic + groups: + - aws_node_local + ulimits: + - nofile:262144:262144 +provisioner: + name: ansible + env: + ATL_STARTUP_RESTART: "false" + options: + skip-tags: runtime_pkg + inventory: + links: + group_vars: ../../../../group_vars/ +verifier: + name: testinfra diff --git a/roles/product_startup/molecule/startup_restart_false/tests/test_default.py b/roles/product_startup/molecule/startup_restart_false/tests/test_default.py new file mode 100644 index 0000000..a70d8d7 --- /dev/null +++ b/roles/product_startup/molecule/startup_restart_false/tests/test_default.py @@ -0,0 +1,12 @@ +import os + +import testinfra.utils.ansible_runner + +testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner( + os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all') + + +def test_atl_startup_restart(host): + f = host.file('/tmp/ansible-vars.yml') + # value should appear as YAML boolean false (i.e., boolean true or string 'false' will fail) + assert f.contains(r'^\s*atl_startup_restart: false$')