1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
|
/*
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.
*/
package oras_test
import (
"bytes"
"context"
"encoding/json"
"fmt"
"net/http"
"net/http/httptest"
"net/url"
"os"
"strconv"
"strings"
"testing"
"github.com/opencontainers/go-digest"
specs "github.com/opencontainers/image-spec/specs-go"
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
"oras.land/oras-go/v2"
"oras.land/oras-go/v2/content/memory"
"oras.land/oras-go/v2/content/oci"
"oras.land/oras-go/v2/internal/spec"
"oras.land/oras-go/v2/registry/remote"
"oras.land/oras-go/v2/registry/remote/auth"
"oras.land/oras-go/v2/registry/remote/retry"
)
var exampleMemoryStore oras.Target
var remoteHost string
var (
exampleManifest, _ = json.Marshal(spec.Artifact{
MediaType: spec.MediaTypeArtifactManifest,
ArtifactType: "example/content"})
exampleManifestDescriptor = ocispec.Descriptor{
MediaType: spec.MediaTypeArtifactManifest,
Digest: digest.Digest(digest.FromBytes(exampleManifest)),
Size: int64(len(exampleManifest))}
exampleSignatureManifest, _ = json.Marshal(spec.Artifact{
MediaType: spec.MediaTypeArtifactManifest,
ArtifactType: "example/signature",
Subject: &exampleManifestDescriptor})
exampleSignatureManifestDescriptor = ocispec.Descriptor{
MediaType: spec.MediaTypeArtifactManifest,
Digest: digest.FromBytes(exampleSignatureManifest),
Size: int64(len(exampleSignatureManifest))}
)
func pushBlob(ctx context.Context, mediaType string, blob []byte, target oras.Target) (desc ocispec.Descriptor, err error) {
desc = ocispec.Descriptor{ // Generate descriptor based on the media type and blob content
MediaType: mediaType,
Digest: digest.FromBytes(blob), // Calculate digest
Size: int64(len(blob)), // Include blob size
}
return desc, target.Push(ctx, desc, bytes.NewReader(blob)) // Push the blob to the registry target
}
func generateManifestContent(config ocispec.Descriptor, layers ...ocispec.Descriptor) ([]byte, error) {
content := ocispec.Manifest{
Config: config, // Set config blob
Layers: layers, // Set layer blobs
Versioned: specs.Versioned{SchemaVersion: 2},
}
return json.Marshal(content) // Get json content
}
func TestMain(m *testing.M) {
const exampleTag = "latest"
const exampleUploadUUid = "0bc84d80-837c-41d9-824e-1907463c53b3"
// Setup example local target
exampleMemoryStore = memory.New()
layerBlob := []byte("Hello layer")
ctx := context.Background()
layerDesc, err := pushBlob(ctx, ocispec.MediaTypeImageLayer, layerBlob, exampleMemoryStore) // push layer blob
if err != nil {
panic(err)
}
configBlob := []byte("Hello config")
configDesc, err := pushBlob(ctx, ocispec.MediaTypeImageConfig, configBlob, exampleMemoryStore) // push config blob
if err != nil {
panic(err)
}
manifestBlob, err := generateManifestContent(configDesc, layerDesc) // generate a image manifest
if err != nil {
panic(err)
}
manifestDesc, err := pushBlob(ctx, ocispec.MediaTypeImageManifest, manifestBlob, exampleMemoryStore) // push manifest blob
if err != nil {
panic(err)
}
err = exampleMemoryStore.Tag(ctx, manifestDesc, exampleTag)
if err != nil {
panic(err)
}
// Setup example remote target
httpsServer := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
p := r.URL.Path
m := r.Method
switch {
case strings.Contains(p, "/blobs/uploads/") && m == "POST":
w.Header().Set("Content-Type", ocispec.MediaTypeImageManifest)
w.Header().Set("Location", p+exampleUploadUUid)
w.WriteHeader(http.StatusAccepted)
case strings.Contains(p, "/blobs/uploads/"+exampleUploadUUid) && m == "GET":
w.WriteHeader(http.StatusCreated)
case strings.Contains(p, "/manifests/"+string(exampleSignatureManifestDescriptor.Digest)):
w.Header().Set("Content-Type", spec.MediaTypeArtifactManifest)
w.Header().Set("Docker-Content-Digest", string(exampleSignatureManifestDescriptor.Digest))
w.Header().Set("Content-Length", strconv.Itoa(len(exampleSignatureManifest)))
w.Write(exampleSignatureManifest)
case strings.Contains(p, "/manifests/latest") && m == "PUT":
w.WriteHeader(http.StatusCreated)
case strings.Contains(p, "/manifests/"+string(exampleManifestDescriptor.Digest)),
strings.Contains(p, "/manifests/latest") && m == "HEAD":
w.Header().Set("Content-Type", spec.MediaTypeArtifactManifest)
w.Header().Set("Docker-Content-Digest", string(exampleManifestDescriptor.Digest))
w.Header().Set("Content-Length", strconv.Itoa(len(exampleManifest)))
if m == "GET" {
w.Write(exampleManifest)
}
case strings.Contains(p, "/v2/source/referrers/"):
var referrers []ocispec.Descriptor
if p == "/v2/source/referrers/"+exampleManifestDescriptor.Digest.String() {
referrers = []ocispec.Descriptor{exampleSignatureManifestDescriptor}
}
result := ocispec.Index{
Versioned: specs.Versioned{
SchemaVersion: 2, // historical value. does not pertain to OCI or docker version
},
MediaType: ocispec.MediaTypeImageIndex,
Manifests: referrers,
}
w.Header().Set("Content-Type", ocispec.MediaTypeImageIndex)
if err := json.NewEncoder(w).Encode(result); err != nil {
panic(err)
}
case strings.Contains(p, "/manifests/") && (m == "HEAD" || m == "GET"):
w.Header().Set("Content-Type", ocispec.MediaTypeImageManifest)
w.Header().Set("Docker-Content-Digest", string(manifestDesc.Digest))
w.Header().Set("Content-Length", strconv.Itoa(len([]byte(manifestBlob))))
w.Write([]byte(manifestBlob))
case strings.Contains(p, "/blobs/") && (m == "GET" || m == "HEAD"):
arr := strings.Split(p, "/")
digest := arr[len(arr)-1]
var desc ocispec.Descriptor
var content []byte
switch digest {
case layerDesc.Digest.String():
desc = layerDesc
content = layerBlob
case configDesc.Digest.String():
desc = configDesc
content = configBlob
case manifestDesc.Digest.String():
desc = manifestDesc
content = manifestBlob
}
w.Header().Set("Content-Type", desc.MediaType)
w.Header().Set("Docker-Content-Digest", digest)
w.Header().Set("Content-Length", strconv.Itoa(len([]byte(content))))
w.Write([]byte(content))
case strings.Contains(p, "/manifests/") && m == "PUT":
w.WriteHeader(http.StatusCreated)
}
}))
defer httpsServer.Close()
u, err := url.Parse(httpsServer.URL)
if err != nil {
panic(err)
}
remoteHost = u.Host
http.DefaultTransport = httpsServer.Client().Transport
os.Exit(m.Run())
}
func ExampleCopy_repositoryToRepository() {
reg, err := remote.NewRegistry(remoteHost)
if err != nil {
panic(err) // Handle error
}
ctx := context.Background()
src, err := reg.Repository(ctx, "source")
if err != nil {
panic(err) // Handle error
}
dst, err := reg.Repository(ctx, "destination")
if err != nil {
panic(err) // Handle error
}
tagName := "latest"
desc, err := oras.Copy(ctx, src, tagName, dst, tagName, oras.DefaultCopyOptions)
if err != nil {
panic(err) // Handle error
}
fmt.Println(desc.Digest)
// Output:
// sha256:7cbb44b44e8ede5a89cf193db3f5f2fd019d89697e6b87e8ed2589e60649b0d1
}
func ExampleCopy_repositoryToRepositoryWithMount() {
reg, err := remote.NewRegistry(remoteHost)
if err != nil {
panic(err) // Handle error
}
ctx := context.Background()
src, err := reg.Repository(ctx, "source")
if err != nil {
panic(err) // Handle error
}
dst, err := reg.Repository(ctx, "destination")
if err != nil {
panic(err) // Handle error
}
tagName := "latest"
opts := oras.CopyOptions{}
// optionally be notified that a mount occurred.
opts.OnMounted = func(ctx context.Context, desc ocispec.Descriptor) error {
// log.Println("Mounted", desc.Digest)
return nil
}
// Enable cross-repository blob mounting
opts.MountFrom = func(ctx context.Context, desc ocispec.Descriptor) ([]string, error) {
// the slice of source repositories may also come from a database of known locations of blobs
return []string{"source/repository/name"}, nil
}
desc, err := oras.Copy(ctx, src, tagName, dst, tagName, opts)
if err != nil {
panic(err) // Handle error
}
fmt.Println("Final", desc.Digest)
// Output:
// Final sha256:7cbb44b44e8ede5a89cf193db3f5f2fd019d89697e6b87e8ed2589e60649b0d1
}
func ExampleCopy_repositoryToMemory() {
reg, err := remote.NewRegistry(remoteHost)
if err != nil {
panic(err) // Handle error
}
ctx := context.Background()
src, err := reg.Repository(ctx, "source")
if err != nil {
panic(err) // Handle error
}
dst := memory.New()
tagName := "latest"
desc, err := oras.Copy(ctx, src, tagName, dst, tagName, oras.DefaultCopyOptions)
if err != nil {
panic(err) // Handle error
}
fmt.Println(desc.Digest)
// Output:
// sha256:7cbb44b44e8ede5a89cf193db3f5f2fd019d89697e6b87e8ed2589e60649b0d1
}
func ExampleCopy_memoryToMemory() {
src := exampleMemoryStore
dst := memory.New()
tagName := "latest"
ctx := context.Background()
desc, err := oras.Copy(ctx, src, tagName, dst, tagName, oras.DefaultCopyOptions)
if err != nil {
panic(err) // Handle error
}
fmt.Println(desc.Digest)
// Output:
// sha256:7cbb44b44e8ede5a89cf193db3f5f2fd019d89697e6b87e8ed2589e60649b0d1
}
func ExampleCopy_memoryToOCIStore() {
src := exampleMemoryStore
tempDir, err := os.MkdirTemp("", "oras_oci_example_*")
if err != nil {
panic(err) // Handle error
}
defer os.RemoveAll(tempDir)
dst, err := oci.New(tempDir)
if err != nil {
panic(err) // Handle error
}
tagName := "latest"
ctx := context.Background()
desc, err := oras.Copy(ctx, src, tagName, dst, tagName, oras.DefaultCopyOptions)
if err != nil {
panic(err) // Handle error
}
fmt.Println(desc.Digest)
// Output:
// sha256:7cbb44b44e8ede5a89cf193db3f5f2fd019d89697e6b87e8ed2589e60649b0d1
}
func ExampleCopy_memoryToRepository() {
src := exampleMemoryStore
reg, err := remote.NewRegistry(remoteHost)
if err != nil {
panic(err) // Handle error
}
ctx := context.Background()
dst, err := reg.Repository(ctx, "destination")
if err != nil {
panic(err) // Handle error
}
tagName := "latest"
desc, err := oras.Copy(ctx, src, tagName, dst, tagName, oras.DefaultCopyOptions)
if err != nil {
panic(err) // Handle error
}
fmt.Println(desc.Digest)
// Output:
// sha256:7cbb44b44e8ede5a89cf193db3f5f2fd019d89697e6b87e8ed2589e60649b0d1
}
// ExampleCopyArtifactFromRepository gives an example of copying
// an artifact from a remote repository into memory.
func Example_copyArtifactFromRepository() {
// 0. Connect to a remote repository
repositoryName := "source"
src, err := remote.NewRepository(fmt.Sprintf("%s/%s", remoteHost, repositoryName))
if err != nil {
panic(err)
}
// 1. Create a memory store
dst := memory.New()
ctx := context.Background()
// 2. Resolve the descriptor of the artifact from the digest
exampleDigest := "sha256:70c29a81e235dda5c2cebb8ec06eafd3cca346cbd91f15ac74cefd98681c5b3d"
descriptor, err := src.Resolve(ctx, exampleDigest)
if err != nil {
panic(err)
}
// 3. Copy the artifact from the remote repository
err = oras.CopyGraph(ctx, src, dst, descriptor, oras.DefaultCopyGraphOptions)
if err != nil {
panic(err)
}
// 4. Verify that the artifact manifest described by the descriptor exists in dst
contentExists, err := dst.Exists(ctx, descriptor)
if err != nil {
panic(err)
}
fmt.Println(contentExists)
// Output:
// true
}
// ExampleExtendedCopyArtifactAndReferrersFromRepository gives an example of
// copying an artifact along with its referrers from a remote repository into
// memory.
func Example_extendedCopyArtifactAndReferrersFromRepository() {
// 0. Connect to a remote repository
repositoryName := "source"
src, err := remote.NewRepository(fmt.Sprintf("%s/%s", remoteHost, repositoryName))
if err != nil {
panic(err)
}
// 1. Create a memory store
dst := memory.New()
ctx := context.Background()
// 2. Copy the artifact and its referrers from the remote repository
tagName := "latest"
// ExtendedCopy will copy the artifact tagged by "latest" along with all of its
// referrers from src to dst.
desc, err := oras.ExtendedCopy(ctx, src, tagName, dst, tagName, oras.DefaultExtendedCopyOptions)
if err != nil {
panic(err)
}
fmt.Println(desc.Digest)
// Output:
// sha256:f396bc4d300934a39ca28ab0d5ac8a3573336d7d63c654d783a68cd1e2057662
}
// ExampleExtendedCopyArtifactAndReferrersToRepository is an example of pushing
// an artifact and its referrer to a remote repository.
func Example_extendedCopyArtifactAndReferrersToRepository() {
// 0. Assemble the referenced manifest in memory with tag "v1"
ctx := context.Background()
src := memory.New()
manifestDescriptor, err := oras.PackManifest(ctx, src, oras.PackManifestVersion1_1, "application/vnd.example+type", oras.PackManifestOptions{})
if err != nil {
panic(err)
}
fmt.Println("created manifest: ", manifestDescriptor)
tag := "v1"
err = src.Tag(ctx, manifestDescriptor, tag)
if err != nil {
panic(err)
}
fmt.Println("tagged manifest: ", manifestDescriptor.Digest)
// 1. Assemble the referrer manifest in memory
referrerPackOpts := oras.PackManifestOptions{
Subject: &manifestDescriptor,
}
referrerDescriptor, err := oras.PackManifest(ctx, src, oras.PackManifestVersion1_1, "sbom/example", referrerPackOpts)
if err != nil {
panic(err)
}
fmt.Println("created referrer: ", referrerDescriptor)
// 2. Connect to a remote repository with basic authentication
registry := "myregistry.example.com"
repository := "myrepo"
repo, err := remote.NewRepository(fmt.Sprintf("%s/%s", registry, repository))
if err != nil {
panic(err)
}
// Note: The below code can be omitted if authentication is not required.
repo.Client = &auth.Client{
Client: retry.DefaultClient,
Cache: auth.NewCache(),
Credential: auth.StaticCredential(registry, auth.Credential{
Username: "username",
Password: "password",
}),
}
// 3. Push the manifest and its referrer to the remote repository
desc, err := oras.ExtendedCopy(ctx, src, tag, repo, "", oras.DefaultExtendedCopyOptions)
if err != nil {
panic(err)
}
fmt.Println("pushed: ", desc.Digest)
}
|