-
Notifications
You must be signed in to change notification settings - Fork 90
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.
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
Migration source and target implementations #124
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,151 @@ | ||
package migration | ||
|
||
import ( | ||
"bytes" | ||
"fmt" | ||
"os" | ||
"path/filepath" | ||
|
||
"github.com/pkg/errors" | ||
"github.com/spf13/afero" | ||
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" | ||
"k8s.io/apimachinery/pkg/util/yaml" | ||
sigsyaml "sigs.k8s.io/yaml" | ||
) | ||
|
||
// FileSystemSource is a source implementation to read resources from filesystem | ||
type FileSystemSource struct { | ||
index int | ||
items []UnstructuredWithMetadata | ||
afero afero.Afero | ||
} | ||
|
||
// FileSystemSourceOption allows you to configure FileSystemSource | ||
type FileSystemSourceOption func(*FileSystemSource) | ||
|
||
// FsWithFileSystem configures the filesystem to use. Used mostly for testing. | ||
func FsWithFileSystem(f afero.Fs) FileSystemSourceOption { | ||
return func(fs *FileSystemSource) { | ||
fs.afero = afero.Afero{Fs: f} | ||
} | ||
} | ||
|
||
// NewFileSystemSource returns a FileSystemSource | ||
func NewFileSystemSource(dir string, opts ...FileSystemSourceOption) (*FileSystemSource, error) { | ||
fs := &FileSystemSource{ | ||
afero: afero.Afero{Fs: afero.NewOsFs()}, | ||
} | ||
for _, f := range opts { | ||
f(fs) | ||
} | ||
|
||
if err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error { | ||
if err != nil { | ||
return errors.Wrap(err, fmt.Sprintf("cannot read %s", path)) | ||
} | ||
|
||
if info.IsDir() { | ||
return nil | ||
} | ||
|
||
data, err := fs.afero.ReadFile(path) | ||
if err != nil { | ||
return errors.Wrap(err, "cannot read source file") | ||
} | ||
|
||
decoder := yaml.NewYAMLOrJSONDecoder(bytes.NewBufferString(string(data)), 1024) | ||
u := &unstructured.Unstructured{} | ||
if err := decoder.Decode(&u); err != nil { | ||
return errors.Wrap(err, "cannot decode read data") | ||
} | ||
|
||
fs.items = append(fs.items, UnstructuredWithMetadata{ | ||
Object: *u, | ||
Metadata: Metadata{ | ||
Path: path, | ||
}, | ||
}) | ||
|
||
return nil | ||
}); err != nil { | ||
return nil, errors.Wrap(err, "cannot read source directory") | ||
} | ||
|
||
return fs, nil | ||
} | ||
|
||
// HasNext checks the next item | ||
func (fs *FileSystemSource) HasNext() (bool, error) { | ||
return fs.index < len(fs.items), nil | ||
} | ||
|
||
// Next returns the next item of slice | ||
func (fs *FileSystemSource) Next() (UnstructuredWithMetadata, error) { | ||
if hasNext, _ := fs.HasNext(); hasNext { | ||
item := fs.items[fs.index] | ||
fs.index++ | ||
return item, nil | ||
} | ||
return UnstructuredWithMetadata{}, errors.New("no more elements") | ||
} | ||
|
||
// FileSystemTarget is a target implementation to write/patch/delete resources to file system | ||
type FileSystemTarget struct { | ||
afero afero.Afero | ||
} | ||
|
||
// FileSystemTargetOption allows you to configure FileSystemTarget | ||
type FileSystemTargetOption func(*FileSystemTarget) | ||
|
||
// FtWithFileSystem configures the filesystem to use. Used mostly for testing. | ||
func FtWithFileSystem(f afero.Fs) FileSystemTargetOption { | ||
return func(ft *FileSystemTarget) { | ||
ft.afero = afero.Afero{Fs: f} | ||
} | ||
} | ||
|
||
// NewFileSystemTarget returns a FileSystemTarget | ||
func NewFileSystemTarget(opts ...FileSystemTargetOption) *FileSystemTarget { | ||
ft := &FileSystemTarget{ | ||
afero: afero.Afero{Fs: afero.NewOsFs()}, | ||
} | ||
for _, f := range opts { | ||
f(ft) | ||
} | ||
return ft | ||
} | ||
|
||
// Put writes input to filesystem | ||
func (ft *FileSystemTarget) Put(o UnstructuredWithMetadata) error { | ||
b, err := sigsyaml.Marshal(o.Object.Object) | ||
if err != nil { | ||
return errors.Wrap(err, "cannot marshal object") | ||
} | ||
if o.Metadata.Parents != "" { | ||
f, err := ft.afero.OpenFile(o.Metadata.Path, os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0600) | ||
if err != nil { | ||
return errors.Wrap(err, "cannot open file") | ||
} | ||
|
||
defer f.Close() //nolint:errcheck | ||
|
||
if _, err = f.WriteString(fmt.Sprintf("\n---\n\n%s", string(b))); err != nil { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So the idea is, if a migration converter produces multiple managed resources, then all will be appended to the same file, right? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, right! This block adds |
||
return errors.Wrap(err, "cannot write file") | ||
} | ||
} else { | ||
f, err := ft.afero.Create(o.Metadata.Path) | ||
if err != nil { | ||
return errors.Wrap(err, "cannot create file") | ||
} | ||
if _, err := f.Write(b); err != nil { | ||
return errors.Wrap(err, "cannot write file") | ||
} | ||
} | ||
|
||
return nil | ||
} | ||
|
||
// Delete deletes a file from filesystem | ||
func (ft *FileSystemTarget) Delete(o UnstructuredWithMetadata) error { | ||
return ft.afero.Remove(o.Metadata.Path) | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are there any fields other than the
Fs
that we might configure (so that we may prefer to use anafero.Afero
as a parameter instead of anafero.Fs
in the functional option)?