summaryrefslogtreecommitdiff
path: root/new/image_builder.py
blob: cb5f8798f6c8c25faa79c2583d8102a9528b1f7b (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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
#!/usr/bin/env python3
import argparse
from contextlib import closing
from http.server import ThreadingHTTPServer, SimpleHTTPRequestHandler
import logging
import os
from shlex import quote
import shutil
import socket
from threading import Thread
from time import monotonic

import netifaces
import pendulum

from lib.debranding import Debranding
from lib.docker import Docker
from lib.git import Git
from lib.helpers import setup_logging, refuse_root, project_dir, get_my_log_file


class ImageBuilder:
    version_mapping = {
        "sagitta": "1.4.x",
        "circinus": "1.5.x",
    }
    vyos_build_repo = None
    docker = None

    def __init__(self, branch, vyos_build_git, vyos_build_docker, vyos_mirror, extra_options, flavor, build_by,
                 version, bind_addr, bind_port, keep_build, debranding: Debranding):
        self.branch = branch
        self.vyos_build_git = vyos_build_git
        self.vyos_build_docker = vyos_build_docker
        self.vyos_mirror = vyos_mirror
        self.extra_options = extra_options
        self.flavor = flavor
        self.build_by = build_by
        self.version = version
        self.bind_addr = bind_addr
        self.bind_port = bind_port
        self.keep_build = keep_build
        self.debranding = debranding

        self.cwd = os.getcwd()

    def build(self):
        begin = monotonic()
        if self.vyos_mirror == "local":
            vyos_mirror = self.start_local_apt_webserver()
            logging.info("Starting local APT repository at %s" % vyos_mirror)
        else:
            vyos_mirror = self.vyos_mirror
            logging.info("Using supplied APT repository at %s" % vyos_mirror)

        self.vyos_build_repo = os.path.join(project_dir, "build", "%s-image-build" % self.branch)

        logging.info("Pulling vyos-build docker image")
        self.docker = Docker(self.vyos_build_docker, self.branch, self.vyos_build_repo)
        self.docker.pull()

        git = Git(self.vyos_build_repo)
        if not self.keep_build:
            if git.exists():
                # We want to delete original vyos-build repo and do fresh clone to clean cached build files.
                self.docker.rmtree(self.vyos_build_repo)

        if not git.exists():
            git.clone(self.vyos_build_git, self.branch)

        self.debranding.remove_image_branding(self.vyos_build_repo)

        # TODO: remove me, temporary hack until vyos-build is fixed
        with open(os.path.join(git.repo_path, "data/build-flavors/generic.toml"), "r+") as file:
            contents = file.read()
            contents = contents.replace("vyos-xe-guest-utilities", "xen-guest-agent")
            file.seek(0)
            file.write(contents)
            file.truncate()

        version = self.version
        if version == "auto":
            if self.branch in self.version_mapping:
                version = self.version_mapping[self.branch]
            else:
                version = "%s-%s" % (self.branch, pendulum.now().format("YYYY-MM-DD"))

        # build image
        build_image_pieces = [
            "sudo --preserve-env ./build-vyos-image",
            quote(self.flavor),
            "--architecture", quote("amd64"),
            "--build-by", quote(self.build_by),
            "--build-type", quote("release"),
            "--version", quote(version),
            "--vyos-mirror", quote(vyos_mirror),
        ]
        if self.vyos_mirror == "local":
            build_image_pieces.extend([
                "--custom-apt-key", quote("/opt/apt.gpg.key"),
            ])
        if self.extra_options:
            build_image_pieces.append(self.extra_options)
        build_image_command = " ".join(build_image_pieces)

        logging.info("Using build image command: '%s'" % build_image_command)
        logging.info("Executing image build now...")

        extra_mounts = []
        if self.vyos_mirror == "local":
            apt_key_path = os.path.join(project_dir, "apt", "apt.gpg.key")
            extra_mounts.append((apt_key_path, "/opt/apt.gpg.key"))

        self.docker.run(
            command=build_image_command,
            work_dir="/vyos",
            extra_mounts=extra_mounts,
            log_command="IMAGE_BUILD_COMMAND"
        )

        image_path = None
        build_dir = os.path.join(self.vyos_build_repo, "build")
        if os.path.exists(build_dir):
            for entry in os.scandir(build_dir):
                if version in entry.name and entry.name.endswith(".iso"):
                    image_path = entry.path
                    break

        if image_path is None:
            image_path = os.path.join(build_dir, "live-image-amd64.hybrid.iso")

        if not os.path.exists(image_path):
            logging.error(
                "Build failed (image not found), see log above for reason why"
                ", inspect build here: %s"
                ", log file: %s" % (build_dir, get_my_log_file())
            )
            exit(1)

        new_image_path = os.path.join(self.cwd, os.path.basename(image_path))
        if image_path != new_image_path:
            shutil.copy2(image_path, new_image_path)

        elapsed = round(monotonic() - begin, 3)
        logging.info("Done in %s seconds, image is available here: %s" % (elapsed, new_image_path))

    def start_local_apt_webserver(self):
        address = self.get_local_ip() if not self.bind_addr else self.bind_addr
        port = self.get_free_port(address) if not self.bind_port else self.bind_port
        thread = Thread(target=self.serve_apt, args=(address, port), name="LocalWebServer", daemon=True)
        thread.start()
        return "http://%s:%s/%s" % (address, "" if port == 80 else port, self.branch)

    def serve_apt(self, address, port):
        # noinspection PyTypeChecker
        server = ThreadingHTTPServer((address, port), AptWebServerHandler)
        server.serve_forever()

    def get_free_port(self, address):
        with closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as sock:
            sock.bind((address, 0))
            sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
            return sock.getsockname()[1]

    def get_local_ip(self):
        selected_address = None
        docker_address = None
        for interface in netifaces.interfaces():
            if interface.startswith("lo"):
                continue

            addresses = netifaces.ifaddresses(interface)
            if netifaces.AF_INET not in addresses:
                continue

            for address in addresses[netifaces.AF_INET]:
                if "addr" not in address or not address["addr"]:
                    continue

                selected_address = address["addr"]
                if interface == "docker0":
                    docker_address = selected_address

        if docker_address:
            selected_address = docker_address

        if selected_address is None:
            raise Exception(
                "Unable to find local address, please specify local IP (NOT localhost) via --bind-addr option"
            )

        return selected_address


class AptWebServerHandler(SimpleHTTPRequestHandler):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, directory=os.path.join(project_dir, "apt"), **kwargs)

    def log_message(self, format, *args):
        pass


