Skip to content

Add find_manifest_descriptor_with_tag #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cgwalters merged 2 commits into from
Oct 12, 2024
Merged

Add find_manifest_descriptor_with_tag #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f3d811
Add find_manifest_descriptor_with_tag
ariel-miculas Sep 30, 2024
7f58190
Modify read_index to return an ImageIndex instead of an Option<ImageI…
ariel-miculas Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To access an existing OCI directory:
# fn main() -> anyhow::Result<()> {
let d = cap_std::fs::Dir::open_ambient_dir("/path/to/ocidir", cap_std::ambient_authority())?;
let d = ocidir::OciDir::open(d)?;
println!("{:?}", d.read_index()?.ok_or_else(|| anyhow!("missing Image Index"))?);
println!("{:?}", d.read_index()?);
# Ok(())
# }
```
Expand Down
76 changes: 42 additions & 34 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ pub enum Error {
#[error("Expected digest algorithm sha256 but found {found}")]
/// Returned when a digest algorithm is not supported
UnsupportedDigestAlgorithm { found: Box<str> },
#[error("Cannot find the Image Index (index.json)")]
/// Returned when the OCI Image Index (index.json) is missing
MissingImageIndex,
#[error("error")]
/// An unknown other error
Other(Box<str>),
Expand Down Expand Up @@ -384,9 +387,7 @@ impl OciDir {

/// Returns `true` if the manifest is already present.
pub fn has_manifest(&self, desc: &oci_spec::image::Descriptor) -> Result<bool> {
let Some(index) = self.read_index()? else {
return Ok(false);
};
let index = self.read_index()?;
Ok(index
.manifests()
.iter()
Expand Down Expand Up @@ -414,11 +415,11 @@ impl OciDir {
}

/// Read the image index.
pub fn read_index(&self) -> Result<Option<ImageIndex>> {
pub fn read_index(&self) -> Result<ImageIndex> {
let r = if let Some(index) = self.dir.open_optional("index.json")?.map(BufReader::new) {
Some(oci_image::ImageIndex::from_reader(index)?)
oci_image::ImageIndex::from_reader(index)?
} else {
None
return Err(Error::MissingImageIndex);
};
Ok(r)
}
Expand All @@ -442,21 +443,23 @@ impl OciDir {
manifest.set_annotations(Some(annotations));
}

let index = self.read_index()?;
let index = if let Some(mut index) = index {
let mut manifests = index.manifests().clone();
if let Some(tag) = tag {
manifests.retain(|d| !Self::descriptor_is_tagged(d, tag));
let index = match self.read_index() {
Ok(mut index) => {
let mut manifests = index.manifests().clone();
if let Some(tag) = tag {
manifests.retain(|d| !Self::descriptor_is_tagged(d, tag));
}
manifests.push(manifest.clone());
index.set_manifests(manifests);
index
}
manifests.push(manifest.clone());
index.set_manifests(manifests);
index
} else {
oci_image::ImageIndexBuilder::default()
Err(Error::MissingImageIndex) => oci_image::ImageIndexBuilder::default()
.schema_version(oci_image::SCHEMA_VERSION)
.manifests(vec![manifest.clone()])
.build()
.unwrap()
.build()?,
Err(e) => {
return Err(e);
}
};

self.dir
Expand Down Expand Up @@ -519,14 +522,21 @@ impl OciDir {

/// Find the manifest with the provided tag
pub fn find_manifest_with_tag(&self, tag: &str) -> Result<Option<oci_image::ImageManifest>> {
let f = self.dir.open("index.json")?;
let idx: oci_image::ImageIndex = serde_json::from_reader(BufReader::new(f))?;
for img in idx.manifests() {
if Self::descriptor_is_tagged(img, tag) {
return self.read_json_blob(img).map(Some);
}
}
Ok(None)
let desc = self.find_manifest_descriptor_with_tag(tag)?;
desc.map(|img| self.read_json_blob(&img)).transpose()
}

/// Find the manifest descriptor with the provided tag
pub fn find_manifest_descriptor_with_tag(
&self,
tag: &str,
) -> Result<Option<oci_image::Descriptor>> {
let idx = self.read_index()?;
Ok(idx
.manifests()
.iter()
.find(|desc| Self::descriptor_is_tagged(desc, tag))
.cloned())
}

/// Verify a single manifest and all of its referenced objects.
Expand Down Expand Up @@ -567,9 +577,7 @@ impl OciDir {
/// Verify consistency of the index, its manifests, the config and blobs (all the latter)
/// by verifying their descriptor.
pub fn fsck(&self) -> Result<u64> {
let Some(index) = self.read_index()? else {
return Ok(0);
};
let index = self.read_index()?;
let mut validated_blobs = HashSet::new();
for manifest_descriptor in index.manifests() {
let expected_sha256 = sha256_of_descriptor(manifest_descriptor)?;
Expand Down Expand Up @@ -813,7 +821,7 @@ mod tests {
"349438e5faf763e8875b43de4d7101540ef4d865190336c2cc549a11f33f8d7c"
);
// Nothing referencing this blob yet
assert_eq!(w.fsck().unwrap(), 0);
assert!(matches!(w.fsck().unwrap_err(), Error::MissingImageIndex));
assert!(w.has_blob(&root_layer_desc).unwrap());

// Check that we don't find nonexistent blobs
Expand All @@ -834,7 +842,7 @@ mod tests {
let config = w.write_config(config)?;
manifest.set_config(config);
w.replace_with_single_manifest(manifest.clone(), oci_image::Platform::default())?;
assert_eq!(w.read_index().unwrap().unwrap().manifests().len(), 1);
assert_eq!(w.read_index().unwrap().manifests().len(), 1);
assert_eq!(w.fsck().unwrap(), 3);
// Also verify that corrupting a blob is found
{
Expand All @@ -851,7 +859,7 @@ mod tests {
assert_eq!(w.fsck().unwrap(), 3);
}

let idx = w.read_index()?.unwrap();
let idx = w.read_index()?;
let manifest_desc = idx.manifests().first().unwrap();
let read_manifest = w.read_json_blob(manifest_desc).unwrap();
assert_eq!(&read_manifest, &manifest);
Expand All @@ -860,7 +868,7 @@ mod tests {
w.insert_manifest(manifest, Some("latest"), oci_image::Platform::default())?;
assert!(w.has_manifest(&desc).unwrap());
// There's more than one now
assert_eq!(w.read_index().unwrap().unwrap().manifests().len(), 2);
assert_eq!(w.read_index().unwrap().manifests().len(), 2);

assert!(w.find_manifest_with_tag("noent").unwrap().is_none());
let found_via_tag = w.find_manifest_with_tag("latest").unwrap().unwrap();
Expand All @@ -880,7 +888,7 @@ mod tests {
Some("latest"),
oci_image::Platform::default(),
)?;
assert_eq!(w.read_index().unwrap().unwrap().manifests().len(), 2);
assert_eq!(w.read_index().unwrap().manifests().len(), 2);
assert_eq!(w.fsck().unwrap(), 6);
Ok(())
}
Expand Down