6164b38fb9
This commit adds semi-structured documentation to all osbuild stages and
assemblers. The variables added work like this:
* STAGE_DESC: Short description of the stage.
* STAGE_INFO: Longer documentation of the stage, including expected
behavior, required binaries, etc.
* STAGE_OPTS: A JSON Schema describing the stage's expected/allowed
options. (see https://json-schema.org/ for details)
It also has a little unittest to check stageinfo - specifically:
1. All (executable) stages in stages/* and assemblers/ must define strings named
STAGE_DESC, STAGE_INFO, and STAGE_OPTS
2. The contents of STAGE_OPTS must be valid JSON (if you put '{' '}'
around it)
3. STAGE_OPTS, if non-empty, should have a "properties" object
4. if STAGE_OPTS lists "required" properties, those need to be present
in the "properties" object.
The test is *not* included in .travis.yml because I'm not sure we want
to fail the build for this, but it's still helpful as a lint-style
check.
86 lines
2.8 KiB
Python
Executable file
86 lines
2.8 KiB
Python
Executable file
#!/usr/bin/python3
|
|
|
|
import contextlib
|
|
import json
|
|
import os
|
|
import socket
|
|
import subprocess
|
|
import sys
|
|
import osbuild.remoteloop as remoteloop
|
|
|
|
STAGE_DESC = "Assemble tree into a raw ext4 filesystem image"
|
|
STAGE_INFO = """
|
|
Assemble the tree into a raw ext4 filesystem image named `filename`, with the
|
|
UUID `root_fs_uuid`.
|
|
|
|
The image is a sparse file of the given `size`, which is created using the
|
|
`truncate(1)` command. The `size` is an integer with an optional suffix:
|
|
K,M,G,T,... (for powers of 1024) or KB,MB,GB,TB,... (powers of 1000).
|
|
|
|
NOTE: If the tree contents are larger than `size`, this assembler will fail.
|
|
On the other hand, since the image is a sparse file, the unused parts of the
|
|
image take up almost no disk space - so a 1GB tree in a 20GB image should not
|
|
use much more than 1GB disk space.
|
|
|
|
The filesystem UUID should be a standard (RFC4122) UUID, which you can
|
|
generate with uuid.uuid4() in Python, `uuidgen(1)` in a shell script, or
|
|
read from `/proc/sys/kernel/random/uuid` if your kernel provides it.
|
|
"""
|
|
STAGE_OPTS = """
|
|
"required": ["filename", "root_fs_uuid", "size"],
|
|
"properties": {
|
|
"filename": {
|
|
"description": "Raw ext4 filesystem image filename",
|
|
"type": "string"
|
|
},
|
|
"root_fs_uuid": {
|
|
"description": "UUID for the filesystem",
|
|
"type": "string",
|
|
"pattern": "^[0-9A-Za-z]{8}(-[0-9A-Za-z]{4}){3}-[0-9A-Za-z]{12}$",
|
|
"examples": ["9c6ae55b-cf88-45b8-84e8-64990759f39d"]
|
|
},
|
|
"size": {
|
|
"description": "Maximum size of the filesystem",
|
|
"type": "string",
|
|
"examples": ["500M", "20GB"]
|
|
}
|
|
}
|
|
"""
|
|
|
|
@contextlib.contextmanager
|
|
def mount(source, dest, *options):
|
|
os.makedirs(dest, 0o755, True)
|
|
subprocess.run(["mount", *options, source, dest], check=True)
|
|
try:
|
|
yield
|
|
finally:
|
|
subprocess.run(["umount", "-R", dest], check=True)
|
|
|
|
|
|
def main(tree, output_dir, options, loop_client):
|
|
filename = options["filename"]
|
|
root_fs_uuid = options["root_fs_uuid"]
|
|
size = options["size"]
|
|
|
|
image = f"/var/tmp/osbuild-image.raw"
|
|
mountpoint = f"/tmp/osbuild-mnt"
|
|
|
|
subprocess.run(["truncate", "--size", str(size), image], check=True)
|
|
subprocess.run(["mkfs.ext4", "-U", root_fs_uuid, image], input="y", encoding='utf-8', check=True)
|
|
|
|
# Copy the tree into the target image
|
|
with loop_client.device(image) as loop, mount(loop, mountpoint):
|
|
subprocess.run(["cp", "-a", f"{tree}/.", mountpoint], check=True)
|
|
|
|
subprocess.run(["mv", image, f"{output_dir}/{filename}"], check=True)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
args = json.load(sys.stdin)
|
|
|
|
with socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM) as sock:
|
|
sock.setsockopt(socket.SOL_SOCKET, socket.SO_PASSCRED, 1)
|
|
sock.connect("/run/osbuild/api/remoteloop")
|
|
r = main(args["tree"], args["output_dir"], args["options"], remoteloop.LoopClient(sock))
|
|
|
|
sys.exit(r)
|