packages/isula-build
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
isula-build/patch/0077-test-optimize-save-client-options-and-add-unit-test.patch
DCCooper 3d943142b3 isula-build:support save/load separated image 
reason: 1. support save/load separated image
        2. add relative test cases and bugfixes

Signed-off-by: DCCooper <1866858@gmail.com>
2021-11-02 12:40:19 +08:00

441 lines
13 KiB
Diff
Raw Blame History

From 6e321766a0b4ace2211c9d39cfce58bf4627e63f Mon Sep 17 00:00:00 2001
From: DCCooper <1866858@gmail.com>
Date: Wed, 27 Oct 2021 21:32:12 +0800
Subject: [PATCH 04/16] test: optimize save client options and add unit test
Signed-off-by: DCCooper <1866858@gmail.com>
---
cmd/cli/save.go | 84 ++++++++--------
cmd/cli/save_test.go | 232 ++++++++++++++++++++++++++++++++++++++++++-
2 files changed, 270 insertions(+), 46 deletions(-)
diff --git a/cmd/cli/save.go b/cmd/cli/save.go
index 4d22798a..599d394d 100644
--- a/cmd/cli/save.go
+++ b/cmd/cli/save.go
@@ -18,7 +18,6 @@ import (
"fmt"
"io"
"os"
- "path/filepath"
"strings"
"github.com/pkg/errors"
@@ -51,21 +50,21 @@ const (
saveExample = `isula-build ctr-img save busybox:latest -o busybox.tar
isula-build ctr-img save 21c3e96ac411 -o myimage.tar
isula-build ctr-img save busybox:latest alpine:3.9 -o all.tar
-isula-build ctr-img save app:latest app1:latest -d Images
+isula-build ctr-img save app:latest -b busybox:latest -d Images
isula-build ctr-img save app:latest app1:latest -d Images -b busybox:latest -l lib:latest -r rename.json`
)
// NewSaveCmd cmd for container image saving
func NewSaveCmd() *cobra.Command {
saveCmd := &cobra.Command{
- Use: "save IMAGE [IMAGE...] [FLAGS]",
+ Use: "save IMAGE [IMAGE...] FLAGS",
Short: "Save image to tarball",
Example: saveExample,
RunE: saveCommand,
}
saveCmd.PersistentFlags().StringVarP(&saveOpts.path, "output", "o", "", "Path to save the tarball")
- saveCmd.PersistentFlags().StringVarP(&saveOpts.sep.destPath, "dest", "d", "Images", "Destination file directory to store separated images")
+ saveCmd.PersistentFlags().StringVarP(&saveOpts.sep.destPath, "dest", "d", "", "Destination file directory to store separated images")
saveCmd.PersistentFlags().StringVarP(&saveOpts.sep.baseImgName, "base", "b", "", "Base image name of separated images")
saveCmd.PersistentFlags().StringVarP(&saveOpts.sep.libImageName, "lib", "l", "", "Lib image name of separated images")
saveCmd.PersistentFlags().StringVarP(&saveOpts.sep.renameFile, "rename", "r", "", "Rename json file path of separated images")
@@ -95,12 +94,16 @@ func saveCommand(cmd *cobra.Command, args []string) error {
}
func (sep *separatorSaveOption) check(pwd string) error {
- if len(sep.baseImgName) != 0 {
- if !util.IsValidImageName(sep.baseImgName) {
- return errors.Errorf("invalid base image name %s", sep.baseImgName)
- }
+ if len(sep.baseImgName) == 0 {
+ return errors.New("base image name(-b) must be provided")
+ }
+ if !util.IsValidImageName(sep.baseImgName) {
+ return errors.Errorf("invalid base image name %s", sep.baseImgName)
}
if len(sep.libImageName) != 0 {
+ if sep.libImageName == sep.baseImgName {
+ return errors.New("base and lib images are the same")
+ }
if !util.IsValidImageName(sep.libImageName) {
return errors.Errorf("invalid lib image name %s", sep.libImageName)
}
@@ -108,16 +111,12 @@ func (sep *separatorSaveOption) check(pwd string) error {
if len(sep.destPath) == 0 {
sep.destPath = "Images"
}
- if !filepath.IsAbs(sep.destPath) {
- sep.destPath = util.MakeAbsolute(sep.destPath, pwd)
- }
+ sep.destPath = util.MakeAbsolute(sep.destPath, pwd)
if util.IsExist(sep.destPath) {
- return errors.Errorf("output file already exist: %q, try to remove existing tarball or rename output file", sep.destPath)
+ return errors.Errorf("dest path already exist: %q, try to remove or rename it", sep.destPath)
}
if len(sep.renameFile) != 0 {
- if !filepath.IsAbs(sep.renameFile) {
- sep.renameFile = util.MakeAbsolute(sep.renameFile, pwd)
- }
+ sep.renameFile = util.MakeAbsolute(sep.renameFile, pwd)
}
return nil
@@ -136,39 +135,36 @@ func (opt *saveOptions) checkSaveOpts(args []string) error {
return errors.New("get current path failed")
}
- // normal save
- if !opt.sep.isEnabled() {
- // only check oci format when doing normal save operation
- if opt.format == constant.OCITransport && len(args) >= 2 {
- return errors.New("oci image format now only supports saving single image")
+ // separator save
+ if opt.sep.isEnabled() {
+ if len(opt.path) != 0 {
+ return errors.New("conflict flags between -o and [-b -l -r -d]")
}
- if err := util.CheckImageFormat(opt.format); err != nil {
+ // separate image only support docker image spec
+ opt.format = constant.DockerTransport
+ if err := opt.sep.check(pwd); err != nil {
return err
}
- if len(opt.path) == 0 {
- return errors.New("output path should not be empty")
- }
- if !filepath.IsAbs(opt.path) {
- opt.path = util.MakeAbsolute(opt.path, pwd)
- }
- if util.IsExist(opt.path) {
- return errors.Errorf("output file already exist: %q, try to remove existing tarball or rename output file", opt.path)
- }
+ opt.sep.enabled = true
+
return nil
}
- // separator save
- opt.sep.enabled = true
- if len(opt.path) != 0 {
- return errors.New("conflict options between -o and [-b -l -r]")
+ // normal save
+ // only check oci format when doing normal save operation
+ if len(opt.path) == 0 {
+ return errors.New("output path(-o) should not be empty")
}
- // separate image only support docker image spec
- opt.format = constant.DockerTransport
-
- if err := opt.sep.check(pwd); err != nil {
+ if opt.format == constant.OCITransport && len(args) >= 2 {
+ return errors.New("oci image format now only supports saving single image")
+ }
+ if err := util.CheckImageFormat(opt.format); err != nil {
return err
}
-
+ opt.path = util.MakeAbsolute(opt.path, pwd)
+ if util.IsExist(opt.path) {
+ return errors.Errorf("output file already exist: %q, try to remove existing tarball or rename output file", opt.path)
+ }
return nil
}
@@ -177,10 +173,10 @@ func runSave(ctx context.Context, cli Cli, args []string) error {
saveOpts.images = args
sep := &pb.SeparatorSave{
- Base: saveOpts.sep.baseImgName,
- Lib: saveOpts.sep.libImageName,
- Rename: saveOpts.sep.renameFile,
- Dest: saveOpts.sep.destPath,
+ Base: saveOpts.sep.baseImgName,
+ Lib: saveOpts.sep.libImageName,
+ Rename: saveOpts.sep.renameFile,
+ Dest: saveOpts.sep.destPath,
Enabled: saveOpts.sep.enabled,
}
@@ -212,5 +208,5 @@ func runSave(ctx context.Context, cli Cli, args []string) error {
}
func (sep *separatorSaveOption) isEnabled() bool {
- return util.AnyFlagSet(sep.baseImgName, sep.libImageName, sep.renameFile)
+ return util.AnyFlagSet(sep.baseImgName, sep.libImageName, sep.renameFile, sep.destPath)
}
diff --git a/cmd/cli/save_test.go b/cmd/cli/save_test.go
index 3fe6bf81..72f6ded3 100644
--- a/cmd/cli/save_test.go
+++ b/cmd/cli/save_test.go
@@ -16,10 +16,13 @@ package main
import (
"context"
"fmt"
+ "os"
+ "path/filepath"
"testing"
"gotest.tools/v3/assert"
"gotest.tools/v3/fs"
+ constant "isula.org/isula-build"
)
func TestSaveCommand(t *testing.T) {
@@ -38,7 +41,7 @@ func TestSaveCommand(t *testing.T) {
wantErr bool
}
- // For normal cases, default err is "invalid socket path: unix:///var/run/isula_build.sock".
+ // For normal cases, default err is "invalid socket path: unix:///var/run/isula_build.sock".
// As daemon is not running as we run unit test.
var testcases = []testcase{
{
@@ -86,7 +89,7 @@ func TestSaveCommand(t *testing.T) {
path: "",
args: []string{"testImage"},
wantErr: true,
- errString: "output path should not be empty",
+ errString: "output path(-o) should not be empty",
format: "docker",
},
{
@@ -194,3 +197,228 @@ func TestRunSave(t *testing.T) {
})
}
}
+
+func TestCheckSaveOpts(t *testing.T) {
+ pwd, err := os.Getwd()
+ assert.NilError(t, err)
+ existDirPath := filepath.Join(pwd, "DirAlreadyExist")
+ existFilePath := filepath.Join(pwd, "FileAlreadExist")
+ err = os.Mkdir(existDirPath, constant.DefaultRootDirMode)
+ assert.NilError(t, err)
+ _, err = os.Create(existFilePath)
+ assert.NilError(t, err)
+ defer os.Remove(existDirPath)
+ defer os.Remove(existFilePath)
+
+ type fields struct {
+ images []string
+ sep separatorSaveOption
+ path string
+ saveID string
+ format string
+ }
+ type args struct {
+ args []string
+ }
+ tests := []struct {
+ name string
+ fields fields
+ args args
+ wantErr bool
+ }{
+ {
+ name: "TC-normal save",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ path: "test.tar",
+ format: constant.DockerTransport,
+ },
+ },
+ {
+ name: "TC-normal save with empty args",
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ },
+ wantErr: true,
+ },
+ {
+ name: "TC-normal save with path has colon in it",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ path: "invalid:path.tar",
+ },
+ wantErr: true,
+ },
+ {
+ name: "TC-normal save without path",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ },
+ wantErr: true,
+ },
+ {
+ name: "TC-normal save with oci format",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ path: "test.tar",
+ format: constant.OCITransport,
+ },
+ wantErr: true,
+ },
+ {
+ name: "TC-normal save with invalid format",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ path: "test.tar",
+ format: "invalidFormat",
+ },
+ wantErr: true,
+ },
+ {
+ name: "TC-normal save with path already exist",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ path: existFilePath,
+ format: constant.DockerTransport,
+ },
+ wantErr: true,
+ },
+ {
+ name: "TC-separated save",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ format: constant.DockerTransport,
+ sep: separatorSaveOption{
+ baseImgName: "base",
+ libImageName: "lib",
+ renameFile: "rename.json",
+ destPath: "Images",
+ },
+ },
+ },
+ {
+ name: "TC-separated save with -o flag",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ path: "test.tar",
+ format: constant.DockerTransport,
+ sep: separatorSaveOption{
+ baseImgName: "base",
+ libImageName: "lib",
+ renameFile: "rename.json",
+ destPath: "Images",
+ },
+ },
+ wantErr: true,
+ },
+ {
+ name: "TC-separated save without -b flag",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ format: constant.DockerTransport,
+ sep: separatorSaveOption{
+ libImageName: "lib",
+ renameFile: "rename.json",
+ destPath: "Images",
+ },
+ },
+ wantErr: true,
+ },
+ {
+ name: "TC-separated save invalid base image name",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ format: constant.DockerTransport,
+ sep: separatorSaveOption{
+ baseImgName: "in:valid:base:name",
+ libImageName: "lib",
+ renameFile: "rename.json",
+ destPath: "Images",
+ },
+ },
+ wantErr: true,
+ },
+ {
+ name: "TC-separated save invalid lib image name",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ format: constant.DockerTransport,
+ sep: separatorSaveOption{
+ baseImgName: "base",
+ libImageName: "in:valid:lib:name",
+ renameFile: "rename.json",
+ destPath: "Images",
+ },
+ },
+ wantErr: true,
+ },
+ {
+ name: "TC-separated save without dest option",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ format: constant.DockerTransport,
+ sep: separatorSaveOption{
+ baseImgName: "base",
+ libImageName: "lib",
+ renameFile: "rename.json",
+ },
+ },
+ },
+ {
+ name: "TC-separated save with dest already exist",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ format: constant.DockerTransport,
+ sep: separatorSaveOption{
+ baseImgName: "base",
+ libImageName: "lib",
+ renameFile: "rename.json",
+ destPath: existDirPath,
+ },
+ },
+ wantErr: true,
+ },
+ {
+ name: "TC-separated save with same base and lib image",
+ args: args{[]string{"app:latest", "app1:latest"}},
+ fields: fields{
+ images: []string{"app:latest", "app1:latest"},
+ format: constant.DockerTransport,
+ sep: separatorSaveOption{
+ baseImgName: "same:image",
+ libImageName: "same:image",
+ renameFile: "rename.json",
+ destPath: existDirPath,
+ },
+ },
+ wantErr: true,
+ },
+ }
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ opt := &saveOptions{
+ images: tt.fields.images,
+ sep: tt.fields.sep,
+ path: tt.fields.path,
+ saveID: tt.fields.saveID,
+ format: tt.fields.format,
+ }
+ if err := opt.checkSaveOpts(tt.args.args); (err != nil) != tt.wantErr {
+ t.Errorf("saveOptions.checkSaveOpts() error = %v, wantErr %v", err, tt.wantErr)
+ }
+ })
+ }
+}
--
2.27.0
Reference in New Issue View Git Blame Copy Permalink