if __name__ == "__main__":
    setup_logging(name="image_builder")

    try:
        refuse_root()

        debranding = Debranding()

        parser = argparse.ArgumentParser()
        parser.add_argument("branch", help="VyOS branch (current, circinus)")
        parser.add_argument("--vyos-build-git", default="https://github.com/vyos/vyos-build.git",
                            help="Git URL of vyos-build")
        parser.add_argument("--vyos-mirror", default="local", help="VyOS package repository (URL or 'local')")
        parser.add_argument("--vyos-build-docker", default="vyos/vyos-build",
                            help="Default option uses vyos/vyos-build from dockerhub")
        parser.add_argument("--extra-options", help="Extra options for the build-vyos-image")
        parser.add_argument("--flavor", default="generic")
        parser.add_argument("--build-by", default="myself@localhost")
        parser.add_argument("--version", default="auto")
        parser.add_argument("--bind-addr", help="Bind local webserver to static address instead of automatic")
        parser.add_argument("--bind-port", type=int, help="Bind local webserver to static port instead of random")
        parser.add_argument("--keep-build", action="store_true", help="Keep previous vyos-build repository")

        debranding.populate_cli_parser(parser)

        args = parser.parse_args()
        values = vars(args)

        debranding.extract_cli_values(values)

        builder = ImageBuilder(debranding=debranding, **values)
        builder.build()

    except KeyboardInterrupt:
        exit(1)
    except Exception as e:
        logging.exception(e)
        logging.error("Something went wrong, log file: %s" % get_my_log_file())
        exit(1)