Update the manifest tagging script (zephyrproject-rtos#17)

- Rewritten in Python as tag_manifest.py
- Delete the deprecated tag_main.sh script

Signed-off-by: Connor Graydon <connor.graydon@intel.com>

src/scripts/tag_manifest.py

@@ -0,0 +1,240 @@
+""" Tag Repos for Manifest Update Process
+
+This script will create and push a tag in the correct format for tagging the
+zephyr and zephyr-intel repos for main-intel and main branches, respectively.
+
+Working dir is set to /srv/buid/manifest. Change to your liking.
+
+It takes an argument of the path to your ssh key for git repo access in the
+format of:
+
+    python3 tag_manifest.py /path/to/your/key/key_name
+
+If the tag already exists on one or both of the remote repos, the script will
+notify and exit.
+
+If the tag exists in the local repos but not on the remotes, it will use the
+existing tags. Since the local repos get nuked each time, this is kind of moot
+right now, but intent is to be able to reuse a repo or recover a failed run.
+i.e. To skip cloning repos again, since that is time consuming and GitPython
+is notoriously slow. It's useful for debug and testing as well.
+
+Script prompts for option to display tags before pushing. Also prompts to
+confirm push of tags.
+
+Error checking is non-existent at present, so checking on end result is a
+great idea.
+
+TODO:
+    - Error checking
+    - Better arg parsing
+    - reuse of repos, rather than blind nuke
+    - Deal with corner cases like tag on one repo, but not on other
+    - Allow passing in of working dir or use cwd.
+
+"""
+
+import os
+import sys
+import argparse
+from shutil import rmtree
+from git import Repo
+from git import Git
+from datetime import datetime
+
+
+class ManifestRepo:
+
+    def __init__(self, repo):
+
+        name = repo[0]
+        branch = repo[1]
+
+        repo_base = "git@github.com:intel-innersource/os.rtos.zephyr"
+        repo_url = repo_base + "." + name
+
+        self.name = name
+        self.repo_url = repo_url
+        self.branch = branch
+        self.version = ""
+        self.pr = ""
+        self.tag_exists = "false"
+
+
+def clean_workspace(workspace, repo_list):
+
+    print("Cleaning workspace: ", workspace)
+    os.chdir(workspace)
+    for repo in repo_list:
+        repo_name = repo[0]
+        repo_path = os.path.join(workspace, repo_name)
+        if os.path.exists(repo_path):
+            # This doesn't always print: why???
+            print(f"Found an existing {repo_name} repo. Nuking it.")
+            rmtree(repo_path)
+
+
+def clone_repo(workspace, repo, git_ssh_identity_file):
+
+    print(f"Cloning {repo.name}...", end =" ")
+    git_ssh_cmd = 'ssh -i %s' % git_ssh_identity_file
+    Repo.clone_from(repo.repo_url, os.path.join(workspace, repo.name), branch=repo.branch, env=dict(GIT_SSH_COMMAND=git_ssh_cmd))
+    print("Done.")
+
+
+
+def tag_repo(tag, repos):
+
+    # Note that local_repo here is not the checked out repo dir. It's just
+    # name mangling to distinguish the manifest repo object from a git/gitpython repo object.
+    # The local_repo.git.ls_remote line is looking at the remote for tags and not in
+    # the checked out directory.
+    for repo in repos:
+        local_repo = Repo(os.path.join(workspace, repo.name))
+        tags = local_repo.git.ls_remote("--tags", "origin")
+        if tag in tags:
+            repo.tag_exists  = True
+        else:
+            repo.tag_exists = False
+
+    if repos[0].tag_exists == True and repos[1].tag_exists == True:
+        print(f"Tag exists on both {repos[0].name} and {repos[1].name} remotes. Already tagged.")
+        sys.exit(1)
+    elif repos[0].tag_exists == True or repos[1].tag_exists == True:
+        if repos[0].tag_exists == True:
+            print(f"Tag exists on {repos[0].name} remote. Manual intervention required.")
+        else:
+            print(f"Tag exists on {repos[1].name} remote. Manual intervention required.")
+        sys.exit(1)
+    elif repos[0].tag_exists == False and repos[1].tag_exists == False:
+        print(f"No pre-existing tag exists on either remote repo. Good to go.")
+        for repo in repos:
+            local_repo = Repo(os.path.join(workspace, repo.name))
+            if repo.name == "zephyr":
+                ref_name = "main-intel"
+            else:
+                ref_name = "main"
+            local_tags = local_repo.tags
+            local_tags = local_repo.tags
+            if tag in local_tags:
+                print(f"{repo.name.title()}: {tag} tag exists locally but not on remote. Using it.")
+            else:
+                print(f"{repo.name.title()}: No local {tag} tag. Creating it.")
+                the_tag = local_repo.create_tag(tag, ref=ref_name, message=tag)
+
+    return
+
+
+def create_tag(workspace, repo):
+
+    # Tag format:
+    # zephyr-3.1.99-intel-yyymmdd
+    # VERSION = PREFIX-MAJOR.MINOR.PATCH-SUFFIX-date_stamp
+
+    PREFIX = repo.name + '-'
+    SUFFIX = "intel"
+
+    date_stamp = datetime.today().strftime('%Y%m%d')
+
+    repo_dir = os.path.join(workspace, repo.name)
+    os.chdir(repo_dir)
+
+    # We don't care about these lines in VERSION file
+    del_list = ["VERSION_TWEAK", "EXTRAVERSION"]
+
+    with open("VERSION") as f:
+        version_dict = { k.strip(): v.strip() for line in f for (k, v) in [line.rstrip().split("=")]}
+        [version_dict.pop(key) for key in del_list]
+
+    version = '.'.join(str(val) for key, val in version_dict.items())
+
+    tag = PREFIX + version + "-" + SUFFIX + "-" + date_stamp
+    print("TAG: ", tag)
+
+    return tag
+
+
+def show_tag(tag, repos):
+
+    # Note that local_repo here is not the checked out repo dir. It's just
+    # name mangling to distinguish the manifest repo object from a git/gitpython repo object.
+    # The local_repo.git.ls_remote line is looking at the remote for tags and not in
+    # the checked out directory.
+    for repo in repos:
+        local_repo = Repo(os.path.join(workspace, repo.name))
+        print("repo: ", repo.name)
+        local_tags = local_repo.tags
+        print(f"{repo.name} tag info: {local_repo.git.show(tag)}: \n")
+
+    return
+
+
+def push_tag(tag, repos):
+
+    # TODO: add some error checking here.
+    # Check for failure.
+    # Check for tag on remote.
+
+    answer = input("\nDo you want to push the tags? y/n: ").lower()
+    if answer == "y":
+        for repo in repos:
+            local_repo = Repo(os.path.join(workspace, repo.name))
+            print(f"Pushing {repo.name} tag. ", end="")
+            local_repo.remotes.origin.push(tag)
+            print("Done.")
+
+    return
+
+
+os.system("clear")
+
+
+# Create the parser and add arguments
+parser = argparse.ArgumentParser()
+parser.add_argument(dest='key_path', help="/path/to/key/key_name")
+
+# Parse and print the results
+args = parser.parse_args()
+print(args.key_path)
+
+git_ssh_identity_file = args.key_path
+
+workspace  = "/srv/build/manifest"    # or whatever your workdir is
+
+repo_list = [['zephyr', 'main-intel'], ['zephyr-intel', 'main']]
+
+# Check workspace exists. Create/Clean it.
+if not os.path.exists(workspace):
+    print(f"Creating workspace {workspace}.")
+    os.mkdir(workspace)
+elif os.path.exists(workspace):
+    print(f"Cleaning workspace {workspace}.")
+    clean_workspace(workspace, repo_list)
+
+# Create some repo objects and set some things
+for repo in repo_list:
+    if repo[0] == "zephyr":
+        zephyr_repo = ManifestRepo(repo)
+    elif repo[0] == "zephyr-intel":
+        zephyr_intel_repo = ManifestRepo(repo)
+
+repos = [zephyr_repo, zephyr_intel_repo]
+
+# Clone the repos
+for repo in repos:
+    print(f"Cloning {repo.name}.")
+    clone_repo(workspace, repo, git_ssh_identity_file)
+
+# Create the tag
+tag = create_tag(workspace, zephyr_repo)
+tag_repo(tag, repos)
+
+# Make this better. Like don't just quit if y/n not selected.
+answer = input("\nDo you want to see the tag info? y/n: ").lower()
+
+if answer == "y":
+    show_tag(tag, repos)
+
+push_tag(tag, repos)
+
+