implement initialization with copier-org/copier (#1229)

Fixes #

## Proposed Changes

* Refactor implementation of --init using copier-org/copier

## Docs and Tests

* [ ] Tests added
* [ ] Updated documentation

kapitan/cli.py

@@ -585,10 +585,21 @@ def build_parser():
 
     init_parser.add_argument(
         "--directory",
-        default=from_dot_kapitan("init", "directory", "."),
+        default="./",
         help="set path, in which to generate the project skeleton,"
         'assumes directory already exists. default is "./"',
     )
+
+    init_parser.add_argument(
+        "--template_git_url",
+        default=from_dot_kapitan("init", "template_git_url ", defaults.COPIER_TEMPLATE_REPOSITORY),
+        help=f"Cruft template_git_url, default is {defaults.COPIER_TEMPLATE_REPOSITORY}",
+    )
+    init_parser.add_argument(
+        "--checkout_ref",
+        default=from_dot_kapitan("init", "checkout_ref ", defaults.COPIER_TEMPLATE_REF),
+        help=f"Cruft checkout_ref, default is {defaults.COPIER_TEMPLATE_REF}",
+    )
     return parser
 
 

kapitan/defaults.py

@@ -18,3 +18,5 @@
 
 # default path from where user defined custom filters are read
 DEFAULT_JINJA2_FILTERS_PATH = os.path.join("lib", "jinja2_filters.py")
+COPIER_TEMPLATE_REPOSITORY = "https://github.com/kapicorp/kapitan-reference.git"
+COPIER_TEMPLATE_REF = "copier"

kapitan/initialiser.py

@@ -7,33 +7,49 @@
 
 "initialiser module"
 
+import glob
 import logging
 import os
 
-from kapitan.utils import copy_tree
+from copier import run_copy
+
+from kapitan.errors import KapitanError
+from kapitan.version import VERSION as kapitan_version
 
 logger = logging.getLogger(__name__)
 
 
 def initialise_skeleton(args):
-    """Initialises a directory with a recommended skeleton structure
+    """Initialises a directory with a recommended skeleton structure using cruft
     Args:
-        args.directory (string): path which to initialise, directory is assumed to exist
+        args.template_git_url (string): path or url that contains the cruft repository template
+        args.checkout_ref (string): branch, tag or commit to checkout from the template repository
+        args.directory (string): directory to initialise the skeleton in (default is current directory)
     """
 
-    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):
-        # 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]):
-            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:
-                    sub_indent = " " * 4 * (level + 1)
-                    logger.info("%s%s", sub_indent, fname)
+    template_git_url = args.template_git_url
+    checkout_ref = args.checkout_ref
+    directory = os.path.abspath(args.directory)
+
+    if set(glob.iglob(os.path.join(directory, "./*"))):
+        raise KapitanError(f"Directory {directory} is not empty. Please initialise in an empty directory.")
+
+    logger.info(f"Initialising kapitan from {template_git_url}@{checkout_ref} in {directory}")
+    user_defaults = {
+        "kapitan_version": kapitan_version,
+    }
+    run_copy(
+        template_git_url,
+        vcs_ref=args.checkout_ref,
+        unsafe=True,
+        dst_path=directory,
+        quiet=True,
+        user_defaults=user_defaults,
+        skip_answered=False,
+    )
+
+    if directory == os.path.abspath(os.path.curdir):
+        logger.info(f"Successfully initialised: run `kapitan --version`")
+    else:
+        logger.info(f"Successfully initialised kapitan in {directory}")
+        logger.info("Please go to the directory and run `kapitan --version`")