09c76e2380
The config_template comment parser will now respect all comments in INI files, as they are written. This will ensure spacing, paragraphs, and other comments bits that may be in an INI file remain intact, even when overriding options and sections. With this feature we'll now be able to insert options in OSLO config generated files without truncating or making a mess of the file structure. This is an internal enhancement and requires no change from the operator or from within any ansible task. To ensure enhanced comments are working, new tests have been added which will run though all of the `config_template` INI file functions using a mock service file. Existing tests for the old comment structure has been removed. This includes tests that were running redundant tasks for file diffs or expected the only style, merged, comment layout. All of the tests have been broken out into descriptive task files. This was largely done for readability. It was difficult to see what tests we had and how I needed to extend them to test the enhanced comments functionality given the INI type tests were all thoughout the `tests/test-common-tasks.yml`. Now that the files have been broken out developers will easily be able to audit our tests making it simple to extend. Change-Id: Ia6cdc215c35fa9ac45b718c211616a9887a74e37 Signed-off-by: Kevin Carter <kecarter@redhat.com>
126 lines
3.7 KiB
YAML
126 lines
3.7 KiB
YAML
---
|
|
# Copyright 2018, Rackspace US
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
# Test basic function of config_template
|
|
|
|
# Test list additions in config_template
|
|
- name: Template test YML template
|
|
config_template:
|
|
src: "{{ playbook_dir }}/templates/test.yml"
|
|
dest: "/tmp/test_extend.yml"
|
|
config_overrides: "{{ test_config_yml_overrides }}"
|
|
config_type: "yaml"
|
|
list_extend: True
|
|
register: test_extend_yml
|
|
notify: test_extend_yml check diff
|
|
|
|
- name: Read test_extend.yml
|
|
slurp:
|
|
src: /tmp/test_extend.yml
|
|
register: extend_file
|
|
|
|
- debug:
|
|
msg: "extend - {{ extend_file.content | b64decode }}"
|
|
|
|
- debug:
|
|
msg: "extend.expected - {{ extend_file_expected.content | b64decode }}"
|
|
|
|
- name: Compare files
|
|
assert:
|
|
that:
|
|
- "(extend_file.content | b64decode) == (extend_file_expected.content | b64decode)"
|
|
|
|
|
|
# Test list replacement in config_template
|
|
- name: Template test YML template
|
|
config_template:
|
|
src: "{{ playbook_dir }}/templates/test.yml"
|
|
dest: "/tmp/test_no_extend.yml"
|
|
config_overrides: "{{ test_config_yml_overrides }}"
|
|
config_type: "yaml"
|
|
list_extend: False
|
|
register: test_no_extend_yml
|
|
notify: test_no_extend_yml check diff
|
|
|
|
- name: Read test_no_extend.yml
|
|
slurp:
|
|
src: /tmp/test_no_extend.yml
|
|
register: no_extend_file
|
|
|
|
- debug:
|
|
msg: "no_extend - {{ no_extend_file.content | b64decode }}"
|
|
|
|
- debug:
|
|
msg: "no_extend.expected - {{ no_extend_file_expected.content | b64decode }}"
|
|
|
|
- name: Compare files
|
|
assert:
|
|
that:
|
|
- "(no_extend_file.content | b64decode) == (no_extend_file_expected.content | b64decode)"
|
|
|
|
|
|
# Test dumping hostvars using config overrides
|
|
- name: Template test YML template with hostvars override
|
|
config_template:
|
|
src: "{{ playbook_dir }}/templates/test.yml"
|
|
dest: "/tmp/test_hostvars.yml"
|
|
config_overrides: "{{ test_config_yml_hostvars_overrides }}"
|
|
config_type: "yaml"
|
|
register: test_hostvars_yml
|
|
notify: test_hostvars_yml check diff
|
|
|
|
- name: Read test_hostvars.yml
|
|
slurp:
|
|
src: /tmp/test_hostvars.yml
|
|
register: hostvars_file
|
|
|
|
- debug:
|
|
msg: "hostvars - {{ (hostvars_file.content | b64decode | from_yaml).test_hostvar }}"
|
|
|
|
- debug:
|
|
msg: "hostvars.expected - {{ test_config_yml_hostvars_overrides.test_hostvar }}"
|
|
|
|
- name: Compare files
|
|
assert:
|
|
that:
|
|
- "((hostvars_file.content | b64decode | from_yaml).test_hostvar) == (test_config_yml_hostvars_overrides.test_hostvar)"
|
|
|
|
|
|
# Values containing newlines should not be chopped into a list
|
|
# when yml_multilines is set to True
|
|
- name: Test multiline strings in yaml
|
|
config_template:
|
|
src: "{{ playbook_dir }}/templates/test_multiline_strs.yml"
|
|
dest: "/tmp/multiline_strs.yml"
|
|
config_overrides: "{{ test_multiline_strs_yml_overrides }}"
|
|
config_type: yaml
|
|
yml_multilines: True
|
|
|
|
- name: Read multiline_strs.yml
|
|
slurp:
|
|
src: /tmp/multiline_strs.yml
|
|
register: multiline_strs_file
|
|
|
|
- debug:
|
|
msg: "Multiline Yaml Strings - {{ multiline_strs_file.content | b64decode }}"
|
|
|
|
- debug:
|
|
msg: "Multiline Yaml Strings Expected - {{ multiline_strs_file_expected.content | b64decode }}"
|
|
|
|
- name: Compare files
|
|
assert:
|
|
that:
|
|
- "(multiline_strs_file_expected.content | b64decode) == (multiline_strs_file.content | b64decode)"
|