kt: Add setup command

Usage: kt setup --help

It will clone all the repos a developer needs for kernel development.

It clones the common_repos from kernels.yaml file in the config.base_path
directory.
If config.base_path = ~/ciq, these will be created:

~/ciq/kernel-src-tree
~/ciq/dist-git-tree-fips
~/ciq/dist-git-tree-cbr
~/ciq/dit-git-tree-lts
~/ciq/kernel-src-tree-tools
~/ciq/kernel-tools

Signed-off-by: Roxana Nicolescu <rnicolescu@ciq.com>

Author: roxanan1996

bin/kt

@@ -5,6 +5,7 @@ import logging
 import click
 
 from kt.commands.list_kernels.command import list_kernels
+from kt.commands.setup.command import setup
 
 epilog = """
 Base of all tooling used for kernel development.
@@ -22,6 +23,7 @@ def main():
     logging.basicConfig(format="%(levelname)s:%(message)s", level=logging.INFO)
 
     cli.add_command(list_kernels)
+    cli.add_command(setup)
     cli()
 
 

kt/KT.md

@@ -145,3 +145,30 @@ lts-8.8
 lts-9.2
 lts-9.4
 ```
+
+### kt setup
+
+```
+$ kt setup --help
+```
+
+It prepares the working directory for later commands:
+
+It clones the common_repos from kernels.yaml file in the config.base_path
+directory.
+If config.base_path = ~/ciq, these will be created:
+
+~/ciq/kernel-src-tree
+
+~/ciq/dist-git-tree-fips
+
+~/ciq/dist-git-tree-cbr
+
+~/ciq/dit-git-tree-lts
+
+~/ciq/kernel-src-tree-tools
+
+~/ciq/kernel-tools
+
+If there's a repo that needs to be cloned relevant for any future command,
+this is when it should be cloned.

kt/commands/setup/command.py

@@ -0,0 +1,35 @@
+import click
+
+from kt.commands.setup.impl import main
+
+epilog = """
+Prepares the working directory for later commands:
+
+It clones the common_repos from kernels.yaml file in the config.base_path
+directory.
+If the repos are cloned already, they will be updated.
+
+If config.base_path = ~/ciq, these will be created:
+
+~/ciq/kernel-src-tree
+
+~/ciq/dist-git-tree-fips
+
+~/ciq/dist-git-tree-cbr
+
+~/ciq/dit-git-tree-lts
+
+~/ciq/kernel-src-tree-tools
+
+~/ciq/kernel-tools
+
+Examples:
+
+\b
+$ kt setup
+"""
+
+
+@click.command(epilog=epilog)
+def setup():
+    main()

kt/commands/setup/impl.py

@@ -0,0 +1,13 @@
+from kt.ktlib.config import Config
+from kt.ktlib.kernels import KernelsInfo
+
+
+def main():
+    config = Config.load()
+
+    # create working dir if it does not exist
+    config.base_path.mkdir(parents=True, exist_ok=True)
+
+    repos = KernelsInfo.from_yaml(config=config).repos
+    for repo in repos.values():
+        repo.setup_repo()

kt/ktlib/kernels.py

@@ -5,24 +5,13 @@
 from pathlib3x import Path
 
 from kt.ktlib.config import Config
+from kt.ktlib.repo import RepoInfo
 from kt.ktlib.util import Constants
 
 # TODO move this to a separate repo
 KERNEL_INFO_YAML_PATH = Path(__file__).parent.parent.joinpath("data/kernels.yaml")
 
 
-@dataclass
-class RepoInfo:
-    """
-    Dataclass that represents a local clone of a git repository.
-    folder: absolute path to the local clone
-    url: remote origin
-    """
-
-    folder: Path
-    url: str
-
-
 @dataclass
 class KernelInfo:
     """

kt/ktlib/repo.py

@@ -0,0 +1,44 @@
+import logging
+from dataclasses import dataclass
+
+import git
+from git import Repo
+from pathlib3x import Path
+
+
+@dataclass
+class RepoInfo:
+    """
+    Dataclass that represents a local clone of a git repository.
+    folder: absolute path to the local clone
+    url: remote origin
+    """
+
+    folder: Path
+    url: str
+
+    def _clone_repo(self):
+        """
+        It clones the repo into destination folder
+        """
+
+        # TODO show progress
+        logging.info(f"Cloning {self.url} to {self.folder}")
+        git.Repo.clone_from(self.url, self.folder)
+
+    def _update(self):
+        repo = Repo(self.folder)
+        repo.remotes.origin.pull(rebase=True)
+
+    def setup_repo(self):
+        """
+        Set up a git repository at the destination.
+        If destination already exists and override == True,
+        nothing is done
+        """
+        if not self.folder.exists():
+            self._clone_repo()
+            return
+
+        logging.info(f"{self.folder} already exists, updating it")
+        self._update()

pyproject.toml

@@ -7,6 +7,7 @@ readme = "README.md"
 version = "0.0.1"
 dependencies = [
 	"click",
+	"gitpython",
 	"pathlib3x",
 ]