Skip to content
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.

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

feat: Implement Pack Manifests #149

Merged
merged 15 commits into from
Nov 12, 2024
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// Copyright The ORAS Authors.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System;

namespace OrasProject.Oras.Exceptions;

/// <summary>
/// InvalidDateTimeFormatException is thrown when a time format is invalid.
/// </summary>
public class InvalidDateTimeFormatException : FormatException
{
public InvalidDateTimeFormatException()
{
}

Check warning on line 25 in src/OrasProject.Oras/Exceptions/InvalidDateTimeFormatException.cs

View check run for this annotation

Codecov / codecov/patch

src/OrasProject.Oras/Exceptions/InvalidDateTimeFormatException.cs#L23-L25

Added lines #L23 - L25 were not covered by tests

public InvalidDateTimeFormatException(string? message)
: base(message)
{
}

Check warning on line 30 in src/OrasProject.Oras/Exceptions/InvalidDateTimeFormatException.cs

View check run for this annotation

Codecov / codecov/patch

src/OrasProject.Oras/Exceptions/InvalidDateTimeFormatException.cs#L28-L30

Added lines #L28 - L30 were not covered by tests

public InvalidDateTimeFormatException(string? message, Exception? inner)
: base(message, inner)
{
}

Check warning on line 35 in src/OrasProject.Oras/Exceptions/InvalidDateTimeFormatException.cs

View check run for this annotation

Codecov / codecov/patch

src/OrasProject.Oras/Exceptions/InvalidDateTimeFormatException.cs#L33-L35

Added lines #L33 - L35 were not covered by tests
}
36 changes: 36 additions & 0 deletions src/OrasProject.Oras/Exceptions/InvalidMediaTypeException.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// Copyright The ORAS Authors.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System;

namespace OrasProject.Oras.Exceptions;

/// <summary>
/// InvalidMediaTypeException is thrown when media type is invalid.
/// </summary>
public class InvalidMediaTypeException : FormatException
{
public InvalidMediaTypeException()
{
}

Check warning on line 25 in src/OrasProject.Oras/Exceptions/InvalidMediaTypeException.cs

View check run for this annotation

Codecov / codecov/patch

src/OrasProject.Oras/Exceptions/InvalidMediaTypeException.cs#L23-L25

Added lines #L23 - L25 were not covered by tests

public InvalidMediaTypeException(string? message)
: base(message)
{
}

public InvalidMediaTypeException(string? message, Exception? inner)
: base(message, inner)
{
}

Check warning on line 35 in src/OrasProject.Oras/Exceptions/InvalidMediaTypeException.cs

View check run for this annotation

Codecov / codecov/patch

src/OrasProject.Oras/Exceptions/InvalidMediaTypeException.cs#L33-L35

Added lines #L33 - L35 were not covered by tests
}
36 changes: 36 additions & 0 deletions src/OrasProject.Oras/Exceptions/MissingArtifactTypeException.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// Copyright The ORAS Authors.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System;

namespace OrasProject.Oras.Exceptions;

/// <summary>
/// MissingArtifactTypeException is thrown when artifactType is not found in manifest.
/// </summary>
public class MissingArtifactTypeException : FormatException
{
public MissingArtifactTypeException()
{
}

Check warning on line 25 in src/OrasProject.Oras/Exceptions/MissingArtifactTypeException.cs

View check run for this annotation

Codecov / codecov/patch

src/OrasProject.Oras/Exceptions/MissingArtifactTypeException.cs#L23-L25

Added lines #L23 - L25 were not covered by tests

public MissingArtifactTypeException(string? message)
: base(message)
{
}

public MissingArtifactTypeException(string? message, Exception? inner)
: base(message, inner)
{
}

Check warning on line 35 in src/OrasProject.Oras/Exceptions/MissingArtifactTypeException.cs

View check run for this annotation

Codecov / codecov/patch

src/OrasProject.Oras/Exceptions/MissingArtifactTypeException.cs#L33-L35

Added lines #L33 - L35 were not covered by tests
}
17 changes: 17 additions & 0 deletions src/OrasProject.Oras/Oci/Descriptor.cs
nhu1997 marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@
// See the License for the specific language governing permissions and
// limitations under the License.

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Text;
using System.Text.Json.Serialization;

namespace OrasProject.Oras.Oci;
Expand Down Expand Up @@ -47,5 +50,19 @@ public class Descriptor
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? ArtifactType { get; set; }

public static Descriptor Create(Span<byte> data, string mediaType)
{
byte[] byteData = data.ToArray();
return new Descriptor
{
MediaType = mediaType,
Data = byteData,
nhu1997 marked this conversation as resolved.
Show resolved Hide resolved
Digest = OrasProject.Oras.Content.Digest.ComputeSHA256(byteData),
Size = byteData.Length
};
}

public static Descriptor Empty => Descriptor.Create(new byte[] { 0x7B, 0x7D }, OrasProject.Oras.Oci.MediaType.EmptyJson);
nhu1997 marked this conversation as resolved.
Show resolved Hide resolved

internal BasicDescriptor BasicDescriptor => new BasicDescriptor(MediaType, Digest, Size);
}
55 changes: 55 additions & 0 deletions src/OrasProject.Oras/PackManifestOptions.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
// Copyright The ORAS Authors.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using OrasProject.Oras.Oci;

using System.Collections.Generic;
using System.Threading;

namespace OrasProject.Oras;

public struct PackManifestOptions
{
public static PackManifestOptions None { get; }

Check warning on line 23 in src/OrasProject.Oras/PackManifestOptions.cs

View check run for this annotation

Codecov / codecov/patch

src/OrasProject.Oras/PackManifestOptions.cs#L23

Added line #L23 was not covered by tests

/// <summary>
/// Config references a configuration object for a container, by digest
/// For more details: https://github.com/opencontainers/image-spec/blob/v1.1.0/manifest.md#image-manifest-property-descriptions.
/// </summary>
public Descriptor Config { get; set; }
nhu1997 marked this conversation as resolved.
Show resolved Hide resolved

/// <summary>
/// Layers is an array of objects, and each object id a Content Descriptor (or simply Descriptor)
/// For more details: https://github.com/opencontainers/image-spec/blob/v1.1.0/manifest.md#image-manifest-property-descriptions.
/// </summary>
public IList<Descriptor>? Layers { get; set; }

/// <summary>
/// Subject is the subject of the manifest.
/// This option is invalid when PackManifestVersion is PackManifestVersion1_0.
/// </summary>
public Descriptor? Subject { get; set; }

/// <summary>
/// ManifestAnnotations is OPTIONAL property. It contains arbitrary metadata for the image manifest
/// and MUST use the annotation rules
/// </summary>
public IDictionary<string, string>? ManifestAnnotations { get; set; }

/// <summary>
/// ConfigAnnotations is the annotation map of the config descriptor.
/// This option is valid only when Config is null.
/// </summary>
public IDictionary<string, string>? ConfigAnnotations { get; set; }
}

Loading
Loading