From 259cb8b9e41c8e21b559b236434e1c5e92a7b0b1 Mon Sep 17 00:00:00 2001 From: Akira Yokochi Date: Tue, 16 Jan 2024 18:14:01 +0900 Subject: [PATCH] docs: Fixed validate lookup plugin and module filter examples in document (#325) * fix validate examples * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- changelogs/fragments/validate-doc.yaml | 4 ++++ docs/ansible.utils.validate_lookup.rst | 6 +++--- docs/ansible.utils.validate_module.rst | 8 ++++---- plugins/lookup/validate.py | 6 +++--- plugins/modules/validate.py | 8 ++++---- 5 files changed, 18 insertions(+), 14 deletions(-) create mode 100644 changelogs/fragments/validate-doc.yaml diff --git a/changelogs/fragments/validate-doc.yaml b/changelogs/fragments/validate-doc.yaml new file mode 100644 index 0000000..cb8fd4c --- /dev/null +++ b/changelogs/fragments/validate-doc.yaml @@ -0,0 +1,4 @@ +--- +doc_changes: + - validate lookup plugin - Fix syntax in EXAMPLES. + - validate module - Fix syntax in EXAMPLES. diff --git a/docs/ansible.utils.validate_lookup.rst b/docs/ansible.utils.validate_lookup.rst index 8917876..b9fa304 100644 --- a/docs/ansible.utils.validate_lookup.rst +++ b/docs/ansible.utils.validate_lookup.rst @@ -116,12 +116,12 @@ Examples - name: set facts for data and criteria ansible.builtin.set_fact: - data: "{{ lookup('ansible.builtin.file', './validate/data/show_interfaces_iosxr.json')}}" - criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/jsonschema/show_interfaces_iosxr.json')}}" + data: "{{ lookup('ansible.builtin.file', './validate/data/show_interfaces_iosxr.json') }}" + criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/jsonschema/show_interfaces_iosxr.json') }}" - name: validate data in json format using jsonschema with lookup plugin by passing plugin configuration variable as key/value pairs ansible.builtin.set_fact: - data_criteria_checks: "{{ lookup(data, criteria, engine='ansible.utils.jsonschema', draft='draft7') }}" + data_criteria_checks: "{{ lookup('ansible.utils.validate', data, criteria, engine='ansible.utils.jsonschema', draft='draft7') }}" - name: validate data in json format using jsonschema with lookup plugin by passing plugin configuration variable as task variable ansible.builtin.set_fact: diff --git a/docs/ansible.utils.validate_module.rst b/docs/ansible.utils.validate_module.rst index 615b68a..6948e39 100644 --- a/docs/ansible.utils.validate_module.rst +++ b/docs/ansible.utils.validate_module.rst @@ -103,8 +103,8 @@ Examples - name: set facts for data and criteria ansible.builtin.set_fact: - data: "{{ lookup('ansible.builtin.file', './validate/data/show_interfaces_iosxr.json')}}" - criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/jsonschema/show_interfaces_iosxr.json')}}" + data: "{{ lookup('ansible.builtin.file', './validate/data/show_interfaces_iosxr.json') }}" + criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/jsonschema/show_interfaces_iosxr.json') }}" - name: validate data in with jsonschema engine (by passing task vars as configurable plugin options) ansible.utils.validate: @@ -116,8 +116,8 @@ Examples - name: validate configuration with config plugin (see config plugin for criteria examples) ansible.utils.validate: - data: "{{ lookup('ansible.builtin.file', './backup/eos.config' }}" - criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/config/eos_config_rules.yaml' }}" + data: "{{ lookup('ansible.builtin.file', './backup/eos.config') }}" + criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/config/eos_config_rules.yaml') }}" engine: ansible.utils.config diff --git a/plugins/lookup/validate.py b/plugins/lookup/validate.py index 5567f15..711c3c9 100644 --- a/plugins/lookup/validate.py +++ b/plugins/lookup/validate.py @@ -60,12 +60,12 @@ DOCUMENTATION = """ EXAMPLES = r""" - name: set facts for data and criteria ansible.builtin.set_fact: - data: "{{ lookup('ansible.builtin.file', './validate/data/show_interfaces_iosxr.json')}}" - criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/jsonschema/show_interfaces_iosxr.json')}}" + data: "{{ lookup('ansible.builtin.file', './validate/data/show_interfaces_iosxr.json') }}" + criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/jsonschema/show_interfaces_iosxr.json') }}" - name: validate data in json format using jsonschema with lookup plugin by passing plugin configuration variable as key/value pairs ansible.builtin.set_fact: - data_criteria_checks: "{{ lookup(data, criteria, engine='ansible.utils.jsonschema', draft='draft7') }}" + data_criteria_checks: "{{ lookup('ansible.utils.validate', data, criteria, engine='ansible.utils.jsonschema', draft='draft7') }}" - name: validate data in json format using jsonschema with lookup plugin by passing plugin configuration variable as task variable ansible.builtin.set_fact: diff --git a/plugins/modules/validate.py b/plugins/modules/validate.py index fafefb4..4d0e085 100644 --- a/plugins/modules/validate.py +++ b/plugins/modules/validate.py @@ -52,8 +52,8 @@ notes: EXAMPLES = r""" - name: set facts for data and criteria ansible.builtin.set_fact: - data: "{{ lookup('ansible.builtin.file', './validate/data/show_interfaces_iosxr.json')}}" - criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/jsonschema/show_interfaces_iosxr.json')}}" + data: "{{ lookup('ansible.builtin.file', './validate/data/show_interfaces_iosxr.json') }}" + criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/jsonschema/show_interfaces_iosxr.json') }}" - name: validate data in with jsonschema engine (by passing task vars as configurable plugin options) ansible.utils.validate: @@ -65,8 +65,8 @@ EXAMPLES = r""" - name: validate configuration with config plugin (see config plugin for criteria examples) ansible.utils.validate: - data: "{{ lookup('ansible.builtin.file', './backup/eos.config' }}" - criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/config/eos_config_rules.yaml' }}" + data: "{{ lookup('ansible.builtin.file', './backup/eos.config') }}" + criteria: "{{ lookup('ansible.builtin.file', './validate/criteria/config/eos_config_rules.yaml') }}" engine: ansible.utils.config """