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.

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

test: improve the symlink unit tests for file store #414

Merged
merged 3 commits into from
Jan 17, 2023
Merged

test: improve the symlink unit tests for file store #414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ae8749
fix symlink test
Wwwsylvia Jan 17, 2023
fb6444a
improve ut
Wwwsylvia Jan 17, 2023
7f3dfa6
fix oci error message
Wwwsylvia Jan 17, 2023
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
119 changes: 42 additions & 77 deletions content/file/file_unix_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ package file
import (
"bytes"
"context"
"io"
"os"
"path/filepath"
"testing"
Expand All @@ -46,8 +45,9 @@ func TestStore_Dir_ExtractSymlinkRel(t *testing.T) {
t.Fatal("error calling WriteFile(), error =", err)
}
// create symlink to a relative path
symlink := filepath.Join(dirPath, "test_symlink")
if err := os.Symlink(fileName, symlink); err != nil {
symlinkName := "test_symlink"
symlinkPath := filepath.Join(dirPath, symlinkName)
if err := os.Symlink(fileName, symlinkPath); err != nil {
t.Fatal("error calling Symlink(), error =", err)
}

Expand All @@ -63,23 +63,6 @@ func TestStore_Dir_ExtractSymlinkRel(t *testing.T) {
if err != nil {
t.Fatal("Store.Add() error =", err)
}
val, ok := src.digestToPath.Load(desc.Digest)
if !ok {
t.Fatal("failed to find internal gz")
}
tmpPath := val.(string)
zrc, err := os.Open(tmpPath)
if err != nil {
t.Fatal("failed to open internal gz, error =", err)
}
gotgz, err := io.ReadAll(zrc)
if err != nil {
t.Fatal("failed to read internal gz, error =", err)
}
if err := zrc.Close(); err != nil {
t.Error("failed to close internal gz, error =", err)
}

// pack a manifest
manifestDesc, err := oras.Pack(ctx, src, "dir", []ocispec.Descriptor{desc}, oras.PackOptions{})
if err != nil {
Expand All @@ -97,21 +80,21 @@ func TestStore_Dir_ExtractSymlinkRel(t *testing.T) {
t.Fatal("oras.CopyGraph() error =", err)
}

// compare content
rc, err := dstAbs.Fetch(ctx, desc)
// verify extracted symlink
extractedSymlink := filepath.Join(tempDir, dirName, symlinkName)
symlinkDst, err := os.Readlink(extractedSymlink)
if err != nil {
t.Fatal("Store.Fetch() error =", err)
t.Fatal("failed to get symlink destination, error =", err)
}
got, err := io.ReadAll(rc)
if err != nil {
t.Fatal("Store.Fetch().Read() error =", err)
if want := fileName; symlinkDst != want {
t.Errorf("symlink destination = %v, want %v", symlinkDst, want)
}
err = rc.Close()
got, err := os.ReadFile(extractedSymlink)
if err != nil {
t.Error("Store.Fetch().Close() error =", err)
t.Fatal("failed to read symlink file, error =", err)
}
if !bytes.Equal(got, gotgz) {
t.Errorf("Store.Fetch() = %v, want %v", got, gotgz)
if !bytes.Equal(got, content) {
t.Errorf("symlink content = %v, want %v", got, content)
}

// copy to another file store created from a relative root, to trigger extracting directory
Expand All @@ -128,21 +111,21 @@ func TestStore_Dir_ExtractSymlinkRel(t *testing.T) {
t.Fatal("oras.CopyGraph() error =", err)
}

// compare content
rc, err = dstRel.Fetch(ctx, desc)
// verify extracted symlink
extractedSymlink = filepath.Join(tempDir, dirName, symlinkName)
symlinkDst, err = os.Readlink(extractedSymlink)
if err != nil {
t.Fatal("Store.Fetch() error =", err)
t.Fatal("failed to get symlink destination, error =", err)
}
got, err = io.ReadAll(rc)
if err != nil {
t.Fatal("Store.Fetch().Read() error =", err)
if want := fileName; symlinkDst != want {
t.Errorf("symlink destination = %v, want %v", symlinkDst, want)
}
err = rc.Close()
got, err = os.ReadFile(extractedSymlink)
if err != nil {
t.Error("Store.Fetch().Close() error =", err)
t.Fatal("failed to read symlink file, error =", err)
}
if !bytes.Equal(got, gotgz) {
t.Errorf("Store.Fetch() = %v, want %v", got, gotgz)
if !bytes.Equal(got, content) {
t.Errorf("symlink content = %v, want %v", got, content)
}
}

Expand Down Expand Up @@ -180,23 +163,6 @@ func TestStore_Dir_ExtractSymlinkAbs(t *testing.T) {
if err != nil {
t.Fatal("Store.Add() error =", err)
}
val, ok := src.digestToPath.Load(desc.Digest)
if !ok {
t.Fatal("failed to find internal gz")
}
tmpPath := val.(string)
zrc, err := os.Open(tmpPath)
if err != nil {
t.Fatal("failed to open internal gz, error =", err)
}
gotgz, err := io.ReadAll(zrc)
if err != nil {
t.Fatal("failed to read internal gz, error =", err)
}
if err := zrc.Close(); err != nil {
t.Error("failed to close internal gz, error =", err)
}

// pack a manifest
manifestDesc, err := oras.Pack(ctx, src, "dir", []ocispec.Descriptor{desc}, oras.PackOptions{})
if err != nil {
Expand All @@ -216,21 +182,20 @@ func TestStore_Dir_ExtractSymlinkAbs(t *testing.T) {
t.Fatal("oras.CopyGraph() error =", err)
}

// compare content
rc, err := dstAbs.Fetch(ctx, desc)
// verify extracted symlink
symlinkDst, err := os.Readlink(symlink)
if err != nil {
t.Fatal("Store.Fetch() error =", err)
t.Fatal("failed to get symlink destination, error =", err)
}
got, err := io.ReadAll(rc)
if err != nil {
t.Fatal("Store.Fetch().Read() error =", err)
if want := filePath; symlinkDst != want {
t.Errorf("symlink destination = %v, want %v", symlinkDst, want)
}
err = rc.Close()
got, err := os.ReadFile(symlink)
if err != nil {
t.Error("Store.Fetch().Close() error =", err)
t.Fatal("failed to read symlink file, error =", err)
}
if !bytes.Equal(got, gotgz) {
t.Errorf("Store.Fetch() = %v, want %v", got, gotgz)
if !bytes.Equal(got, content) {
t.Errorf("symlink content = %v, want %v", got, content)
}

// remove the original testing directory and create a new store using a relative path
Expand All @@ -248,21 +213,21 @@ func TestStore_Dir_ExtractSymlinkAbs(t *testing.T) {
if err := oras.CopyGraph(ctx, src, dstRel, manifestDesc, oras.DefaultCopyGraphOptions); err != nil {
t.Fatal("oras.CopyGraph() error =", err)
}
// compare content
rc, err = dstRel.Fetch(ctx, desc)

// verify extracted symlink
symlinkDst, err = os.Readlink(symlink)
if err != nil {
t.Fatal("Store.Fetch() error =", err)
t.Fatal("failed to get symlink destination, error =", err)
}
got, err = io.ReadAll(rc)
if err != nil {
t.Fatal("Store.Fetch().Read() error =", err)
if want := filePath; symlinkDst != want {
t.Errorf("symlink destination = %v, want %v", symlinkDst, want)
}
err = rc.Close()
got, err = os.ReadFile(symlink)
if err != nil {
t.Error("Store.Fetch().Close() error =", err)
t.Fatal("failed to read symlink file, error =", err)
}
if !bytes.Equal(got, gotgz) {
t.Errorf("Store.Fetch() = %v, want %v", got, gotgz)
if !bytes.Equal(got, content) {
t.Errorf("symlink content = %v, want %v", got, content)
}

// copy to another file store created from an outside root, to trigger extracting directory
Expand Down
2 changes: 1 addition & 1 deletion content/oci/storage.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ type Storage struct {
func NewStorage(root string) (*Storage, error) {
rootAbs, err := filepath.Abs(root)
if err != nil {
return nil, err
return nil, fmt.Errorf("failed to resolve absolute path for %s: %w", root, err)
}

return &Storage{
Expand Down