Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only emit tls_hostname deprecation warning if TLS is actually used #143

Merged
merged 2 commits into from
May 17, 2021
Merged

Only emit tls_hostname deprecation warning if TLS is actually used #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dae8863
Only emit tls_hostname deprecation warning if TLS is actually used.
felixfontein May 16, 2021
fe8f6f8
Linting.
felixfontein May 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelogs/fragments/143-tls_hostname-deprecation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
bugfixes:
- "docker_* modules and plugins, except ``docker_swarm`` connection plugin and ``docker_compose`` and ``docker_stack*` modules - only emit ``tls_hostname`` deprecation message if TLS is actually used (https://github.com/ansible-collections/community.docker/pull/143)."
12 changes: 8 additions & 4 deletions plugins/module_utils/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,11 @@ def log(self, msg, pretty_print=False):
# log_file.write(msg + u'\n')


def update_tls_hostname(result, old_behavior=False, deprecate_function=None):
def update_tls_hostname(result, old_behavior=False, deprecate_function=None, uses_tls=True):
if result['tls_hostname'] is None:
if old_behavior:
result['tls_hostname'] = DEFAULT_TLS_HOSTNAME
if deprecate_function is not None:
if uses_tls and deprecate_function is not None:
deprecate_function(
'The default value "localhost" for tls_hostname is deprecated and will be removed in community.docker 2.0.0.'
' From then on, docker_host will be used to compute tls_hostname. If you want to keep using "localhost",'
Expand All @@ -200,8 +200,12 @@ def _get_tls_config(fail_function, **kwargs):
fail_function("TLS config error: %s" % exc)


def is_using_tls(auth):
return auth['tls_verify'] or auth['tls']


def get_connect_params(auth, fail_function):
if auth['tls'] or auth['tls_verify']:
if is_using_tls(auth):
auth['docker_host'] = auth['docker_host'].replace('tcp://', 'https://')

result = dict(
Expand Down Expand Up @@ -391,7 +395,7 @@ def auth_params(self):
def depr(*args, **kwargs):
self.deprecate(*args, **kwargs)

update_tls_hostname(result, old_behavior=True, deprecate_function=depr)
update_tls_hostname(result, old_behavior=True, deprecate_function=depr, uses_tls=is_using_tls(result))

return result

Expand Down