ansible-core 2.18.7__py3-none-any.whl → 2.19.0__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.
Potentially problematic release.
This version of ansible-core might be problematic. Click here for more details.
- ansible/_internal/__init__.py +53 -0
- ansible/_internal/_ansiballz/__init__.py +0 -0
- ansible/_internal/_ansiballz/_builder.py +101 -0
- ansible/_internal/_ansiballz/_wrapper.py +262 -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/_alarm_timeout.py +66 -0
- ansible/_internal/_errors/_captured.py +123 -0
- ansible/_internal/_errors/_error_factory.py +89 -0
- ansible/_internal/_errors/_error_utils.py +240 -0
- ansible/_internal/_errors/_handler.py +91 -0
- ansible/_internal/_errors/_task_timeout.py +28 -0
- ansible/_internal/_event_formatting.py +127 -0
- ansible/_internal/_json/__init__.py +214 -0
- ansible/_internal/_json/_legacy_encoder.py +34 -0
- ansible/_internal/_json/_profiles/__init__.py +0 -0
- ansible/_internal/_json/_profiles/_cache_persistence.py +57 -0
- ansible/_internal/_json/_profiles/_inventory_legacy.py +40 -0
- ansible/_internal/_json/_profiles/_legacy.py +189 -0
- ansible/_internal/_locking.py +21 -0
- ansible/_internal/_plugins/__init__.py +0 -0
- ansible/_internal/_plugins/_cache.py +57 -0
- ansible/_internal/_ssh/__init__.py +0 -0
- ansible/_internal/_ssh/_agent_launch.py +91 -0
- ansible/_internal/_ssh/_ssh_agent.py +619 -0
- ansible/_internal/_task.py +78 -0
- ansible/_internal/_templating/__init__.py +12 -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 +592 -0
- ansible/_internal/_templating/_errors.py +28 -0
- ansible/_internal/_templating/_jinja_bits.py +1106 -0
- ansible/_internal/_templating/_jinja_common.py +323 -0
- ansible/_internal/_templating/_jinja_patches.py +44 -0
- ansible/_internal/_templating/_jinja_plugins.py +375 -0
- ansible/_internal/_templating/_lazy_containers.py +633 -0
- ansible/_internal/_templating/_marker_behaviors.py +103 -0
- ansible/_internal/_templating/_template_vars.py +72 -0
- ansible/_internal/_templating/_transform.py +70 -0
- ansible/_internal/_templating/_utils.py +108 -0
- ansible/_internal/_testing.py +26 -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 +70 -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 +27 -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 +93 -104
- ansible/cli/_ssh_askpass.py +54 -0
- ansible/cli/adhoc.py +20 -10
- ansible/cli/arguments/option_helpers.py +163 -10
- ansible/cli/config.py +43 -68
- ansible/cli/console.py +13 -11
- ansible/cli/doc.py +134 -77
- ansible/cli/galaxy.py +27 -20
- ansible/cli/inventory.py +28 -28
- ansible/cli/playbook.py +4 -12
- ansible/cli/pull.py +6 -3
- ansible/cli/scripts/ansible_connection_cli_stub.py +7 -7
- ansible/cli/vault.py +12 -11
- ansible/compat/__init__.py +2 -2
- ansible/compat/importlib_resources.py +9 -12
- ansible/config/base.yml +218 -133
- ansible/config/manager.py +220 -159
- ansible/constants.py +2 -65
- ansible/errors/__init__.py +350 -256
- ansible/executor/interpreter_discovery.py +28 -149
- ansible/executor/module_common.py +480 -514
- 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 +204 -153
- ansible/executor/powershell/become_wrapper.ps1 +107 -144
- ansible/executor/powershell/bootstrap_wrapper.ps1 +46 -9
- ansible/executor/powershell/coverage_wrapper.ps1 +91 -135
- ansible/executor/powershell/exec_wrapper.ps1 +675 -196
- ansible/executor/powershell/module_manifest.py +469 -265
- ansible/executor/powershell/module_wrapper.ps1 +195 -186
- ansible/executor/powershell/powershell_expand_user.ps1 +20 -0
- ansible/executor/powershell/powershell_mkdtemp.ps1 +17 -0
- 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 +139 -149
- ansible/executor/stats.py +5 -5
- ansible/executor/task_executor.py +270 -297
- ansible/executor/task_queue_manager.py +135 -137
- ansible/executor/task_result.py +182 -79
- ansible/galaxy/__init__.py +2 -2
- ansible/galaxy/api.py +26 -25
- ansible/galaxy/collection/__init__.py +6 -14
- ansible/galaxy/collection/concrete_artifact_manager.py +12 -21
- ansible/galaxy/dependency_resolution/dataclasses.py +14 -4
- ansible/galaxy/dependency_resolution/providers.py +4 -4
- ansible/galaxy/dependency_resolution/reporters.py +81 -0
- ansible/galaxy/role.py +6 -10
- ansible/galaxy/token.py +28 -21
- ansible/inventory/data.py +47 -57
- ansible/inventory/group.py +50 -73
- ansible/inventory/helpers.py +9 -0
- ansible/inventory/host.py +37 -54
- ansible/inventory/manager.py +79 -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/__init__.py +0 -0
- ansible/module_utils/_internal/_ansiballz/_extensions/__init__.py +0 -0
- ansible/module_utils/_internal/_ansiballz/_extensions/_coverage.py +45 -0
- ansible/module_utils/_internal/_ansiballz/_extensions/_pydevd.py +62 -0
- ansible/module_utils/_internal/_ansiballz/_loader.py +81 -0
- ansible/module_utils/_internal/_ansiballz/_respawn.py +32 -0
- ansible/module_utils/_internal/_ansiballz/_respawn_wrapper.py +23 -0
- ansible/module_utils/_internal/_concurrent/_daemon_threading.py +1 -0
- ansible/module_utils/_internal/_dataclass_validation.py +217 -0
- ansible/module_utils/_internal/_datatag/__init__.py +961 -0
- ansible/module_utils/_internal/_datatag/_tags.py +16 -0
- ansible/module_utils/_internal/_debugging.py +31 -0
- ansible/module_utils/_internal/_deprecator.py +157 -0
- ansible/module_utils/_internal/_errors.py +101 -0
- ansible/module_utils/_internal/_event_utils.py +61 -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 +428 -0
- ansible/module_utils/_internal/_json/_profiles/_fallback_to_str.py +73 -0
- ansible/module_utils/_internal/_json/_profiles/_module_legacy_c2m.py +33 -0
- ansible/module_utils/_internal/_json/_profiles/_module_legacy_m2c.py +37 -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 +52 -0
- ansible/module_utils/_internal/_messages.py +130 -0
- ansible/module_utils/_internal/_patches/__init__.py +66 -0
- ansible/module_utils/_internal/_patches/_dataclass_annotation_patch.py +53 -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_info.py +38 -0
- ansible/module_utils/_internal/_stack.py +22 -0
- ansible/module_utils/_internal/_testing.py +0 -0
- ansible/module_utils/_internal/_text_utils.py +6 -0
- ansible/module_utils/_internal/_traceback.py +92 -0
- ansible/module_utils/_internal/_validation.py +14 -0
- ansible/module_utils/ansible_release.py +2 -2
- ansible/module_utils/api.py +1 -2
- ansible/module_utils/basic.py +303 -202
- ansible/module_utils/common/_utils.py +24 -28
- ansible/module_utils/common/arg_spec.py +8 -3
- ansible/module_utils/common/collections.py +7 -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/parameters.py +27 -24
- ansible/module_utils/common/process.py +2 -3
- ansible/module_utils/common/respawn.py +11 -33
- 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 +143 -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 +10 -13
- ansible/module_utils/csharp/Ansible.Basic.cs +15 -12
- ansible/module_utils/csharp/Ansible.Become.cs +1 -0
- ansible/module_utils/csharp/Ansible.Privilege.cs +2 -2
- ansible/module_utils/csharp/Ansible._Async.cs +517 -0
- ansible/module_utils/datatag.py +49 -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 +2 -2
- 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 +5 -5
- 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 +2 -3
- ansible/module_utils/facts/other/ohai.py +2 -3
- ansible/module_utils/facts/sysctl.py +4 -6
- ansible/module_utils/facts/system/apparmor.py +1 -2
- ansible/module_utils/facts/system/caps.py +3 -3
- 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 +27 -13
- 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 +2 -3
- 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/linux.py +3 -3
- 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 +7 -1
- ansible/module_utils/powershell/Ansible.ModuleUtils.AddType.psm1 +1 -1
- ansible/module_utils/powershell/Ansible.ModuleUtils.CamelConversion.psm1 +1 -1
- ansible/module_utils/powershell/Ansible.ModuleUtils.CommandUtil.psm1 +1 -1
- ansible/module_utils/powershell/Ansible.ModuleUtils.WebRequest.psm1 +1 -1
- ansible/module_utils/service.py +21 -31
- ansible/module_utils/splitter.py +7 -7
- ansible/module_utils/testing.py +31 -0
- ansible/module_utils/urls.py +64 -35
- ansible/modules/add_host.py +4 -4
- ansible/modules/apt.py +69 -49
- ansible/modules/apt_key.py +19 -12
- ansible/modules/apt_repository.py +32 -51
- ansible/modules/assemble.py +16 -14
- ansible/modules/assert.py +4 -4
- ansible/modules/async_status.py +24 -24
- ansible/modules/async_wrapper.py +20 -25
- ansible/modules/blockinfile.py +6 -7
- ansible/modules/command.py +13 -20
- ansible/modules/copy.py +60 -147
- ansible/modules/cron.py +24 -21
- 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 +13 -15
- ansible/modules/fail.py +4 -4
- ansible/modules/fetch.py +4 -4
- ansible/modules/file.py +184 -144
- ansible/modules/find.py +22 -20
- ansible/modules/gather_facts.py +3 -3
- ansible/modules/get_url.py +77 -54
- ansible/modules/getent.py +7 -9
- ansible/modules/git.py +38 -38
- ansible/modules/group.py +6 -6
- ansible/modules/group_by.py +4 -4
- ansible/modules/hostname.py +15 -32
- 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 +22 -24
- ansible/modules/lineinfile.py +5 -5
- ansible/modules/meta.py +4 -4
- ansible/modules/mount_facts.py +2 -2
- ansible/modules/package.py +10 -4
- ansible/modules/package_facts.py +22 -10
- ansible/modules/pause.py +6 -6
- ansible/modules/ping.py +6 -6
- ansible/modules/pip.py +21 -26
- ansible/modules/raw.py +6 -6
- ansible/modules/reboot.py +6 -6
- ansible/modules/replace.py +10 -14
- ansible/modules/rpm_key.py +7 -8
- ansible/modules/script.py +4 -4
- ansible/modules/service.py +10 -17
- 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 +16 -19
- ansible/modules/stat.py +15 -31
- ansible/modules/subversion.py +15 -15
- ansible/modules/systemd.py +7 -7
- ansible/modules/systemd_service.py +7 -7
- ansible/modules/sysvinit.py +9 -9
- ansible/modules/tempfile.py +5 -6
- ansible/modules/template.py +6 -6
- ansible/modules/unarchive.py +38 -17
- ansible/modules/uri.py +33 -26
- ansible/modules/user.py +45 -32
- ansible/modules/validate_argument_spec.py +10 -7
- ansible/modules/wait_for.py +70 -60
- ansible/modules/wait_for_connection.py +6 -6
- ansible/modules/yum_repository.py +10 -9
- ansible/parsing/ajson.py +17 -37
- ansible/parsing/dataloader.py +99 -54
- ansible/parsing/mod_args.py +62 -60
- 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 +327 -99
- 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 +187 -134
- 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 +32 -26
- ansible/playbook/loop_control.py +2 -2
- ansible/playbook/play.py +85 -44
- ansible/playbook/play_context.py +14 -17
- ansible/playbook/playbook_include.py +27 -62
- ansible/playbook/role/__init__.py +64 -49
- 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 +28 -12
- ansible/playbook/task.py +192 -121
- ansible/playbook/task_include.py +5 -5
- ansible/plugins/__init__.py +58 -26
- ansible/plugins/action/__init__.py +188 -186
- ansible/plugins/action/add_host.py +2 -2
- ansible/plugins/action/assemble.py +11 -18
- ansible/plugins/action/assert.py +55 -67
- ansible/plugins/action/async_status.py +7 -2
- ansible/plugins/action/copy.py +14 -17
- 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 +7 -8
- ansible/plugins/action/gather_facts.py +13 -14
- ansible/plugins/action/group_by.py +1 -1
- ansible/plugins/action/include_vars.py +10 -11
- ansible/plugins/action/package.py +8 -14
- ansible/plugins/action/pause.py +2 -2
- ansible/plugins/action/script.py +27 -38
- ansible/plugins/action/service.py +9 -18
- ansible/plugins/action/set_fact.py +3 -12
- ansible/plugins/action/set_stats.py +3 -8
- ansible/plugins/action/template.py +47 -67
- ansible/plugins/action/unarchive.py +6 -16
- ansible/plugins/action/uri.py +9 -20
- 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 +52 -63
- 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 +294 -201
- ansible/plugins/callback/default.py +99 -95
- ansible/plugins/callback/junit.py +44 -43
- ansible/plugins/callback/minimal.py +28 -25
- ansible/plugins/callback/oneline.py +34 -21
- ansible/plugins/callback/tree.py +27 -16
- ansible/plugins/connection/__init__.py +47 -34
- ansible/plugins/connection/local.py +156 -60
- ansible/plugins/connection/paramiko_ssh.py +34 -24
- ansible/plugins/connection/psrp.py +76 -165
- ansible/plugins/connection/ssh.py +326 -86
- ansible/plugins/connection/winrm.py +62 -141
- 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 +8 -4
- 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 +245 -120
- ansible/plugins/filter/encryption.py +42 -34
- 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/pow.yml +1 -1
- ansible/plugins/filter/regex_search.yml +1 -4
- ansible/plugins/filter/root.yml +1 -1
- ansible/plugins/filter/split.yml +1 -1
- ansible/plugins/filter/strftime.yml +3 -3
- ansible/plugins/filter/to_nice_yaml.yml +0 -4
- ansible/plugins/filter/to_uuid.yml +1 -1
- 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 +107 -86
- 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 +190 -120
- ansible/plugins/inventory/toml.py +16 -126
- ansible/plugins/inventory/yaml.py +10 -8
- ansible/plugins/list.py +72 -19
- ansible/plugins/loader.py +383 -198
- ansible/plugins/lookup/__init__.py +21 -4
- ansible/plugins/lookup/config.py +21 -35
- ansible/plugins/lookup/csvfile.py +19 -73
- 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 +87 -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 +47 -36
- ansible/plugins/lookup/together.py +0 -12
- ansible/plugins/lookup/unvault.py +1 -5
- ansible/plugins/lookup/url.py +4 -10
- ansible/plugins/lookup/vars.py +16 -24
- ansible/plugins/shell/__init__.py +58 -4
- ansible/plugins/shell/cmd.py +2 -2
- ansible/plugins/shell/powershell.py +106 -31
- ansible/plugins/shell/sh.py +13 -7
- ansible/plugins/strategy/__init__.py +168 -193
- 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 +75 -35
- ansible/plugins/test/files.py +1 -1
- ansible/plugins/test/finished.yml +1 -1
- ansible/plugins/test/mathstuff.py +3 -3
- ansible/plugins/test/uri.py +5 -8
- ansible/plugins/vars/host_group_vars.py +7 -14
- ansible/release.py +2 -2
- ansible/template/__init__.py +353 -943
- ansible/utils/__init__.py +0 -18
- ansible/utils/collection_loader/__init__.py +54 -5
- ansible/utils/collection_loader/_collection_config.py +5 -6
- ansible/utils/collection_loader/_collection_finder.py +82 -96
- ansible/utils/collection_loader/_collection_meta.py +15 -8
- ansible/utils/display.py +485 -73
- ansible/utils/encrypt.py +27 -19
- ansible/utils/fqcn.py +2 -2
- ansible/utils/galaxy.py +2 -2
- ansible/utils/hashing.py +8 -10
- ansible/utils/helpers.py +2 -2
- ansible/utils/listify.py +10 -8
- ansible/utils/lock.py +2 -2
- ansible/utils/path.py +10 -12
- ansible/utils/plugin_docs.py +16 -14
- ansible/utils/py3compat.py +2 -7
- ansible/utils/sentinel.py +4 -62
- ansible/utils/singleton.py +2 -0
- ansible/utils/ssh_functions.py +6 -2
- ansible/utils/unsafe_proxy.py +23 -332
- ansible/utils/vars.py +55 -8
- ansible/utils/version.py +2 -2
- ansible/vars/clean.py +5 -5
- ansible/vars/hostvars.py +60 -90
- ansible/vars/manager.py +220 -285
- ansible/vars/plugins.py +4 -4
- ansible/vars/reserved.py +13 -12
- {ansible_core-2.18.7.dist-info → ansible_core-2.19.0.dist-info}/METADATA +4 -3
- ansible_core-2.19.0.dist-info/RECORD +1097 -0
- ansible_core-2.19.0.dist-info/licenses/licenses/BSD-3-Clause.txt +28 -0
- 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 +2 -2
- ansible_test/_data/requirements/sanity.import.plugin.txt +2 -2
- ansible_test/_data/requirements/sanity.pep8.txt +1 -1
- ansible_test/_data/requirements/sanity.pylint.txt +5 -5
- 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 +6 -0
- ansible_test/_internal/ansible_util.py +3 -1
- 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 -5
- 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 +52 -5
- 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 +3 -2
- 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 +22 -5
- 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 +3 -2
- 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 +8 -2
- 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 +19 -2
- 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 +12 -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 +25 -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 +44 -4
- ansible_test/_internal/commands/units/__init__.py +5 -1
- 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 +23 -13
- 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/debugging.py +166 -0
- ansible_test/_internal/delegation.py +22 -13
- 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 +260 -16
- ansible_test/_internal/http.py +1 -0
- ansible_test/_internal/init.py +1 -0
- ansible_test/_internal/inventory.py +39 -3
- ansible_test/_internal/io.py +1 -0
- ansible_test/_internal/metadata.py +95 -4
- ansible_test/_internal/payload.py +1 -0
- ansible_test/_internal/processes.py +80 -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 +11 -4
- ansible_test/_internal/pypi_proxy.py +6 -5
- ansible_test/_internal/python_requirements.py +28 -0
- ansible_test/_internal/ssh.py +2 -5
- ansible_test/_internal/target.py +9 -0
- ansible_test/_internal/test.py +3 -2
- ansible_test/_internal/thread.py +3 -1
- ansible_test/_internal/timeout.py +2 -1
- ansible_test/_internal/util.py +41 -12
- ansible_test/_internal/util_common.py +18 -5
- 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 +8 -5
- ansible_test/_util/controller/sanity/pylint/config/ansible-test.cfg +8 -5
- ansible_test/_util/controller/sanity/pylint/config/code-smell.cfg +8 -5
- ansible_test/_util/controller/sanity/pylint/config/collection.cfg +4 -5
- ansible_test/_util/controller/sanity/pylint/config/default.cfg +8 -7
- ansible_test/_util/controller/sanity/pylint/plugins/deprecated_calls.py +541 -0
- ansible_test/_util/controller/sanity/pylint/plugins/deprecated_comment.py +137 -0
- 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/injector/python.py +8 -0
- 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 +38 -36
- 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.7.dist-info/RECORD +0 -992
- ansible_test/_util/controller/sanity/pylint/plugins/deprecated.py +0 -411
- {ansible_core-2.18.7.dist-info → ansible_core-2.19.0.dist-info}/WHEEL +0 -0
- {ansible_core-2.18.7.dist-info → ansible_core-2.19.0.dist-info}/entry_points.txt +0 -0
- {ansible_core-2.18.7.dist-info → ansible_core-2.19.0.dist-info}/licenses/COPYING +0 -0
- {ansible_core-2.18.7.dist-info → ansible_core-2.19.0.dist-info}/licenses/licenses/Apache-License.txt +0 -0
- {ansible_core-2.18.7.dist-info → ansible_core-2.19.0.dist-info}/licenses/licenses/MIT-license.txt +0 -0
- {ansible_core-2.18.7.dist-info → ansible_core-2.19.0.dist-info}/licenses/licenses/PSF-license.txt +0 -0
- {ansible_core-2.18.7.dist-info → ansible_core-2.19.0.dist-info}/licenses/licenses/simplified_bsd.txt +0 -0
- {ansible_core-2.18.7.dist-info → ansible_core-2.19.0.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import importlib
|
|
4
|
+
import typing as t
|
|
5
|
+
|
|
6
|
+
from ansible.module_utils import _internal
|
|
7
|
+
from ansible.module_utils._internal._json import _profiles
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def get_controller_serialize_map() -> dict[type, t.Callable]:
|
|
11
|
+
"""
|
|
12
|
+
Injected into module_utils code to augment serialization maps with controller-only types.
|
|
13
|
+
This implementation replaces the no-op version in module_utils._internal in controller contexts.
|
|
14
|
+
"""
|
|
15
|
+
from ansible._internal._templating import _lazy_containers
|
|
16
|
+
from ansible.parsing.vault import EncryptedString
|
|
17
|
+
|
|
18
|
+
return {
|
|
19
|
+
_lazy_containers._AnsibleLazyTemplateDict: _profiles._JSONSerializationProfile.discard_tags,
|
|
20
|
+
_lazy_containers._AnsibleLazyTemplateList: _profiles._JSONSerializationProfile.discard_tags,
|
|
21
|
+
EncryptedString: str, # preserves tags since this is an instance of EncryptedString; if tags should be discarded from str, another entry will handle it
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def import_controller_module(module_name: str, /) -> t.Any:
|
|
26
|
+
"""
|
|
27
|
+
Injected into module_utils code to import and return the specified module.
|
|
28
|
+
This implementation replaces the no-op version in module_utils._internal in controller contexts.
|
|
29
|
+
"""
|
|
30
|
+
return importlib.import_module(module_name)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
_T = t.TypeVar('_T')
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
def experimental(obj: _T) -> _T:
|
|
37
|
+
"""
|
|
38
|
+
Decorator for experimental types and methods outside the `_internal` package which accept or expose internal types.
|
|
39
|
+
As with internal APIs, these are subject to change at any time without notice.
|
|
40
|
+
"""
|
|
41
|
+
return obj
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
def setup() -> None:
|
|
45
|
+
"""No-op function to ensure that side-effect only imports of this module are not flagged/removed as 'unused'."""
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
# DTFIX-FUTURE: this is really fragile- disordered/incorrect imports (among other things) can mess it up. Consider a hosting-env-managed context
|
|
49
|
+
# with an enum with at least Controller/Target/Unknown values, and possibly using lazy-init module shims or some other mechanism to allow controller-side
|
|
50
|
+
# notification/augmentation of this kind of metadata.
|
|
51
|
+
_internal.get_controller_serialize_map = get_controller_serialize_map
|
|
52
|
+
_internal.import_controller_module = import_controller_module
|
|
53
|
+
_internal.is_controller = True
|
|
File without changes
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import dataclasses
|
|
4
|
+
import json
|
|
5
|
+
|
|
6
|
+
import typing as t
|
|
7
|
+
|
|
8
|
+
from ansible.module_utils._internal._ansiballz import _extensions
|
|
9
|
+
from ansible.module_utils._internal._ansiballz._extensions import _pydevd, _coverage
|
|
10
|
+
from ansible.constants import config
|
|
11
|
+
|
|
12
|
+
_T = t.TypeVar('_T')
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class ExtensionManager:
|
|
16
|
+
"""AnsiballZ extension manager."""
|
|
17
|
+
|
|
18
|
+
def __init__(
|
|
19
|
+
self,
|
|
20
|
+
debugger: _pydevd.Options | None = None,
|
|
21
|
+
coverage: _coverage.Options | None = None,
|
|
22
|
+
) -> None:
|
|
23
|
+
options = dict(
|
|
24
|
+
_pydevd=debugger,
|
|
25
|
+
_coverage=coverage,
|
|
26
|
+
)
|
|
27
|
+
|
|
28
|
+
self._debugger = debugger
|
|
29
|
+
self._coverage = coverage
|
|
30
|
+
self._extension_names = tuple(name for name, option in options.items() if option)
|
|
31
|
+
self._module_names = tuple(f'{_extensions.__name__}.{name}' for name in self._extension_names)
|
|
32
|
+
|
|
33
|
+
self.source_mapping: dict[str, str] = {}
|
|
34
|
+
|
|
35
|
+
@property
|
|
36
|
+
def debugger_enabled(self) -> bool:
|
|
37
|
+
"""Returns True if the debugger extension is enabled, otherwise False."""
|
|
38
|
+
return bool(self._debugger)
|
|
39
|
+
|
|
40
|
+
@property
|
|
41
|
+
def extension_names(self) -> tuple[str, ...]:
|
|
42
|
+
"""Names of extensions to include in the AnsiballZ payload."""
|
|
43
|
+
return self._extension_names
|
|
44
|
+
|
|
45
|
+
@property
|
|
46
|
+
def module_names(self) -> tuple[str, ...]:
|
|
47
|
+
"""Python module names of extensions to include in the AnsiballZ payload."""
|
|
48
|
+
return self._module_names
|
|
49
|
+
|
|
50
|
+
def get_extensions(self) -> dict[str, dict[str, object]]:
|
|
51
|
+
"""Return the configured extensions and their options."""
|
|
52
|
+
extension_options: dict[str, t.Any] = {}
|
|
53
|
+
|
|
54
|
+
if self._debugger:
|
|
55
|
+
extension_options['_pydevd'] = dataclasses.replace(
|
|
56
|
+
self._debugger,
|
|
57
|
+
source_mapping=self._get_source_mapping(),
|
|
58
|
+
)
|
|
59
|
+
|
|
60
|
+
if self._coverage:
|
|
61
|
+
extension_options['_coverage'] = self._coverage
|
|
62
|
+
|
|
63
|
+
extensions = {extension: dataclasses.asdict(options) for extension, options in extension_options.items()}
|
|
64
|
+
|
|
65
|
+
return extensions
|
|
66
|
+
|
|
67
|
+
def _get_source_mapping(self) -> dict[str, str]:
|
|
68
|
+
"""Get the source mapping, adjusting the source root as needed."""
|
|
69
|
+
if self._debugger.source_mapping:
|
|
70
|
+
source_mapping = {self._translate_path(key): value for key, value in self.source_mapping.items()}
|
|
71
|
+
else:
|
|
72
|
+
source_mapping = self.source_mapping
|
|
73
|
+
|
|
74
|
+
return source_mapping
|
|
75
|
+
|
|
76
|
+
def _translate_path(self, path: str) -> str:
|
|
77
|
+
"""Translate a local path to a foreign path."""
|
|
78
|
+
for replace, match in self._debugger.source_mapping.items():
|
|
79
|
+
if path.startswith(match):
|
|
80
|
+
return replace + path[len(match) :]
|
|
81
|
+
|
|
82
|
+
return path
|
|
83
|
+
|
|
84
|
+
@classmethod
|
|
85
|
+
def create(cls, task_vars: dict[str, object]) -> t.Self:
|
|
86
|
+
"""Create an instance using the provided task vars."""
|
|
87
|
+
return cls(
|
|
88
|
+
debugger=cls._get_options('_ANSIBALLZ_DEBUGGER_CONFIG', _pydevd.Options, task_vars),
|
|
89
|
+
coverage=cls._get_options('_ANSIBALLZ_COVERAGE_CONFIG', _coverage.Options, task_vars),
|
|
90
|
+
)
|
|
91
|
+
|
|
92
|
+
@classmethod
|
|
93
|
+
def _get_options(cls, name: str, config_type: type[_T], task_vars: dict[str, object]) -> _T | None:
|
|
94
|
+
"""Parse configuration from the named environment variable as the specified type, or None if not configured."""
|
|
95
|
+
if (value := config.get_config_value(name, variables=task_vars)) is None:
|
|
96
|
+
return None
|
|
97
|
+
|
|
98
|
+
data = json.loads(value) if isinstance(value, str) else value
|
|
99
|
+
options = config_type(**data)
|
|
100
|
+
|
|
101
|
+
return options
|
|
@@ -0,0 +1,262 @@
|
|
|
1
|
+
# shebang placeholder
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import datetime
|
|
6
|
+
|
|
7
|
+
# For test-module.py script to tell this is a ANSIBALLZ_WRAPPER
|
|
8
|
+
_ANSIBALLZ_WRAPPER = True
|
|
9
|
+
|
|
10
|
+
# This code is part of Ansible, but is an independent component.
|
|
11
|
+
# The code in this particular templatable string, and this templatable string
|
|
12
|
+
# only, is BSD licensed. Modules which end up using this snippet, which is
|
|
13
|
+
# dynamically combined together by Ansible still belong to the author of the
|
|
14
|
+
# module, and they may assign their own license to the complete work.
|
|
15
|
+
#
|
|
16
|
+
# Copyright (c), James Cammarata, 2016
|
|
17
|
+
# Copyright (c), Toshio Kuratomi, 2016
|
|
18
|
+
#
|
|
19
|
+
# Redistribution and use in source and binary forms, with or without modification,
|
|
20
|
+
# are permitted provided that the following conditions are met:
|
|
21
|
+
#
|
|
22
|
+
# * Redistributions of source code must retain the above copyright
|
|
23
|
+
# notice, this list of conditions and the following disclaimer.
|
|
24
|
+
# * Redistributions in binary form must reproduce the above copyright notice,
|
|
25
|
+
# this list of conditions and the following disclaimer in the documentation
|
|
26
|
+
# and/or other materials provided with the distribution.
|
|
27
|
+
#
|
|
28
|
+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
29
|
+
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
30
|
+
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
31
|
+
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
32
|
+
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
33
|
+
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
34
|
+
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
35
|
+
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
|
36
|
+
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
def _ansiballz_main(
|
|
40
|
+
zip_data: str,
|
|
41
|
+
ansible_module: str,
|
|
42
|
+
module_fqn: str,
|
|
43
|
+
params: str,
|
|
44
|
+
profile: str,
|
|
45
|
+
date_time: datetime.datetime,
|
|
46
|
+
extensions: dict[str, dict[str, object]],
|
|
47
|
+
rlimit_nofile: int,
|
|
48
|
+
) -> None:
|
|
49
|
+
import os
|
|
50
|
+
import os.path
|
|
51
|
+
|
|
52
|
+
# Access to the working directory is required by Python when using pipelining, as well as for the coverage module.
|
|
53
|
+
# Some platforms, such as macOS, may not allow querying the working directory when using become to drop privileges.
|
|
54
|
+
try:
|
|
55
|
+
os.getcwd()
|
|
56
|
+
except OSError:
|
|
57
|
+
try:
|
|
58
|
+
os.chdir(os.path.expanduser('~'))
|
|
59
|
+
except OSError:
|
|
60
|
+
os.chdir('/')
|
|
61
|
+
|
|
62
|
+
if rlimit_nofile:
|
|
63
|
+
import resource
|
|
64
|
+
|
|
65
|
+
existing_soft, existing_hard = resource.getrlimit(resource.RLIMIT_NOFILE)
|
|
66
|
+
|
|
67
|
+
# adjust soft limit subject to existing hard limit
|
|
68
|
+
requested_soft = min(existing_hard, rlimit_nofile)
|
|
69
|
+
|
|
70
|
+
if requested_soft != existing_soft:
|
|
71
|
+
try:
|
|
72
|
+
resource.setrlimit(resource.RLIMIT_NOFILE, (requested_soft, existing_hard))
|
|
73
|
+
except ValueError:
|
|
74
|
+
# some platforms (eg macOS) lie about their hard limit
|
|
75
|
+
pass
|
|
76
|
+
|
|
77
|
+
import sys
|
|
78
|
+
import __main__
|
|
79
|
+
|
|
80
|
+
# For some distros and python versions we pick up this script in the temporary
|
|
81
|
+
# directory. This leads to problems when the ansible module masks a python
|
|
82
|
+
# library that another import needs. We have not figured out what about the
|
|
83
|
+
# specific distros and python versions causes this to behave differently.
|
|
84
|
+
#
|
|
85
|
+
# Tested distros:
|
|
86
|
+
# Fedora23 with python3.4 Works
|
|
87
|
+
# Ubuntu15.10 with python2.7 Works
|
|
88
|
+
# Ubuntu15.10 with python3.4 Fails without this
|
|
89
|
+
# Ubuntu16.04.1 with python3.5 Fails without this
|
|
90
|
+
# To test on another platform:
|
|
91
|
+
# * use the copy module (since this shadows the stdlib copy module)
|
|
92
|
+
# * Turn off pipelining
|
|
93
|
+
# * Make sure that the destination file does not exist
|
|
94
|
+
# * ansible ubuntu16-test -m copy -a 'src=/etc/motd dest=/var/tmp/m'
|
|
95
|
+
# This will traceback in shutil. Looking at the complete traceback will show
|
|
96
|
+
# that shutil is importing copy which finds the ansible module instead of the
|
|
97
|
+
# stdlib module
|
|
98
|
+
scriptdir = None
|
|
99
|
+
try:
|
|
100
|
+
scriptdir = os.path.dirname(os.path.realpath(__main__.__file__))
|
|
101
|
+
except (AttributeError, OSError):
|
|
102
|
+
# Some platforms don't set __file__ when reading from stdin
|
|
103
|
+
# OSX raises OSError if using abspath() in a directory we don't have
|
|
104
|
+
# permission to read (realpath calls abspath)
|
|
105
|
+
pass
|
|
106
|
+
|
|
107
|
+
# Strip cwd from sys.path to avoid potential permissions issues
|
|
108
|
+
excludes = {'', '.', scriptdir}
|
|
109
|
+
sys.path = [p for p in sys.path if p not in excludes]
|
|
110
|
+
|
|
111
|
+
import base64
|
|
112
|
+
import shutil
|
|
113
|
+
import tempfile
|
|
114
|
+
import zipfile
|
|
115
|
+
|
|
116
|
+
def invoke_module(modlib_path: str, json_params: bytes) -> None:
|
|
117
|
+
# When installed via setuptools (including python setup.py install),
|
|
118
|
+
# ansible may be installed with an easy-install.pth file. That file
|
|
119
|
+
# may load the system-wide install of ansible rather than the one in
|
|
120
|
+
# the module. sitecustomize is the only way to override that setting.
|
|
121
|
+
z = zipfile.ZipFile(modlib_path, mode='a')
|
|
122
|
+
|
|
123
|
+
# py3: modlib_path will be text, py2: it's bytes. Need bytes at the end
|
|
124
|
+
sitecustomize = u'import sys\\nsys.path.insert(0,"%s")\\n' % modlib_path
|
|
125
|
+
sitecustomize = sitecustomize.encode('utf-8')
|
|
126
|
+
# Use a ZipInfo to work around zipfile limitation on hosts with
|
|
127
|
+
# clocks set to a pre-1980 year (for instance, Raspberry Pi)
|
|
128
|
+
zinfo = zipfile.ZipInfo()
|
|
129
|
+
zinfo.filename = 'sitecustomize.py'
|
|
130
|
+
zinfo.date_time = date_time.utctimetuple()[:6]
|
|
131
|
+
z.writestr(zinfo, sitecustomize)
|
|
132
|
+
z.close()
|
|
133
|
+
|
|
134
|
+
# Put the zipped up module_utils we got from the controller first in the python path so that we
|
|
135
|
+
# can monkeypatch the right basic
|
|
136
|
+
sys.path.insert(0, modlib_path)
|
|
137
|
+
|
|
138
|
+
from ansible.module_utils._internal._ansiballz import _loader
|
|
139
|
+
|
|
140
|
+
_loader.run_module(
|
|
141
|
+
json_params=json_params,
|
|
142
|
+
profile=profile,
|
|
143
|
+
module_fqn=module_fqn,
|
|
144
|
+
modlib_path=modlib_path,
|
|
145
|
+
extensions=extensions,
|
|
146
|
+
)
|
|
147
|
+
|
|
148
|
+
def debug(command: str, modlib_path: str, json_params: bytes) -> None:
|
|
149
|
+
# The code here normally doesn't run. It's only used for debugging on the
|
|
150
|
+
# remote machine.
|
|
151
|
+
#
|
|
152
|
+
# The subcommands in this function make it easier to debug ansiballz
|
|
153
|
+
# modules. Here's the basic steps:
|
|
154
|
+
#
|
|
155
|
+
# Run ansible with the environment variable: ANSIBLE_KEEP_REMOTE_FILES=1 and -vvv
|
|
156
|
+
# to save the module file remotely::
|
|
157
|
+
# $ ANSIBLE_KEEP_REMOTE_FILES=1 ansible host1 -m ping -a 'data=october' -vvv
|
|
158
|
+
#
|
|
159
|
+
# Part of the verbose output will tell you where on the remote machine the
|
|
160
|
+
# module was written to::
|
|
161
|
+
# [...]
|
|
162
|
+
# <host1> SSH: EXEC ssh -C -q -o ControlMaster=auto -o ControlPersist=60s -o KbdInteractiveAuthentication=no -o
|
|
163
|
+
# PreferredAuthentications=gssapi-with-mic,gssapi-keyex,hostbased,publickey -o PasswordAuthentication=no -o ConnectTimeout=10 -o
|
|
164
|
+
# ControlPath=/home/badger/.ansible/cp/ansible-ssh-%h-%p-%r -tt rhel7 '/bin/sh -c '"'"'LANG=en_US.UTF-8 LC_ALL=en_US.UTF-8
|
|
165
|
+
# LC_MESSAGES=en_US.UTF-8 /usr/bin/python /home/badger/.ansible/tmp/ansible-tmp-1461173013.93-9076457629738/ping'"'"''
|
|
166
|
+
# [...]
|
|
167
|
+
#
|
|
168
|
+
# Login to the remote machine and run the module file via from the previous
|
|
169
|
+
# step with the explode subcommand to extract the module payload into
|
|
170
|
+
# source files::
|
|
171
|
+
# $ ssh host1
|
|
172
|
+
# $ /usr/bin/python /home/badger/.ansible/tmp/ansible-tmp-1461173013.93-9076457629738/ping explode
|
|
173
|
+
# Module expanded into:
|
|
174
|
+
# /home/badger/.ansible/tmp/ansible-tmp-1461173408.08-279692652635227/ansible
|
|
175
|
+
#
|
|
176
|
+
# You can now edit the source files to instrument the code or experiment with
|
|
177
|
+
# different parameter values. When you're ready to run the code you've modified
|
|
178
|
+
# (instead of the code from the actual zipped module), use the execute subcommand like this::
|
|
179
|
+
# $ /usr/bin/python /home/badger/.ansible/tmp/ansible-tmp-1461173013.93-9076457629738/ping execute
|
|
180
|
+
|
|
181
|
+
# Okay to use __file__ here because we're running from a kept file
|
|
182
|
+
basedir = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'debug_dir')
|
|
183
|
+
args_path = os.path.join(basedir, 'args')
|
|
184
|
+
|
|
185
|
+
if command == 'explode':
|
|
186
|
+
# transform the ZIPDATA into an exploded directory of code and then
|
|
187
|
+
# print the path to the code. This is an easy way for people to look
|
|
188
|
+
# at the code on the remote machine for debugging it in that
|
|
189
|
+
# environment
|
|
190
|
+
z = zipfile.ZipFile(modlib_path)
|
|
191
|
+
for filename in z.namelist():
|
|
192
|
+
if filename.startswith('/'):
|
|
193
|
+
raise Exception('Something wrong with this module zip file: should not contain absolute paths')
|
|
194
|
+
|
|
195
|
+
dest_filename = os.path.join(basedir, filename)
|
|
196
|
+
if dest_filename.endswith(os.path.sep) and not os.path.exists(dest_filename):
|
|
197
|
+
os.makedirs(dest_filename)
|
|
198
|
+
else:
|
|
199
|
+
directory = os.path.dirname(dest_filename)
|
|
200
|
+
if not os.path.exists(directory):
|
|
201
|
+
os.makedirs(directory)
|
|
202
|
+
with open(dest_filename, 'wb') as writer:
|
|
203
|
+
writer.write(z.read(filename))
|
|
204
|
+
|
|
205
|
+
# write the args file
|
|
206
|
+
with open(args_path, 'wb') as writer:
|
|
207
|
+
writer.write(json_params)
|
|
208
|
+
|
|
209
|
+
print('Module expanded into:')
|
|
210
|
+
print(basedir)
|
|
211
|
+
|
|
212
|
+
elif command == 'execute':
|
|
213
|
+
# Execute the exploded code instead of executing the module from the
|
|
214
|
+
# embedded ZIPDATA. This allows people to easily run their modified
|
|
215
|
+
# code on the remote machine to see how changes will affect it.
|
|
216
|
+
|
|
217
|
+
# Set pythonpath to the debug dir
|
|
218
|
+
sys.path.insert(0, basedir)
|
|
219
|
+
|
|
220
|
+
# read in the args file which the user may have modified
|
|
221
|
+
with open(args_path, 'rb') as reader:
|
|
222
|
+
json_params = reader.read()
|
|
223
|
+
|
|
224
|
+
from ansible.module_utils._internal._ansiballz import _loader
|
|
225
|
+
|
|
226
|
+
_loader.run_module(
|
|
227
|
+
json_params=json_params,
|
|
228
|
+
profile=profile,
|
|
229
|
+
module_fqn=module_fqn,
|
|
230
|
+
modlib_path=modlib_path,
|
|
231
|
+
extensions=extensions,
|
|
232
|
+
)
|
|
233
|
+
|
|
234
|
+
else:
|
|
235
|
+
print(f'FATAL: Unknown debug command {command!r}. Doing nothing.')
|
|
236
|
+
|
|
237
|
+
#
|
|
238
|
+
# See comments in the debug() method for information on debugging
|
|
239
|
+
#
|
|
240
|
+
|
|
241
|
+
encoded_params = params.encode()
|
|
242
|
+
|
|
243
|
+
# There's a race condition with the controller removing the
|
|
244
|
+
# remote_tmpdir and this module executing under async. So we cannot
|
|
245
|
+
# store this in remote_tmpdir (use system tempdir instead)
|
|
246
|
+
# Only need to use [ansible_module]_payload_ in the temp_path until we move to zipimport
|
|
247
|
+
# (this helps ansible-test produce coverage stats)
|
|
248
|
+
# IMPORTANT: The real path must be used here to ensure a remote debugger such as PyCharm (using pydevd) can resolve paths correctly.
|
|
249
|
+
temp_path = os.path.realpath(tempfile.mkdtemp(prefix='ansible_' + ansible_module + '_payload_'))
|
|
250
|
+
|
|
251
|
+
try:
|
|
252
|
+
zipped_mod = os.path.join(temp_path, 'ansible_' + ansible_module + '_payload.zip')
|
|
253
|
+
|
|
254
|
+
with open(zipped_mod, 'wb') as modlib:
|
|
255
|
+
modlib.write(base64.b64decode(zip_data))
|
|
256
|
+
|
|
257
|
+
if len(sys.argv) == 2:
|
|
258
|
+
debug(sys.argv[1], zipped_mod, encoded_params)
|
|
259
|
+
else:
|
|
260
|
+
invoke_module(zipped_mod, encoded_params)
|
|
261
|
+
finally:
|
|
262
|
+
shutil.rmtree(temp_path, ignore_errors=True)
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
from __future__ import annotations as _annotations
|
|
2
|
+
|
|
3
|
+
import collections.abc as _c
|
|
4
|
+
import typing as _t
|
|
5
|
+
|
|
6
|
+
_T_co = _t.TypeVar('_T_co', covariant=True)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class SequenceProxy(_c.Sequence[_T_co]):
|
|
10
|
+
"""A read-only sequence proxy."""
|
|
11
|
+
|
|
12
|
+
# DTFIX5: needs unit test coverage
|
|
13
|
+
|
|
14
|
+
__slots__ = ('__value',)
|
|
15
|
+
|
|
16
|
+
def __init__(self, value: _c.Sequence[_T_co]) -> None:
|
|
17
|
+
self.__value = value
|
|
18
|
+
|
|
19
|
+
@_t.overload
|
|
20
|
+
def __getitem__(self, index: int) -> _T_co: ...
|
|
21
|
+
|
|
22
|
+
@_t.overload
|
|
23
|
+
def __getitem__(self, index: slice) -> _c.Sequence[_T_co]: ...
|
|
24
|
+
|
|
25
|
+
def __getitem__(self, index: int | slice) -> _T_co | _c.Sequence[_T_co]:
|
|
26
|
+
if isinstance(index, slice):
|
|
27
|
+
return self.__class__(self.__value[index])
|
|
28
|
+
|
|
29
|
+
return self.__value[index]
|
|
30
|
+
|
|
31
|
+
def __len__(self) -> int:
|
|
32
|
+
return len(self.__value)
|
|
33
|
+
|
|
34
|
+
def __contains__(self, item: object) -> bool:
|
|
35
|
+
return item in self.__value
|
|
36
|
+
|
|
37
|
+
def __iter__(self) -> _t.Iterator[_T_co]:
|
|
38
|
+
yield from self.__value
|
|
39
|
+
|
|
40
|
+
def __reversed__(self) -> _c.Iterator[_T_co]:
|
|
41
|
+
return reversed(self.__value)
|
|
42
|
+
|
|
43
|
+
def index(self, *args) -> int:
|
|
44
|
+
return self.__value.index(*args)
|
|
45
|
+
|
|
46
|
+
def count(self, value: object) -> int:
|
|
47
|
+
return self.__value.count(value)
|
|
File without changes
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import dataclasses
|
|
4
|
+
import os
|
|
5
|
+
import types
|
|
6
|
+
import typing as t
|
|
7
|
+
|
|
8
|
+
from ansible.module_utils._internal._datatag import _tag_dataclass_kwargs, AnsibleDatatagBase, AnsibleSingletonTagBase
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
@dataclasses.dataclass(**_tag_dataclass_kwargs)
|
|
12
|
+
class Origin(AnsibleDatatagBase):
|
|
13
|
+
"""
|
|
14
|
+
A tag that stores origin metadata for a tagged value, intended for forensic/diagnostic use.
|
|
15
|
+
Origin metadata should not be used to make runtime decisions, as it is not guaranteed to be present or accurate.
|
|
16
|
+
Setting both `path` and `line_num` can result in diagnostic display of referenced file contents.
|
|
17
|
+
Either `path` or `description` must be present.
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
path: str | None = None
|
|
21
|
+
"""The path from which the tagged content originated."""
|
|
22
|
+
description: str | None = None
|
|
23
|
+
"""A description of the origin, for display to users."""
|
|
24
|
+
line_num: int | None = None
|
|
25
|
+
"""An optional line number, starting at 1."""
|
|
26
|
+
col_num: int | None = None
|
|
27
|
+
"""An optional column number, starting at 1."""
|
|
28
|
+
|
|
29
|
+
UNKNOWN: t.ClassVar[t.Self]
|
|
30
|
+
|
|
31
|
+
@classmethod
|
|
32
|
+
def get_or_create_tag(cls, value: t.Any, path: str | os.PathLike | None) -> Origin:
|
|
33
|
+
"""Return the tag from the given value, creating a tag from the provided path if no tag was found."""
|
|
34
|
+
if not (origin := cls.get_tag(value)):
|
|
35
|
+
if path:
|
|
36
|
+
origin = Origin(path=str(path)) # convert tagged strings and path-like values to a native str
|
|
37
|
+
else:
|
|
38
|
+
origin = Origin.UNKNOWN
|
|
39
|
+
|
|
40
|
+
return origin
|
|
41
|
+
|
|
42
|
+
def replace(
|
|
43
|
+
self,
|
|
44
|
+
path: str | types.EllipsisType = ...,
|
|
45
|
+
description: str | types.EllipsisType = ...,
|
|
46
|
+
line_num: int | None | types.EllipsisType = ...,
|
|
47
|
+
col_num: int | None | types.EllipsisType = ...,
|
|
48
|
+
) -> t.Self:
|
|
49
|
+
"""Return a new origin based on an existing one, with the given fields replaced."""
|
|
50
|
+
return dataclasses.replace(
|
|
51
|
+
self,
|
|
52
|
+
**{
|
|
53
|
+
key: value
|
|
54
|
+
for key, value in dict(
|
|
55
|
+
path=path,
|
|
56
|
+
description=description,
|
|
57
|
+
line_num=line_num,
|
|
58
|
+
col_num=col_num,
|
|
59
|
+
).items()
|
|
60
|
+
if value is not ...
|
|
61
|
+
}, # type: ignore[arg-type]
|
|
62
|
+
)
|
|
63
|
+
|
|
64
|
+
def _post_validate(self) -> None:
|
|
65
|
+
if self.path:
|
|
66
|
+
if not self.path.startswith('/'):
|
|
67
|
+
raise RuntimeError('The `src` field must be an absolute path.')
|
|
68
|
+
elif not self.description:
|
|
69
|
+
raise RuntimeError('The `src` or `description` field must be specified.')
|
|
70
|
+
|
|
71
|
+
def __str__(self) -> str:
|
|
72
|
+
"""Renders the origin in the form of path:line_num:col_num, omitting missing/invalid elements from the right."""
|
|
73
|
+
if self.path:
|
|
74
|
+
value = self.path
|
|
75
|
+
else:
|
|
76
|
+
value = self.description
|
|
77
|
+
|
|
78
|
+
if self.line_num and self.line_num > 0:
|
|
79
|
+
value += f':{self.line_num}'
|
|
80
|
+
|
|
81
|
+
if self.col_num and self.col_num > 0:
|
|
82
|
+
value += f':{self.col_num}'
|
|
83
|
+
|
|
84
|
+
if self.path and self.description:
|
|
85
|
+
value += f' ({self.description})'
|
|
86
|
+
|
|
87
|
+
return value
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
Origin.UNKNOWN = Origin(description='<unknown>')
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
@dataclasses.dataclass(**_tag_dataclass_kwargs)
|
|
94
|
+
class VaultedValue(AnsibleDatatagBase):
|
|
95
|
+
"""Tag for vault-encrypted strings that carries the original ciphertext for round-tripping."""
|
|
96
|
+
|
|
97
|
+
ciphertext: str
|
|
98
|
+
|
|
99
|
+
def _get_tag_to_propagate(self, src: t.Any, value: object, *, value_type: t.Optional[type] = None) -> t.Self | None:
|
|
100
|
+
# Since VaultedValue stores the encrypted representation of the value on which it is tagged,
|
|
101
|
+
# it is incorrect to propagate the tag to a value which is not equal to the original.
|
|
102
|
+
# If the tag were copied to another value and subsequently serialized as the original encrypted value,
|
|
103
|
+
# the result would then differ from the value on which the tag was applied.
|
|
104
|
+
|
|
105
|
+
# Comparisons which can trigger an exception are indicative of a bug and should not be handled here.
|
|
106
|
+
# For example:
|
|
107
|
+
# * When `src` is an undecryptable `EncryptedString` -- it is not valid to apply this tag to that type.
|
|
108
|
+
# * When `value` is a `Marker` -- this requires a templating, but vaulted values do not support templating.
|
|
109
|
+
|
|
110
|
+
if src == value: # assume the tag was correctly applied to src
|
|
111
|
+
return self # same plaintext value, tag propagation with same ciphertext is safe
|
|
112
|
+
|
|
113
|
+
return self.get_tag(value) # different value, preserve the existing tag, if any
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
@dataclasses.dataclass(**_tag_dataclass_kwargs)
|
|
117
|
+
class TrustedAsTemplate(AnsibleSingletonTagBase):
|
|
118
|
+
"""
|
|
119
|
+
Indicates the tagged string is trusted to parse and render as a template.
|
|
120
|
+
Do *NOT* apply this tag to data from untrusted sources, as this would allow code injection during templating.
|
|
121
|
+
"""
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
@dataclasses.dataclass(**_tag_dataclass_kwargs)
|
|
125
|
+
class SourceWasEncrypted(AnsibleSingletonTagBase):
|
|
126
|
+
"""
|
|
127
|
+
For internal use only.
|
|
128
|
+
Indicates the tagged value was sourced from an encrypted file.
|
|
129
|
+
Currently applied only by DataLoader.get_text_file_contents() and by extension DataLoader.load_from_file().
|
|
130
|
+
"""
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from ansible.module_utils._internal._datatag import AnsibleTagHelper
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
def str_problematic_strip(value: str) -> str:
|
|
7
|
+
"""
|
|
8
|
+
Return a copy of `value` with leading and trailing whitespace removed.
|
|
9
|
+
Used where `str.strip` is needed, but tags must be preserved *AND* the stripping behavior likely shouldn't exist.
|
|
10
|
+
If the stripping behavior is non-problematic, use `AnsibleTagHelper.tag_copy` around `str.strip` instead.
|
|
11
|
+
"""
|
|
12
|
+
if (stripped_value := value.strip()) == value:
|
|
13
|
+
return value
|
|
14
|
+
|
|
15
|
+
# FUTURE: consider deprecating some/all usages of this method; they generally imply a code smell or pattern we shouldn't be supporting
|
|
16
|
+
|
|
17
|
+
stripped_value = AnsibleTagHelper.tag_copy(value, stripped_value)
|
|
18
|
+
|
|
19
|
+
return stripped_value
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import io
|
|
4
|
+
import typing as _t
|
|
5
|
+
|
|
6
|
+
from .._wrapt import ObjectProxy
|
|
7
|
+
from ...module_utils._internal import _datatag
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class TaggedStreamWrapper(ObjectProxy):
|
|
11
|
+
"""
|
|
12
|
+
Janky proxy around IOBase to allow streams to carry tags and support basic interrogation by the tagging API.
|
|
13
|
+
Most tagging operations will have undefined behavior for this type.
|
|
14
|
+
"""
|
|
15
|
+
|
|
16
|
+
_self__ansible_tags_mapping: _datatag._AnsibleTagsMapping
|
|
17
|
+
|
|
18
|
+
def __init__(self, stream: io.IOBase, tags: _datatag.AnsibleDatatagBase | _t.Iterable[_datatag.AnsibleDatatagBase]) -> None:
|
|
19
|
+
super().__init__(stream)
|
|
20
|
+
|
|
21
|
+
tag_list: list[_datatag.AnsibleDatatagBase]
|
|
22
|
+
|
|
23
|
+
# noinspection PyProtectedMember
|
|
24
|
+
if type(tags) in _datatag._known_tag_types:
|
|
25
|
+
tag_list = [tags] # type: ignore[list-item]
|
|
26
|
+
else:
|
|
27
|
+
tag_list = list(tags) # type: ignore[arg-type]
|
|
28
|
+
|
|
29
|
+
self._self__ansible_tags_mapping = _datatag._AnsibleTagsMapping((type(tag), tag) for tag in tag_list)
|
|
30
|
+
|
|
31
|
+
@property
|
|
32
|
+
def _ansible_tags_mapping(self) -> _datatag._AnsibleTagsMapping:
|
|
33
|
+
return self._self__ansible_tags_mapping
|
|
File without changes
|