summarylogtreecommitdiffstats
path: root/generate_submodules_lines.py
blob: 86f589bc4a87eea2bc0aedef29fd2c3c12e6671c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
#!/usr/bin/env python3
"""Small utility for generating the relevant metadata for the PKGBUILD."""
from glob import glob
from os import cpu_count
from os.path import dirname
import shutil
from subprocess import run as run_command
import tempfile
from typing import Tuple


def parse_versions() -> Tuple[str, str]:
    """Return the old and the new version of Telegram Desktop, in this order."""
    with open("PKGBUILD") as PKGBUILD, open(".SRCINFO") as SRCINFO:
        old_content = SRCINFO.readlines()
        new_content = PKGBUILD.readlines()

    def fetch_value(file_lines: list[str]) -> str:
        """Fetch the value of "pkgver" from the file lines"""
        filtered_content = filter(lambda s: s.strip().startswith("pkgver"), file_lines)
        first_value_line = next(filtered_content).strip()
        # Lines are: pkgver = X, with perhaps spaces
        return first_value_line.split("=")[1].strip()

    return fetch_value(old_content), fetch_value(new_content)


def git_clone_repo(old_version: str, new_version: str) -> str:
    """Fetch the Git repository with the proper parameters and provides the folder name."""
    temp_git_folder = tempfile.mkdtemp()

    git_clone_command = [
        "git",
        "clone",
        # "--quiet",
        "--recurse-submodules",
        "--shallow-submodules",
        f"--shallow-since=v{old_version}",
        f"--branch=v{new_version}",
        "https://github.com/telegramdesktop/tdesktop",
        temp_git_folder,
    ]

    cpus = cpu_count()
    if cpus is not None:
        git_clone_command.append(f"--jobs={cpus}")

    print(f"Runnng: {' '.join(git_clone_command)}")

    run_command(git_clone_command, check=True)
    return temp_git_folder


def fetch_submodule_data(git_repository: str, base_repo: str):
    """Return all relevant instructions for the PKGBUILLD given the repository."""
    sources: dict[str, str] = {}
    commands: list[str] = []
    parsed_folders: set[str] = set()

    def generate_repo_data(git_subrepo: str):
        """Do the heavy work for one repo and recurse for the others."""
        if git_subrepo in parsed_folders:
            print(f"# Folder already handled: {git_subrepo}, skipping ...")
        source_folder = git_subrepo.replace(git_repository, base_repo)
        print(f"# Working in {source_folder}...")

        md_sep = "::"
        """custom metadata separator"""

        git_remotes_command = run_command(
            [
                "git",
                "-C",
                git_subrepo,
                "submodule",
                "foreach",
                "--quiet",
                f'printf "$name{md_sep}" ; git remote get-url origin',
            ],
            capture_output=True,
        )
        git_submodules_metadata = git_remotes_command.stdout.decode().splitlines()

        if git_submodules_metadata:
            commands.append(f'git -C "{source_folder}" submodule init')

        for git_submodule_data in git_submodules_metadata:
            submodule_name, git_remote = git_submodule_data.split(md_sep, maxsplit=1)

            # Fetch the unique repo name and make it easy to use
            # https://github.com/some/repo.git -> repo
            git_repo_name = (
                "submodule_" + git_remote.split("/")[-1].split(".git", maxsplit=1)[0]
            )

            if git_repo_name in sources and sources[git_repo_name] != git_remote:
                raise RuntimeError(
                    f"Multiple sources with same name {git_repo_name} but different values: "
                    f"{git_remote} != {sources[git_repo_name]}"
                )

            sources[git_repo_name] = git_remote
            commands.append(
                f'git -C "{source_folder}" config src.{submodule_name}.url "$srcdir/{git_repo_name}"'
            )

        if git_submodules_metadata:
            commands.append(f'git -C "{source_folder}" submodule update')
            commands.append("")

        parsed_folders.add(git_subrepo)

        # Recurse on lower subrepos
        found_gitmodules = glob(f"{git_subrepo}/**/.gitmodules", recursive=True)
        found_subrepos = [
            dirname(gitmodule_path) for gitmodule_path in found_gitmodules
        ]

        for found_subrepo in found_subrepos:
            if found_subrepo in parsed_folders:
                continue
            generate_repo_data(found_subrepo)

    generate_repo_data(git_repository)

    return sources, commands


def generate_metadata():
    """Main method, doing the hard work."""
    old_version, new_version = parse_versions()

    git_repo_path = git_clone_repo(old_version, new_version)

    sources, commands = fetch_submodule_data(git_repo_path, "$srcdir/tdesktop")

    indent = " " * 4

    print("# Sources:")
    for k, v in sorted(sources.items()):
        print(indent + f'"{k}::git+{v}"')

    print("# Commands in prepare:")
    for l in commands:
        print(indent + l if l.strip() else "")

    shutil.rmtree(git_repo_path)


if __name__ == "__main__":
    generate_metadata()