ansible-core 2.18.5rc1__py3-none-any.whl → 2.19.0b2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ansible/_internal/__init__.py +53 -0
- ansible/_internal/_ansiballz.py +265 -0
- ansible/_internal/_collection_proxy.py +47 -0
- ansible/_internal/_datatag/__init__.py +0 -0
- ansible/_internal/_datatag/_tags.py +130 -0
- ansible/_internal/_datatag/_utils.py +19 -0
- ansible/_internal/_datatag/_wrappers.py +33 -0
- ansible/_internal/_errors/__init__.py +0 -0
- ansible/_internal/_errors/_captured.py +128 -0
- ansible/_internal/_errors/_handler.py +91 -0
- ansible/_internal/_errors/_utils.py +310 -0
- ansible/_internal/_json/__init__.py +203 -0
- ansible/_internal/_json/_legacy_encoder.py +34 -0
- ansible/_internal/_json/_profiles/__init__.py +0 -0
- ansible/_internal/_json/_profiles/_cache_persistence.py +55 -0
- ansible/_internal/_json/_profiles/_inventory_legacy.py +40 -0
- ansible/_internal/_json/_profiles/_legacy.py +197 -0
- ansible/_internal/_locking.py +21 -0
- ansible/_internal/_plugins/__init__.py +0 -0
- ansible/_internal/_plugins/_cache.py +57 -0
- ansible/_internal/_task.py +78 -0
- ansible/_internal/_templating/__init__.py +10 -0
- ansible/_internal/_templating/_access.py +86 -0
- ansible/_internal/_templating/_chain_templar.py +63 -0
- ansible/_internal/_templating/_datatag.py +95 -0
- ansible/_internal/_templating/_engine.py +588 -0
- ansible/_internal/_templating/_errors.py +28 -0
- ansible/_internal/_templating/_jinja_bits.py +1066 -0
- ansible/_internal/_templating/_jinja_common.py +332 -0
- ansible/_internal/_templating/_jinja_patches.py +44 -0
- ansible/_internal/_templating/_jinja_plugins.py +345 -0
- ansible/_internal/_templating/_lazy_containers.py +633 -0
- ansible/_internal/_templating/_marker_behaviors.py +103 -0
- ansible/_internal/_templating/_transform.py +63 -0
- ansible/_internal/_templating/_utils.py +107 -0
- ansible/_internal/_wrapt.py +1052 -0
- ansible/_internal/_yaml/__init__.py +0 -0
- ansible/_internal/_yaml/_constructor.py +240 -0
- ansible/_internal/_yaml/_dumper.py +62 -0
- ansible/_internal/_yaml/_errors.py +166 -0
- ansible/_internal/_yaml/_loader.py +66 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/README.md +11 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/action/debug.py +36 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/filter/apply_trust.py +19 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/filter/dump_object.py +18 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/filter/finalize.py +16 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/filter/origin.py +18 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/filter/python_literal_eval.py +24 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/filter/python_literal_eval.yml +33 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/filter/tag_names.py +16 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/filter/true_type.py +17 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/filter/unmask.py +49 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/lookup/config.py +21 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/lookup/config.yml +2 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/test/tagged.py +15 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/test/tagged.yml +19 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/test/tagged_with.py +18 -0
- ansible/_internal/ansible_collections/ansible/_protomatter/plugins/test/tagged_with.yml +19 -0
- ansible/cli/__init__.py +159 -89
- ansible/cli/_ssh_askpass.py +47 -0
- ansible/cli/adhoc.py +14 -7
- ansible/cli/arguments/option_helpers.py +154 -7
- ansible/cli/config.py +43 -68
- ansible/cli/console.py +10 -8
- ansible/cli/doc.py +62 -53
- ansible/cli/galaxy.py +27 -20
- ansible/cli/inventory.py +28 -26
- ansible/cli/playbook.py +4 -12
- ansible/cli/pull.py +51 -11
- ansible/cli/scripts/ansible_connection_cli_stub.py +7 -7
- ansible/cli/vault.py +12 -11
- ansible/compat/__init__.py +2 -2
- ansible/config/base.yml +166 -112
- ansible/config/manager.py +52 -49
- ansible/constants.py +3 -4
- ansible/errors/__init__.py +277 -235
- ansible/executor/interpreter_discovery.py +28 -149
- ansible/executor/module_common.py +426 -493
- ansible/executor/play_iterator.py +22 -27
- ansible/executor/playbook_executor.py +11 -11
- ansible/executor/powershell/async_watchdog.ps1 +97 -102
- ansible/executor/powershell/async_wrapper.ps1 +202 -151
- ansible/executor/powershell/become_wrapper.ps1 +89 -144
- ansible/executor/powershell/bootstrap_wrapper.ps1 +24 -9
- ansible/executor/powershell/coverage_wrapper.ps1 +82 -135
- ansible/executor/powershell/exec_wrapper.ps1 +462 -196
- ansible/executor/powershell/module_manifest.py +417 -265
- ansible/executor/powershell/module_wrapper.ps1 +169 -186
- ansible/executor/powershell/psrp_fetch_file.ps1 +41 -0
- ansible/executor/powershell/psrp_put_file.ps1 +122 -0
- ansible/executor/powershell/winrm_fetch_file.ps1 +46 -0
- ansible/executor/powershell/winrm_put_file.ps1 +36 -0
- ansible/executor/process/worker.py +161 -96
- ansible/executor/stats.py +5 -5
- ansible/executor/task_executor.py +268 -258
- ansible/executor/task_queue_manager.py +124 -90
- ansible/executor/task_result.py +183 -78
- ansible/galaxy/__init__.py +2 -2
- ansible/galaxy/api.py +22 -18
- ansible/galaxy/collection/__init__.py +1 -1
- ansible/galaxy/collection/concrete_artifact_manager.py +8 -11
- ansible/galaxy/dependency_resolution/dataclasses.py +14 -4
- ansible/galaxy/dependency_resolution/providers.py +1 -1
- ansible/galaxy/dependency_resolution/reporters.py +81 -0
- ansible/galaxy/role.py +4 -8
- ansible/galaxy/token.py +28 -21
- ansible/inventory/data.py +47 -57
- ansible/inventory/group.py +44 -72
- ansible/inventory/helpers.py +9 -0
- ansible/inventory/host.py +32 -54
- ansible/inventory/manager.py +78 -34
- ansible/keyword_desc.yml +1 -1
- ansible/module_utils/_internal/__init__.py +55 -0
- ansible/module_utils/_internal/_ambient_context.py +58 -0
- ansible/module_utils/_internal/_ansiballz.py +133 -0
- ansible/module_utils/_internal/_concurrent/_daemon_threading.py +1 -0
- ansible/module_utils/_internal/_dataclass_annotation_patch.py +64 -0
- ansible/module_utils/_internal/_dataclass_validation.py +217 -0
- ansible/module_utils/_internal/_datatag/__init__.py +928 -0
- ansible/module_utils/_internal/_datatag/_tags.py +38 -0
- ansible/module_utils/_internal/_debugging.py +31 -0
- ansible/module_utils/_internal/_errors.py +30 -0
- ansible/module_utils/_internal/_json/__init__.py +63 -0
- ansible/module_utils/_internal/_json/_legacy_encoder.py +26 -0
- ansible/module_utils/_internal/_json/_profiles/__init__.py +410 -0
- ansible/module_utils/_internal/_json/_profiles/_fallback_to_str.py +73 -0
- ansible/module_utils/_internal/_json/_profiles/_module_legacy_c2m.py +31 -0
- ansible/module_utils/_internal/_json/_profiles/_module_legacy_m2c.py +35 -0
- ansible/module_utils/_internal/_json/_profiles/_module_modern_c2m.py +35 -0
- ansible/module_utils/_internal/_json/_profiles/_module_modern_m2c.py +33 -0
- ansible/module_utils/_internal/_json/_profiles/_tagless.py +50 -0
- ansible/module_utils/_internal/_patches/__init__.py +66 -0
- ansible/module_utils/_internal/_patches/_dataclass_annotation_patch.py +55 -0
- ansible/module_utils/_internal/_patches/_socket_patch.py +34 -0
- ansible/module_utils/_internal/_patches/_sys_intern_patch.py +34 -0
- ansible/module_utils/_internal/_plugin_exec_context.py +49 -0
- ansible/module_utils/_internal/_testing.py +0 -0
- ansible/module_utils/_internal/_traceback.py +89 -0
- ansible/module_utils/ansible_release.py +2 -2
- ansible/module_utils/api.py +1 -2
- ansible/module_utils/basic.py +152 -120
- ansible/module_utils/common/_utils.py +24 -28
- ansible/module_utils/common/collections.py +1 -2
- ansible/module_utils/common/dict_transformations.py +2 -2
- ansible/module_utils/common/file.py +2 -2
- ansible/module_utils/common/json.py +90 -84
- ansible/module_utils/common/locale.py +2 -2
- ansible/module_utils/common/messages.py +108 -0
- ansible/module_utils/common/parameters.py +27 -24
- ansible/module_utils/common/process.py +2 -2
- ansible/module_utils/common/respawn.py +41 -19
- ansible/module_utils/common/sentinel.py +66 -0
- ansible/module_utils/common/sys_info.py +8 -8
- ansible/module_utils/common/text/converters.py +16 -37
- ansible/module_utils/common/validation.py +35 -24
- ansible/module_utils/common/warnings.py +86 -25
- ansible/module_utils/common/yaml.py +29 -3
- ansible/module_utils/compat/datetime.py +33 -21
- ansible/module_utils/compat/paramiko.py +21 -10
- ansible/module_utils/compat/typing.py +6 -5
- ansible/module_utils/connection.py +2 -2
- ansible/module_utils/csharp/Ansible.Basic.cs +14 -11
- ansible/module_utils/csharp/Ansible.Become.cs +1 -0
- ansible/module_utils/csharp/Ansible._Async.cs +517 -0
- ansible/module_utils/datatag.py +46 -0
- ansible/module_utils/distro/__init__.py +2 -2
- ansible/module_utils/facts/ansible_collector.py +4 -5
- ansible/module_utils/facts/collector.py +13 -14
- ansible/module_utils/facts/compat.py +4 -4
- ansible/module_utils/facts/default_collectors.py +1 -1
- ansible/module_utils/facts/hardware/aix.py +34 -0
- ansible/module_utils/facts/hardware/base.py +1 -1
- ansible/module_utils/facts/hardware/darwin.py +1 -3
- ansible/module_utils/facts/hardware/freebsd.py +2 -2
- ansible/module_utils/facts/hardware/linux.py +4 -4
- ansible/module_utils/facts/namespace.py +1 -1
- ansible/module_utils/facts/network/base.py +1 -1
- ansible/module_utils/facts/network/fc_wwn.py +1 -2
- ansible/module_utils/facts/network/iscsi.py +1 -2
- ansible/module_utils/facts/network/nvme.py +1 -2
- ansible/module_utils/facts/other/facter.py +1 -2
- ansible/module_utils/facts/other/ohai.py +2 -3
- ansible/module_utils/facts/system/apparmor.py +1 -2
- ansible/module_utils/facts/system/caps.py +1 -1
- ansible/module_utils/facts/system/chroot.py +1 -2
- ansible/module_utils/facts/system/cmdline.py +1 -2
- ansible/module_utils/facts/system/date_time.py +5 -3
- ansible/module_utils/facts/system/distribution.py +9 -8
- ansible/module_utils/facts/system/dns.py +1 -1
- ansible/module_utils/facts/system/env.py +1 -2
- ansible/module_utils/facts/system/fips.py +7 -20
- ansible/module_utils/facts/system/loadavg.py +1 -2
- ansible/module_utils/facts/system/local.py +1 -2
- ansible/module_utils/facts/system/lsb.py +1 -2
- ansible/module_utils/facts/system/pkg_mgr.py +1 -2
- ansible/module_utils/facts/system/platform.py +1 -2
- ansible/module_utils/facts/system/python.py +1 -2
- ansible/module_utils/facts/system/selinux.py +1 -1
- ansible/module_utils/facts/system/service_mgr.py +1 -2
- ansible/module_utils/facts/system/ssh_pub_keys.py +1 -1
- ansible/module_utils/facts/system/systemd.py +1 -1
- ansible/module_utils/facts/system/user.py +1 -2
- ansible/module_utils/facts/utils.py +3 -3
- ansible/module_utils/facts/virtual/base.py +1 -1
- ansible/module_utils/facts/virtual/sunos.py +3 -15
- ansible/module_utils/facts/virtual/sysctl.py +3 -16
- ansible/module_utils/json_utils.py +2 -2
- ansible/module_utils/parsing/convert_bool.py +1 -1
- ansible/module_utils/service.py +18 -21
- ansible/module_utils/splitter.py +7 -7
- ansible/module_utils/testing.py +31 -0
- ansible/module_utils/urls.py +60 -31
- ansible/modules/add_host.py +4 -4
- ansible/modules/apt.py +60 -46
- ansible/modules/apt_key.py +19 -12
- ansible/modules/apt_repository.py +19 -16
- ansible/modules/assemble.py +6 -6
- ansible/modules/assert.py +4 -4
- ansible/modules/async_status.py +10 -12
- ansible/modules/async_wrapper.py +8 -3
- ansible/modules/blockinfile.py +6 -7
- ansible/modules/command.py +10 -17
- ansible/modules/copy.py +57 -144
- ansible/modules/cron.py +20 -15
- ansible/modules/deb822_repository.py +8 -9
- ansible/modules/debconf.py +5 -5
- ansible/modules/debug.py +4 -4
- ansible/modules/dnf.py +8 -8
- ansible/modules/dnf5.py +39 -13
- ansible/modules/dpkg_selections.py +4 -4
- ansible/modules/expect.py +8 -10
- ansible/modules/fail.py +4 -4
- ansible/modules/fetch.py +4 -4
- ansible/modules/file.py +174 -133
- ansible/modules/find.py +19 -17
- ansible/modules/gather_facts.py +3 -3
- ansible/modules/get_url.py +59 -53
- ansible/modules/getent.py +7 -9
- ansible/modules/git.py +28 -25
- ansible/modules/group.py +6 -6
- ansible/modules/group_by.py +4 -4
- ansible/modules/hostname.py +13 -29
- ansible/modules/import_playbook.py +6 -6
- ansible/modules/import_role.py +6 -6
- ansible/modules/import_tasks.py +6 -6
- ansible/modules/include_role.py +6 -6
- ansible/modules/include_tasks.py +6 -6
- ansible/modules/include_vars.py +6 -6
- ansible/modules/iptables.py +86 -73
- ansible/modules/known_hosts.py +10 -10
- ansible/modules/lineinfile.py +5 -5
- ansible/modules/meta.py +4 -4
- ansible/modules/mount_facts.py +2 -2
- ansible/modules/package.py +4 -4
- ansible/modules/package_facts.py +22 -10
- ansible/modules/pause.py +6 -6
- ansible/modules/ping.py +6 -6
- ansible/modules/pip.py +10 -11
- ansible/modules/raw.py +4 -4
- ansible/modules/reboot.py +6 -6
- ansible/modules/replace.py +9 -13
- ansible/modules/rpm_key.py +7 -8
- ansible/modules/script.py +4 -4
- ansible/modules/service.py +7 -8
- ansible/modules/service_facts.py +87 -10
- ansible/modules/set_fact.py +5 -5
- ansible/modules/set_stats.py +4 -4
- ansible/modules/setup.py +2 -2
- ansible/modules/shell.py +6 -6
- ansible/modules/slurp.py +6 -6
- ansible/modules/stat.py +9 -23
- ansible/modules/subversion.py +15 -15
- ansible/modules/systemd.py +6 -6
- ansible/modules/systemd_service.py +6 -6
- ansible/modules/sysvinit.py +6 -6
- ansible/modules/tempfile.py +5 -6
- ansible/modules/template.py +6 -6
- ansible/modules/unarchive.py +32 -11
- ansible/modules/uri.py +33 -26
- ansible/modules/user.py +53 -34
- ansible/modules/validate_argument_spec.py +10 -7
- ansible/modules/wait_for.py +32 -27
- ansible/modules/wait_for_connection.py +6 -6
- ansible/modules/yum_repository.py +6 -6
- ansible/parsing/ajson.py +14 -32
- ansible/parsing/dataloader.py +99 -54
- ansible/parsing/mod_args.py +28 -44
- ansible/parsing/plugin_docs.py +21 -86
- ansible/parsing/quoting.py +1 -1
- ansible/parsing/splitter.py +27 -12
- ansible/parsing/utils/addresses.py +24 -24
- ansible/parsing/utils/jsonify.py +5 -1
- ansible/parsing/utils/yaml.py +32 -61
- ansible/parsing/vault/__init__.py +319 -87
- ansible/parsing/yaml/__init__.py +0 -18
- ansible/parsing/yaml/dumper.py +6 -120
- ansible/parsing/yaml/loader.py +6 -39
- ansible/parsing/yaml/objects.py +43 -335
- ansible/playbook/__init__.py +1 -1
- ansible/playbook/attribute.py +8 -3
- ansible/playbook/base.py +182 -132
- ansible/playbook/block.py +26 -24
- ansible/playbook/collectionsearch.py +1 -15
- ansible/playbook/conditional.py +3 -77
- ansible/playbook/handler.py +8 -2
- ansible/playbook/helpers.py +41 -53
- ansible/playbook/included_file.py +31 -27
- ansible/playbook/loop_control.py +2 -2
- ansible/playbook/play.py +85 -44
- ansible/playbook/play_context.py +12 -17
- ansible/playbook/playbook_include.py +14 -15
- ansible/playbook/role/__init__.py +24 -26
- ansible/playbook/role/definition.py +15 -17
- ansible/playbook/role/include.py +2 -4
- ansible/playbook/role/metadata.py +10 -11
- ansible/playbook/role_include.py +3 -3
- ansible/playbook/taggable.py +13 -8
- ansible/playbook/task.py +188 -118
- ansible/playbook/task_include.py +5 -5
- ansible/plugins/__init__.py +68 -21
- ansible/plugins/action/__init__.py +209 -176
- ansible/plugins/action/add_host.py +1 -1
- ansible/plugins/action/assemble.py +1 -1
- ansible/plugins/action/assert.py +54 -66
- ansible/plugins/action/copy.py +7 -11
- ansible/plugins/action/debug.py +37 -31
- ansible/plugins/action/dnf.py +3 -4
- ansible/plugins/action/fail.py +1 -1
- ansible/plugins/action/fetch.py +4 -5
- ansible/plugins/action/gather_facts.py +7 -6
- ansible/plugins/action/group_by.py +1 -1
- ansible/plugins/action/include_vars.py +10 -11
- ansible/plugins/action/package.py +3 -6
- ansible/plugins/action/pause.py +2 -2
- ansible/plugins/action/script.py +15 -8
- ansible/plugins/action/service.py +6 -11
- ansible/plugins/action/set_fact.py +3 -12
- ansible/plugins/action/set_stats.py +3 -8
- ansible/plugins/action/template.py +35 -59
- ansible/plugins/action/unarchive.py +1 -1
- ansible/plugins/action/validate_argument_spec.py +5 -5
- ansible/plugins/action/wait_for_connection.py +1 -1
- ansible/plugins/become/__init__.py +31 -8
- ansible/plugins/become/runas.py +71 -0
- ansible/plugins/become/su.py +13 -8
- ansible/plugins/become/sudo.py +19 -0
- ansible/plugins/cache/__init__.py +35 -44
- ansible/plugins/cache/base.py +8 -0
- ansible/plugins/cache/jsonfile.py +10 -16
- ansible/plugins/cache/memory.py +6 -12
- ansible/plugins/callback/__init__.py +284 -179
- ansible/plugins/callback/default.py +99 -92
- ansible/plugins/callback/junit.py +44 -39
- ansible/plugins/callback/minimal.py +28 -25
- ansible/plugins/callback/oneline.py +28 -21
- ansible/plugins/callback/tree.py +16 -11
- ansible/plugins/connection/__init__.py +47 -34
- ansible/plugins/connection/local.py +150 -54
- ansible/plugins/connection/paramiko_ssh.py +21 -18
- ansible/plugins/connection/psrp.py +76 -165
- ansible/plugins/connection/ssh.py +301 -78
- ansible/plugins/connection/winrm.py +58 -140
- ansible/plugins/doc_fragments/action_common_attributes.py +14 -14
- ansible/plugins/doc_fragments/action_core.py +6 -6
- ansible/plugins/doc_fragments/backup.py +2 -2
- ansible/plugins/doc_fragments/checksum_common.py +27 -0
- ansible/plugins/doc_fragments/constructed.py +6 -2
- ansible/plugins/doc_fragments/decrypt.py +2 -2
- ansible/plugins/doc_fragments/default_callback.py +2 -2
- ansible/plugins/doc_fragments/files.py +2 -2
- ansible/plugins/doc_fragments/inventory_cache.py +2 -2
- ansible/plugins/doc_fragments/result_format_callback.py +2 -2
- ansible/plugins/doc_fragments/return_common.py +2 -2
- ansible/plugins/doc_fragments/template_common.py +4 -4
- ansible/plugins/doc_fragments/url.py +17 -1
- ansible/plugins/doc_fragments/url_windows.py +2 -2
- ansible/plugins/doc_fragments/validate.py +2 -2
- ansible/plugins/doc_fragments/vars_plugin_staging.py +2 -2
- ansible/plugins/filter/__init__.py +6 -2
- ansible/plugins/filter/b64decode.yml +22 -0
- ansible/plugins/filter/b64encode.yml +22 -0
- ansible/plugins/filter/bool.yml +11 -4
- ansible/plugins/filter/core.py +225 -108
- ansible/plugins/filter/encryption.py +32 -32
- ansible/plugins/filter/flatten.yml +3 -2
- ansible/plugins/filter/human_to_bytes.yml +1 -1
- ansible/plugins/filter/mathstuff.py +30 -37
- ansible/plugins/filter/password_hash.yml +8 -0
- ansible/plugins/filter/regex_search.yml +1 -4
- ansible/plugins/filter/split.yml +1 -1
- ansible/plugins/filter/to_nice_yaml.yml +0 -4
- ansible/plugins/filter/to_yaml.yml +0 -4
- ansible/plugins/filter/unvault.yml +1 -1
- ansible/plugins/filter/urls.py +1 -1
- ansible/plugins/filter/urlsplit.py +8 -9
- ansible/plugins/filter/vault.yml +14 -9
- ansible/plugins/filter/win_basename.yml +6 -1
- ansible/plugins/filter/win_dirname.yml +5 -0
- ansible/plugins/inventory/__init__.py +97 -77
- ansible/plugins/inventory/advanced_host_list.py +7 -5
- ansible/plugins/inventory/auto.py +11 -4
- ansible/plugins/inventory/constructed.py +21 -24
- ansible/plugins/inventory/generator.py +16 -11
- ansible/plugins/inventory/host_list.py +7 -5
- ansible/plugins/inventory/ini.py +78 -44
- ansible/plugins/inventory/script.py +189 -119
- ansible/plugins/inventory/toml.py +16 -126
- ansible/plugins/inventory/yaml.py +10 -8
- ansible/plugins/list.py +3 -3
- ansible/plugins/loader.py +197 -82
- ansible/plugins/lookup/__init__.py +21 -4
- ansible/plugins/lookup/config.py +21 -35
- ansible/plugins/lookup/csvfile.py +3 -2
- ansible/plugins/lookup/dict.py +1 -6
- ansible/plugins/lookup/env.py +12 -9
- ansible/plugins/lookup/file.py +5 -8
- ansible/plugins/lookup/first_found.py +86 -55
- ansible/plugins/lookup/indexed_items.py +1 -10
- ansible/plugins/lookup/ini.py +14 -13
- ansible/plugins/lookup/items.py +1 -1
- ansible/plugins/lookup/lines.py +8 -1
- ansible/plugins/lookup/list.py +1 -1
- ansible/plugins/lookup/nested.py +2 -18
- ansible/plugins/lookup/password.py +5 -5
- ansible/plugins/lookup/pipe.py +5 -7
- ansible/plugins/lookup/sequence.py +18 -8
- ansible/plugins/lookup/subelements.py +1 -4
- ansible/plugins/lookup/template.py +42 -36
- ansible/plugins/lookup/together.py +0 -12
- ansible/plugins/lookup/unvault.py +1 -5
- ansible/plugins/lookup/url.py +2 -8
- ansible/plugins/lookup/vars.py +16 -24
- ansible/plugins/shell/__init__.py +2 -2
- ansible/plugins/shell/cmd.py +2 -2
- ansible/plugins/shell/powershell.py +39 -22
- ansible/plugins/shell/sh.py +3 -2
- ansible/plugins/strategy/__init__.py +159 -184
- ansible/plugins/strategy/debug.py +2 -2
- ansible/plugins/strategy/free.py +16 -31
- ansible/plugins/strategy/host_pinned.py +2 -2
- ansible/plugins/strategy/linear.py +41 -41
- ansible/plugins/terminal/__init__.py +4 -4
- ansible/plugins/test/__init__.py +7 -2
- ansible/plugins/test/core.py +55 -21
- ansible/plugins/test/files.py +1 -1
- ansible/plugins/test/mathstuff.py +3 -3
- ansible/plugins/test/uri.py +3 -3
- ansible/plugins/vars/host_group_vars.py +7 -14
- ansible/release.py +2 -2
- ansible/template/__init__.py +370 -944
- ansible/utils/__init__.py +0 -18
- ansible/utils/_ssh_agent.py +657 -0
- ansible/utils/collection_loader/__init__.py +52 -5
- ansible/utils/collection_loader/_collection_config.py +5 -6
- ansible/utils/collection_loader/_collection_finder.py +79 -93
- ansible/utils/collection_loader/_collection_meta.py +13 -8
- ansible/utils/display.py +433 -63
- ansible/utils/encrypt.py +27 -19
- ansible/utils/fqcn.py +2 -2
- ansible/utils/hashing.py +2 -2
- ansible/utils/helpers.py +2 -2
- ansible/utils/listify.py +8 -8
- ansible/utils/lock.py +2 -2
- ansible/utils/path.py +4 -4
- ansible/utils/plugin_docs.py +14 -13
- ansible/utils/sentinel.py +4 -62
- ansible/utils/singleton.py +2 -0
- ansible/utils/ssh_functions.py +1 -1
- ansible/utils/unsafe_proxy.py +23 -332
- ansible/utils/vars.py +51 -8
- ansible/utils/version.py +2 -2
- ansible/vars/clean.py +5 -5
- ansible/vars/hostvars.py +60 -90
- ansible/vars/manager.py +206 -282
- ansible/vars/reserved.py +8 -9
- ansible_core-2.19.0b2.dist-info/BSD-3-Clause.txt +28 -0
- {ansible_core-2.18.5rc1.dist-info → ansible_core-2.19.0b2.dist-info}/METADATA +5 -4
- ansible_core-2.19.0b2.dist-info/RECORD +1072 -0
- {ansible_core-2.18.5rc1.dist-info → ansible_core-2.19.0b2.dist-info}/WHEEL +1 -1
- ansible_test/_data/completion/docker.txt +7 -7
- ansible_test/_data/completion/remote.txt +6 -6
- ansible_test/_data/completion/windows.txt +1 -0
- ansible_test/_data/requirements/ansible.txt +2 -2
- ansible_test/_data/requirements/sanity.ansible-doc.txt +3 -3
- ansible_test/_data/requirements/sanity.changelog.txt +1 -1
- ansible_test/_data/requirements/sanity.import.plugin.txt +2 -2
- ansible_test/_data/requirements/sanity.pylint.txt +4 -4
- ansible_test/_data/requirements/sanity.validate-modules.txt +2 -2
- ansible_test/_data/requirements/sanity.yamllint.txt +1 -1
- ansible_test/_data/requirements/units.txt +1 -0
- ansible_test/_internal/__init__.py +1 -0
- ansible_test/_internal/ansible_util.py +2 -0
- ansible_test/_internal/become.py +1 -0
- ansible_test/_internal/bootstrap.py +1 -0
- ansible_test/_internal/cache.py +1 -0
- ansible_test/_internal/cgroup.py +1 -0
- ansible_test/_internal/ci/__init__.py +1 -0
- ansible_test/_internal/ci/azp.py +1 -0
- ansible_test/_internal/ci/local.py +1 -0
- ansible_test/_internal/classification/__init__.py +1 -0
- ansible_test/_internal/classification/common.py +1 -0
- ansible_test/_internal/classification/csharp.py +1 -0
- ansible_test/_internal/classification/powershell.py +1 -0
- ansible_test/_internal/classification/python.py +1 -0
- ansible_test/_internal/cli/__init__.py +1 -0
- ansible_test/_internal/cli/actions.py +1 -0
- ansible_test/_internal/cli/argparsing/__init__.py +1 -0
- ansible_test/_internal/cli/argparsing/actions.py +1 -0
- ansible_test/_internal/cli/argparsing/argcompletion.py +1 -0
- ansible_test/_internal/cli/argparsing/parsers.py +1 -0
- ansible_test/_internal/cli/commands/__init__.py +11 -0
- ansible_test/_internal/cli/commands/coverage/__init__.py +1 -0
- ansible_test/_internal/cli/commands/coverage/analyze/__init__.py +1 -0
- ansible_test/_internal/cli/commands/coverage/analyze/targets/__init__.py +1 -0
- ansible_test/_internal/cli/commands/coverage/analyze/targets/combine.py +1 -0
- ansible_test/_internal/cli/commands/coverage/analyze/targets/expand.py +1 -0
- ansible_test/_internal/cli/commands/coverage/analyze/targets/filter.py +1 -0
- ansible_test/_internal/cli/commands/coverage/analyze/targets/generate.py +1 -0
- ansible_test/_internal/cli/commands/coverage/analyze/targets/missing.py +1 -0
- ansible_test/_internal/cli/commands/coverage/combine.py +1 -0
- ansible_test/_internal/cli/commands/coverage/erase.py +1 -0
- ansible_test/_internal/cli/commands/coverage/html.py +1 -0
- ansible_test/_internal/cli/commands/coverage/report.py +1 -0
- ansible_test/_internal/cli/commands/coverage/xml.py +1 -0
- ansible_test/_internal/cli/commands/env.py +1 -0
- ansible_test/_internal/cli/commands/integration/__init__.py +1 -0
- ansible_test/_internal/cli/commands/integration/network.py +1 -0
- ansible_test/_internal/cli/commands/integration/posix.py +1 -0
- ansible_test/_internal/cli/commands/integration/windows.py +1 -0
- ansible_test/_internal/cli/commands/sanity.py +9 -0
- ansible_test/_internal/cli/commands/shell.py +1 -0
- ansible_test/_internal/cli/commands/units.py +1 -0
- ansible_test/_internal/cli/compat.py +1 -0
- ansible_test/_internal/cli/completers.py +1 -0
- ansible_test/_internal/cli/converters.py +1 -0
- ansible_test/_internal/cli/environments.py +1 -0
- ansible_test/_internal/cli/epilog.py +1 -0
- ansible_test/_internal/cli/parsers/__init__.py +1 -0
- ansible_test/_internal/cli/parsers/base_argument_parsers.py +1 -0
- ansible_test/_internal/cli/parsers/helpers.py +1 -0
- ansible_test/_internal/cli/parsers/host_config_parsers.py +1 -0
- ansible_test/_internal/cli/parsers/key_value_parsers.py +1 -0
- ansible_test/_internal/cli/parsers/value_parsers.py +1 -0
- ansible_test/_internal/commands/__init__.py +1 -0
- ansible_test/_internal/commands/coverage/__init__.py +2 -1
- ansible_test/_internal/commands/coverage/analyze/__init__.py +1 -0
- ansible_test/_internal/commands/coverage/analyze/targets/__init__.py +1 -0
- ansible_test/_internal/commands/coverage/analyze/targets/combine.py +1 -0
- ansible_test/_internal/commands/coverage/analyze/targets/expand.py +1 -0
- ansible_test/_internal/commands/coverage/analyze/targets/filter.py +1 -0
- ansible_test/_internal/commands/coverage/analyze/targets/generate.py +1 -0
- ansible_test/_internal/commands/coverage/analyze/targets/missing.py +1 -0
- ansible_test/_internal/commands/coverage/combine.py +2 -1
- ansible_test/_internal/commands/coverage/erase.py +1 -0
- ansible_test/_internal/commands/coverage/html.py +1 -0
- ansible_test/_internal/commands/coverage/report.py +1 -0
- ansible_test/_internal/commands/coverage/xml.py +1 -0
- ansible_test/_internal/commands/env/__init__.py +2 -0
- ansible_test/_internal/commands/integration/__init__.py +4 -0
- ansible_test/_internal/commands/integration/cloud/__init__.py +1 -0
- ansible_test/_internal/commands/integration/cloud/acme.py +2 -1
- ansible_test/_internal/commands/integration/cloud/aws.py +1 -0
- ansible_test/_internal/commands/integration/cloud/azure.py +1 -0
- ansible_test/_internal/commands/integration/cloud/cs.py +1 -0
- ansible_test/_internal/commands/integration/cloud/digitalocean.py +1 -0
- ansible_test/_internal/commands/integration/cloud/galaxy.py +3 -2
- ansible_test/_internal/commands/integration/cloud/hcloud.py +1 -0
- ansible_test/_internal/commands/integration/cloud/httptester.py +2 -1
- ansible_test/_internal/commands/integration/cloud/nios.py +2 -1
- ansible_test/_internal/commands/integration/cloud/opennebula.py +1 -0
- ansible_test/_internal/commands/integration/cloud/openshift.py +1 -0
- ansible_test/_internal/commands/integration/cloud/scaleway.py +1 -0
- ansible_test/_internal/commands/integration/cloud/vcenter.py +1 -0
- ansible_test/_internal/commands/integration/cloud/vultr.py +1 -0
- ansible_test/_internal/commands/integration/coverage.py +1 -0
- ansible_test/_internal/commands/integration/filters.py +1 -0
- ansible_test/_internal/commands/integration/network.py +1 -0
- ansible_test/_internal/commands/integration/posix.py +1 -0
- ansible_test/_internal/commands/integration/windows.py +1 -0
- ansible_test/_internal/commands/sanity/__init__.py +16 -1
- ansible_test/_internal/commands/sanity/ansible_doc.py +1 -0
- ansible_test/_internal/commands/sanity/bin_symlinks.py +1 -0
- ansible_test/_internal/commands/sanity/compile.py +1 -0
- ansible_test/_internal/commands/sanity/ignores.py +1 -0
- ansible_test/_internal/commands/sanity/import.py +1 -0
- ansible_test/_internal/commands/sanity/integration_aliases.py +1 -0
- ansible_test/_internal/commands/sanity/pep8.py +1 -0
- ansible_test/_internal/commands/sanity/pslint.py +1 -0
- ansible_test/_internal/commands/sanity/pylint.py +24 -26
- ansible_test/_internal/commands/sanity/shellcheck.py +1 -0
- ansible_test/_internal/commands/sanity/validate_modules.py +1 -0
- ansible_test/_internal/commands/sanity/yamllint.py +1 -0
- ansible_test/_internal/commands/shell/__init__.py +1 -0
- ansible_test/_internal/commands/units/__init__.py +1 -0
- ansible_test/_internal/compat/__init__.py +1 -0
- ansible_test/_internal/compat/packaging.py +1 -0
- ansible_test/_internal/compat/yaml.py +1 -0
- ansible_test/_internal/completion.py +1 -0
- ansible_test/_internal/config.py +2 -0
- ansible_test/_internal/connections.py +1 -0
- ansible_test/_internal/constants.py +1 -0
- ansible_test/_internal/containers.py +1 -0
- ansible_test/_internal/content_config.py +1 -0
- ansible_test/_internal/core_ci.py +1 -0
- ansible_test/_internal/coverage_util.py +11 -10
- ansible_test/_internal/data.py +1 -0
- ansible_test/_internal/delegation.py +1 -0
- ansible_test/_internal/dev/__init__.py +1 -0
- ansible_test/_internal/dev/container_probe.py +1 -0
- ansible_test/_internal/diff.py +3 -2
- ansible_test/_internal/docker_util.py +2 -1
- ansible_test/_internal/encoding.py +1 -0
- ansible_test/_internal/executor.py +1 -0
- ansible_test/_internal/git.py +1 -0
- ansible_test/_internal/host_configs.py +1 -0
- ansible_test/_internal/host_profiles.py +1 -0
- ansible_test/_internal/http.py +1 -0
- ansible_test/_internal/init.py +1 -0
- ansible_test/_internal/inventory.py +35 -3
- ansible_test/_internal/io.py +1 -0
- ansible_test/_internal/metadata.py +1 -0
- ansible_test/_internal/payload.py +1 -0
- ansible_test/_internal/provider/__init__.py +1 -0
- ansible_test/_internal/provider/layout/__init__.py +1 -0
- ansible_test/_internal/provider/layout/ansible.py +1 -0
- ansible_test/_internal/provider/layout/collection.py +1 -0
- ansible_test/_internal/provider/layout/unsupported.py +1 -0
- ansible_test/_internal/provider/source/__init__.py +1 -0
- ansible_test/_internal/provider/source/git.py +1 -0
- ansible_test/_internal/provider/source/installed.py +1 -0
- ansible_test/_internal/provider/source/unsupported.py +1 -0
- ansible_test/_internal/provider/source/unversioned.py +1 -0
- ansible_test/_internal/provisioning.py +1 -0
- ansible_test/_internal/pypi_proxy.py +6 -5
- ansible_test/_internal/python_requirements.py +1 -0
- ansible_test/_internal/ssh.py +1 -0
- ansible_test/_internal/target.py +1 -0
- ansible_test/_internal/test.py +3 -2
- ansible_test/_internal/thread.py +1 -0
- ansible_test/_internal/timeout.py +1 -0
- ansible_test/_internal/util.py +1 -0
- ansible_test/_internal/util_common.py +5 -2
- ansible_test/_internal/venv.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/action-plugin-docs.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/changelog/sphinx.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/changelog.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/empty-init.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/line-endings.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/no-assert.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/no-get-exception.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/no-illegal-filenames.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/no-smart-quotes.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/replace-urlopen.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/runtime-metadata.py +28 -1
- ansible_test/_util/controller/sanity/code-smell/shebang.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/symlinks.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/use-argspec-type-path.py +1 -0
- ansible_test/_util/controller/sanity/code-smell/use-compat-six.py +1 -0
- ansible_test/_util/controller/sanity/integration-aliases/yaml_to_json.py +2 -1
- ansible_test/_util/controller/sanity/pep8/current-ignore.txt +4 -0
- ansible_test/_util/controller/sanity/pylint/config/ansible-test-target.cfg +7 -5
- ansible_test/_util/controller/sanity/pylint/config/ansible-test.cfg +7 -5
- ansible_test/_util/controller/sanity/pylint/config/code-smell.cfg +7 -5
- ansible_test/_util/controller/sanity/pylint/config/collection.cfg +3 -5
- ansible_test/_util/controller/sanity/pylint/config/default.cfg +7 -7
- ansible_test/_util/controller/sanity/pylint/plugins/deprecated.py +1 -13
- ansible_test/_util/controller/sanity/pylint/plugins/hide_unraisable.py +1 -0
- ansible_test/_util/controller/sanity/pylint/plugins/string_format.py +1 -8
- ansible_test/_util/controller/sanity/pylint/plugins/unwanted.py +1 -8
- ansible_test/_util/controller/sanity/validate-modules/validate_modules/main.py +55 -28
- ansible_test/_util/controller/sanity/validate-modules/validate_modules/module_args.py +12 -5
- ansible_test/_util/controller/sanity/validate-modules/validate_modules/schema.py +13 -2
- ansible_test/_util/controller/sanity/validate-modules/validate_modules/utils.py +1 -0
- ansible_test/_util/controller/sanity/yamllint/yamllinter.py +35 -17
- ansible_test/_util/controller/tools/collection_detail.py +1 -0
- ansible_test/_util/controller/tools/yaml_to_json.py +2 -1
- ansible_test/_util/target/pytest/plugins/ansible_forked.py +6 -1
- ansible_test/_util/target/pytest/plugins/ansible_pytest_collections.py +2 -1
- ansible_test/_util/target/pytest/plugins/ansible_pytest_coverage.py +1 -0
- ansible_test/_util/target/sanity/compile/compile.py +1 -0
- ansible_test/_util/target/sanity/import/importer.py +15 -16
- ansible_test/_util/target/setup/bootstrap.sh +9 -20
- ansible_test/_util/target/setup/probe_cgroups.py +1 -0
- ansible_test/_util/target/setup/quiet_pip.py +1 -0
- ansible_test/_util/target/setup/requirements.py +35 -27
- ansible_test/_util/target/tools/virtualenvcheck.py +2 -1
- ansible_test/_util/target/tools/yamlcheck.py +2 -1
- ansible/compat/selectors.py +0 -32
- ansible/errors/yaml_strings.py +0 -138
- ansible/executor/action_write_locks.py +0 -44
- ansible/executor/discovery/python_target.py +0 -47
- ansible/executor/powershell/module_powershell_wrapper.ps1 +0 -86
- ansible/executor/powershell/module_script_wrapper.ps1 +0 -22
- ansible/module_utils/compat/importlib.py +0 -26
- ansible/module_utils/compat/selectors.py +0 -32
- ansible/module_utils/pycompat24.py +0 -73
- ansible/parsing/yaml/constructor.py +0 -178
- ansible/template/native_helpers.py +0 -251
- ansible/template/template.py +0 -43
- ansible/template/vars.py +0 -77
- ansible/utils/native_jinja.py +0 -11
- ansible/vars/fact_cache.py +0 -71
- ansible_core-2.18.5rc1.dist-info/RECORD +0 -992
- {ansible_core-2.18.5rc1.dist-info → ansible_core-2.19.0b2.dist-info}/Apache-License.txt +0 -0
- {ansible_core-2.18.5rc1.dist-info → ansible_core-2.19.0b2.dist-info}/COPYING +0 -0
- {ansible_core-2.18.5rc1.dist-info → ansible_core-2.19.0b2.dist-info}/MIT-license.txt +0 -0
- {ansible_core-2.18.5rc1.dist-info → ansible_core-2.19.0b2.dist-info}/PSF-license.txt +0 -0
- {ansible_core-2.18.5rc1.dist-info → ansible_core-2.19.0b2.dist-info}/entry_points.txt +0 -0
- {ansible_core-2.18.5rc1.dist-info → ansible_core-2.19.0b2.dist-info}/simplified_bsd.txt +0 -0
- {ansible_core-2.18.5rc1.dist-info → ansible_core-2.19.0b2.dist-info}/top_level.txt +0 -0
ansible/template/__init__.py
CHANGED
@@ -1,1003 +1,429 @@
|
|
1
|
-
|
2
|
-
#
|
3
|
-
# This file is part of Ansible
|
4
|
-
#
|
5
|
-
# Ansible is free software: you can redistribute it and/or modify
|
6
|
-
# it under the terms of the GNU General Public License as published by
|
7
|
-
# the Free Software Foundation, either version 3 of the License, or
|
8
|
-
# (at your option) any later version.
|
9
|
-
#
|
10
|
-
# Ansible is distributed in the hope that it will be useful,
|
11
|
-
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
12
|
-
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
13
|
-
# GNU General Public License for more details.
|
14
|
-
#
|
15
|
-
# You should have received a copy of the GNU General Public License
|
16
|
-
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
17
|
-
|
18
|
-
from __future__ import annotations
|
19
|
-
|
20
|
-
import ast
|
21
|
-
import datetime
|
22
|
-
import functools
|
23
|
-
import os
|
24
|
-
import pwd
|
25
|
-
import re
|
26
|
-
import time
|
27
|
-
|
28
|
-
from collections.abc import Iterator, Sequence, Mapping, MappingView, MutableMapping
|
29
|
-
from contextlib import contextmanager
|
30
|
-
from numbers import Number
|
31
|
-
from traceback import format_exc
|
32
|
-
|
33
|
-
from jinja2.exceptions import TemplateSyntaxError, UndefinedError, SecurityError
|
34
|
-
from jinja2.loaders import FileSystemLoader
|
35
|
-
from jinja2.nativetypes import NativeEnvironment
|
36
|
-
from jinja2.runtime import Context, StrictUndefined
|
37
|
-
|
38
|
-
from ansible import constants as C
|
39
|
-
from ansible.errors import (
|
40
|
-
AnsibleAssertionError,
|
41
|
-
AnsibleError,
|
42
|
-
AnsibleFilterError,
|
43
|
-
AnsibleLookupError,
|
44
|
-
AnsibleOptionsError,
|
45
|
-
AnsibleUndefinedVariable,
|
46
|
-
)
|
47
|
-
from ansible.module_utils.six import string_types
|
48
|
-
from ansible.module_utils.common.text.converters import to_native, to_text, to_bytes
|
49
|
-
from ansible.module_utils.common.collections import is_sequence
|
50
|
-
from ansible.plugins.loader import filter_loader, lookup_loader, test_loader
|
51
|
-
from ansible.template.native_helpers import AnsibleUndefined, ansible_native_concat, ansible_eval_concat, ansible_concat
|
52
|
-
from ansible.template.template import AnsibleJ2Template
|
53
|
-
from ansible.template.vars import AnsibleJ2Vars
|
54
|
-
from ansible.utils.display import Display
|
55
|
-
from ansible.utils.listify import listify_lookup_plugin_terms
|
56
|
-
from ansible.utils.native_jinja import NativeJinjaText
|
57
|
-
from ansible.utils.unsafe_proxy import to_unsafe_text, wrap_var, AnsibleUnsafeText, AnsibleUnsafeBytes, NativeJinjaUnsafeText
|
58
|
-
|
59
|
-
display = Display()
|
60
|
-
|
61
|
-
|
62
|
-
__all__ = ['Templar', 'generate_ansible_template_vars']
|
63
|
-
|
64
|
-
# Primitive Types which we don't want Jinja to convert to strings.
|
65
|
-
NON_TEMPLATED_TYPES = (bool, Number)
|
66
|
-
|
67
|
-
JINJA2_OVERRIDE = '#jinja2:'
|
68
|
-
|
69
|
-
JINJA2_BEGIN_TOKENS = frozenset(('variable_begin', 'block_begin', 'comment_begin', 'raw_begin'))
|
70
|
-
JINJA2_END_TOKENS = frozenset(('variable_end', 'block_end', 'comment_end', 'raw_end'))
|
71
|
-
|
72
|
-
RANGE_TYPE = type(range(0))
|
73
|
-
|
74
|
-
|
75
|
-
def generate_ansible_template_vars(path, fullpath=None, dest_path=None):
|
1
|
+
from __future__ import annotations as _annotations
|
76
2
|
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
3
|
+
import contextlib as _contextlib
|
4
|
+
import datetime as _datetime
|
5
|
+
import io as _io
|
6
|
+
import os as _os
|
7
|
+
import pwd as _pwd
|
8
|
+
import time as _time
|
9
|
+
import typing as _t
|
81
10
|
|
82
|
-
|
83
|
-
template_uid = pwd.getpwuid(os.stat(b_path).st_uid).pw_name
|
84
|
-
except (KeyError, TypeError):
|
85
|
-
template_uid = os.stat(b_path).st_uid
|
86
|
-
|
87
|
-
temp_vars = {
|
88
|
-
'template_host': to_unsafe_text(os.uname()[1]),
|
89
|
-
'template_path': to_unsafe_text(path),
|
90
|
-
'template_mtime': datetime.datetime.fromtimestamp(os.path.getmtime(b_path)),
|
91
|
-
'template_uid': to_unsafe_text(template_uid),
|
92
|
-
'template_run_date': datetime.datetime.now(),
|
93
|
-
'template_destpath': wrap_var(to_native(dest_path)) if dest_path else None,
|
94
|
-
}
|
11
|
+
from jinja2 import environment as _environment
|
95
12
|
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
13
|
+
from ansible import _internal
|
14
|
+
from ansible import constants as _constants
|
15
|
+
from ansible import errors as _errors
|
16
|
+
from ansible._internal._datatag import _tags, _wrappers
|
17
|
+
from ansible._internal._templating import _jinja_bits, _engine, _jinja_common
|
18
|
+
from ansible.module_utils import datatag as _module_utils_datatag
|
19
|
+
from ansible.module_utils._internal import _datatag
|
20
|
+
from ansible.utils.display import Display as _Display
|
100
21
|
|
101
|
-
|
102
|
-
|
103
|
-
host="{{ template_host }}",
|
104
|
-
uid="{{ template_uid }}",
|
105
|
-
file="{{ template_path }}"
|
106
|
-
)
|
107
|
-
temp_vars['ansible_managed'] = time.strftime(to_native(managed_str), time.localtime(os.path.getmtime(b_path)))
|
108
|
-
|
109
|
-
return temp_vars
|
22
|
+
if _t.TYPE_CHECKING: # pragma: nocover
|
23
|
+
import collections as _collections
|
110
24
|
|
25
|
+
from ansible.parsing import dataloader as _dataloader
|
111
26
|
|
112
|
-
|
113
|
-
"""Double backslashes within jinja2 expressions
|
27
|
+
_VariableContainer = dict[str, _t.Any] | _collections.ChainMap[str, _t.Any]
|
114
28
|
|
115
|
-
A user may enter something like this in a playbook::
|
116
29
|
|
117
|
-
|
118
|
-
|
30
|
+
_display: _t.Final[_Display] = _Display()
|
31
|
+
_UNSET = _t.cast(_t.Any, object())
|
32
|
+
_TTrustable = _t.TypeVar('_TTrustable', bound=str | _io.IOBase | _t.TextIO | _t.BinaryIO)
|
33
|
+
_TRUSTABLE_TYPES = (str, _io.IOBase)
|
119
34
|
|
120
|
-
|
121
|
-
|
122
|
-
it is processed by both python and jinja2, the backslash escaped
|
123
|
-
characters get unescaped twice. This means that we'd normally have to use
|
124
|
-
four backslashes to escape that. This is painful for playbook authors as
|
125
|
-
they have to remember different rules for inside vs outside of a jinja2
|
126
|
-
expression (The backslashes outside of the "{{ }}" only get processed by
|
127
|
-
yaml and python. So they only need to be escaped once). The following
|
128
|
-
code fixes this by automatically performing the extra quoting of
|
129
|
-
backslashes inside of a jinja2 expression.
|
35
|
+
AnsibleUndefined = _jinja_common.UndefinedMarker
|
36
|
+
"""Backwards compatibility alias for UndefinedMarker."""
|
130
37
|
|
131
|
-
"""
|
132
|
-
if '\\' in data and jinja_env.variable_start_string in data:
|
133
|
-
new_data = []
|
134
|
-
d2 = jinja_env.preprocess(data)
|
135
|
-
in_var = False
|
136
|
-
|
137
|
-
for token in jinja_env.lex(d2):
|
138
|
-
if token[1] == 'variable_begin':
|
139
|
-
in_var = True
|
140
|
-
new_data.append(token[2])
|
141
|
-
elif token[1] == 'variable_end':
|
142
|
-
in_var = False
|
143
|
-
new_data.append(token[2])
|
144
|
-
elif in_var and token[1] == 'string':
|
145
|
-
# Double backslashes only if we're inside of a jinja2 variable
|
146
|
-
new_data.append(token[2].replace('\\', '\\\\'))
|
147
|
-
else:
|
148
|
-
new_data.append(token[2])
|
149
38
|
|
150
|
-
|
39
|
+
class Templar:
|
40
|
+
"""Primary public API container for Ansible's template engine."""
|
41
|
+
|
42
|
+
def __init__(
|
43
|
+
self,
|
44
|
+
loader: _dataloader.DataLoader | None = None,
|
45
|
+
variables: _VariableContainer | None = None,
|
46
|
+
) -> None:
|
47
|
+
self._engine = _engine.TemplateEngine(loader=loader, variables=variables)
|
48
|
+
self._overrides = _jinja_bits.TemplateOverrides.DEFAULT
|
49
|
+
|
50
|
+
@classmethod
|
51
|
+
@_internal.experimental
|
52
|
+
def _from_template_engine(cls, engine: _engine.TemplateEngine) -> _t.Self:
|
53
|
+
"""
|
54
|
+
EXPERIMENTAL: For internal use within ansible-core only.
|
55
|
+
Create a `Templar` instance from the given `TemplateEngine` instance.
|
56
|
+
"""
|
57
|
+
templar = object.__new__(cls)
|
58
|
+
templar._engine = engine.copy()
|
59
|
+
templar._overrides = _jinja_bits.TemplateOverrides.DEFAULT
|
60
|
+
|
61
|
+
return templar
|
62
|
+
|
63
|
+
def resolve_variable_expression(
|
64
|
+
self,
|
65
|
+
expression: str,
|
66
|
+
*,
|
67
|
+
local_variables: dict[str, _t.Any] | None = None,
|
68
|
+
) -> _t.Any:
|
69
|
+
"""
|
70
|
+
Resolve a potentially untrusted string variable expression consisting only of valid identifiers, integers, dots, and indexing containing these.
|
71
|
+
Optional local variables may be provided, which can only be referenced directly by the given expression.
|
72
|
+
Valid: x, x.y, x[y].z, x[1], 1, x[y.z]
|
73
|
+
Error: 'x', x['y'], q('env')
|
74
|
+
"""
|
75
|
+
return self._engine.resolve_variable_expression(expression, local_variables=local_variables)
|
76
|
+
|
77
|
+
def evaluate_expression(
|
78
|
+
self,
|
79
|
+
expression: str,
|
80
|
+
*,
|
81
|
+
local_variables: dict[str, _t.Any] | None = None,
|
82
|
+
escape_backslashes: bool = True,
|
83
|
+
) -> _t.Any:
|
84
|
+
"""
|
85
|
+
Evaluate a trusted string expression and return its result.
|
86
|
+
Optional local variables may be provided, which can only be referenced directly by the given expression.
|
87
|
+
"""
|
88
|
+
return self._engine.evaluate_expression(expression, local_variables=local_variables, escape_backslashes=escape_backslashes)
|
151
89
|
|
152
|
-
|
90
|
+
def evaluate_conditional(self, conditional: str | bool) -> bool:
|
91
|
+
"""
|
92
|
+
Evaluate a trusted string expression or boolean and return its boolean result. A non-boolean result will raise `AnsibleBrokenConditionalError`.
|
93
|
+
The ALLOW_BROKEN_CONDITIONALS configuration option can temporarily relax this requirement, allowing truthy conditionals to succeed.
|
94
|
+
The ALLOW_EMBEDDED_TEMPLATES configuration option can temporarily enable inline Jinja template delimiter support (e.g., {{ }}, {% %}).
|
95
|
+
"""
|
96
|
+
return self._engine.evaluate_conditional(conditional)
|
153
97
|
|
98
|
+
@property
|
99
|
+
def basedir(self) -> str:
|
100
|
+
"""The basedir from DataLoader."""
|
101
|
+
# DTFIX-RELEASE: come up with a better way to handle this so it can be deprecated
|
102
|
+
return self._engine.basedir
|
154
103
|
|
155
|
-
|
156
|
-
|
157
|
-
|
104
|
+
@property
|
105
|
+
def available_variables(self) -> _VariableContainer:
|
106
|
+
"""Available variables this instance will use when templating."""
|
107
|
+
return self._engine.available_variables
|
158
108
|
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
has_override_header = False
|
163
|
-
|
164
|
-
if overrides or has_override_header:
|
165
|
-
overlay = jinja_env.overlay(**overrides)
|
166
|
-
else:
|
167
|
-
overlay = jinja_env
|
168
|
-
|
169
|
-
# Get jinja env overrides from template
|
170
|
-
if has_override_header:
|
171
|
-
eol = data.find('\n')
|
172
|
-
line = data[len(JINJA2_OVERRIDE):eol]
|
173
|
-
data = data[eol + 1:]
|
174
|
-
for pair in line.split(','):
|
175
|
-
if ':' not in pair:
|
176
|
-
raise AnsibleError("failed to parse jinja2 override '%s'."
|
177
|
-
" Did you use something different from colon as key-value separator?" % pair.strip())
|
178
|
-
(key, val) = pair.split(':', 1)
|
179
|
-
key = key.strip()
|
180
|
-
if hasattr(overlay, key):
|
181
|
-
setattr(overlay, key, ast.literal_eval(val.strip()))
|
182
|
-
else:
|
183
|
-
display.warning(f"Could not find Jinja2 environment setting to override: '{key}'")
|
109
|
+
@available_variables.setter
|
110
|
+
def available_variables(self, variables: _VariableContainer) -> None:
|
111
|
+
self._engine.available_variables = variables
|
184
112
|
|
185
|
-
|
113
|
+
@property
|
114
|
+
def _available_variables(self) -> _VariableContainer:
|
115
|
+
"""Deprecated. Use `available_variables` instead."""
|
116
|
+
# Commonly abused by numerous collection lookup plugins and the Ceph Ansible `config_template` action.
|
117
|
+
_display.deprecated(
|
118
|
+
msg='Direct access to the `_available_variables` internal attribute is deprecated.',
|
119
|
+
help_text='Use `available_variables` instead.',
|
120
|
+
version='2.23',
|
121
|
+
)
|
186
122
|
|
123
|
+
return self.available_variables
|
187
124
|
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
|
125
|
+
@property
|
126
|
+
def _loader(self) -> _dataloader.DataLoader:
|
127
|
+
"""Deprecated. Use `copy_with_new_env` to create a new instance."""
|
128
|
+
# Abused by cloud.common, community.general and felixfontein.tools collections to create a new Templar instance.
|
129
|
+
_display.deprecated(
|
130
|
+
msg='Direct access to the `_loader` internal attribute is deprecated.',
|
131
|
+
help_text='Use `copy_with_new_env` to create a new instance.',
|
132
|
+
version='2.23',
|
133
|
+
)
|
192
134
|
|
193
|
-
|
194
|
-
This method may return ``True`` on a string that is not templatable.
|
135
|
+
return self._engine._loader
|
195
136
|
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
return False
|
137
|
+
@property
|
138
|
+
def environment(self) -> _environment.Environment:
|
139
|
+
"""Deprecated."""
|
140
|
+
_display.deprecated(
|
141
|
+
msg='Direct access to the `environment` attribute is deprecated.',
|
142
|
+
help_text='Consider using `copy_with_new_env` or passing `overrides` to `template`.',
|
143
|
+
version='2.23',
|
144
|
+
)
|
205
145
|
|
146
|
+
return self._engine.environment
|
147
|
+
|
148
|
+
def copy_with_new_env(
|
149
|
+
self,
|
150
|
+
*,
|
151
|
+
searchpath: str | _os.PathLike | _t.Sequence[str | _os.PathLike] | None = None,
|
152
|
+
available_variables: _VariableContainer | None = None,
|
153
|
+
**context_overrides: _t.Any,
|
154
|
+
) -> Templar:
|
155
|
+
"""Return a new templar based on the current one with customizations applied."""
|
156
|
+
if context_overrides.pop('environment_class', _UNSET) is not _UNSET:
|
157
|
+
_display.deprecated(
|
158
|
+
msg="The `environment_class` argument is ignored.",
|
159
|
+
version='2.23',
|
160
|
+
)
|
206
161
|
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
start = True
|
214
|
-
comment = False
|
215
|
-
d2 = jinja_env.preprocess(data)
|
216
|
-
|
217
|
-
# Quick check to see if this is remotely like a template before doing
|
218
|
-
# more expensive investigation.
|
219
|
-
if not is_possibly_template(d2, jinja_env):
|
220
|
-
return False
|
221
|
-
|
222
|
-
# This wraps a lot of code, but this is due to lex returning a generator
|
223
|
-
# so we may get an exception at any part of the loop
|
224
|
-
try:
|
225
|
-
for token in jinja_env.lex(d2):
|
226
|
-
if token[1] in JINJA2_BEGIN_TOKENS:
|
227
|
-
if start and token[1] == 'comment_begin':
|
228
|
-
# Comments can wrap other token types
|
229
|
-
comment = True
|
230
|
-
start = False
|
231
|
-
# Example: variable_end -> variable
|
232
|
-
found = token[1].split('_')[0]
|
233
|
-
elif token[1] in JINJA2_END_TOKENS:
|
234
|
-
if token[1].split('_')[0] == found:
|
235
|
-
return True
|
236
|
-
elif comment:
|
237
|
-
continue
|
238
|
-
return False
|
239
|
-
except TemplateSyntaxError:
|
240
|
-
return False
|
241
|
-
|
242
|
-
return False
|
243
|
-
|
244
|
-
|
245
|
-
def _count_newlines_from_end(in_str):
|
246
|
-
'''
|
247
|
-
Counts the number of newlines at the end of a string. This is used during
|
248
|
-
the jinja2 templating to ensure the count matches the input, since some newlines
|
249
|
-
may be thrown away during the templating.
|
250
|
-
'''
|
162
|
+
if context_overrides:
|
163
|
+
_display.deprecated(
|
164
|
+
msg='Passing Jinja environment overrides to `copy_with_new_env` is deprecated.',
|
165
|
+
help_text='Pass Jinja environment overrides to individual `template` calls.',
|
166
|
+
version='2.23',
|
167
|
+
)
|
251
168
|
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
j -= 1
|
257
|
-
return i - 1 - j
|
258
|
-
except IndexError:
|
259
|
-
# Uncommon cases: zero length string and string containing only newlines
|
260
|
-
return i
|
261
|
-
|
262
|
-
|
263
|
-
def recursive_check_defined(item):
|
264
|
-
from jinja2.runtime import Undefined
|
265
|
-
|
266
|
-
if isinstance(item, MutableMapping):
|
267
|
-
for key in item:
|
268
|
-
recursive_check_defined(item[key])
|
269
|
-
elif isinstance(item, list):
|
270
|
-
for i in item:
|
271
|
-
recursive_check_defined(i)
|
272
|
-
else:
|
273
|
-
if isinstance(item, Undefined):
|
274
|
-
raise AnsibleFilterError("{0} is undefined".format(item))
|
275
|
-
|
276
|
-
|
277
|
-
def _is_rolled(value):
|
278
|
-
"""Helper method to determine if something is an unrolled generator,
|
279
|
-
iterator, or similar object
|
280
|
-
"""
|
281
|
-
return (
|
282
|
-
isinstance(value, Iterator) or
|
283
|
-
isinstance(value, MappingView) or
|
284
|
-
isinstance(value, RANGE_TYPE)
|
285
|
-
)
|
169
|
+
templar = Templar(
|
170
|
+
loader=self._engine._loader,
|
171
|
+
variables=self._engine._variables if available_variables is None else available_variables,
|
172
|
+
)
|
286
173
|
|
174
|
+
# backward compatibility: filter out None values from overrides, even though it is a valid value for some of them
|
175
|
+
templar._overrides = self._overrides.merge({key: value for key, value in context_overrides.items() if value is not None})
|
176
|
+
|
177
|
+
if searchpath is not None:
|
178
|
+
templar._engine.environment.loader.searchpath = searchpath
|
179
|
+
|
180
|
+
return templar
|
181
|
+
|
182
|
+
@_contextlib.contextmanager
|
183
|
+
def set_temporary_context(
|
184
|
+
self,
|
185
|
+
*,
|
186
|
+
searchpath: str | _os.PathLike | _t.Sequence[str | _os.PathLike] | None = None,
|
187
|
+
available_variables: _VariableContainer | None = None,
|
188
|
+
**context_overrides: _t.Any,
|
189
|
+
) -> _t.Generator[None, None, None]:
|
190
|
+
"""Context manager used to set temporary templating context, without having to worry about resetting original values afterward."""
|
191
|
+
_display.deprecated(
|
192
|
+
msg='The `set_temporary_context` method on `Templar` is deprecated.',
|
193
|
+
help_text='Use the `copy_with_new_env` method on `Templar` instead.',
|
194
|
+
version='2.23',
|
195
|
+
)
|
287
196
|
|
288
|
-
|
289
|
-
|
290
|
-
|
291
|
-
|
292
|
-
"""
|
293
|
-
def wrapper(*args, **kwargs):
|
294
|
-
ret = func(*args, **kwargs)
|
295
|
-
if _is_rolled(ret):
|
296
|
-
return list(ret)
|
297
|
-
return ret
|
197
|
+
targets = dict(
|
198
|
+
searchpath=self._engine.environment.loader,
|
199
|
+
available_variables=self._engine,
|
200
|
+
)
|
298
201
|
|
299
|
-
|
202
|
+
target_args = dict(
|
203
|
+
searchpath=searchpath,
|
204
|
+
available_variables=available_variables,
|
205
|
+
)
|
300
206
|
|
207
|
+
original: dict[str, _t.Any] = {}
|
208
|
+
previous_overrides = self._overrides
|
301
209
|
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
315
|
-
|
316
|
-
|
317
|
-
|
318
|
-
|
319
|
-
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
|
333
|
-
if
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
a key or value which contains jinja2 syntax and would otherwise
|
342
|
-
lose the AnsibleUnsafe value.
|
343
|
-
'''
|
344
|
-
if isinstance(val, dict):
|
345
|
-
for key in val.keys():
|
346
|
-
if self._is_unsafe(val[key]):
|
347
|
-
return True
|
348
|
-
elif isinstance(val, list):
|
349
|
-
for item in val:
|
350
|
-
if self._is_unsafe(item):
|
351
|
-
return True
|
352
|
-
elif getattr(val, '__UNSAFE__', False) is True:
|
353
|
-
return True
|
354
|
-
return False
|
355
|
-
|
356
|
-
def _update_unsafe(self, val):
|
357
|
-
if val is not None and not self.unsafe and self._is_unsafe(val):
|
358
|
-
self.unsafe = True
|
359
|
-
|
360
|
-
def resolve_or_missing(self, key):
|
361
|
-
val = super(AnsibleContext, self).resolve_or_missing(key)
|
362
|
-
self._update_unsafe(val)
|
363
|
-
return val
|
364
|
-
|
365
|
-
def get_all(self):
|
366
|
-
"""Return the complete context as a dict including the exported
|
367
|
-
variables. For optimizations reasons this might not return an
|
368
|
-
actual copy so be careful with using it.
|
369
|
-
|
370
|
-
This is to prevent from running ``AnsibleJ2Vars`` through dict():
|
371
|
-
|
372
|
-
``dict(self.parent, **self.vars)``
|
373
|
-
|
374
|
-
In Ansible this means that ALL variables would be templated in the
|
375
|
-
process of re-creating the parent because ``AnsibleJ2Vars`` templates
|
376
|
-
each variable in its ``__getitem__`` method. Instead we re-create the
|
377
|
-
parent via ``AnsibleJ2Vars.add_locals`` that creates a new
|
378
|
-
``AnsibleJ2Vars`` copy without templating each variable.
|
379
|
-
|
380
|
-
This will prevent unnecessarily templating unused variables in cases
|
381
|
-
like setting a local variable and passing it to {% include %}
|
382
|
-
in a template.
|
383
|
-
|
384
|
-
Also see ``AnsibleJ2Template``and
|
385
|
-
https://github.com/pallets/jinja/commit/d67f0fd4cc2a4af08f51f4466150d49da7798729
|
386
|
-
"""
|
387
|
-
if not self.vars:
|
388
|
-
return self.parent
|
389
|
-
if not self.parent:
|
390
|
-
return self.vars
|
210
|
+
try:
|
211
|
+
for key, value in target_args.items():
|
212
|
+
if value is not None:
|
213
|
+
target = targets[key]
|
214
|
+
original[key] = getattr(target, key)
|
215
|
+
setattr(target, key, value)
|
216
|
+
|
217
|
+
# backward compatibility: filter out None values from overrides, even though it is a valid value for some of them
|
218
|
+
self._overrides = self._overrides.merge({key: value for key, value in context_overrides.items() if value is not None})
|
219
|
+
|
220
|
+
yield
|
221
|
+
finally:
|
222
|
+
for key, value in original.items():
|
223
|
+
setattr(targets[key], key, value)
|
224
|
+
|
225
|
+
self._overrides = previous_overrides
|
226
|
+
|
227
|
+
# noinspection PyUnusedLocal
|
228
|
+
def template(
|
229
|
+
self,
|
230
|
+
variable: _t.Any,
|
231
|
+
convert_bare: bool = _UNSET,
|
232
|
+
preserve_trailing_newlines: bool = True,
|
233
|
+
escape_backslashes: bool = True,
|
234
|
+
fail_on_undefined: bool = True,
|
235
|
+
overrides: dict[str, _t.Any] | None = None,
|
236
|
+
convert_data: bool = _UNSET,
|
237
|
+
disable_lookups: bool = _UNSET,
|
238
|
+
) -> _t.Any:
|
239
|
+
"""Templates (possibly recursively) any given data as input."""
|
240
|
+
# DTFIX-FUTURE: offer a public version of TemplateOverrides to support an optional strongly typed `overrides` argument
|
241
|
+
if convert_bare is not _UNSET:
|
242
|
+
# Skipping a deferred deprecation due to minimal usage outside ansible-core.
|
243
|
+
# Use `hasattr(templar, 'evaluate_expression')` to determine if `template` or `evaluate_expression` should be used.
|
244
|
+
_display.deprecated(
|
245
|
+
msg="Passing `convert_bare` to `template` is deprecated.",
|
246
|
+
help_text="Use `evaluate_expression` instead.",
|
247
|
+
version="2.23",
|
248
|
+
)
|
391
249
|
|
392
|
-
|
393
|
-
|
250
|
+
if convert_bare and isinstance(variable, str):
|
251
|
+
contains_filters = "|" in variable
|
252
|
+
first_part = variable.split("|")[0].split(".")[0].split("[")[0]
|
253
|
+
convert_bare = (contains_filters or first_part in self.available_variables) and not self.is_possibly_template(variable, overrides)
|
254
|
+
else:
|
255
|
+
convert_bare = False
|
394
256
|
else:
|
395
|
-
|
396
|
-
return dict(self.parent, **self.vars)
|
397
|
-
|
398
|
-
|
399
|
-
class JinjaPluginIntercept(MutableMapping):
|
400
|
-
''' Simulated dict class that loads Jinja2Plugins at request
|
401
|
-
otherwise all plugins would need to be loaded a priori.
|
402
|
-
|
403
|
-
NOTE: plugin_loader still loads all 'builtin/legacy' at
|
404
|
-
start so only collection plugins are really at request.
|
405
|
-
'''
|
406
|
-
|
407
|
-
def __init__(self, delegatee, pluginloader, *args, **kwargs):
|
257
|
+
convert_bare = False
|
408
258
|
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
# our names take precedence over Jinja's, but let things we've tried to resolve skip the pluginloader
|
417
|
-
self._seen_it = set()
|
418
|
-
|
419
|
-
def __getitem__(self, key):
|
259
|
+
if fail_on_undefined is None:
|
260
|
+
# The pre-2.19 config fallback is ignored for content portability.
|
261
|
+
_display.deprecated(
|
262
|
+
msg="Falling back to `True` for `fail_on_undefined`.",
|
263
|
+
help_text="Use either `True` or `False` for `fail_on_undefined` when calling `template`.",
|
264
|
+
version="2.23",
|
265
|
+
)
|
420
266
|
|
421
|
-
|
422
|
-
raise ValueError('key must be a string, got %s instead' % type(key))
|
267
|
+
fail_on_undefined = True
|
423
268
|
|
424
|
-
|
425
|
-
|
426
|
-
#
|
427
|
-
|
428
|
-
|
429
|
-
|
430
|
-
|
431
|
-
plugin = self._pluginloader.get(key)
|
432
|
-
except (AnsibleError, KeyError) as e:
|
433
|
-
original_exc = e
|
434
|
-
except Exception as e:
|
435
|
-
display.vvvv('Unexpected plugin load (%s) exception: %s' % (key, to_native(e)))
|
436
|
-
raise e
|
269
|
+
if convert_data is not _UNSET:
|
270
|
+
# Skipping a deferred deprecation due to minimal usage outside ansible-core.
|
271
|
+
# Use `hasattr(templar, 'evaluate_expression')` as a surrogate check to determine if `convert_data` is accepted.
|
272
|
+
_display.deprecated(
|
273
|
+
msg="Passing `convert_data` to `template` is deprecated.",
|
274
|
+
version="2.23",
|
275
|
+
)
|
437
276
|
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
277
|
+
if disable_lookups is not _UNSET:
|
278
|
+
# Skipping a deferred deprecation due to no known usage outside ansible-core.
|
279
|
+
# Use `hasattr(templar, 'evaluate_expression')` as a surrogate check to determine if `disable_lookups` is accepted.
|
280
|
+
_display.deprecated(
|
281
|
+
msg="Passing `disable_lookups` to `template` is deprecated.",
|
282
|
+
version="2.23",
|
283
|
+
)
|
442
284
|
|
443
|
-
# raise template syntax error if we could not find ours or jinja2 one
|
444
285
|
try:
|
445
|
-
|
446
|
-
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
286
|
+
if convert_bare: # pre-2.19 compat
|
287
|
+
return self.evaluate_expression(variable, escape_backslashes=escape_backslashes)
|
288
|
+
|
289
|
+
return self._engine.template(
|
290
|
+
variable=variable,
|
291
|
+
options=_engine.TemplateOptions(
|
292
|
+
preserve_trailing_newlines=preserve_trailing_newlines,
|
293
|
+
escape_backslashes=escape_backslashes,
|
294
|
+
overrides=self._overrides.merge(overrides),
|
295
|
+
),
|
296
|
+
mode=_engine.TemplateMode.ALWAYS_FINALIZE,
|
297
|
+
)
|
298
|
+
except _errors.AnsibleUndefinedVariable:
|
299
|
+
if not fail_on_undefined:
|
300
|
+
return variable
|
459
301
|
|
460
|
-
|
302
|
+
raise
|
461
303
|
|
462
|
-
def
|
463
|
-
|
304
|
+
def is_template(self, data: _t.Any) -> bool:
|
305
|
+
"""
|
306
|
+
Evaluate the input data to determine if it contains a template, even if that template is invalid. Containers will be recursively searched.
|
307
|
+
Objects subject to template-time transforms that do not yield a template are not considered templates by this method.
|
308
|
+
Gating a conditional call to `template` with this method is redundant and inefficient -- request templating unconditionally instead.
|
309
|
+
"""
|
310
|
+
return self._engine.is_template(data, self._overrides)
|
464
311
|
|
465
|
-
def
|
466
|
-
|
312
|
+
def is_possibly_template(
|
313
|
+
self,
|
314
|
+
data: _t.Any,
|
315
|
+
overrides: dict[str, _t.Any] | None = None,
|
316
|
+
) -> bool:
|
317
|
+
"""
|
318
|
+
A lightweight check to determine if the given value is a string that looks like it contains a template, even if that template is invalid.
|
319
|
+
Returns `True` if the given value is a string that starts with a Jinja overrides header or if it contains template start strings.
|
320
|
+
Gating a conditional call to `template` with this method is redundant and inefficient -- request templating unconditionally instead.
|
321
|
+
"""
|
322
|
+
return isinstance(data, str) and _jinja_bits.is_possibly_template(data, self._overrides.merge(overrides))
|
323
|
+
|
324
|
+
def do_template(
|
325
|
+
self,
|
326
|
+
data: _t.Any,
|
327
|
+
preserve_trailing_newlines: bool = True,
|
328
|
+
escape_backslashes: bool = True,
|
329
|
+
fail_on_undefined: bool = True,
|
330
|
+
overrides: dict[str, _t.Any] | None = None,
|
331
|
+
disable_lookups: bool = _UNSET,
|
332
|
+
convert_data: bool = _UNSET,
|
333
|
+
) -> _t.Any:
|
334
|
+
"""Deprecated. Use `template` instead."""
|
335
|
+
_display.deprecated(
|
336
|
+
msg='The `do_template` method on `Templar` is deprecated.',
|
337
|
+
help_text='Use the `template` method on `Templar` instead.',
|
338
|
+
version='2.23',
|
339
|
+
)
|
467
340
|
|
468
|
-
|
469
|
-
|
470
|
-
return iter(self._delegatee)
|
341
|
+
if not isinstance(data, str):
|
342
|
+
return data
|
471
343
|
|
472
|
-
|
473
|
-
|
474
|
-
|
344
|
+
return self.template(
|
345
|
+
variable=data,
|
346
|
+
preserve_trailing_newlines=preserve_trailing_newlines,
|
347
|
+
escape_backslashes=escape_backslashes,
|
348
|
+
fail_on_undefined=fail_on_undefined,
|
349
|
+
overrides=overrides,
|
350
|
+
disable_lookups=disable_lookups,
|
351
|
+
convert_data=convert_data,
|
352
|
+
)
|
475
353
|
|
476
354
|
|
477
|
-
def
|
478
|
-
"""Recursively find an undefined value in a nested data structure
|
479
|
-
and properly raise the undefined exception.
|
355
|
+
def generate_ansible_template_vars(path: str, fullpath: str | None = None, dest_path: str | None = None) -> dict[str, object]:
|
480
356
|
"""
|
481
|
-
|
482
|
-
|
483
|
-
_fail_on_undefined(value)
|
484
|
-
elif is_sequence(data):
|
485
|
-
for item in data:
|
486
|
-
_fail_on_undefined(item)
|
487
|
-
else:
|
488
|
-
if isinstance(data, StrictUndefined):
|
489
|
-
# To actually raise the undefined exception we need to
|
490
|
-
# access the undefined object otherwise the exception would
|
491
|
-
# be raised on the next access which might not be properly
|
492
|
-
# handled.
|
493
|
-
# See https://github.com/ansible/ansible/issues/52158
|
494
|
-
# and StrictUndefined implementation in upstream Jinja2.
|
495
|
-
str(data)
|
496
|
-
return data
|
497
|
-
|
498
|
-
|
499
|
-
@_unroll_iterator
|
500
|
-
def _ansible_finalize(thing):
|
501
|
-
"""A custom finalize function for jinja2, which prevents None from being
|
502
|
-
returned. This avoids a string of ``"None"`` as ``None`` has no
|
503
|
-
importance in YAML.
|
504
|
-
|
505
|
-
The function is decorated with ``_unroll_iterator`` so that users are not
|
506
|
-
required to explicitly use ``|list`` to unroll a generator. This only
|
507
|
-
affects the scenario where the final result of templating
|
508
|
-
is a generator, e.g. ``range``, ``dict.items()`` and so on. Filters
|
509
|
-
which can produce a generator in the middle of a template are already
|
510
|
-
wrapped with ``_unroll_generator`` in ``JinjaPluginIntercept``.
|
357
|
+
Generate and return a dictionary with variable metadata about the template specified by `fullpath`.
|
358
|
+
If `fullpath` is `None`, `path` will be used instead.
|
511
359
|
"""
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
class AnsibleEnvironment(NativeEnvironment):
|
516
|
-
'''
|
517
|
-
Our custom environment, which simply allows us to override the class-level
|
518
|
-
values for the Template and Context classes used by jinja2 internally.
|
519
|
-
'''
|
520
|
-
context_class = AnsibleContext
|
521
|
-
template_class = AnsibleJ2Template
|
522
|
-
concat = staticmethod(ansible_eval_concat) # type: ignore[assignment]
|
523
|
-
|
524
|
-
def __init__(self, *args, **kwargs):
|
525
|
-
super().__init__(*args, **kwargs)
|
526
|
-
|
527
|
-
self.filters = JinjaPluginIntercept(self.filters, filter_loader)
|
528
|
-
self.tests = JinjaPluginIntercept(self.tests, test_loader)
|
529
|
-
|
530
|
-
self.trim_blocks = True
|
531
|
-
|
532
|
-
self.undefined = AnsibleUndefined
|
533
|
-
self.finalize = _ansible_finalize
|
534
|
-
|
535
|
-
|
536
|
-
class AnsibleNativeEnvironment(AnsibleEnvironment):
|
537
|
-
concat = staticmethod(ansible_native_concat) # type: ignore[assignment]
|
538
|
-
|
539
|
-
def __init__(self, *args, **kwargs):
|
540
|
-
super().__init__(*args, **kwargs)
|
541
|
-
self.finalize = _unroll_iterator(_fail_on_undefined)
|
542
|
-
|
543
|
-
|
544
|
-
class Templar:
|
545
|
-
'''
|
546
|
-
The main class for templating, with the main entry-point of template().
|
547
|
-
'''
|
548
|
-
|
549
|
-
def __init__(self, loader, variables=None):
|
550
|
-
self._loader = loader
|
551
|
-
self._available_variables = {} if variables is None else variables
|
552
|
-
|
553
|
-
self._fail_on_undefined_errors = C.DEFAULT_UNDEFINED_VAR_BEHAVIOR
|
554
|
-
|
555
|
-
environment_class = AnsibleNativeEnvironment if C.DEFAULT_JINJA2_NATIVE else AnsibleEnvironment
|
556
|
-
|
557
|
-
self.environment = environment_class(
|
558
|
-
extensions=self._get_extensions(),
|
559
|
-
loader=FileSystemLoader(loader.get_basedir() if loader else '.'),
|
560
|
-
)
|
561
|
-
self.environment.template_class.environment_class = environment_class
|
562
|
-
|
563
|
-
# Custom globals
|
564
|
-
self.environment.globals['lookup'] = self._lookup
|
565
|
-
self.environment.globals['query'] = self.environment.globals['q'] = self._query_lookup
|
566
|
-
self.environment.globals['now'] = self._now_datetime
|
567
|
-
self.environment.globals['undef'] = self._make_undefined
|
568
|
-
|
569
|
-
# the current rendering context under which the templar class is working
|
570
|
-
self.cur_context = None
|
571
|
-
|
572
|
-
# this regex is re-compiled each time variable_start_string and variable_end_string are possibly changed
|
573
|
-
self._compile_single_var(self.environment)
|
574
|
-
|
575
|
-
self.jinja2_native = C.DEFAULT_JINJA2_NATIVE
|
576
|
-
|
577
|
-
def _compile_single_var(self, env):
|
578
|
-
self.SINGLE_VAR = re.compile(r"^%s\s*(\w*)\s*%s$" % (env.variable_start_string, env.variable_end_string))
|
579
|
-
|
580
|
-
def copy_with_new_env(self, environment_class=AnsibleEnvironment, **kwargs):
|
581
|
-
r"""Creates a new copy of Templar with a new environment.
|
582
|
-
|
583
|
-
:kwarg environment_class: Environment class used for creating a new environment.
|
584
|
-
:kwarg \*\*kwargs: Optional arguments for the new environment that override existing
|
585
|
-
environment attributes.
|
586
|
-
|
587
|
-
:returns: Copy of Templar with updated environment.
|
588
|
-
"""
|
589
|
-
# We need to use __new__ to skip __init__, mainly not to create a new
|
590
|
-
# environment there only to override it below
|
591
|
-
new_env = object.__new__(environment_class)
|
592
|
-
new_env.__dict__.update(self.environment.__dict__)
|
593
|
-
|
594
|
-
new_templar = object.__new__(Templar)
|
595
|
-
new_templar.__dict__.update(self.__dict__)
|
596
|
-
new_templar.environment = new_env
|
597
|
-
|
598
|
-
new_templar.jinja2_native = environment_class is AnsibleNativeEnvironment
|
599
|
-
|
600
|
-
mapping = {
|
601
|
-
'available_variables': new_templar,
|
602
|
-
'searchpath': new_env.loader,
|
603
|
-
}
|
604
|
-
|
605
|
-
for key, value in kwargs.items():
|
606
|
-
obj = mapping.get(key, new_env)
|
607
|
-
try:
|
608
|
-
if value is not None:
|
609
|
-
setattr(obj, key, value)
|
610
|
-
except AttributeError:
|
611
|
-
# Ignore invalid attrs
|
612
|
-
pass
|
613
|
-
|
614
|
-
return new_templar
|
615
|
-
|
616
|
-
def _get_extensions(self):
|
617
|
-
'''
|
618
|
-
Return jinja2 extensions to load.
|
619
|
-
|
620
|
-
If some extensions are set via jinja_extensions in ansible.cfg, we try
|
621
|
-
to load them with the jinja environment.
|
622
|
-
'''
|
623
|
-
|
624
|
-
jinja_exts = []
|
625
|
-
if C.DEFAULT_JINJA2_EXTENSIONS:
|
626
|
-
# make sure the configuration directive doesn't contain spaces
|
627
|
-
# and split extensions in an array
|
628
|
-
jinja_exts = C.DEFAULT_JINJA2_EXTENSIONS.replace(" ", "").split(',')
|
629
|
-
|
630
|
-
return jinja_exts
|
631
|
-
|
632
|
-
@property
|
633
|
-
def available_variables(self):
|
634
|
-
return self._available_variables
|
635
|
-
|
636
|
-
@available_variables.setter
|
637
|
-
def available_variables(self, variables):
|
638
|
-
'''
|
639
|
-
Sets the list of template variables this Templar instance will use
|
640
|
-
to template things, so we don't have to pass them around between
|
641
|
-
internal methods. We also clear the template cache here, as the variables
|
642
|
-
are being changed.
|
643
|
-
'''
|
644
|
-
|
645
|
-
if not isinstance(variables, Mapping):
|
646
|
-
raise AnsibleAssertionError("the type of 'variables' should be a Mapping but was a %s" % (type(variables)))
|
647
|
-
self._available_variables = variables
|
648
|
-
|
649
|
-
@contextmanager
|
650
|
-
def set_temporary_context(self, **kwargs):
|
651
|
-
"""Context manager used to set temporary templating context, without having to worry about resetting
|
652
|
-
original values afterward
|
653
|
-
|
654
|
-
Use a keyword that maps to the attr you are setting. Applies to ``self.environment`` by default, to
|
655
|
-
set context on another object, it must be in ``mapping``.
|
656
|
-
"""
|
657
|
-
mapping = {
|
658
|
-
'available_variables': self,
|
659
|
-
'searchpath': self.environment.loader,
|
660
|
-
}
|
661
|
-
original = {}
|
662
|
-
|
663
|
-
for key, value in kwargs.items():
|
664
|
-
obj = mapping.get(key, self.environment)
|
665
|
-
try:
|
666
|
-
original[key] = getattr(obj, key)
|
667
|
-
if value is not None:
|
668
|
-
setattr(obj, key, value)
|
669
|
-
except AttributeError:
|
670
|
-
# Ignore invalid attrs
|
671
|
-
pass
|
672
|
-
|
673
|
-
yield
|
674
|
-
|
675
|
-
for key in original:
|
676
|
-
obj = mapping.get(key, self.environment)
|
677
|
-
setattr(obj, key, original[key])
|
678
|
-
|
679
|
-
def template(self, variable, convert_bare=False, preserve_trailing_newlines=True, escape_backslashes=True, fail_on_undefined=None, overrides=None,
|
680
|
-
convert_data=True, static_vars=None, disable_lookups=False):
|
681
|
-
'''
|
682
|
-
Templates (possibly recursively) any given data as input. If convert_bare is
|
683
|
-
set to True, the given data will be wrapped as a jinja2 variable ('{{foo}}')
|
684
|
-
before being sent through the template engine.
|
685
|
-
'''
|
686
|
-
static_vars = [] if static_vars is None else static_vars
|
687
|
-
|
688
|
-
# Don't template unsafe variables, just return them.
|
689
|
-
if hasattr(variable, '__UNSAFE__'):
|
690
|
-
return variable
|
691
|
-
|
692
|
-
if fail_on_undefined is None:
|
693
|
-
fail_on_undefined = self._fail_on_undefined_errors
|
694
|
-
|
695
|
-
if convert_bare:
|
696
|
-
variable = self._convert_bare_variable(variable)
|
360
|
+
if fullpath is None:
|
361
|
+
fullpath = _os.path.abspath(path)
|
697
362
|
|
698
|
-
|
699
|
-
|
700
|
-
return variable
|
363
|
+
template_path = fullpath
|
364
|
+
template_stat = _os.stat(template_path)
|
701
365
|
|
702
|
-
|
703
|
-
# var. In this case we don't want to accidentally change the type of the variable
|
704
|
-
# to a string by using the jinja template renderer. We just want to pass it.
|
705
|
-
only_one = self.SINGLE_VAR.match(variable)
|
706
|
-
if only_one:
|
707
|
-
var_name = only_one.group(1)
|
708
|
-
if var_name in self._available_variables:
|
709
|
-
resolved_val = self._available_variables[var_name]
|
710
|
-
if isinstance(resolved_val, NON_TEMPLATED_TYPES):
|
711
|
-
return resolved_val
|
712
|
-
elif resolved_val is None:
|
713
|
-
return C.DEFAULT_NULL_REPRESENTATION
|
714
|
-
|
715
|
-
result = self.do_template(
|
716
|
-
variable,
|
717
|
-
preserve_trailing_newlines=preserve_trailing_newlines,
|
718
|
-
escape_backslashes=escape_backslashes,
|
719
|
-
fail_on_undefined=fail_on_undefined,
|
720
|
-
overrides=overrides,
|
721
|
-
disable_lookups=disable_lookups,
|
722
|
-
convert_data=convert_data,
|
723
|
-
)
|
724
|
-
self._compile_single_var(self.environment)
|
725
|
-
|
726
|
-
return result
|
727
|
-
|
728
|
-
elif is_sequence(variable):
|
729
|
-
return [self.template(
|
730
|
-
v,
|
731
|
-
preserve_trailing_newlines=preserve_trailing_newlines,
|
732
|
-
fail_on_undefined=fail_on_undefined,
|
733
|
-
overrides=overrides,
|
734
|
-
disable_lookups=disable_lookups,
|
735
|
-
) for v in variable]
|
736
|
-
elif isinstance(variable, Mapping):
|
737
|
-
d = {}
|
738
|
-
# we don't use iteritems() here to avoid problems if the underlying dict
|
739
|
-
# changes sizes due to the templating, which can happen with hostvars
|
740
|
-
for k in variable.keys():
|
741
|
-
if k not in static_vars:
|
742
|
-
d[k] = self.template(
|
743
|
-
variable[k],
|
744
|
-
preserve_trailing_newlines=preserve_trailing_newlines,
|
745
|
-
fail_on_undefined=fail_on_undefined,
|
746
|
-
overrides=overrides,
|
747
|
-
disable_lookups=disable_lookups,
|
748
|
-
)
|
749
|
-
else:
|
750
|
-
d[k] = variable[k]
|
751
|
-
return d
|
752
|
-
else:
|
753
|
-
return variable
|
754
|
-
|
755
|
-
def is_template(self, data):
|
756
|
-
'''lets us know if data has a template'''
|
757
|
-
if isinstance(data, string_types):
|
758
|
-
return is_template(data, self.environment)
|
759
|
-
elif isinstance(data, (list, tuple)):
|
760
|
-
for v in data:
|
761
|
-
if self.is_template(v):
|
762
|
-
return True
|
763
|
-
elif isinstance(data, dict):
|
764
|
-
for k in data:
|
765
|
-
if self.is_template(k) or self.is_template(data[k]):
|
766
|
-
return True
|
767
|
-
return False
|
768
|
-
|
769
|
-
templatable = is_template
|
770
|
-
|
771
|
-
def is_possibly_template(self, data, overrides=None):
|
772
|
-
data, env = _create_overlay(data, overrides, self.environment)
|
773
|
-
return is_possibly_template(data, env)
|
774
|
-
|
775
|
-
def _convert_bare_variable(self, variable):
|
776
|
-
'''
|
777
|
-
Wraps a bare string, which may have an attribute portion (ie. foo.bar)
|
778
|
-
in jinja2 variable braces so that it is evaluated properly.
|
779
|
-
'''
|
780
|
-
|
781
|
-
if isinstance(variable, string_types):
|
782
|
-
contains_filters = "|" in variable
|
783
|
-
first_part = variable.split("|")[0].split(".")[0].split("[")[0]
|
784
|
-
if (contains_filters or first_part in self._available_variables) and self.environment.variable_start_string not in variable:
|
785
|
-
return "%s%s%s" % (self.environment.variable_start_string, variable, self.environment.variable_end_string)
|
786
|
-
|
787
|
-
# the variable didn't meet the conditions to be converted,
|
788
|
-
# so just return it as-is
|
789
|
-
return variable
|
790
|
-
|
791
|
-
def _fail_lookup(self, name, *args, **kwargs):
|
792
|
-
raise AnsibleError("The lookup `%s` was found, however lookups were disabled from templating" % name)
|
793
|
-
|
794
|
-
def _now_datetime(self, utc=False, fmt=None):
|
795
|
-
'''jinja2 global function to return current datetime, potentially formatted via strftime'''
|
796
|
-
if utc:
|
797
|
-
now = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
|
798
|
-
else:
|
799
|
-
now = datetime.datetime.now()
|
366
|
+
template_uid: int | str
|
800
367
|
|
801
|
-
|
802
|
-
|
368
|
+
try:
|
369
|
+
template_uid = _pwd.getpwuid(template_stat.st_uid).pw_name
|
370
|
+
except KeyError:
|
371
|
+
template_uid = template_stat.st_uid
|
803
372
|
|
804
|
-
|
373
|
+
managed_default = _constants.config.get_config_value('DEFAULT_MANAGED_STR')
|
805
374
|
|
806
|
-
|
807
|
-
|
808
|
-
|
809
|
-
|
375
|
+
managed_str = managed_default.format(
|
376
|
+
# IMPORTANT: These values must be constant strings to avoid template injection.
|
377
|
+
# Use Jinja template expressions where variables are needed.
|
378
|
+
host="{{ template_host }}",
|
379
|
+
uid="{{ template_uid }}",
|
380
|
+
file="{{ template_path }}",
|
381
|
+
)
|
810
382
|
|
811
|
-
|
812
|
-
|
383
|
+
ansible_managed = _time.strftime(managed_str, _time.localtime(template_stat.st_mtime))
|
384
|
+
# DTFIX-RELEASE: this should not be tag_copy, it should either be an origin copy or some kind of derived origin
|
385
|
+
ansible_managed = _datatag.AnsibleTagHelper.tag_copy(managed_default, ansible_managed)
|
386
|
+
ansible_managed = trust_as_template(ansible_managed)
|
387
|
+
ansible_managed = _module_utils_datatag.deprecate_value(
|
388
|
+
value=ansible_managed,
|
389
|
+
msg="The `ansible_managed` variable is deprecated.",
|
390
|
+
help_text="Define and use a custom variable instead.",
|
391
|
+
removal_version='2.23',
|
392
|
+
)
|
813
393
|
|
814
|
-
|
815
|
-
|
394
|
+
temp_vars = dict(
|
395
|
+
template_host=_os.uname()[1],
|
396
|
+
template_path=path,
|
397
|
+
template_mtime=_datetime.datetime.fromtimestamp(template_stat.st_mtime),
|
398
|
+
template_uid=template_uid,
|
399
|
+
template_run_date=_datetime.datetime.now(),
|
400
|
+
template_destpath=dest_path,
|
401
|
+
template_fullpath=fullpath,
|
402
|
+
ansible_managed=ansible_managed,
|
403
|
+
)
|
816
404
|
|
817
|
-
|
818
|
-
allow_unsafe = kwargs.pop('allow_unsafe', C.DEFAULT_ALLOW_UNSAFE_LOOKUPS)
|
819
|
-
errors = kwargs.pop('errors', 'strict')
|
405
|
+
return temp_vars
|
820
406
|
|
821
|
-
loop_terms = listify_lookup_plugin_terms(terms=args, templar=self, fail_on_undefined=True, convert_bare=False)
|
822
|
-
# safely catch run failures per #5059
|
823
|
-
try:
|
824
|
-
ran = instance.run(loop_terms, variables=self._available_variables, **kwargs)
|
825
|
-
except (AnsibleUndefinedVariable, UndefinedError) as e:
|
826
|
-
raise AnsibleUndefinedVariable(e)
|
827
|
-
except AnsibleOptionsError as e:
|
828
|
-
# invalid options given to lookup, just reraise
|
829
|
-
raise e
|
830
|
-
except AnsibleLookupError as e:
|
831
|
-
# lookup handled error but still decided to bail
|
832
|
-
msg = 'Lookup failed but the error is being ignored: %s' % to_native(e)
|
833
|
-
if errors == 'warn':
|
834
|
-
display.warning(msg)
|
835
|
-
elif errors == 'ignore':
|
836
|
-
display.display(msg, log_only=True)
|
837
|
-
else:
|
838
|
-
raise e
|
839
|
-
return [] if wantlist else None
|
840
|
-
except Exception as e:
|
841
|
-
# errors not handled by lookup
|
842
|
-
msg = u"An unhandled exception occurred while running the lookup plugin '%s'. Error was a %s, original message: %s" % \
|
843
|
-
(name, type(e), to_text(e))
|
844
|
-
if errors == 'warn':
|
845
|
-
display.warning(msg)
|
846
|
-
elif errors == 'ignore':
|
847
|
-
display.display(msg, log_only=True)
|
848
|
-
else:
|
849
|
-
display.vvv('exception during Jinja2 execution: {0}'.format(format_exc()))
|
850
|
-
raise AnsibleError(to_native(msg), orig_exc=e)
|
851
|
-
return [] if wantlist else None
|
852
|
-
|
853
|
-
if not is_sequence(ran):
|
854
|
-
raise AnsibleLookupError(
|
855
|
-
f'The lookup plugin \'{name}\' was expected to return a list, got \'{type(ran)}\' instead. '
|
856
|
-
f'The lookup plugin \'{name}\' needs to be changed to return a list. '
|
857
|
-
)
|
858
407
|
|
859
|
-
|
860
|
-
|
861
|
-
|
862
|
-
|
863
|
-
|
864
|
-
|
865
|
-
|
866
|
-
try:
|
867
|
-
if isinstance(ran[0], NativeJinjaText):
|
868
|
-
ran = wrap_var(NativeJinjaText(",".join(ran)))
|
869
|
-
else:
|
870
|
-
ran = wrap_var(",".join(ran))
|
871
|
-
except TypeError:
|
872
|
-
# Lookup Plugins should always return lists. Throw an error if that's not
|
873
|
-
# the case:
|
874
|
-
if not isinstance(ran, Sequence):
|
875
|
-
raise AnsibleError("The lookup plugin '%s' did not return a list."
|
876
|
-
% name)
|
877
|
-
|
878
|
-
# The TypeError we can recover from is when the value *inside* of the list
|
879
|
-
# is not a string
|
880
|
-
if len(ran) == 1:
|
881
|
-
ran = wrap_var(ran[0])
|
882
|
-
else:
|
883
|
-
ran = wrap_var(ran)
|
884
|
-
except KeyError:
|
885
|
-
# Lookup Plugin returned a dict. Return comma-separated string of keys
|
886
|
-
# for backwards compat.
|
887
|
-
# FIXME this can be removed when support for non-list return types is removed.
|
888
|
-
# See https://github.com/ansible/ansible/pull/77789
|
889
|
-
ran = wrap_var(",".join(ran))
|
890
|
-
|
891
|
-
return ran
|
892
|
-
|
893
|
-
def _make_undefined(self, hint=None):
|
894
|
-
from jinja2.runtime import Undefined
|
895
|
-
|
896
|
-
if hint is None or isinstance(hint, Undefined) or hint == '':
|
897
|
-
hint = "Mandatory variable has not been overridden"
|
898
|
-
return AnsibleUndefined(hint)
|
899
|
-
|
900
|
-
def do_template(self, data, preserve_trailing_newlines=True, escape_backslashes=True, fail_on_undefined=None, overrides=None, disable_lookups=False,
|
901
|
-
convert_data=False):
|
902
|
-
if self.jinja2_native and not isinstance(data, string_types):
|
903
|
-
return data
|
408
|
+
def trust_as_template(value: _TTrustable) -> _TTrustable:
|
409
|
+
"""
|
410
|
+
Returns `value` tagged as trusted for templating.
|
411
|
+
Raises a `TypeError` if `value` is not a supported type.
|
412
|
+
"""
|
413
|
+
if isinstance(value, str):
|
414
|
+
return _tags.TrustedAsTemplate().tag(value) # type: ignore[return-value]
|
904
415
|
|
905
|
-
|
906
|
-
|
907
|
-
data_newlines = _count_newlines_from_end(data)
|
416
|
+
if isinstance(value, _io.IOBase): # covers TextIO and BinaryIO at runtime, but type checking disagrees
|
417
|
+
return _wrappers.TaggedStreamWrapper(value, _tags.TrustedAsTemplate())
|
908
418
|
|
909
|
-
|
910
|
-
fail_on_undefined = self._fail_on_undefined_errors
|
419
|
+
raise TypeError(f"Trust cannot be applied to {_module_utils_datatag.native_type_name(value)}, only to 'str' or 'IOBase'.")
|
911
420
|
|
912
|
-
try:
|
913
|
-
# NOTE Creating an overlay that lives only inside do_template means that overrides are not applied
|
914
|
-
# when templating nested variables in AnsibleJ2Vars where Templar.environment is used, not the overlay.
|
915
|
-
data, myenv = _create_overlay(data, overrides, self.environment)
|
916
|
-
# in case delimiters change
|
917
|
-
self._compile_single_var(myenv)
|
918
|
-
|
919
|
-
if escape_backslashes:
|
920
|
-
# Allow users to specify backslashes in playbooks as "\\" instead of as "\\\\".
|
921
|
-
data = _escape_backslashes(data, myenv)
|
922
|
-
|
923
|
-
try:
|
924
|
-
t = myenv.from_string(data)
|
925
|
-
except (TemplateSyntaxError, SyntaxError) as e:
|
926
|
-
raise AnsibleError("template error while templating string: %s. String: %s" % (to_native(e), to_native(data)), orig_exc=e)
|
927
|
-
except Exception as e:
|
928
|
-
if 'recursion' in to_native(e):
|
929
|
-
raise AnsibleError("recursive loop detected in template string: %s" % to_native(data), orig_exc=e)
|
930
|
-
else:
|
931
|
-
return data
|
932
|
-
|
933
|
-
if disable_lookups:
|
934
|
-
t.globals['query'] = t.globals['q'] = t.globals['lookup'] = self._fail_lookup
|
935
|
-
|
936
|
-
jvars = AnsibleJ2Vars(self, t.globals)
|
937
|
-
|
938
|
-
# In case this is a recursive call to do_template we need to
|
939
|
-
# save/restore cur_context to prevent overriding __UNSAFE__.
|
940
|
-
cached_context = self.cur_context
|
941
|
-
|
942
|
-
# In case this is a recursive call and we set different concat
|
943
|
-
# function up the stack, reset it in case the value of convert_data
|
944
|
-
# changed in this call
|
945
|
-
myenv.concat = myenv.__class__.concat
|
946
|
-
# the concat function is set for each Ansible environment,
|
947
|
-
# however for convert_data=False we need to use the concat
|
948
|
-
# function that avoids any evaluation and set it temporarily
|
949
|
-
# on the environment so it is used correctly even when
|
950
|
-
# the concat function is called internally in Jinja,
|
951
|
-
# most notably for macro execution
|
952
|
-
if not self.jinja2_native and not convert_data:
|
953
|
-
myenv.concat = ansible_concat
|
954
|
-
|
955
|
-
self.cur_context = t.new_context(jvars, shared=True)
|
956
|
-
rf = t.root_render_func(self.cur_context)
|
957
|
-
|
958
|
-
try:
|
959
|
-
res = myenv.concat(rf)
|
960
|
-
unsafe = getattr(self.cur_context, 'unsafe', False)
|
961
|
-
if unsafe:
|
962
|
-
res = wrap_var(res)
|
963
|
-
except TypeError as te:
|
964
|
-
if 'AnsibleUndefined' in to_native(te):
|
965
|
-
errmsg = "Unable to look up a name or access an attribute in template string (%s).\n" % to_native(data)
|
966
|
-
errmsg += "Make sure your variable name does not contain invalid characters like '-': %s" % to_native(te)
|
967
|
-
raise AnsibleUndefinedVariable(errmsg, orig_exc=te)
|
968
|
-
else:
|
969
|
-
display.debug("failing because of a type error, template data is: %s" % to_text(data))
|
970
|
-
raise AnsibleError("Unexpected templating type error occurred on (%s): %s" % (to_native(data), to_native(te)), orig_exc=te)
|
971
|
-
finally:
|
972
|
-
self.cur_context = cached_context
|
973
|
-
|
974
|
-
if isinstance(res, string_types) and preserve_trailing_newlines:
|
975
|
-
# The low level calls above do not preserve the newline
|
976
|
-
# characters at the end of the input data, so we use the
|
977
|
-
# calculate the difference in newlines and append them
|
978
|
-
# to the resulting output for parity
|
979
|
-
#
|
980
|
-
# Using Environment's keep_trailing_newline instead would
|
981
|
-
# result in change in behavior when trailing newlines
|
982
|
-
# would be kept also for included templates, for example:
|
983
|
-
# "Hello {% include 'world.txt' %}!" would render as
|
984
|
-
# "Hello world\n!\n" instead of "Hello world!\n".
|
985
|
-
res_newlines = _count_newlines_from_end(res)
|
986
|
-
if data_newlines > res_newlines:
|
987
|
-
res += myenv.newline_sequence * (data_newlines - res_newlines)
|
988
|
-
if unsafe:
|
989
|
-
res = wrap_var(res)
|
990
|
-
return res
|
991
|
-
except UndefinedError as e:
|
992
|
-
if fail_on_undefined:
|
993
|
-
raise AnsibleUndefinedVariable(e)
|
994
|
-
display.debug("Ignoring undefined failure: %s" % to_text(e))
|
995
|
-
return data
|
996
|
-
except AnsibleUndefinedVariable as e:
|
997
|
-
if fail_on_undefined:
|
998
|
-
raise
|
999
|
-
display.debug("Ignoring undefined failure: %s" % to_text(e))
|
1000
|
-
return data
|
1001
421
|
|
1002
|
-
|
1003
|
-
|
422
|
+
def is_trusted_as_template(value: object) -> bool:
|
423
|
+
"""
|
424
|
+
Returns `True` if `value` is a `str` or `IOBase` marked as trusted for templating, otherwise returns `False`.
|
425
|
+
Returns `False` for types which cannot be trusted for templating.
|
426
|
+
Containers are not recursed and will always return `False`.
|
427
|
+
This function should not be needed for production code, but may be useful in unit tests.
|
428
|
+
"""
|
429
|
+
return isinstance(value, _TRUSTABLE_TYPES) and _tags.TrustedAsTemplate.is_tagged_on(value)
|