From bcd6e574502e96552330822c1a2be978ab59e68b Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sat, 1 Feb 2025 23:14:19 +0100 Subject: [PATCH] Vendored Docker SDK for Python code: remove unused constants (#1037) * Remove constants that are never used. * Adjust unit tests. --- plugins/module_utils/_api/constants.py | 4 ---- .../plugins/module_utils/_api/api/test_client.py | 4 ++-- tests/unit/plugins/module_utils/_api/constants.py | 13 +++++++++++++ tests/unit/plugins/module_utils/_api/fake_api.py | 3 ++- .../module_utils/_api/utils/test_decorators.py | 2 +- .../plugins/module_utils/_api/utils/test_utils.py | 3 ++- 6 files changed, 20 insertions(+), 9 deletions(-) create mode 100644 tests/unit/plugins/module_utils/_api/constants.py diff --git a/plugins/module_utils/_api/constants.py b/plugins/module_utils/_api/constants.py index 23e10b13..f1340cbf 100644 --- a/plugins/module_utils/_api/constants.py +++ b/plugins/module_utils/_api/constants.py @@ -12,7 +12,6 @@ __metaclass__ = type import sys -DEFAULT_DOCKER_API_VERSION = '1.41' MINIMUM_DOCKER_API_VERSION = '1.21' DEFAULT_TIMEOUT_SECONDS = 60 STREAM_HEADER_SIZE_BYTES = 8 @@ -45,6 +44,3 @@ DEFAULT_NUM_POOLS_SSH = 9 DEFAULT_MAX_POOL_SIZE = 10 DEFAULT_DATA_CHUNK_SIZE = 1024 * 2048 - -DEFAULT_SWARM_ADDR_POOL = ['10.0.0.0/8'] -DEFAULT_SWARM_SUBNET_SIZE = 24 diff --git a/tests/unit/plugins/module_utils/_api/api/test_client.py b/tests/unit/plugins/module_utils/_api/api/test_client.py index 87769a3c..5b39980d 100644 --- a/tests/unit/plugins/module_utils/_api/api/test_client.py +++ b/tests/unit/plugins/module_utils/_api/api/test_client.py @@ -34,7 +34,7 @@ if sys.version_info < (2, 7): from ansible_collections.community.docker.plugins.module_utils._api import constants, errors from ansible_collections.community.docker.plugins.module_utils._api.api.client import APIClient -from ansible_collections.community.docker.plugins.module_utils._api.constants import DEFAULT_DOCKER_API_VERSION +from ansible_collections.community.docker.tests.unit.plugins.module_utils._api.constants import DEFAULT_DOCKER_API_VERSION from requests.packages import urllib3 from .. import fake_api @@ -109,7 +109,7 @@ def fake_read_from_socket(self, response, stream, tty=False, demux=False): url_base = '{prefix}/'.format(prefix=fake_api.prefix) url_prefix = '{0}v{1}/'.format( url_base, - constants.DEFAULT_DOCKER_API_VERSION) + DEFAULT_DOCKER_API_VERSION) class BaseAPIClientTest(unittest.TestCase): diff --git a/tests/unit/plugins/module_utils/_api/constants.py b/tests/unit/plugins/module_utils/_api/constants.py new file mode 100644 index 00000000..f2d32288 --- /dev/null +++ b/tests/unit/plugins/module_utils/_api/constants.py @@ -0,0 +1,13 @@ +# -*- coding: utf-8 -*- +# This code is part of the Ansible collection community.docker, but is an independent component. +# This particular file, and this file only, is based on the Docker SDK for Python (https://github.com/docker/docker-py/) +# +# Copyright (c) 2016-2022 Docker, Inc. +# +# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) +# SPDX-License-Identifier: Apache-2.0 + +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +DEFAULT_DOCKER_API_VERSION = '1.45' diff --git a/tests/unit/plugins/module_utils/_api/fake_api.py b/tests/unit/plugins/module_utils/_api/fake_api.py index b794ff3d..9a312f9b 100644 --- a/tests/unit/plugins/module_utils/_api/fake_api.py +++ b/tests/unit/plugins/module_utils/_api/fake_api.py @@ -11,10 +11,11 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type from ansible_collections.community.docker.plugins.module_utils._api import constants +from ansible_collections.community.docker.tests.unit.plugins.module_utils._api.constants import DEFAULT_DOCKER_API_VERSION from . import fake_stat -CURRENT_VERSION = 'v{api_version}'.format(api_version=constants.DEFAULT_DOCKER_API_VERSION) +CURRENT_VERSION = 'v{api_version}'.format(api_version=DEFAULT_DOCKER_API_VERSION) FAKE_CONTAINER_ID = '3cc2351ab11b' FAKE_IMAGE_ID = 'e9aa60c60128' diff --git a/tests/unit/plugins/module_utils/_api/utils/test_decorators.py b/tests/unit/plugins/module_utils/_api/utils/test_decorators.py index 8ba1ec5f..621f2825 100644 --- a/tests/unit/plugins/module_utils/_api/utils/test_decorators.py +++ b/tests/unit/plugins/module_utils/_api/utils/test_decorators.py @@ -19,8 +19,8 @@ if sys.version_info < (2, 7): pytestmark = pytest.mark.skip('Python 2.6 is not supported') from ansible_collections.community.docker.plugins.module_utils._api.api.client import APIClient -from ansible_collections.community.docker.plugins.module_utils._api.constants import DEFAULT_DOCKER_API_VERSION from ansible_collections.community.docker.plugins.module_utils._api.utils.decorators import update_headers +from ansible_collections.community.docker.tests.unit.plugins.module_utils._api.constants import DEFAULT_DOCKER_API_VERSION class DecoratorsTest(unittest.TestCase): diff --git a/tests/unit/plugins/module_utils/_api/utils/test_utils.py b/tests/unit/plugins/module_utils/_api/utils/test_utils.py index cc0dc695..8e4d72d0 100644 --- a/tests/unit/plugins/module_utils/_api/utils/test_utils.py +++ b/tests/unit/plugins/module_utils/_api/utils/test_utils.py @@ -27,7 +27,7 @@ if sys.version_info < (2, 7): pytestmark = pytest.mark.skip('Python 2.6 is not supported') from ansible_collections.community.docker.plugins.module_utils._api.api.client import APIClient -from ansible_collections.community.docker.plugins.module_utils._api.constants import IS_WINDOWS_PLATFORM, DEFAULT_DOCKER_API_VERSION +from ansible_collections.community.docker.plugins.module_utils._api.constants import IS_WINDOWS_PLATFORM from ansible_collections.community.docker.plugins.module_utils._api.errors import DockerException from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( convert_filters, convert_volume_binds, @@ -35,6 +35,7 @@ from ansible_collections.community.docker.plugins.module_utils._api.utils.utils parse_devices, parse_env_file, parse_host, parse_repository_tag, split_command, format_environment, ) +from ansible_collections.community.docker.tests.unit.plugins.module_utils._api.constants import DEFAULT_DOCKER_API_VERSION TEST_CERT_DIR = os.path.join(