fix(cli): prevent --template-ref from being set without --template-source in renku init (#2146)

* fix(cli): prevent --template-ref from being set without --template-source in renku init

* fix template clone whithout main branch

Author: Panaetius

renku/cli/init.py

@@ -250,7 +250,7 @@ def check_git_user_config():
 @click.option("-i", "--template-index", help="Provide the index number of the template to use.", type=int)
 @click.option("-s", "--template-source", help="Provide the templates repository url or path.")
 @click.option(
-    "-r", "--template-ref", default="master", help="Specify the reference to checkout on remote template repository."
+    "-r", "--template-ref", default=None, help="Specify the reference to checkout on remote template repository."
 )
 @click.option(
     "-p",
@@ -297,6 +297,10 @@ def init(
             "\tgit config --global --add user.email "
             '"[email protected]"\n'
         )
+
+    if template_ref and not template_source:
+        raise errors.ParameterError("Can't use '--template-ref' without specifying '--template-source'")
+
     communicator = ClickCallback()
     init_command().with_communicator(communicator).build().execute(
         ctx=ctx,

renku/core/commands/init.py

@@ -334,7 +334,7 @@ def init_command():
     return Command().command(_init)
 
 
-def fetch_template_from_git(source, ref="master", tempdir=None):
+def fetch_template_from_git(source, ref=None, tempdir=None):
     """Fetch the template from a git repository and checkout the relevant data.
 
     :param source: url or full path of the templates repository
@@ -351,17 +351,22 @@ def fetch_template_from_git(source, ref="master", tempdir=None):
     except git.exc.GitCommandError as e:
         raise errors.GitError("Cannot clone repo from {0}".format(source)) from e
 
-    try:
-        # fetch ref and set the HEAD
-        template_repo.remotes.origin.fetch(ref)
+    if ref:
         try:
-            template_repo.head.reset(template_repo.commit(ref))
-        except git.exc.BadName:
-            ref = "origin/{0}".format(ref)
-            template_repo.head.reset(template_repo.commit(ref))
+            # fetch ref and set the HEAD
+            template_repo.remotes.origin.fetch(ref)
+            try:
+                template_repo.head.reset(template_repo.commit(ref))
+            except git.exc.BadName:
+                ref = "origin/{0}".format(ref)
+                template_repo.head.reset(template_repo.commit(ref))
+            git_repo = git.Git(str(tempdir))
+        except git.exc.GitCommandError as e:
+            raise errors.GitError("Cannot fetch and checkout reference {0}".format(ref)) from e
+    else:
+        template_repo.remotes.origin.fetch()
+        template_repo.head.reset(template_repo.commit())
         git_repo = git.Git(str(tempdir))
-    except git.exc.GitCommandError as e:
-        raise errors.GitError("Cannot fetch and checkout reference {0}".format(ref)) from e
 
     # checkout the manifest
     try:
@@ -380,14 +385,17 @@ def fetch_template(template_source, template_ref):
     :return: tuple of (template manifest, template folder, template source, template version)
     """
     if template_source and template_source != "renku":
-        communication.echo("Fetching template from {0}@{1}... ".format(template_source, template_ref))
+        communication.echo("Fetching template from {0}@{1}... ".format(template_source, template_ref or ""))
         template_folder = Path(mkdtemp())
         _, template_version = fetch_template_from_git(template_source, template_ref, template_folder)
         template_manifest = read_template_manifest(template_folder, checkout=True)
         communication.echo("OK")
     else:
         from renku import __version__
 
+        if template_ref:
+            raise errors.ParameterError("Templates included in renku don't support specifying a template_ref")
+
         template_folder = Path(pkg_resources.resource_filename("renku", "templates"))
         template_manifest = read_template_manifest(template_folder)
         template_source = "renku"

tests/cli/test_init.py

@@ -412,7 +412,7 @@ def test_default_init_parameters(isolated_runner, mocker, project_init, template
         "__sanitized_project_name__",
     } <= set(metadata.keys())
     assert metadata["__template_source__"] == "renku"
-    assert metadata["__template_ref__"] == "master"
+    assert metadata["__template_ref__"] is None
     assert metadata["__template_id__"] == template["id"]
     assert metadata["__namespace__"] == ""
     assert metadata["__repository__"] == ""