Skip to content

Commit

Permalink
Add unit testcase for addon file patterns
Browse files Browse the repository at this point in the history
afero introduced for mocking a filesystem.
  • Loading branch information
laozc committed Jan 16, 2019
1 parent a7a105d commit d14b3ca
Show file tree
Hide file tree
Showing 8 changed files with 156 additions and 15 deletions.
16 changes: 10 additions & 6 deletions pkg/minikube/assets/addons.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"strconv"

"github.com/pkg/errors"
"github.com/spf13/afero"
"k8s.io/minikube/pkg/minikube/config"
"k8s.io/minikube/pkg/minikube/constants"
"k8s.io/minikube/pkg/util"
Expand Down Expand Up @@ -247,10 +248,10 @@ var Addons = map[string]*Addon{
}

func AddMinikubeDirAssets(assets *[]CopyableFile) error {
if err := addMinikubeDirToAssets(constants.MakeMiniPath("addons"), constants.AddonsPath, assets); err != nil {
if err := addMinikubeDirToAssets(nil, constants.MakeMiniPath("addons"), constants.AddonsPath, assets); err != nil {
return errors.Wrap(err, "adding addons folder to assets")
}
if err := addMinikubeDirToAssets(constants.MakeMiniPath("files"), "", assets); err != nil {
if err := addMinikubeDirToAssets(nil, constants.MakeMiniPath("files"), "", assets); err != nil {
return errors.Wrap(err, "adding files rootfs to assets")
}

Expand All @@ -260,9 +261,12 @@ func AddMinikubeDirAssets(assets *[]CopyableFile) error {
// AddMinikubeDirToAssets adds all the files in the basedir argument to the list
// of files to be copied to the vm. If vmpath is left blank, the files will be
// transferred to the location according to their relative minikube folder path.
func addMinikubeDirToAssets(basedir, vmpath string, assets *[]CopyableFile) error {
err := filepath.Walk(basedir, func(hostpath string, info os.FileInfo, err error) error {
isDir, err := util.IsDirectory(hostpath)
func addMinikubeDirToAssets(fs *afero.Afero, basedir, vmpath string, assets *[]CopyableFile) error {
if fs == nil {
fs = &afero.Afero{Fs: afero.NewOsFs()}
}
err := fs.Walk(basedir, func(hostpath string, info os.FileInfo, err error) error {
isDir, err := util.IsDirectory(fs, hostpath)
if err != nil {
return errors.Wrapf(err, "checking if %s is directory", hostpath)
}
Expand All @@ -283,7 +287,7 @@ func addMinikubeDirToAssets(basedir, vmpath string, assets *[]CopyableFile) erro
permString = fmt.Sprintf("0%s", permString)
}

f, err := NewFileAsset(hostpath, vmdir, filepath.Base(hostpath), permString)
f, err := NewFileAsset(fs, hostpath, vmdir, filepath.Base(hostpath), permString)
if err != nil {
return errors.Wrapf(err, "creating file asset for %s", hostpath)
}
Expand Down
132 changes: 132 additions & 0 deletions pkg/minikube/assets/addons_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
/*
Copyright 2016 The Kubernetes Authors All rights reserved.
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 assets

import (
"path/filepath"
"testing"

"github.com/spf13/afero"
"k8s.io/minikube/pkg/minikube/constants"
)

func TestAddMinikubeDirAssets(t *testing.T) {

tests := []struct {
description string
baseDir string
files []struct {
relativePath string
expectedPath string
}
vmPath string
expectedCfg string
}{
{
description: "relative path assets",
baseDir: "/files",
files: []struct {
relativePath string
expectedPath string
}{
{
relativePath: "/dir1/file1.txt",
expectedPath: constants.AddonsPath,
},
{
relativePath: "/dir1/file2.txt",
expectedPath: constants.AddonsPath,
},
{
relativePath: "/dir2/file1.txt",
expectedPath: constants.AddonsPath,
},
},
vmPath: constants.AddonsPath,
},
{
description: "absolute path assets",
baseDir: "/files",
files: []struct {
relativePath string
expectedPath string
}{
{
relativePath: "/dir1/file1.txt",
expectedPath: "/dir1",
},
{
relativePath: "/dir1/file2.txt",
expectedPath: "/dir1",
},
{
relativePath: "/dir2/file1.txt",
expectedPath: "/dir2",
},
},
vmPath: "",
},
}
for _, test := range tests {
t.Run(test.description, func(t *testing.T) {
fs := &afero.Afero{Fs: afero.NewMemMapFs()}
assetNames := make([]string, 0)
for _, fileDef := range test.files {
err := func() error {
path := filepath.Join(test.baseDir, fileDef.relativePath)
assetNames = append(assetNames, path)
err := fs.MkdirAll(filepath.Dir(path), 0755)
if err != nil {
return err
}

file, err := fs.Create(path)
if err != nil {
return err
}

defer file.Close()

_, err = file.WriteString("test")
return err
}()
if err != nil {
t.Errorf("unable to create file on fs: %v", err)
return
}
}

var actualFiles []CopyableFile
err := addMinikubeDirToAssets(fs, test.baseDir, test.vmPath, &actualFiles)
if err != nil {
t.Errorf("got unexpected error add minikube dir assets: %v", err)
return
}
for idx, actualFile := range actualFiles {
if actualFile.GetAssetName() != assetNames[idx] {
t.Errorf("actual file assets does not match expected. actual:\n%s\nexpected:\n%s", actualFile.GetAssetName(), assetNames[idx])
return
}
if actualFile.GetTargetDir() != test.files[idx].expectedPath {
t.Errorf("actual file target dir does not match expected. actual:\n%s\nexpected:\n%s", actualFile.GetTargetDir(), test.files[idx].expectedPath)
return
}
}
})
}

}
8 changes: 6 additions & 2 deletions pkg/minikube/assets/vm_assets.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"path"

"github.com/pkg/errors"
"github.com/spf13/afero"
)

type CopyableFile interface {
Expand Down Expand Up @@ -68,7 +69,10 @@ func NewMemoryAssetTarget(d []byte, targetPath, permissions string) *MemoryAsset
return NewMemoryAsset(d, path.Dir(targetPath), path.Base(targetPath), permissions)
}

func NewFileAsset(assetName, targetDir, targetName, permissions string) (*FileAsset, error) {
func NewFileAsset(fs afero.Fs, assetName, targetDir, targetName, permissions string) (*FileAsset, error) {
if fs == nil {
fs = afero.NewOsFs()
}
f := &FileAsset{
BaseAsset{
AssetName: assetName,
Expand All @@ -77,7 +81,7 @@ func NewFileAsset(assetName, targetDir, targetName, permissions string) (*FileAs
Permissions: permissions,
},
}
file, err := os.Open(f.AssetName)
file, err := fs.Open(f.AssetName)
if err != nil {
return nil, errors.Wrapf(err, "Error opening file asset: %s", f.AssetName)
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/minikube/bootstrapper/certs.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ func SetupCerts(cmd CommandRunner, k8s config.KubernetesConfig) error {
if strings.HasSuffix(cert, ".key") {
perms = "0600"
}
certFile, err := assets.NewFileAsset(p, util.DefaultCertPath, cert, perms)
certFile, err := assets.NewFileAsset(nil, p, util.DefaultCertPath, cert, perms)
if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/minikube/bootstrapper/kubeadm/kubeadm.go
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ func (k *KubeadmBootstrapper) UpdateCluster(cfg config.KubernetesConfig) error {
if err != nil {
return errors.Wrapf(err, "downloading %s", bin)
}
f, err := assets.NewFileAsset(path, "/usr/bin", bin, "0641")
f, err := assets.NewFileAsset(nil, path, "/usr/bin", bin, "0641")
if err != nil {
return errors.Wrap(err, "making new file asset")
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/minikube/machine/cache_images.go
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ func LoadFromCacheBlocking(cmd bootstrapper.CommandRunner, src string) error {
}
}
dst := path.Join(tempLoadDir, filename)
f, err := assets.NewFileAsset(src, tempLoadDir, filename, "0777")
f, err := assets.NewFileAsset(nil, src, tempLoadDir, filename, "0777")
if err != nil {
return errors.Wrapf(err, "creating copyable file asset: %s", filename)
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/provision/buildroot.go
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ func configureAuth(p *BuildrootProvisioner) error {
}

for src, dst := range hostCerts {
f, err := assets.NewFileAsset(src, path.Dir(dst), filepath.Base(dst), "0777")
f, err := assets.NewFileAsset(nil, src, path.Dir(dst), filepath.Base(dst), "0777")
if err != nil {
return errors.Wrapf(err, "open cert file: %s", src)
}
Expand Down Expand Up @@ -280,7 +280,7 @@ func configureAuth(p *BuildrootProvisioner) error {
}
sshRunner := bootstrapper.NewSSHRunner(sshClient)
for src, dst := range remoteCerts {
f, err := assets.NewFileAsset(src, path.Dir(dst), filepath.Base(dst), "0640")
f, err := assets.NewFileAsset(nil, src, path.Dir(dst), filepath.Base(dst), "0640")
if err != nil {
return errors.Wrapf(err, "error copying %s to %s", src, dst)
}
Expand Down
5 changes: 3 additions & 2 deletions pkg/util/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import (
units "github.com/docker/go-units"
"github.com/golang/glog"
"github.com/pkg/errors"
"github.com/spf13/afero"
)

const ErrPrefix = "! "
Expand Down Expand Up @@ -168,8 +169,8 @@ func (m MultiError) ToError() error {
return errors.New(strings.Join(errStrings, "\n"))
}

func IsDirectory(path string) (bool, error) {
fileInfo, err := os.Stat(path)
func IsDirectory(fs afero.Fs, path string) (bool, error) {
fileInfo, err := fs.Stat(path)
if err != nil {
return false, errors.Wrapf(err, "Error calling os.Stat on file %s", path)
}
Expand Down

0 comments on commit d14b3ca

Please sign in to comment.