def test_large_file(nydus_anchor, compressor, backend, amplified_size):
_tmp_dir = tempfile.TemporaryDirectory(dir=nydus_anchor.workspace)
large_file_dir = _tmp_dir.name
dist = Distributor(large_file_dir, 3, 3)
dist.generate_tree()
dist.put_single_file(Size(20, Unit.MB))
dist.put_single_file(Size(10891, Unit.KB))
dist.put_multiple_files(10, Size(2, Unit.MB))
dist.put_multiple_files(10, Size(4, Unit.MB))
image = RafsImage(nydus_anchor, large_file_dir, "bs_large", "blob_large")
image.set_backend(backend).create_image(compressor=compressor)
rafs_conf = (RafsConf(nydus_anchor,
image).enable_rafs_blobcache().amplify_io(
amplified_size).set_rafs_backend(backend,
image=image))
rafs = RafsMount(nydus_anchor, image, rafs_conf)
rafs.thread_num(4).mount()
workload_gen = WorkloadGen(nydus_anchor.mount_point, large_file_dir)
workload_gen.setup_workload_generator()
workload_gen.torture_read(8, 5)
workload_gen.finish_torture_read()
assert not workload_gen.io_error
rafs.umount()
image.clean_up()
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_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_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_detect_io_hang(nydus_anchor, nydus_image: RafsImage,
rafs_conf: RafsConf):
rafs_conf.enable_files_iostats().set_rafs_backend(Backend.OSS)
rafs_conf.dump_rafs_conf()
nydus_image.set_backend(Backend.OSS).create_image()
rafs = RafsMount(nydus_anchor, nydus_image, rafs_conf)
rafs.thread_num(5).mount()
wg = WorkloadGen(nydus_anchor.mount_point, nydus_image.rootfs())
wg.setup_workload_generator()
wg.torture_read(4, 8)
nc = NydusAPIClient(rafs.get_apisock())
for _ in range(0, 30):
ops = nc.get_inflight_metrics()
time.sleep(0.1)
print(ops)
wg.finish_torture_read()
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_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()
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)