[ACR] Add upload/download code for blobs and manifests (Azure#27383)

* new branch for OCI Blobs additions

* add ContentDescriptor and swagger transfrom to set manifest Content-Type

* more swagger transforms

* make OciManifest a public type

* Add UploadManifest(Manifest) overload

* add generated API listing

* remove unused options types.  add strongly-typed overload for stream.  support only OCI manifest format

* update api

* API tweaks

* make upload artifact succeed

* record the successful test run

* Support Upload and Download manifest

* api updates

* remove abstract base Manifest class from public API

* change approach to validation for blob download

* light tidy

* more tidy up

* test cleanup

* remove unused type

* update docstrings

* combine file paths differently

* make test data available

* pr fb

* remove manifest stream upload methods

* update changelog and project version

* update API listing

* update changelog

* Increment version for containerregistry releases (Azure#23836)

Increment package version after release of Azure.Containers.ContainerRegistry

* [ACR] Add an overload for `UploadManifest()` that takes a `Stream` as input (Azure#24685)

* Add an overload for `UploadManifest()` that takes a `Stream` as input

* Add an overload for `DownloadManifest()` that takes a tag or a digest as input

* Remove `DownloadManifest()` overload that takes a digest parameter

* Implement `IDisposable` on `Stream` containing result types
Validate manifest digest in `UploadManifest` methods

* Update Changelog

* Ensure that `Digest` is always populated in `DownloadManifestResult`

* Extract digest from response if needed for validation

* Use the `using` syntax to dispose objects
Remove an errant '.' in the README

* Avoid computing digest twice

Co-authored-by: Anne Thompson <[email protected]>

* Transform swagger to upload stream as manifest

* Copy stream locally to avoid working with a closed stream
Reset stream position when neeed

* Extract content digest from header for validation
Add test to upload manifest with tag and download by tag and digest

* Reset downloaded manifest stream before returning
Add test to validate that downloadStream.Position = 0

Co-authored-by: Anne Thompson <[email protected]>

* [ACR] Verify Audience must be set in Options (Azure#24889)

* Increment version for containerregistry releases (Azure#24910)

Increment package version after release of Azure.Containers.ContainerRegistry

* [ACR] Support anon access in ACR blob client (Azure#25087)

* Support anon access in ACR blob client

* Incorporate analyzer suggestions

* Use https for sparse checkout command (Azure#25067)

Co-authored-by: Ben Broderick Phillips <[email protected]>

* Update cspell.json from main

Co-authored-by: Azure SDK Bot <[email protected]>
Co-authored-by: Ben Broderick Phillips <[email protected]>

* [ACR] Mark version 1.1.0-beta.3 in release (Azure#25156)

* Increment version for containerregistry releases (Azure#25237)

Increment package version after release of Azure.Containers.ContainerRegistry

* Use `ResponseError` when creating `RequestFailedException`

* Add `GetTagPropertiesCollection()` on `RegistryArtifact`

* Update test session records

* Update test session records

* Temporarily mark `CanUploadBlob()` test as ignored

* Update test session records for `CanUploadOciManifest()`

* Sanitize 'access_token' and 'refresh_token' from request and response headers

* Clean-up `CanUploadBlob()` test session records

* Revert sanitizing the entire 'refresh_token' and 'access_token'

* Regenerate test session records after fix in Core test recording code

* Create test session record for `CanUploadBlob()` test
The test passes on .NET 6.0

* Remove download-blob step in the `CanUploadBlob()` test

* Undo temporary changes made to test service behavior

* Fix order of entries in Changelog

* Update session records for `CanUploadBlob()` test

* Add `Tag` as an optional param to `UploadManifestOptions`

* Update public API

* Ignore comparison of 'Accept' header values

* Update release date of preview package

Co-authored-by: Anne Thompson <[email protected]>
Co-authored-by: Azure SDK Bot <[email protected]>
Co-authored-by: Ben Broderick Phillips <[email protected]>

Author: 4 people

sdk/containerregistry/Azure.Containers.ContainerRegistry/CHANGELOG.md

@@ -1,32 +1,53 @@
 # Release History
 
-## 1.1.0-beta.1 (Unreleased)
+## 1.1.0-beta.4 (2022-04-05)
 
 ### Features Added
 
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
+- Unifies features from the earlier preview releases with the latest stable release.
 
 ## 1.0.0 (2022-01-11)
 
 ### Features Added
 
 - Adds stable features and bug fixes from the earlier preview releases.
+
 ### Breaking Changes
 
 - Renamed `ArtifactManifestOrderBy` to `ArtifactManifestOrder`.
 - Renamed `ArtifactTagOrderBy` to `ArtifactTagOrder`.
 
-
 ## 1.0.0-beta.5 (2021-11-18)
 
 ### Features Added
 - Updated the supported service version to "2021-07-01".
 - Added support to create instances of `ArtifactManifestProperties` using the `ContainerRegistryModelFactory`.
 
+## 1.1.0-beta.3 (2021-11-09)
+
+### Features Added
+
+- Added support for [anonymous pull access](https://docs.microsoft.com/azure/container-registry/anonymous-pull-access#configure-anonymous-pull-access) using the `ContainerRegistryBlobClient`
+
+## 1.1.0-beta.2 (2021-10-13)
+
+### Features Added
+
+- Added an overload for `UploadManifest(Async) method that takes the manifest `Stream` as an input.
+- Added methods in `ContainerRegistryModelFactory` that create instances of `DownloadBlobResult`, `DownloadManifestResult`, `UploadBlobResult` and `UploadManifestResult` for mocking.
+- Added `DownloadManifestOptions` type to allow callers to  pass-in either a tag or a digest in `DownloadManifest(Async)`.
+- Added `ManifestStream` as a property in `DownloadManifestResult` that contains the raw manifest stream from the service response.
+
+### Breaking Changes
+
+- Changed `DownloadManifest(Async)` method to take `DownloadManifestOptions` as an input parameter. This allows callers to pass-in either a tag or a digest as the manifest identifier.
+
+## 1.1.0-beta.1 (2021-09-07)
+
+### Features Added
+
+- Added `ContainerRegistryBlobClient` with methods to upload and download OCI Manifests and artifact blobs, to enable implementation of push/pull for OCI artifacts.
+
 ## 1.0.0-beta.4 (2021-08-10)
 
 ### Breaking Changes

sdk/containerregistry/Azure.Containers.ContainerRegistry/api/Azure.Containers.ContainerRegistry.netstandard2.0.cs

@@ -160,6 +160,10 @@ public static partial class ContainerRegistryModelFactory
         public static Azure.Containers.ContainerRegistry.ArtifactManifestProperties ArtifactManifestProperties(string registryLoginServer = null, string repositoryName = null, string digest = null, long? sizeInBytes = default(long?), System.DateTimeOffset createdOn = default(System.DateTimeOffset), System.DateTimeOffset lastUpdatedOn = default(System.DateTimeOffset), Azure.Containers.ContainerRegistry.ArtifactArchitecture? architecture = default(Azure.Containers.ContainerRegistry.ArtifactArchitecture?), Azure.Containers.ContainerRegistry.ArtifactOperatingSystem? operatingSystem = default(Azure.Containers.ContainerRegistry.ArtifactOperatingSystem?), System.Collections.Generic.IEnumerable<Azure.Containers.ContainerRegistry.ArtifactManifestPlatform> relatedArtifacts = null, System.Collections.Generic.IEnumerable<string> tags = null, bool? canDelete = default(bool?), bool? canWrite = default(bool?), bool? canList = default(bool?), bool? canRead = default(bool?)) { throw null; }
         public static Azure.Containers.ContainerRegistry.ArtifactTagProperties ArtifactTagProperties(string registryLoginServer = null, string repositoryName = null, string name = null, string digest = null, System.DateTimeOffset createdOn = default(System.DateTimeOffset), System.DateTimeOffset lastUpdatedOn = default(System.DateTimeOffset), bool? canDelete = default(bool?), bool? canWrite = default(bool?), bool? canList = default(bool?), bool? canRead = default(bool?)) { throw null; }
         public static Azure.Containers.ContainerRegistry.ContainerRepositoryProperties ContainerRepositoryProperties(string registryLoginServer = null, string name = null, System.DateTimeOffset createdOn = default(System.DateTimeOffset), System.DateTimeOffset lastUpdatedOn = default(System.DateTimeOffset), int manifestCount = 0, int tagCount = 0, bool? canDelete = default(bool?), bool? canWrite = default(bool?), bool? canList = default(bool?), bool? canRead = default(bool?)) { throw null; }
+        public static Azure.Containers.ContainerRegistry.Specialized.DownloadBlobResult DownloadBlobResult(string digest = null, System.IO.Stream content = null) { throw null; }
+        public static Azure.Containers.ContainerRegistry.Specialized.DownloadManifestResult DownloadManifestResult(string digest = null, Azure.Containers.ContainerRegistry.Specialized.OciManifest manifest = null, System.IO.Stream manifestStream = null) { throw null; }
+        public static Azure.Containers.ContainerRegistry.Specialized.UploadBlobResult UploadBlobResult(string digest = null) { throw null; }
+        public static Azure.Containers.ContainerRegistry.Specialized.UploadManifestResult UploadManifestResult(string digest = null) { throw null; }
     }
     public partial class ContainerRepository
     {
@@ -206,9 +210,107 @@ protected RegistryArtifact() { }
         public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Containers.ContainerRegistry.ArtifactManifestProperties>> GetManifestPropertiesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual Azure.Response<Azure.Containers.ContainerRegistry.ArtifactTagProperties> GetTagProperties(string tag, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Containers.ContainerRegistry.ArtifactTagProperties>> GetTagPropertiesAsync(string tag, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Pageable<Azure.Containers.ContainerRegistry.ArtifactTagProperties> GetTagPropertiesCollection(Azure.Containers.ContainerRegistry.ArtifactTagOrder orderBy = Azure.Containers.ContainerRegistry.ArtifactTagOrder.None, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.AsyncPageable<Azure.Containers.ContainerRegistry.ArtifactTagProperties> GetTagPropertiesCollectionAsync(Azure.Containers.ContainerRegistry.ArtifactTagOrder orderBy = Azure.Containers.ContainerRegistry.ArtifactTagOrder.None, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual Azure.Response<Azure.Containers.ContainerRegistry.ArtifactManifestProperties> UpdateManifestProperties(Azure.Containers.ContainerRegistry.ArtifactManifestProperties value, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Containers.ContainerRegistry.ArtifactManifestProperties>> UpdateManifestPropertiesAsync(Azure.Containers.ContainerRegistry.ArtifactManifestProperties value, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual Azure.Response<Azure.Containers.ContainerRegistry.ArtifactTagProperties> UpdateTagProperties(string tag, Azure.Containers.ContainerRegistry.ArtifactTagProperties value, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Containers.ContainerRegistry.ArtifactTagProperties>> UpdateTagPropertiesAsync(string tag, Azure.Containers.ContainerRegistry.ArtifactTagProperties value, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
     }
 }
+namespace Azure.Containers.ContainerRegistry.Specialized
+{
+    public partial class ContainerRegistryBlobClient
+    {
+        protected ContainerRegistryBlobClient() { }
+        public ContainerRegistryBlobClient(System.Uri endpoint, Azure.Core.TokenCredential credential, string repository) { }
+        public ContainerRegistryBlobClient(System.Uri endpoint, Azure.Core.TokenCredential credential, string repository, Azure.Containers.ContainerRegistry.ContainerRegistryClientOptions options) { }
+        public ContainerRegistryBlobClient(System.Uri endpoint, string repository) { }
+        public ContainerRegistryBlobClient(System.Uri endpoint, string repository, Azure.Containers.ContainerRegistry.ContainerRegistryClientOptions options) { }
+        public virtual System.Uri Endpoint { get { throw null; } }
+        public virtual string RepositoryName { get { throw null; } }
+        public virtual Azure.Response DeleteBlob(string digest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response> DeleteBlobAsync(string digest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response DeleteManifest(string digest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response> DeleteManifestAsync(string digest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response<Azure.Containers.ContainerRegistry.Specialized.DownloadBlobResult> DownloadBlob(string digest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Containers.ContainerRegistry.Specialized.DownloadBlobResult>> DownloadBlobAsync(string digest, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response<Azure.Containers.ContainerRegistry.Specialized.DownloadManifestResult> DownloadManifest(Azure.Containers.ContainerRegistry.Specialized.DownloadManifestOptions options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Containers.ContainerRegistry.Specialized.DownloadManifestResult>> DownloadManifestAsync(Azure.Containers.ContainerRegistry.Specialized.DownloadManifestOptions options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response<Azure.Containers.ContainerRegistry.Specialized.UploadBlobResult> UploadBlob(System.IO.Stream stream, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Containers.ContainerRegistry.Specialized.UploadBlobResult>> UploadBlobAsync(System.IO.Stream stream, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response<Azure.Containers.ContainerRegistry.Specialized.UploadManifestResult> UploadManifest(Azure.Containers.ContainerRegistry.Specialized.OciManifest manifest, Azure.Containers.ContainerRegistry.Specialized.UploadManifestOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response<Azure.Containers.ContainerRegistry.Specialized.UploadManifestResult> UploadManifest(System.IO.Stream manifestStream, Azure.Containers.ContainerRegistry.Specialized.UploadManifestOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Containers.ContainerRegistry.Specialized.UploadManifestResult>> UploadManifestAsync(Azure.Containers.ContainerRegistry.Specialized.OciManifest manifest, Azure.Containers.ContainerRegistry.Specialized.UploadManifestOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Containers.ContainerRegistry.Specialized.UploadManifestResult>> UploadManifestAsync(System.IO.Stream manifestStream, Azure.Containers.ContainerRegistry.Specialized.UploadManifestOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+    }
+    public partial class DownloadBlobResult : System.IDisposable
+    {
+        internal DownloadBlobResult() { }
+        public System.IO.Stream Content { get { throw null; } }
+        public string Digest { get { throw null; } }
+        public void Dispose() { }
+    }
+    public partial class DownloadManifestOptions
+    {
+        public DownloadManifestOptions(string tag = null, string digest = null) { }
+        public string Digest { get { throw null; } }
+        public string Tag { get { throw null; } }
+    }
+    public partial class DownloadManifestResult : System.IDisposable
+    {
+        internal DownloadManifestResult() { }
+        public string Digest { get { throw null; } }
+        public Azure.Containers.ContainerRegistry.Specialized.OciManifest Manifest { get { throw null; } }
+        public System.IO.Stream ManifestStream { get { throw null; } }
+        public void Dispose() { }
+    }
+    public partial class OciAnnotations
+    {
+        public OciAnnotations() { }
+        public System.Collections.Generic.IDictionary<string, object> AdditionalProperties { get { throw null; } }
+        public string Authors { get { throw null; } set { } }
+        public System.DateTimeOffset? CreatedOn { get { throw null; } set { } }
+        public string Description { get { throw null; } set { } }
+        public string Documentation { get { throw null; } set { } }
+        public string Licenses { get { throw null; } set { } }
+        public string Name { get { throw null; } set { } }
+        public string Revision { get { throw null; } set { } }
+        public string Source { get { throw null; } set { } }
+        public string Title { get { throw null; } set { } }
+        public string Url { get { throw null; } set { } }
+        public string Vendor { get { throw null; } set { } }
+        public string Version { get { throw null; } set { } }
+    }
+    public partial class OciBlobDescriptor
+    {
+        public OciBlobDescriptor() { }
+        public Azure.Containers.ContainerRegistry.Specialized.OciAnnotations Annotations { get { throw null; } set { } }
+        public string Digest { get { throw null; } set { } }
+        public string MediaType { get { throw null; } set { } }
+        public long? Size { get { throw null; } set { } }
+    }
+    public partial class OciManifest
+    {
+        public OciManifest() { }
+        public Azure.Containers.ContainerRegistry.Specialized.OciAnnotations Annotations { get { throw null; } }
+        public Azure.Containers.ContainerRegistry.Specialized.OciBlobDescriptor Config { get { throw null; } set { } }
+        public System.Collections.Generic.IList<Azure.Containers.ContainerRegistry.Specialized.OciBlobDescriptor> Layers { get { throw null; } }
+        public int? SchemaVersion { get { throw null; } set { } }
+    }
+    public partial class UploadBlobResult
+    {
+        internal UploadBlobResult() { }
+        public string Digest { get { throw null; } }
+    }
+    public partial class UploadManifestOptions
+    {
+        public UploadManifestOptions(string tag = null) { }
+        public string Tag { get { throw null; } }
+    }
+    public partial class UploadManifestResult
+    {
+        internal UploadManifestResult() { }
+        public string Digest { get { throw null; } }
+    }
+}