def test_meta(nydus_anchor: NydusAnchor, rafs_conf: RafsConf,
nydus_scratch_image: RafsImage):
anchor = nydus_anchor
rafs_conf.set_rafs_backend(Backend.BACKEND_PROXY).enable_rafs_blobcache()
rafs_conf.dump_rafs_conf()
dist = Distributor(nydus_scratch_image.rootfs(), 8, 5)
dist.generate_tree()
xattr_verifier = verifier.XattrVerifier(anchor.mount_point, dist)
xattr_verifier.scratch(nydus_scratch_image.rootfs())
symlink_verifier = verifier.SymlinkVerifier(anchor.mount_point, dist)
symlink_verifier.scratch()
# Do some meta operations on scratch dir before creating rafs image file.
# Use scratch dir as image source dir as we just prepared test meta into it.
nydus_scratch_image.set_backend(Backend.BACKEND_PROXY).create_image()
rafs = RafsMount(anchor, nydus_scratch_image, rafs_conf)
rafs.thread_num(4).mount()
assert rafs.is_mounted()
xattr_verifier.verify(anchor.mount_point)
symlink_verifier.verify(anchor.mount_point, nydus_scratch_image.rootfs())
workload_gen = WorkloadGen(anchor.mount_point,
nydus_scratch_image.rootfs())
workload_gen.setup_workload_generator()
workload_gen.torture_read(10, 3)
workload_gen.finish_torture_read()
assert workload_gen.io_error == False
assert anchor.check_nydusd_health()
def test_build_image(nydus_anchor, nydus_scratch_image: RafsImage,
rafs_conf: RafsConf):
"""
title: Build nydus image
description: Build nydus image from rootfs generating proper bootstrap and
blob
pass_criteria:
- Image can successfully builded and mounted
- Rafs can be unmounted and do a small account of read io and attr
operation
- Try let image builder upload blob itself.
"""
dist = Distributor(nydus_scratch_image.rootfs(), 80, 1)
dist.generate_tree()
dist.put_directories(100)
dist.put_hardlinks(90)
dist.put_symlinks(200)
dist.put_multiple_files(random.randint(20, 28), Size(10, Unit.MB))
dist.put_multiple_chinese_files(random.randint(20, 28), Size(20, Unit.KB))
Whiteout().whiteout_one_file(nydus_scratch_image.rootfs(),
"i/am/troublemaker/foo")
nydus_scratch_image.set_backend(Backend.BACKEND_PROXY).create_image()
rafs_conf.set_rafs_backend(backend_type=Backend.BACKEND_PROXY)
rafs_conf.dump_rafs_conf()
rafs = RafsMount(nydus_anchor, nydus_scratch_image, rafs_conf)
wg = WorkloadGen(nydus_anchor.mount_point, nydus_scratch_image.rootfs())
rafs.mount()
assert wg.verify_entire_fs()
rafs.umount()
def test_snapshotter(
nydus_anchor: NydusAnchor,
rafs_conf: RafsConf,
image_url,
nydus_snapshotter,
local_registry,
):
snapshotter = Snapshotter(nydus_anchor)
containerd = Containerd(nydus_anchor, snapshotter).gen_config()
snapshotter.set_root(containerd.root)
nydus_anchor.put_dustbin(snapshotter)
nydus_anchor.put_dustbin(containerd)
converter = Nydusify(nydus_anchor)
converter.docker_v2().convert(image_url)
rafs_conf.set_rafs_backend(Backend.REGISTRY, repo=converter.original_repo)
rafs_conf.enable_xattr()
rafs_conf.dump_rafs_conf()
snapshotter.run(rafs_conf.path())
time.sleep(1)
containerd.run()
cri = Cri(containerd.address, containerd.address)
container_name = str(uuid.uuid4())
cri.run_container(converter.converted_image, container_name)
id, status = cri.check_container_status(container_name, timeout=30)
assert id is not None
assert status
cri.stop_rm_container(id)
cri.remove_image(converter.converted_image)
containerd.remove_image_sync(converter.converted_image)
def test_basic(
nydus_anchor,
nydus_image: RafsImage,
io_duration,
backend,
rafs_conf: RafsConf,
fs_version,
):
"""
title: Basic functionality test
description: Mount rafs with different mount options
pass_criteria:
- Rafs can be mounted.
- Rafs can be unmounted.
"""
nydus_image.set_backend(backend,
blob_dir=()).create_image(fs_version=fs_version)
rafs_conf.set_rafs_backend(backend)
rafs = RafsMount(nydus_anchor, nydus_image, rafs_conf)
rafs.mount()
assert rafs.is_mounted()
workload_gen = WorkloadGen(nydus_anchor.mount_point, nydus_image.rootfs())
workload_gen.setup_workload_generator()
workload_gen.io_read(io_duration)
nydus_anchor.check_nydusd_health()
assert workload_gen.io_error == False
assert workload_gen.verify_entire_fs()
assert rafs.is_mounted()
rafs.umount()
def test_daemon_info(nydus_anchor, nydus_image, rafs_conf: RafsConf):
nydus_image.set_backend(Backend.OSS).create_image()
rafs_conf.set_rafs_backend(Backend.OSS)
rafs = RafsMount(nydus_anchor, nydus_image, rafs_conf)
rafs.mount()
nc = NydusAPIClient(rafs.get_apisock())
nc.get_wait_daemon()
def test_api_mount_with_prefetch(nydus_anchor, nydus_image: RafsImage,
rafs_conf: RafsConf):
nydus_image.set_backend(Backend.OSS).create_image()
hint_files = ["/"]
rafs = RafsMount(nydus_anchor, None, None, with_defaults=False)
# Prefetch must enable blobcache
rafs_conf.enable_rafs_blobcache()
rafs_conf.set_rafs_backend(Backend.OSS)
rafs_conf.enable_fs_prefetch(threads_count=4)
rafs_conf.dump_rafs_conf()
rafs.set_mountpoint(nydus_anchor.mount_point).apisock("api_sock").mount(
dump_config=False, )
nc = NydusAPIClient(rafs.get_apisock())
nc.pseudo_fs_mount(
nydus_image.bootstrap_path,
"/pseudo_fs_1",
rafs_conf.path(),
hint_files,
"rafs",
)
# Only one rafs mountpoint exists, so whether set rafs id or not is not important.
m = nc.get_blobcache_metrics()
# TODO this won't pass
# assert m["prefetch_data_amount"] != 0
wg = WorkloadGen(os.path.join(nydus_anchor.mount_point, "pseudo_fs_1"),
nydus_image.rootfs())
wg.setup_workload_generator()
wg.torture_read(4, 8)
wg.finish_torture_read()
m = nc.get_blobcache_metrics("/pseudo_fs_1")
def test_specified_prefetch(
nydus_anchor: NydusAnchor,
rafs_conf: RafsConf,
nydus_scratch_image: RafsImage,
backend,
):
"""
description:
Nydusd can have a list including files and directories input when started.
Then it can prefetch files from backend per as to the list.
"""
rafs_conf.set_rafs_backend(backend)
rafs_conf.enable_fs_prefetch(prefetch_all=True)
rafs_conf.enable_rafs_blobcache()
rafs_conf.dump_rafs_conf()
dist = Distributor(nydus_scratch_image.rootfs(), 8, 2)
dist.generate_tree()
dirs = dist.put_directories(20)
dist.put_multiple_files(100, Size(64, Unit.KB))
dist.put_symlinks(30)
dist.put_hardlinks(20)
dist.put_multiple_files(40, Size(64, Unit.KB))
dist.put_single_file(Size(3, Unit.MB), name="test")
nydus_scratch_image.set_backend(backend).create_image()
prefetching_files = dirs
prefetching_files += dist.files[:-10]
prefetching_files += dist.dirs[:-5]
prefetching_files += dist.symlinks[:-10]
# Fuzz
prefetching_files.append("/a/b/c/d")
prefetching_files.append(os.path.join("/", "f/g/h/"))
specified_dirs = " ".join(
[os.path.join("/", d) for d in prefetching_files])
rafs = RafsMount(nydus_anchor, nydus_scratch_image, rafs_conf)
rafs.prefetch_files(specified_dirs).mount()
wg = WorkloadGen(nydus_anchor.mount_point, nydus_scratch_image.rootfs())
nc = NydusAPIClient(rafs.get_apisock())
wg.setup_workload_generator()
blobcache_metrics = nc.get_blobcache_metrics()
wg.torture_read(5, 10)
while blobcache_metrics["prefetch_workers"] != 0:
time.sleep(0.5)
blobcache_metrics = nc.get_blobcache_metrics()
begin = nc.get_backend_metrics()["read_amount_total"]
time.sleep(1)
end = nc.get_backend_metrics()["read_amount_total"]
assert end == begin
wg.finish_torture_read()
def test_blobcache(
nydus_anchor: NydusAnchor,
nydus_image: RafsImage,
rafs_conf: RafsConf,
compressor,
backend,
):
"""
Allocate a file with local test working directory.
Loop the file so to get a small file system which is easy to get full.
Change blob cache location the above test blobdir
"""
blobdir = "/blobdir"
blob_backend = "blob_backend"
fd = os.open(blob_backend, os.O_WRONLY | os.O_CREAT | os.O_TRUNC)
os.posix_fallocate(fd, 0, 1024 * 1024 * 4)
os.close(fd)
utils.execute(["mkfs.ext4", "-F", blob_backend])
utils.execute(["mount", blob_backend, blobdir])
rafs_conf.enable_rafs_blobcache()
rafs_conf.set_rafs_backend(backend)
rafs_conf.dump_rafs_conf()
cache_file = os.listdir(blobdir)
assert len(cache_file) == 1
rafs = RafsMount(nydus_anchor, nydus_image, rafs_conf)
rafs.mount()
assert rafs.is_mounted()
workload_gen = WorkloadGen(nydus_anchor.mount_point,
nydus_anchor.source_dir)
workload_gen.setup_workload_generator()
workload_gen.torture_read(4, 15)
nydus_anchor.start_stats_checker()
workload_gen.finish_torture_read()
nydus_anchor.stop_stats_checker()
cache_file = os.listdir(blobdir)
assert len(cache_file) >= 2
if workload_gen.io_error:
warnings.warn(
UserWarning("Rafs will return EIO if blobcache file is full"))
rafs.umount()
ret, _ = utils.execute(["umount", blobdir])
assert ret
os.unlink(blob_backend)
def test_prefetch_with_cache(
nydus_anchor,
nydus_scratch_image: RafsImage,
rafs_conf: RafsConf,
thread_cnt,
compressor,
is_cache_compressed,
):
"""
title: Prefetch from various backend
description:
- Enable rafs backend blob cache, as it is disabled by default
pass_criteria:
- Rafs can be mounted.
- Rafs can be unmounted.
"""
rafs_conf.enable_rafs_blobcache(is_compressed=is_cache_compressed)
rafs_conf.set_rafs_backend(Backend.BACKEND_PROXY, prefix="object_prefix/")
rafs_conf.enable_fs_prefetch(threads_count=4,
bandwidth_rate=Size(40, Unit.MB).B)
rafs_conf.dump_rafs_conf()
dist = Distributor(nydus_scratch_image.rootfs(), 4, 4)
dist.generate_tree()
dist.put_directories(20)
dist.put_multiple_files(40, Size(3, Unit.MB))
dist.put_hardlinks(6)
dist.put_multiple_chinese_files(random.randint(20, 28), Size(20, Unit.KB))
nydus_scratch_image.set_backend(Backend.BACKEND_PROXY,
prefix="object_prefix/").create_image(
compressor=compressor,
readahead_policy="fs",
readahead_files="/".encode(),
)
rafs = RafsMount(nydus_anchor, nydus_scratch_image, rafs_conf)
rafs.thread_num(4).mount()
nc = NydusAPIClient(rafs.get_apisock())
workload_gen = WorkloadGen(nydus_anchor.mount_point,
nydus_scratch_image.rootfs())
m = nc.get_blobcache_metrics()
time.sleep(0.3)
assert m["prefetch_data_amount"] != 0
workload_gen.setup_workload_generator()
workload_gen.torture_read(thread_cnt, 10)
assert NydusAnchor.check_nydusd_health()
workload_gen.finish_torture_read()
assert not workload_gen.io_error
# In this way, we can check if nydusd is crashed.
assert rafs.is_mounted()
rafs.umount()
def test_file_tail(nydus_anchor: NydusAnchor, nydus_scratch_image: RafsImage,
backend):
"""
description: Read data from file tail
- Create several files of different sizes
- Punch hole to each file of which some should have hole tail
- Create rafs image from test scratch directory.
- Mount rafs
- Do some test.
"""
file_size_list = [
Size(1, Unit.KB),
Size(6, Unit.KB),
Size(2, Unit.MB),
Size(10034, Unit.KB),
]
file_list = []
dist = Distributor(nydus_anchor.scratch_dir, 2, 2)
dist.generate_tree()
for f_s in file_size_list:
f_name = dist.put_single_file(f_s)
file_list.append(f_name)
# Punch hole
with utils.pushd(nydus_anchor.scratch_dir):
with open(f_name, "a+b") as f:
fallocate(
f,
f_s.B - 500,
1000,
mode=FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
)
nydus_scratch_image.set_backend(backend).create_image()
rafs_conf = RafsConf(nydus_anchor, nydus_scratch_image)
rafs_conf.set_rafs_backend(backend, image=nydus_scratch_image)
rafs = RafsMount(nydus_anchor, nydus_scratch_image, rafs_conf)
rafs.mount()
with utils.pushd(nydus_anchor.mount_point):
for name in file_list:
with open(name, "rb") as f:
size = os.stat(name).st_size
f.seek(size - 300)
buf = f.read(1000)
assert len(buf) == 300
wg = WorkloadGen(nydus_anchor.mount_point, nydus_scratch_image.rootfs())
for f in file_list:
wg.verify_single_file(os.path.join(nydus_anchor.mount_point, f))
assert wg.io_error == False
def test_basic_conversion(
nydus_anchor: NydusAnchor,
rafs_conf: RafsConf,
source,
fs_version,
local_registry,
nydusify_converter,
):
"""
No need to locate where bootstrap is as we can directly pull it from registry
"""
converter = Nydusify(nydus_anchor)
time.sleep(1)
converter.docker_v2().enable_multiplatfrom(False).convert(
source, fs_version=fs_version)
assert converter.locate_bootstrap() is not None
pulled_bootstrap = converter.pull_bootstrap(
tempfile.TemporaryDirectory(dir=nydus_anchor.workspace,
suffix="bootstrap").name,
"pulled_bootstrap",
)
# Skopeo does not support media type: "application/vnd.oci.image.layer.nydus.blob.v1",
# So can't download build cache like a oci image.
layers, base = converter.extract_source_layers_names_and_download()
nydus_anchor.mount_overlayfs(layers, base)
converted_layers = converter.extract_converted_layers_names()
converted_layers.sort()
rafs_conf.set_rafs_backend(Backend.REGISTRY,
repo=posixpath.basename(source).split(":")[0])
rafs_conf.enable_fs_prefetch()
rafs_conf.enable_rafs_blobcache()
rafs_conf.dump_rafs_conf()
rafs = RafsMount(nydus_anchor, None, rafs_conf)
# Use `nydus-image inspect` to compare blob table in bootstrap and manifest
workload_gen = WorkloadGen(nydus_anchor.mount_point,
nydus_anchor.overlayfs)
# No need to locate where bootstrap is as we can directly pull it from registry
rafs.thread_num(6).bootstrap(pulled_bootstrap).prefetch_files("/").mount()
assert workload_gen.verify_entire_fs()
workload_gen.setup_workload_generator()
workload_gen.torture_read(4, 6, verify=True)
workload_gen.finish_torture_read()
def test_blob_prefetch(nydus_anchor: NydusAnchor,
nydus_scratch_image: RafsImage, readahead_policy):
"""
description:
For rafs, there are two types of prefetching.
1. Prefetch files from fs-layer, which means each file is prefetched one by one.
2. Prefetch directly from backend/blob layer, which means a range will be fetched from blob
"""
# Try to delete any access log since if it present, bootstrap blob prefetch won't work.
utils.execute("rm -rf *.access", shell=True)
dist = Distributor(nydus_scratch_image.rootfs(), 8, 2)
dist.generate_tree()
dist.put_directories(20)
dist.put_multiple_files(100, Size(64, Unit.KB))
dist.put_symlinks(30)
dist.put_hardlinks(20)
dist.put_multiple_files(40, Size(64, Unit.KB))
utils.clean_pagecache()
hint_files = dist.files[-40:]
hint_files.extend(dist.symlinks[-20:])
hint_files = [os.path.join("/", p) for p in hint_files]
hint_files = "\n".join(hint_files)
nydus_scratch_image.set_backend(Backend.LOCALFS).create_image(
readahead_policy=readahead_policy,
readahead_files=hint_files.encode(),
)
rafs_conf = RafsConf(nydus_anchor, nydus_scratch_image)
rafs_conf.set_rafs_backend(Backend.LOCALFS, image=nydus_scratch_image)
rafs_conf.enable_records_readahead(interval=1)
rafs_conf.dump_rafs_conf()
rafs = RafsMount(nydus_anchor, nydus_scratch_image, rafs_conf)
with utils.timer("Mount elapse"):
rafs.thread_num(7).mount()
assert rafs.is_mounted()
wg = WorkloadGen(nydus_anchor.mount_point, nydus_scratch_image.rootfs())
# TODO: Run several parallel read workers against the mount_point
wg.setup_workload_generator()
wg.torture_read(5, 5)
wg.finish_torture_read()
utils.clean_pagecache()
def test_blobcache_recovery(
nydus_anchor: NydusAnchor,
rafs_conf: RafsConf,
nydus_scratch_image: RafsImage,
):
rafs_conf.set_rafs_backend(Backend.BACKEND_PROXY)
rafs_conf.enable_fs_prefetch()
rafs_conf.enable_rafs_blobcache()
rafs_conf.dump_rafs_conf()
dist = Distributor(nydus_scratch_image.rootfs(), 8, 2)
dist.generate_tree()
dirs = dist.put_directories(20)
dist.put_multiple_files(100, Size(64, Unit.KB))
dist.put_symlinks(30)
dist.put_hardlinks(20)
dist.put_multiple_files(40, Size(64, Unit.KB))
dist.put_single_file(Size(3, Unit.MB), name="test")
nydus_scratch_image.set_backend(Backend.BACKEND_PROXY).create_image()
rafs = RafsMount(nydus_anchor, nydus_scratch_image, rafs_conf)
rafs.prefetch_files("/").mount()
wg = WorkloadGen(nydus_anchor.mount_point, nydus_scratch_image.rootfs())
wg.setup_workload_generator()
wg.torture_read(4, 4)
# Hopefully, prefetch can be done in 5 secondes.
time.sleep(5)
wg.finish_torture_read()
rafs.umount()
rafs2 = RafsMount(nydus_anchor, nydus_scratch_image, rafs_conf)
rafs2.mount()
wg.torture_read(4, 4)
time.sleep(0.5)
nc = NydusAPIClient(rafs2.get_apisock())
begin = nc.get_backend_metrics()["read_amount_total"]
time.sleep(1)
end = nc.get_backend_metrics()["read_amount_total"]
assert end == begin == 0
wg.finish_torture_read()
def test_build_image_param_blobid(nydus_anchor, nydus_image: RafsImage,
rafs_conf: RafsConf):
"""
description:
Test if nydus-image argument `--blob-id` works properly
"""
# More strict id check?
nydus_image.set_backend(Backend.BACKEND_PROXY).set_param(
"blob-id", uuid.uuid4()).create_image()
rafs_conf.set_rafs_backend(Backend.BACKEND_PROXY)
rafs = RafsMount(nydus_anchor, nydus_image, rafs_conf)
rafs.mount()
wg = WorkloadGen(nydus_anchor.mount_point, nydus_image.rootfs())
wg.setup_workload_generator()
wg.torture_read(5, 5)
wg.finish_torture_read()
def test_digest_validate(nydus_anchor, rafs_conf: RafsConf,
nydus_image: RafsImage, compressor):
rafs_conf.set_rafs_backend(Backend.LOCALFS)
rafs_conf.enable_validation()
rafs_conf.enable_rafs_blobcache()
nydus_image.set_backend(Backend.LOCALFS,
blob_dir=()).create_image(compressor=compressor)
rafs = RafsMount(nydus_anchor, nydus_image, rafs_conf)
rafs.mount()
wg = WorkloadGen(nydus_anchor.mount_point, nydus_image.rootfs())
wg.setup_workload_generator()
wg.torture_read(5, 5, verify=True)
wg.finish_torture_read()
def test_snapshotter_converted_images(
nydus_anchor: NydusAnchor,
rafs_conf: RafsConf,
converted_images,
nydus_snapshotter,
):
# snapshotter = Snapshotter(nydus_anchor).enable_nydus_overlayfs()
snapshotter = Snapshotter(nydus_anchor)
containerd = Containerd(nydus_anchor, snapshotter).gen_config()
snapshotter.set_root(containerd.root)
nydus_anchor.put_dustbin(snapshotter)
nydus_anchor.put_dustbin(containerd)
# We can safely pass the step provide repo configured into the rafs configuration file.
rafs_conf.set_rafs_backend(Backend.REGISTRY, scheme="https")
rafs_conf.enable_xattr()
rafs_conf.dump_rafs_conf()
snapshotter.run(rafs_conf.path())
time.sleep(1)
containerd.run()
cri = Cri(containerd.address, containerd.address)
id_set = []
for ref in converted_images:
container_name = str(uuid.uuid4())
cri.run_container(ref, container_name)
id, status = cri.check_container_status(container_name, timeout=30)
assert id is not None
assert status
id_set.append((id, ref))
time.sleep(2)
for id, ref in id_set:
cri.stop_rm_container(id)
cri.remove_image(ref)
containerd.remove_image_sync(ref)
# TODO: Rafs won't be unmounted and and nydusd still be alive even image is removed locally
# So kill all nydusd here to make following test verification pass. Is this a bug?
# Ensure nydusd must have been stopped here
time.sleep(3)
def test_snapshotter_restart(
nydus_anchor: NydusAnchor,
rafs_conf: RafsConf,
converted_images,
nydus_snapshotter,
):
snapshotter = Snapshotter(nydus_anchor)
containerd = Containerd(nydus_anchor, snapshotter).gen_config()
snapshotter.set_root(containerd.root)
nydus_anchor.put_dustbin(containerd)
# We can safely pass the step provide repo configured into the rafs configuration file.
rafs_conf.set_rafs_backend(Backend.REGISTRY, scheme="https")
rafs_conf.enable_xattr().enable_fs_prefetch().enable_rafs_blobcache(
work_dir=snapshotter.cache_dir())
rafs_conf.enable_xattr().dump_rafs_conf()
rafs_conf.dump_rafs_conf()
snapshotter.run(rafs_conf.path())
time.sleep(1)
containerd.run()
cri = Cri(containerd.address, containerd.address)
id_set = []
for ref in converted_images:
container_name = str(uuid.uuid4())
cri.run_container(ref, container_name)
id, status = cri.check_container_status(container_name, timeout=30)
assert id is not None
assert status
id_set.append((id, ref))
time.sleep(2)
snapshotter.shutdown()
snapshotter = Snapshotter(nydus_anchor)
snapshotter.set_root(containerd.root)
nydus_anchor.put_dustbin(snapshotter)
snapshotter.run(rafs_conf.path())
for id, ref in id_set:
cri.stop_rm_container(id)
cri.remove_image(ref)
containerd.remove_image_sync(ref)
def test_deep_directory(nydus_anchor, rafs_conf: RafsConf,
nydus_scratch_image: RafsImage):
dist = Distributor(nydus_anchor.scratch_dir, 100, 1)
dist.generate_tree()
nydus_scratch_image.set_backend(Backend.BACKEND_PROXY).create_image()
rafs_conf.set_rafs_backend(Backend.BACKEND_PROXY)
rafs_conf.dump_rafs_conf()
rafs = RafsMount(nydus_anchor, nydus_scratch_image, rafs_conf)
rafs.mount()
wg = WorkloadGen(nydus_anchor.mount_point, nydus_scratch_image.rootfs())
wg.setup_workload_generator()
wg.torture_read(8, 5)
wg.finish_torture_read()
assert wg.verify_entire_fs()
def test_various_file_types(nydus_anchor: NydusAnchor, rafs_conf: RafsConf,
nydus_scratch_image: RafsImage):
"""
description: Put various types of files into rootfs.
- Regular, dir, char, block, fifo, sock, symlink
"""
with utils.pushd(nydus_scratch_image.rootfs()):
fd = os.open("regular", os.O_CREAT | os.O_RDWR)
os.close(fd)
os.mkfifo("fifo")
os.mknod("blk", 0o600 | stat.S_IFBLK, device=random.randint(0, 2 ^ 64))
os.mknod("char",
0o600 | stat.S_IFCHR,
device=random.randint(0, 2 ^ 64))
os.mknod("sock",
0o600 | stat.S_IFSOCK,
device=random.randint(0, 2 ^ 64))
os.symlink("regular", "symlink")
nydus_scratch_image.set_backend(Backend.BACKEND_PROXY).create_image()
rafs_conf.set_rafs_backend(Backend.BACKEND_PROXY)
rafs = RafsMount(nydus_anchor, nydus_scratch_image, rafs_conf)
rafs.mount()
with utils.pushd(nydus_anchor.mount_point):
assert os.path.exists("fifo")
assert os.path.exists("blk")
assert os.path.exists("char")
assert os.path.exists("sock")
assert os.path.exists("symlink")
wg = WorkloadGen(nydus_anchor.mount_point, nydus_scratch_image.rootfs())
wg.setup_workload_generator()
assert wg.verify_entire_fs()
wg.torture_read(2, 4)
wg.finish_torture_read()
def test_signal_handling(nydus_anchor: NydusAnchor,
nydus_scratch_image: RafsImage, rafs_conf: RafsConf,
sig):
dist = Distributor(nydus_scratch_image.rootfs(), 2, 2)
dist.generate_tree()
dist.put_multiple_files(5, Size(2, Unit.KB))
nydus_scratch_image.set_backend(Backend.BACKEND_PROXY).create_image()
victim = os.path.join(nydus_anchor.mount_point, dist.files[-1])
rafs_conf.set_rafs_backend(Backend.BACKEND_PROXY)
rafs = RafsMount(nydus_anchor, nydus_scratch_image, rafs_conf)
rafs.mount()
fd = os.open(victim, os.O_RDONLY)
assert rafs.is_mounted()
os.kill(rafs.p.pid, sig)
time.sleep(3)
assert not os.path.ismount(nydus_anchor.mount_point)
rafs.p.wait()
def test_hardlink(nydus_anchor: NydusAnchor, nydus_scratch_image,
rafs_conf: RafsConf):
dist = Distributor(nydus_scratch_image.rootfs(), 8, 6)
dist.generate_tree()
hardlink_verifier = verifier.HardlinkVerifier(nydus_scratch_image.rootfs(),
dist)
hardlink_verifier.scratch()
nydus_scratch_image.set_backend(Backend.BACKEND_PROXY).create_image()
rafs_conf.set_rafs_backend(Backend.BACKEND_PROXY)
rafs = RafsMount(nydus_anchor, nydus_scratch_image, rafs_conf)
rafs.mount()
wg = WorkloadGen(nydus_anchor.mount_point, nydus_scratch_image.rootfs())
hardlink_verifier.verify(nydus_anchor.mount_point,
nydus_scratch_image.rootfs())
wg.setup_workload_generator()
wg.io_read(3)
nydus_anchor.check_nydusd_health()
assert wg.io_error == False
def test_stargz(
nydus_anchor: NydusAnchor,
rafs_conf: RafsConf,
nydus_scratch_image: RafsImage,
):
"""
Example command:
stargzify file:`pwd`/foo.tar.gz foo.stargz
"""
intermediator = "tmp.tar.gz"
stargz_image = "tmp.stargz"
dist = Distributor(nydus_scratch_image.rootfs(), 4, 4)
dist.generate_tree()
dirs = dist.put_directories(20)
dist.put_multiple_files(100, Size(64, Unit.KB))
dist.put_symlinks(30)
dist.put_multiple_files(10, Size(4, Unit.MB))
dist.put_hardlinks(20)
dist.put_single_file(Size(3, Unit.MB), name="test")
try:
shutil.rmtree("origin")
except Exception:
pass
shutil.copytree(nydus_scratch_image.rootfs(), "origin", symlinks=True)
utils.write_tar_gz(nydus_scratch_image.rootfs(), intermediator)
cmd = ["framework/bin/stargzify", f"file:{intermediator}", stargz_image]
utils.execute(cmd)
toc = utils.parse_stargz(stargz_image)
image = RafsImage(
nydus_anchor,
toc,
"bootstrap_scratched",
"blob_scratched",
clear_from_oss=True,
)
# This is a trick since blob name is usually a temp file created when RafsImage instantiated.
# framework will upload stargz to oss.
image.blob_abs_path = stargz_image
image.set_backend(Backend.OSS).set_param(
"blob-id", uuid.uuid4()).create_image(from_stargz=True)
rafs_conf.set_rafs_backend(Backend.OSS)
rafs_conf.enable_rafs_blobcache(is_compressed=True)
rafs = RafsMount(nydus_anchor, image, rafs_conf)
rafs.mount()
wg = WorkloadGen(nydus_anchor.mount_point, "origin")
wg.verify_entire_fs()
wg.setup_workload_generator()
wg.torture_read(4, 4)
wg.finish_torture_read()
assert not wg.io_error
def test_upload_oss(
nydus_anchor: NydusAnchor,
rafs_conf: RafsConf,
source,
local_registry,
nydusify_converter,
):
"""
docker python client manual: https://docker-py.readthedocs.io/en/stable/
Use pulled bootstrap from registry instead of newly generated by nydus-image to check if the bootstrap is pushed successfully.
"""
converter = Nydusify(nydus_anchor)
time.sleep(1)
oss_prefix = "nydus_v2/"
converter.docker_v2().backend_type(
"oss", oss_object_prefix=oss_prefix, filed=True).build_cache_ref(
"localhost:5000/build_cache:000").force_push().convert(source)
nydus_image_output = converter.nydus_image_output()
blobs_to_remove = nydus_image_output["blobs"]
# Just to observe if convertion is faster
converter.docker_v2().backend_type(
"oss", oss_object_prefix=oss_prefix).build_cache_ref(
"localhost:5000/build_cache:000").force_push().convert(source)
rafs_conf.set_rafs_backend(Backend.OSS, prefix=oss_prefix)
rafs_conf.enable_fs_prefetch()
rafs_conf.enable_rafs_blobcache()
rafs_conf.dump_rafs_conf()
bootstrap = converter.locate_bootstrap()
# `check` deletes all files
checker = Nydusify(nydus_anchor)
checker.backend_type(
"oss", oss_object_prefix=oss_prefix).with_new_work_dir(
nydus_anchor.nydusify_work_dir + "-check").check(source)
converted_layers = converter.extract_converted_layers_names()
# With oss backend, ant useage, `layers` only has one member
records = converter.get_build_cache_records(
"localhost:5000/build_cache:000")
assert len(records) != 0
cached_layers = [c["digest"] for c in records]
assert cached_layers.sort() == converted_layers.sort()
pulled_bootstrap = converter.pull_bootstrap(
tempfile.TemporaryDirectory(dir=nydus_anchor.workspace,
suffix="bootstrap").name,
"pulled_bootstrap",
)
layers, base = converter.extract_source_layers_names_and_download()
nydus_anchor.mount_overlayfs(layers, base)
rafs = RafsMount(nydus_anchor, None, rafs_conf)
workload_gen = WorkloadGen(nydus_anchor.mount_point,
nydus_anchor.overlayfs)
rafs.thread_num(6).bootstrap(pulled_bootstrap).prefetch_files("/").mount()
assert workload_gen.verify_entire_fs()
workload_gen.setup_workload_generator()
workload_gen.torture_read(8, 12, verify=True)
workload_gen.finish_torture_read()
oss = OssHelper(
nydus_anchor.ossutil_bin,
endpoint=nydus_anchor.oss_endpoint,
bucket=nydus_anchor.oss_bucket,
ak_id=nydus_anchor.oss_ak_id,
ak_secret=nydus_anchor.oss_ak_secret,
prefix=None,
)
# Nydusify will skip upload blob as object if it exists.
for b in blobs_to_remove:
oss.rm(b)
def test_backend_swap(nydus_anchor, nydus_scratch_image: RafsImage,
rafs_conf: RafsConf):
dist = Distributor(nydus_scratch_image.rootfs(), 5, 4)
dist.generate_tree()
dist.put_multiple_files(100, Size(2, Unit.MB))
nydus_scratch_image.set_backend(Backend.OSS).create_image(
readahead_policy="fs", readahead_files="/".encode())
rafs_conf.set_rafs_backend(
Backend.OSS).enable_rafs_blobcache().enable_fs_prefetch(
threads_count=7, bandwidth_rate=Size(2, Unit.MB).B)
rafs_conf.dump_rafs_conf()
rafs = RafsMount(nydus_anchor, None, rafs_conf, with_defaults=False)
rafs.thread_num(4).set_mountpoint(
nydus_anchor.mount_point).apisock("api_sock").mount()
nc = NydusAPIClient(rafs.get_apisock())
nc.pseudo_fs_mount(nydus_scratch_image.bootstrap_path, "/",
rafs_conf.path(), None)
nc.umount_rafs("/")
assert len(os.listdir(nydus_anchor.mount_point)) == 0
mp = "/pseudo1"
nc.pseudo_fs_mount(nydus_scratch_image.bootstrap_path, mp,
rafs_conf.path(), None)
rafs_conf_2nd = RafsConf(nydus_anchor, nydus_scratch_image)
rafs_conf_2nd.set_rafs_backend(
Backend.LOCALFS,
image=nydus_scratch_image).enable_rafs_blobcache().enable_fs_prefetch(
threads_count=3, bandwidth_rate=Size(1, Unit.MB).B)
rafs_conf_2nd.dump_rafs_conf()
new_image = (RafsImage(
nydus_anchor, nydus_scratch_image.rootfs()).set_backend(
Backend.LOCALFS).create_image(readahead_policy="fs",
readahead_files="/".encode()))
# TODO: Once upon a time, more than one fd are open. Check why this happens.
wg = WorkloadGen(
os.path.join(nydus_anchor.mount_point, mp.strip("/")),
nydus_scratch_image.rootfs(),
)
wg.setup_workload_generator()
wg.torture_read(8, 8)
for i in range(1, 50):
logging.debug("swap for the %dth time", i)
nc.swap_backend(mp, new_image.bootstrap_name, rafs_conf_2nd.path())
# assert nc.get_blobcache_metrics(mp)["prefetch_workers"] == 3
time.sleep(0.2)
nc.swap_backend(mp, nydus_scratch_image.bootstrap_name,
rafs_conf.path())
utils.clean_pagecache()
wg.finish_torture_read()
assert wg.io_error == False
nc.umount_rafs(mp)
utils.clean_pagecache()
def test_pseudo_fs(nydus_anchor, nydus_image, rafs_conf: RafsConf):
nydus_image.set_backend(Backend.BACKEND_PROXY).create_image()
rafs_conf.set_rafs_backend(Backend.BACKEND_PROXY)
rafs = RafsMount(nydus_anchor, None, rafs_conf)
rafs.mount()
time.sleep(1)
nc = NydusAPIClient(rafs.get_apisock())
try:
shutil.rmtree("pseudo_fs_scratch")
except FileNotFoundError:
pass
scratch_rootfs = shutil.copytree(nydus_image.rootfs(),
"pseudo_fs_scratch",
symlinks=True)
dist = Distributor(scratch_rootfs, 5, 5)
dist.generate_tree()
dist.put_multiple_files(20, Size(8, Unit.KB))
###
suffix = "1"
image = RafsImage(
nydus_anchor,
scratch_rootfs,
"bs" + suffix,
"blob" + suffix,
)
conf = RafsConf(nydus_anchor)
conf.enable_fs_prefetch()
conf.enable_validation()
conf.set_rafs_backend(Backend.BACKEND_PROXY)
conf.dump_rafs_conf()
image.set_backend(Backend.BACKEND_PROXY).create_image()
nc.pseudo_fs_mount(image.bootstrap_path, f"/pseudo{suffix}", conf.path(),
None)
###
suffix = "2"
image = RafsImage(
nydus_anchor,
scratch_rootfs,
"bs" + suffix,
"blob" + suffix,
)
conf = RafsConf(nydus_anchor)
conf.enable_rafs_blobcache()
conf.enable_validation()
conf.enable_records_readahead()
conf.set_rafs_backend(Backend.BACKEND_PROXY)
conf.dump_rafs_conf()
dist.put_multiple_files(20, Size(8, Unit.KB))
image.set_backend(Backend.BACKEND_PROXY).create_image()
nc.pseudo_fs_mount(image.bootstrap_path, f"/pseudo{suffix}", conf.path(),
None)
###
suffix = "3"
image = RafsImage(
nydus_anchor,
scratch_rootfs,
"bs" + suffix,
"blob" + suffix,
)
conf = RafsConf(nydus_anchor)
conf.enable_rafs_blobcache()
conf.enable_records_readahead()
conf.set_rafs_backend(Backend.BACKEND_PROXY)
conf.dump_rafs_conf()
dist.put_multiple_files(20, Size(8, Unit.KB))
image.set_backend(Backend.BACKEND_PROXY).create_image()
nc.pseudo_fs_mount(image.bootstrap_path, f"/pseudo{suffix}", conf.path(),
None)
wg1 = WorkloadGen(os.path.join(nydus_anchor.mount_point, "pseudo1"),
scratch_rootfs)
wg2 = WorkloadGen(os.path.join(nydus_anchor.mount_point, "pseudo2"),
scratch_rootfs)
wg3 = WorkloadGen(os.path.join(nydus_anchor.mount_point, "pseudo3"),
scratch_rootfs)
time.sleep(2)
wg1.setup_workload_generator()
wg2.setup_workload_generator()
wg3.setup_workload_generator()
wg1.torture_read(4, 8)
wg2.torture_read(4, 8)
wg3.torture_read(4, 8)
wg1.finish_torture_read()
wg2.finish_torture_read()
wg3.finish_torture_read()
# TODO: Temporarily disable the verification as hard to select `verify dir`
# assert wg1.verify_entire_fs()
# assert wg2.verify_entire_fs()
# assert wg3.verify_entire_fs()
nc.umount_rafs("/pseudo1")
nc.umount_rafs("/pseudo2")
nc.umount_rafs("/pseudo3")
def test_prefetch_with_cache(
nydus_anchor,
nydus_scratch_image: RafsImage,
rafs_conf: RafsConf,
thread_cnt,
compressor,
is_cache_compressed,
converter,
items,
):
"""
title: Prefetch from various backend
description:
- Enable rafs backend blob cache, as it is disabled by default
pass_criteria:
- Rafs can be mounted.
- Rafs can be unmounted.
"""
dist = Distributor(nydus_scratch_image.rootfs(), 4, 4)
dist.generate_tree()
dist.put_directories(20)
dist.put_multiple_files(40, Size(3, Unit.MB))
dist.put_multiple_files(10, Size(5, Unit.MB))
dist.put_hardlinks(6)
dist.put_multiple_chinese_files(random.randint(20, 28), Size(20, Unit.KB))
nydus_scratch_image.set_backend(Backend.LOCALFS).create_image(
image_bin=converter,
compressor=compressor,
readahead_policy="fs",
readahead_files="/".encode(),
)
rafs_conf.enable_rafs_blobcache(
is_compressed=is_cache_compressed).enable_fs_prefetch()
rafs_conf.set_rafs_backend(Backend.LOCALFS, image=nydus_scratch_image)
if len(items) > 0:
for i in items:
item = RafsConf.__dict__[i]
item(rafs_conf)
rafs = RafsMount(nydus_anchor, nydus_scratch_image, rafs_conf)
rafs.thread_num(6).mount()
nc = NydusAPIClient(rafs.get_apisock())
workload_gen = WorkloadGen(nydus_anchor.mount_point,
nydus_scratch_image.rootfs())
m = nc.get_blobcache_metrics()
time.sleep(0.3)
assert m["prefetch_data_amount"] != 0
workload_gen.verify_entire_fs()
workload_gen.setup_workload_generator()
workload_gen.torture_read(thread_cnt, 6)
assert NydusAnchor.check_nydusd_health()
workload_gen.finish_torture_read()
assert not workload_gen.io_error
def test_cross_platform_multiplatform(
nydus_anchor: NydusAnchor,
rafs_conf: RafsConf,
source,
arch,
enable_multiplatform,
local_registry,
nydusify_converter,
):
"""
- copy the entire repo from source registry to target registry
- One image coresponds to manifest list while the other one to single manifest
- Use cloned source rather than the one from original registry
- Push the converted images to the original source
- Also test multiplatform here
- ? Seems with flag --multiplatform to nydusify, it still just push single manifest
- converted manifest index has one more image than origin.
"""
# Copy the entire repo for multiplatform
skopeo = utils.Skopeo()
source_name_tagged = posixpath.basename(source)
target_image = f"localhost:5000/{source_name_tagged}"
cloned_source = f"localhost:5000/{source_name_tagged}"
skopeo.copy_all_to_registry(source, target_image)
origin_manifest_index = skopeo.manifest_list(cloned_source)
utils.Skopeo.pretty_print(origin_manifest_index)
converter = Nydusify(nydus_anchor)
converter.docker_v2(
).build_cache_ref("localhost:5000/build_cache:000").platform(
f"linux/{arch}").enable_multiplatfrom(enable_multiplatform).convert(
cloned_source, target_ref=target_image)
# TODO: configure registry backend from `local_registry` rather than anchor
rafs_conf.set_rafs_backend(Backend.REGISTRY,
repo=posixpath.basename(source).split(":")[0])
rafs_conf.enable_fs_prefetch()
rafs_conf.enable_rafs_blobcache()
pulled_bootstrap = converter.pull_bootstrap(
tempfile.TemporaryDirectory(dir=nydus_anchor.workspace,
suffix="bootstrap").name,
"pulled_bootstrap",
arch,
)
# Skopeo does not support media type: "application/vnd.oci.image.layer.nydus.blob.v1",
# So can't download build cache like a oci image.
layers, base = converter.extract_source_layers_names_and_download(
arch=arch)
nydus_anchor.mount_overlayfs(layers, base)
converted_layers = converter.extract_converted_layers_names(arch=arch)
converted_layers.sort()
converted_manifest_index = skopeo.manifest_list(cloned_source)
utils.Skopeo.pretty_print(converted_manifest_index)
assert (len(converted_manifest_index["manifests"]) -
len(origin_manifest_index["manifests"]) == 1)
# `inspect` will succeed if image to arch can be found.
skopeo.inspect(target_image, image_arch=arch)
converter.find_nydus_image(target_image, arch)
target_image_config = converter.pull_config(target_image, arch=arch)
assert target_image_config["architecture"] == arch
records = converter.get_build_cache_records(
"localhost:5000/build_cache:000")
assert len(records) != 0
cached_layers = [c["digest"] for c in records]
cached_layers.sort()
# > assert cached_layers == converted_layers
# E AssertionError: assert None == ['sha256:3f18...af3234b4c257']
# E +None
# E -['sha256:3f18b27a912188108c8590684206bd9da7d81bbfd0e8325f3ef0af3234b4c257']
for r in converted_layers:
assert r in cached_layers
# Use `nydus-image inspect` to compare blob table in bootstrap and manifest
workload_gen = WorkloadGen(nydus_anchor.mount_point,
nydus_anchor.overlayfs)
# No need to locate where bootstrap is as we can directly pull it from registry
rafs = RafsMount(nydus_anchor, None, rafs_conf)
rafs.thread_num(6).bootstrap(pulled_bootstrap).prefetch_files("/").mount()
assert workload_gen.verify_entire_fs()
workload_gen.setup_workload_generator()
workload_gen.torture_read(8, 12, verify=True)
workload_gen.finish_torture_read()