From ee630ab593b2f0e08acf5a9c22abdee53001591f Mon Sep 17 00:00:00 2001 From: Jacek Gruzewski Date: Fri, 10 Mar 2023 15:35:18 +0000 Subject: [PATCH 1/7] refactor: replace distutils' copy_tree with shutil copytree --- kapitan/initialiser.py | 22 +++++++----- kapitan/utils.py | 19 ++++++++++ tests/test_utils.py | 81 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 113 insertions(+), 9 deletions(-) create mode 100644 tests/test_utils.py diff --git a/kapitan/initialiser.py b/kapitan/initialiser.py index 1f3f3c4c5..c593990b2 100644 --- a/kapitan/initialiser.py +++ b/kapitan/initialiser.py @@ -9,30 +9,34 @@ import logging import os -from distutils.dir_util import copy_tree +from pathlib import Path + +from kapitan.utils import copy_tree logger = logging.getLogger(__name__) def initialise_skeleton(args): - """Initialises a directory with a recommended skeleton structure + """Initialises a directory with a recommended skeleton structure and prints list of + copied files. + Args: - args.directory (string): path which to initialise, directory is assumed to exist + args.directory (string): path which to initialise, directory is assumed to exist. """ + templates = Path(__file__).resolve().parent.joinpath("inputs", "templates") + destination = Path(args.directory) + copied_files = copy_tree(source=templates, destination=destination, dirs_exist_ok=True) - current_pwd = os.path.dirname(__file__) - templates_directory = os.path.join(current_pwd, "inputs", "templates") - populated = copy_tree(templates_directory, args.directory) logger.info("Populated %s with:", args.directory) - for directory, subs, file_list in os.walk(args.directory): + for directory, _, file_list in os.walk(args.directory): # In order to avoid adding the given directory itself in listing. if directory == args.directory: continue - if any([path.startswith(directory) for path in populated]): + if any([path.startswith(directory) for path in copied_files]): level = directory.replace(args.directory, "").count(os.sep) - 1 indent = " " * 4 * (level) logger.info("%s%s", indent, os.path.basename(directory)) for fname in file_list: - if os.path.join(directory, fname) in populated: + if os.path.join(directory, fname) in copied_files: sub_indent = " " * 4 * (level + 1) logger.info("%s%s", sub_indent, fname) diff --git a/kapitan/utils.py b/kapitan/utils.py index 90699d59e..db3ed67d8 100644 --- a/kapitan/utils.py +++ b/kapitan/utils.py @@ -23,6 +23,9 @@ from distutils.file_util import _copy_file_contents from functools import lru_cache, wraps from hashlib import sha256 +from pathlib import Path +from shutil import copytree +from typing import List from zipfile import ZipFile import jinja2 @@ -631,3 +634,19 @@ def safe_copy_tree(src, dst): outputs.append(dst_name) return outputs + + +def copy_tree(source: Path, destination: Path, dirs_exist_ok: bool = False) -> List[str]: + """Recursively copy a given directory from `source` to `destination` using shutil.copytree + and return list of copied files. When `dirs_exist_ok` is set, the `FileExistsError` is + ignored when destination directory exists. + Args: + source (str): Path to a source directory + destination (str): Path to a destination directory + Returns: + list[str]: List of copied files + """ + inventory_before = list(destination.rglob("*")) + copytree(source, destination, dirs_exist_ok=dirs_exist_ok) + inventory_after = list(destination.rglob("*")) + return [str(d) for d in inventory_after if d not in inventory_before] diff --git a/tests/test_utils.py b/tests/test_utils.py new file mode 100644 index 000000000..a33874a9a --- /dev/null +++ b/tests/test_utils.py @@ -0,0 +1,81 @@ +#!/usr/bin/env python3 + +# Copyright 2019 The Kapitan Authors +# SPDX-FileCopyrightText: 2020 The Kapitan Authors +# +# SPDX-License-Identifier: Apache-2.0 + +from pathlib import Path +import tempfile +from typing import List +import unittest + +from kapitan.utils import copy_tree + + +class CopytreeTest(unittest.TestCase): + def _create_directory_structure(self, root: Path, structure: List[str]): + for sub_path in structure: + full_path = root / sub_path + full_path.parent.mkdir(parents=True, exist_ok=True) + full_path.touch(exist_ok=True) + + def setUp(self): + self.template_structure = [ + "components/my_component/my_component.jsonnet", + "components/other_component/__init__.py", + "inventory/classes/common.yml", + "inventory/classes/my_component.yml", + "templates/docs/my_readme.md", + "templates/scripts/my_script.sh", + ] + self.template_directory = tempfile.TemporaryDirectory() + self.template_directory_path = Path(self.template_directory.name) + + self._create_directory_structure(self.template_directory_path, self.template_structure) + + def tearDown(self): + self.template_directory.cleanup() + + def test_empty_dir(self): + """Validates that all template files were copied to the correct directory and + the right list of copied files was returned.""" + with tempfile.TemporaryDirectory() as destination_directory: + template_files = [destination_directory + "/" + f for f in self.template_structure] + + copied_paths = copy_tree( + source=self.template_directory_path, + destination=Path(destination_directory), + dirs_exist_ok=True, + ) + # We only care about files as they will have full path anyway. + copied_files = [p for p in copied_paths if Path(p).is_file()] + + self.assertSequenceEqual(sorted(copied_files), sorted(template_files)) + self.assertTrue([Path(f).exists() for f in template_files]) + + def test_non_empty_dir(self): + """Makes sure that existing directories and files are untouched.""" + with tempfile.TemporaryDirectory() as destination_directory: + extra_files = [ + "file_that_existed_before.txt", + "this_existed_before/file.txt", + ] + self._create_directory_structure(Path(destination_directory), extra_files) + template_files = [destination_directory + "/" + f for f in self.template_structure] + + copied_paths = copy_tree( + source=self.template_directory_path, + destination=Path(destination_directory), + dirs_exist_ok=True, + ) + # We only care about files as they will have full path anyway. + copied_files = [p for p in copied_paths if Path(p).is_file()] + + self.assertSequenceEqual(sorted(copied_files), sorted(template_files)) + self.assertTrue([Path(f).exists() for f in template_files]) + self.assertTrue([Path(destination_directory + "/" + f).exists() for f in extra_files]) + + +if __name__ == "__main__": + unittest.main() From 6f4aefb49c6e59e7d0fc377e9aad664f1b917b50 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 30 Jan 2024 08:41:33 +0000 Subject: [PATCH 2/7] chore: bump docker from 6.1.3 to 7.0.0 Bumps [docker](https://github.com/docker/docker-py) from 6.1.3 to 7.0.0. - [Release notes](https://github.com/docker/docker-py/releases) - [Commits](https://github.com/docker/docker-py/compare/6.1.3...7.0.0) --- updated-dependencies: - dependency-name: docker dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- poetry.lock | 49 +++++++++++++++++++++++++++---------------------- pyproject.toml | 2 +- 2 files changed, 28 insertions(+), 23 deletions(-) diff --git a/poetry.lock b/poetry.lock index eed4c2b34..3d4cb163b 100644 --- a/poetry.lock +++ b/poetry.lock @@ -388,13 +388,13 @@ test-randomorder = ["pytest-randomly"] [[package]] name = "docker" -version = "6.1.3" +version = "7.0.0" description = "A Python library for the Docker Engine API." optional = true -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "docker-6.1.3-py3-none-any.whl", hash = "sha256:aecd2277b8bf8e506e484f6ab7aec39abe0038e29fa4a6d3ba86c3fe01844ed9"}, - {file = "docker-6.1.3.tar.gz", hash = "sha256:aa6d17830045ba5ef0168d5eaa34d37beeb113948c413affe1d5991fc11f9a20"}, + {file = "docker-7.0.0-py3-none-any.whl", hash = "sha256:12ba681f2777a0ad28ffbcc846a69c31b4dfd9752b47eb425a274ee269c5e14b"}, + {file = "docker-7.0.0.tar.gz", hash = "sha256:323736fb92cd9418fc5e7133bc953e11a9da04f4483f828b527db553f1e7e5a3"}, ] [package.dependencies] @@ -402,10 +402,10 @@ packaging = ">=14.0" pywin32 = {version = ">=304", markers = "sys_platform == \"win32\""} requests = ">=2.26.0" urllib3 = ">=1.26.0" -websocket-client = ">=0.32.0" [package.extras] ssh = ["paramiko (>=2.4.3)"] +websockets = ["websocket-client (>=1.3.0)"] [[package]] name = "exceptiongroup" @@ -728,6 +728,16 @@ files = [ {file = "MarkupSafe-2.1.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:5bbe06f8eeafd38e5d0a4894ffec89378b6c6a625ff57e3028921f8ff59318ac"}, {file = "MarkupSafe-2.1.3-cp311-cp311-win32.whl", hash = "sha256:dd15ff04ffd7e05ffcb7fe79f1b98041b8ea30ae9234aed2a9168b5797c3effb"}, {file = "MarkupSafe-2.1.3-cp311-cp311-win_amd64.whl", hash = "sha256:134da1eca9ec0ae528110ccc9e48041e0828d79f24121a1a146161103c76e686"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:f698de3fd0c4e6972b92290a45bd9b1536bffe8c6759c62471efaa8acb4c37bc"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:aa57bd9cf8ae831a362185ee444e15a93ecb2e344c8e52e4d721ea3ab6ef1823"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ffcc3f7c66b5f5b7931a5aa68fc9cecc51e685ef90282f4a82f0f5e9b704ad11"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:47d4f1c5f80fc62fdd7777d0d40a2e9dda0a05883ab11374334f6c4de38adffd"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1f67c7038d560d92149c060157d623c542173016c4babc0c1913cca0564b9939"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:9aad3c1755095ce347e26488214ef77e0485a3c34a50c5a5e2471dff60b9dd9c"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:14ff806850827afd6b07a5f32bd917fb7f45b046ba40c57abdb636674a8b559c"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8f9293864fe09b8149f0cc42ce56e3f0e54de883a9de90cd427f191c346eb2e1"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-win32.whl", hash = "sha256:715d3562f79d540f251b99ebd6d8baa547118974341db04f5ad06d5ea3eb8007"}, + {file = "MarkupSafe-2.1.3-cp312-cp312-win_amd64.whl", hash = "sha256:1b8dd8c3fd14349433c79fa8abeb573a55fc0fdd769133baac1f5e07abf54aeb"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:8e254ae696c88d98da6555f5ace2279cf7cd5b3f52be2b5cf97feafe883b58d2"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cb0932dc158471523c9637e807d9bfb93e06a95cbf010f1a38b98623b929ef2b"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9402b03f1a1b4dc4c19845e5c749e3ab82d5078d16a2a4c2cd2df62d57bb0707"}, @@ -1094,6 +1104,7 @@ files = [ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, + {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, @@ -1101,8 +1112,16 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, + {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, + {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, + {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, + {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, @@ -1119,6 +1138,7 @@ files = [ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, + {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, @@ -1126,6 +1146,7 @@ files = [ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, + {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, @@ -1407,22 +1428,6 @@ secure = ["certifi", "cryptography (>=1.9)", "idna (>=2.0.0)", "pyopenssl (>=17. socks = ["pysocks (>=1.5.6,!=1.5.7,<2.0)"] zstd = ["zstandard (>=0.18.0)"] -[[package]] -name = "websocket-client" -version = "1.7.0" -description = "WebSocket client for Python with low level API options" -optional = true -python-versions = ">=3.8" -files = [ - {file = "websocket-client-1.7.0.tar.gz", hash = "sha256:10e511ea3a8c744631d3bd77e61eb17ed09304c413ad42cf6ddfa4c7787e8fe6"}, - {file = "websocket_client-1.7.0-py3-none-any.whl", hash = "sha256:f4c3d22fec12a2461427a29957ff07d35098ee2d976d3ba244e688b8b4057588"}, -] - -[package.extras] -docs = ["Sphinx (>=6.0)", "sphinx-rtd-theme (>=1.1.0)"] -optional = ["python-socks", "wsaccel"] -test = ["websockets"] - [[package]] name = "yamllint" version = "1.33.0" @@ -1448,4 +1453,4 @@ test = ["docker"] [metadata] lock-version = "2.0" python-versions = "^3.10" -content-hash = "ac3fdfcfc318acd09a1e0113a1b50fe7059aa20afd0673b24c6a874bf9144ac4" +content-hash = "9702cab37a1a4e5f2d29fdd23503b299331fc1fb7cae5e7cc222cd88909b96e1" diff --git a/pyproject.toml b/pyproject.toml index 0ac05cc67..f7c3d8935 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -62,7 +62,7 @@ gitdb = "^4.0.10" packaging = "^23.0" typing-extensions = "^4.0.0" gojsonnet = { version = "^0.20.0", optional = true } -docker = { version = ">=5,<7", optional = true } +docker = { version = ">=5,<8", optional = true } [tool.poetry.extras] gojsonnet = ["gojsonnet"] From 99658cb6ae7fc9f4cc05ffdfb2de817cfbdbf5de Mon Sep 17 00:00:00 2001 From: Alessandro De Maria Date: Sun, 4 Feb 2024 12:38:26 +0000 Subject: [PATCH 3/7] Revert "refactor: replace distutils' copy_tree with shutil copytree" --- kapitan/initialiser.py | 22 +++++------- kapitan/utils.py | 19 ---------- tests/test_utils.py | 81 ------------------------------------------ 3 files changed, 9 insertions(+), 113 deletions(-) delete mode 100644 tests/test_utils.py diff --git a/kapitan/initialiser.py b/kapitan/initialiser.py index c593990b2..1f3f3c4c5 100644 --- a/kapitan/initialiser.py +++ b/kapitan/initialiser.py @@ -9,34 +9,30 @@ import logging import os -from pathlib import Path - -from kapitan.utils import copy_tree +from distutils.dir_util import copy_tree logger = logging.getLogger(__name__) def initialise_skeleton(args): - """Initialises a directory with a recommended skeleton structure and prints list of - copied files. - + """Initialises a directory with a recommended skeleton structure Args: - args.directory (string): path which to initialise, directory is assumed to exist. + args.directory (string): path which to initialise, directory is assumed to exist """ - templates = Path(__file__).resolve().parent.joinpath("inputs", "templates") - destination = Path(args.directory) - copied_files = copy_tree(source=templates, destination=destination, dirs_exist_ok=True) + current_pwd = os.path.dirname(__file__) + templates_directory = os.path.join(current_pwd, "inputs", "templates") + populated = copy_tree(templates_directory, args.directory) logger.info("Populated %s with:", args.directory) - for directory, _, file_list in os.walk(args.directory): + for directory, subs, file_list in os.walk(args.directory): # In order to avoid adding the given directory itself in listing. if directory == args.directory: continue - if any([path.startswith(directory) for path in copied_files]): + if any([path.startswith(directory) for path in populated]): level = directory.replace(args.directory, "").count(os.sep) - 1 indent = " " * 4 * (level) logger.info("%s%s", indent, os.path.basename(directory)) for fname in file_list: - if os.path.join(directory, fname) in copied_files: + if os.path.join(directory, fname) in populated: sub_indent = " " * 4 * (level + 1) logger.info("%s%s", sub_indent, fname) diff --git a/kapitan/utils.py b/kapitan/utils.py index af947f389..5d7e3418b 100644 --- a/kapitan/utils.py +++ b/kapitan/utils.py @@ -23,9 +23,6 @@ from distutils.file_util import _copy_file_contents from functools import lru_cache, wraps from hashlib import sha256 -from pathlib import Path -from shutil import copytree -from typing import List from zipfile import ZipFile import jinja2 @@ -631,19 +628,3 @@ def safe_copy_tree(src, dst): outputs.append(dst_name) return outputs - - -def copy_tree(source: Path, destination: Path, dirs_exist_ok: bool = False) -> List[str]: - """Recursively copy a given directory from `source` to `destination` using shutil.copytree - and return list of copied files. When `dirs_exist_ok` is set, the `FileExistsError` is - ignored when destination directory exists. - Args: - source (str): Path to a source directory - destination (str): Path to a destination directory - Returns: - list[str]: List of copied files - """ - inventory_before = list(destination.rglob("*")) - copytree(source, destination, dirs_exist_ok=dirs_exist_ok) - inventory_after = list(destination.rglob("*")) - return [str(d) for d in inventory_after if d not in inventory_before] diff --git a/tests/test_utils.py b/tests/test_utils.py deleted file mode 100644 index a33874a9a..000000000 --- a/tests/test_utils.py +++ /dev/null @@ -1,81 +0,0 @@ -#!/usr/bin/env python3 - -# Copyright 2019 The Kapitan Authors -# SPDX-FileCopyrightText: 2020 The Kapitan Authors -# -# SPDX-License-Identifier: Apache-2.0 - -from pathlib import Path -import tempfile -from typing import List -import unittest - -from kapitan.utils import copy_tree - - -class CopytreeTest(unittest.TestCase): - def _create_directory_structure(self, root: Path, structure: List[str]): - for sub_path in structure: - full_path = root / sub_path - full_path.parent.mkdir(parents=True, exist_ok=True) - full_path.touch(exist_ok=True) - - def setUp(self): - self.template_structure = [ - "components/my_component/my_component.jsonnet", - "components/other_component/__init__.py", - "inventory/classes/common.yml", - "inventory/classes/my_component.yml", - "templates/docs/my_readme.md", - "templates/scripts/my_script.sh", - ] - self.template_directory = tempfile.TemporaryDirectory() - self.template_directory_path = Path(self.template_directory.name) - - self._create_directory_structure(self.template_directory_path, self.template_structure) - - def tearDown(self): - self.template_directory.cleanup() - - def test_empty_dir(self): - """Validates that all template files were copied to the correct directory and - the right list of copied files was returned.""" - with tempfile.TemporaryDirectory() as destination_directory: - template_files = [destination_directory + "/" + f for f in self.template_structure] - - copied_paths = copy_tree( - source=self.template_directory_path, - destination=Path(destination_directory), - dirs_exist_ok=True, - ) - # We only care about files as they will have full path anyway. - copied_files = [p for p in copied_paths if Path(p).is_file()] - - self.assertSequenceEqual(sorted(copied_files), sorted(template_files)) - self.assertTrue([Path(f).exists() for f in template_files]) - - def test_non_empty_dir(self): - """Makes sure that existing directories and files are untouched.""" - with tempfile.TemporaryDirectory() as destination_directory: - extra_files = [ - "file_that_existed_before.txt", - "this_existed_before/file.txt", - ] - self._create_directory_structure(Path(destination_directory), extra_files) - template_files = [destination_directory + "/" + f for f in self.template_structure] - - copied_paths = copy_tree( - source=self.template_directory_path, - destination=Path(destination_directory), - dirs_exist_ok=True, - ) - # We only care about files as they will have full path anyway. - copied_files = [p for p in copied_paths if Path(p).is_file()] - - self.assertSequenceEqual(sorted(copied_files), sorted(template_files)) - self.assertTrue([Path(f).exists() for f in template_files]) - self.assertTrue([Path(destination_directory + "/" + f).exists() for f in extra_files]) - - -if __name__ == "__main__": - unittest.main() From 4a5ef6ddea709257f93eb7c6d17083ec682664bc Mon Sep 17 00:00:00 2001 From: Alessandro De Maria Date: Sun, 4 Feb 2024 12:07:56 +0000 Subject: [PATCH 4/7] Install reclass as module --- .gitmodules | 3 --- Dockerfile | 3 ++- poetry.lock | 49 ++++++++++++++++++++++++++++++++++++++++++++++++- pyproject.toml | 3 +-- 4 files changed, 51 insertions(+), 7 deletions(-) delete mode 100644 .gitmodules diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 9d80332aa..000000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "kapitan/reclass"] - path = kapitan/reclass - url = https://github.com/kapicorp/reclass.git diff --git a/Dockerfile b/Dockerfile index 2835ec0d3..a5bb8757b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -9,7 +9,8 @@ WORKDIR /kapitan RUN apt-get update \ && apt-get install --no-install-recommends -y \ curl \ - build-essential + build-essential \ + git ENV POETRY_VERSION=1.7.1 ENV VIRTUAL_ENV=/opt/venv diff --git a/poetry.lock b/poetry.lock index 3d4cb163b..e9ede092f 100644 --- a/poetry.lock +++ b/poetry.lock @@ -386,6 +386,17 @@ ssh = ["bcrypt (>=3.1.5)"] test = ["pretend", "pytest (>=6.2.0)", "pytest-benchmark", "pytest-cov", "pytest-xdist"] test-randomorder = ["pytest-randomly"] +[[package]] +name = "ddt" +version = "1.7.1" +description = "Data-Driven/Decorated Tests" +optional = false +python-versions = "*" +files = [ + {file = "ddt-1.7.1-py2.py3-none-any.whl", hash = "sha256:2c4ac421bbdc10d2403b472294500c6f75ca822386c34d9fe82882d7a2ce9682"}, + {file = "ddt-1.7.1.tar.gz", hash = "sha256:1a4472c477bf766f75f7b1efb628656ff3c35ff3f6c821129ae8e328fff8a9a2"}, +] + [[package]] name = "docker" version = "7.0.0" @@ -405,6 +416,18 @@ urllib3 = ">=1.26.0" [package.extras] ssh = ["paramiko (>=2.4.3)"] + +[[package]] +name = "enum34" +version = "1.1.10" +description = "Python 3.4 Enum backported to 3.3, 3.2, 3.1, 2.7, 2.6, 2.5, and 2.4" +optional = false +python-versions = "*" +files = [ + {file = "enum34-1.1.10-py2-none-any.whl", hash = "sha256:a98a201d6de3f2ab3db284e70a33b0f896fbf35f8086594e8c9e74b909058d53"}, + {file = "enum34-1.1.10-py3-none-any.whl", hash = "sha256:c3858660960c984d6ab0ebad691265180da2b43f07e061c0f8dca9ef3cffd328"}, + {file = "enum34-1.1.10.tar.gz", hash = "sha256:cce6a7477ed816bd2542d03d53db9f0db935dd013b70f336a95c73979289f248"}, +] websockets = ["websocket-client (>=1.3.0)"] [[package]] @@ -1139,6 +1162,7 @@ files = [ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, + {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, @@ -1147,11 +1171,34 @@ files = [ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, + {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, ] +[[package]] +name = "reclass" +version = "1.6.0" +description = "merge data by recursive descent down an ancestry hierarchy (forked extended version)" +optional = false +python-versions = "*" +files = [] +develop = false + +[package.dependencies] +ddt = "*" +enum34 = "*" +pyparsing = "*" +pyyaml = "*" +six = "*" + +[package.source] +type = "git" +url = "https://github.com/kapicorp/reclass" +reference = "HEAD" +resolved_reference = "856b34cb77811d665c6346883238d436ac5c4924" + [[package]] name = "referencing" version = "0.32.1" @@ -1453,4 +1500,4 @@ test = ["docker"] [metadata] lock-version = "2.0" python-versions = "^3.10" -content-hash = "9702cab37a1a4e5f2d29fdd23503b299331fc1fb7cae5e7cc222cd88909b96e1" +content-hash = "2fe358199e545c228705fdc013d4d8591be337d462cb95a29f171cb3beeabf9c" diff --git a/pyproject.toml b/pyproject.toml index f7c3d8935..6c6e577c3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -27,7 +27,6 @@ license = "Apache-2.0" version = "0.33.0" packages = [ { include = "kapitan" }, - { include = "kapitan/reclass" }, ] [tool.poetry.scripts] @@ -63,6 +62,7 @@ packaging = "^23.0" typing-extensions = "^4.0.0" gojsonnet = { version = "^0.20.0", optional = true } docker = { version = ">=5,<8", optional = true } +reclass = {git = "https://github.com/kapicorp/reclass"} [tool.poetry.extras] gojsonnet = ["gojsonnet"] @@ -74,7 +74,6 @@ target-version = ['py310'] exclude = ''' ( /( - .*reclass.* | .*version.py ) ) From 54bb352057063d173d1096340b0d574a83b60ac0 Mon Sep 17 00:00:00 2001 From: Alessandro De Maria Date: Sun, 4 Feb 2024 12:10:31 +0000 Subject: [PATCH 5/7] remove submodule --- kapitan/reclass | 1 - 1 file changed, 1 deletion(-) delete mode 160000 kapitan/reclass diff --git a/kapitan/reclass b/kapitan/reclass deleted file mode 160000 index d220e896a..000000000 --- a/kapitan/reclass +++ /dev/null @@ -1 +0,0 @@ -Subproject commit d220e896a2465783abf298d71eb927de1f53a0ac From 53aef66ef155d56d29e3bd66df62de18cdcf1be1 Mon Sep 17 00:00:00 2001 From: Alessandro De Maria Date: Sun, 4 Feb 2024 12:13:28 +0000 Subject: [PATCH 6/7] Fix tests --- tests/test_dependency_manager.py | 73 -------------------------------- 1 file changed, 73 deletions(-) diff --git a/tests/test_dependency_manager.py b/tests/test_dependency_manager.py index afc9d02ae..bcd17237c 100644 --- a/tests/test_dependency_manager.py +++ b/tests/test_dependency_manager.py @@ -79,79 +79,6 @@ def test_clone_repo_subdir(self): rmtree(temp_dir) rmtree(output_dir) - def test_clone_repo_submodules_false(self): - """ - Tests cloning git repo and check that submodule folder is empty - """ - temp_dir = tempfile.mkdtemp() - output_dir = tempfile.mkdtemp() - source = "https://github.com/kapicorp/kapitan.git" - dep = [ - { - "output_path": output_dir, - "ref": "master", - "submodules": False, - } - ] - fetch_git_dependency((source, dep), temp_dir, force=False) - self.assertEqual(os.listdir(os.path.join(output_dir, "kapitan", "reclass")), []) - rmtree(temp_dir) - rmtree(output_dir) - - def test_clone_repo_without_submodules(self): - """ - Tests cloning a git repo without any submodules - """ - temp_dir = tempfile.mkdtemp() - output_dir = tempfile.mkdtemp() - source = "https://github.com/kapicorp/reclass.git" - dep = [ - { - "output_path": output_dir, - "ref": "master", - } - ] - fetch_git_dependency((source, dep), temp_dir, force=False) - self.assertTrue(os.path.isdir(os.path.join(output_dir, "reclass"))) - rmtree(temp_dir) - rmtree(output_dir) - - def test_clone_repo_with_submodules(self): - """ - Tests cloning git repo and initialize its' submodule - """ - temp_dir = tempfile.mkdtemp() - output_dir = tempfile.mkdtemp() - source = "https://github.com/kapicorp/kapitan.git" - dep = [ - { - "output_path": output_dir, - "ref": "master", - } - ] - fetch_git_dependency((source, dep), temp_dir, force=False) - self.assertTrue(os.listdir(os.path.join(output_dir, "kapitan", "reclass"))) - rmtree(temp_dir) - rmtree(output_dir) - - def test_clone_repo_with_submodule_subdir(self): - """ - Tests cloning subdir in a git repo and initialize its' submodule - """ - temp_dir = tempfile.mkdtemp() - output_dir = tempfile.mkdtemp() - source = "https://github.com/kapicorp/kapitan.git" - dep = [ - { - "output_path": output_dir, - "ref": "master", - "subdir": "kapitan", - } - ] - fetch_git_dependency((source, dep), temp_dir, force=False) - self.assertTrue(os.listdir(os.path.join(output_dir, "reclass"))) - rmtree(temp_dir) - rmtree(output_dir) def test_fetch_helm_chart(self): """ From b7bd490af5ec2bafdda141a7c33bccab04d69750 Mon Sep 17 00:00:00 2001 From: Alessandro De Maria Date: Sun, 4 Feb 2024 13:06:41 +0000 Subject: [PATCH 7/7] fix --- kapitan/inventory/inventory.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kapitan/inventory/inventory.py b/kapitan/inventory/inventory.py index c97d4d3e3..5e2b2f61b 100644 --- a/kapitan/inventory/inventory.py +++ b/kapitan/inventory/inventory.py @@ -13,7 +13,7 @@ from typing import overload, Union from kapitan.errors import KapitanError -from kapitan.reclass.reclass.values import item +from reclass.values import item logger = logging.getLogger(__name__)