mirror of
https://github.com/vbatts/go-mtree.git
synced 2024-10-31 22:36:38 +00:00
72ac04e7ca
With: $ git mv vendor/github.com/{S,s}irupsen $ sed -i 's/Sirupsen/sirupsen/g' $(git grep -l Sirupsen) catching up with the upstream lowercasing [1,2,3,4]. Because of the compatibility issues discussed in [3], some consumers may prefer to use the old uppercase version until they have time to update their other Logrus consumers to the new lowercase form. [1]: https://github.com/sirupsen/logrus/blame/v1.0.3/README.md#L6 [2]: https://github.com/sirupsen/logrus/pull/384 [3]: https://github.com/sirupsen/logrus/issues/570#issuecomment-313933276 [4]: https://github.com/sirupsen/logrus/issues/553
471 lines
12 KiB
Go
471 lines
12 KiB
Go
package main
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"flag"
|
|
"fmt"
|
|
"io"
|
|
"io/ioutil"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/sirupsen/logrus"
|
|
"github.com/vbatts/go-mtree"
|
|
)
|
|
|
|
var (
|
|
// Flags common with mtree(8)
|
|
flCreate = flag.Bool("c", false, "create a directory hierarchy spec")
|
|
flFile = flag.String("f", "", "directory hierarchy spec to validate")
|
|
flPath = flag.String("p", "", "root path that the hierarchy spec is relative to")
|
|
flAddKeywords = flag.String("K", "", "Add the specified (delimited by comma or space) keywords to the current set of keywords")
|
|
flUseKeywords = flag.String("k", "", "Use the specified (delimited by comma or space) keywords as the current set of keywords")
|
|
flDirectoryOnly = flag.Bool("d", false, "Ignore everything except directory type files")
|
|
flUpdateAttributes = flag.Bool("u", false, "Modify the owner, group, permissions and xattrs of files, symbolic links and devices, to match the provided specification. This is not compatible with '-T'.")
|
|
|
|
// Flags unique to gomtree
|
|
flListKeywords = flag.Bool("list-keywords", false, "List the keywords available")
|
|
flResultFormat = flag.String("result-format", "bsd", "output the validation results using the given format (bsd, json, path)")
|
|
flTar = flag.String("T", "", "use tar archive to create or validate a directory hierarchy spec (\"-\" indicates stdin)")
|
|
flBsdKeywords = flag.Bool("bsd-keywords", false, "only operate on keywords that are supported by upstream mtree(8)")
|
|
flListUsedKeywords = flag.Bool("list-used", false, "list all the keywords found in a validation manifest")
|
|
flDebug = flag.Bool("debug", false, "output debug info to STDERR")
|
|
flVersion = flag.Bool("version", false, "display the version of this tool")
|
|
)
|
|
|
|
func main() {
|
|
// so that defers cleanly exec
|
|
if err := app(); err != nil {
|
|
logrus.Fatal(err)
|
|
}
|
|
}
|
|
|
|
func app() error {
|
|
flag.Parse()
|
|
|
|
if *flDebug {
|
|
os.Setenv("DEBUG", "1")
|
|
logrus.SetLevel(logrus.DebugLevel)
|
|
}
|
|
|
|
if *flVersion {
|
|
fmt.Printf("%s :: %s\n", mtree.AppName, mtree.Version)
|
|
return nil
|
|
}
|
|
|
|
// -list-keywords
|
|
if *flListKeywords {
|
|
fmt.Println("Available keywords:")
|
|
for k := range mtree.KeywordFuncs {
|
|
fmt.Print(" ")
|
|
fmt.Print(k)
|
|
if mtree.Keyword(k).Default() {
|
|
fmt.Print(" (default)")
|
|
}
|
|
if !mtree.Keyword(k).Bsd() {
|
|
fmt.Print(" (not upstream)")
|
|
}
|
|
fmt.Print("\n")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// --result-format
|
|
formatFunc, ok := formats[*flResultFormat]
|
|
if !ok {
|
|
return fmt.Errorf("invalid output format: %s", *flResultFormat)
|
|
}
|
|
|
|
var (
|
|
err error
|
|
tmpKeywords []mtree.Keyword
|
|
currentKeywords []mtree.Keyword
|
|
)
|
|
|
|
// -k <keywords>
|
|
if *flUseKeywords != "" {
|
|
tmpKeywords = splitKeywordsArg(*flUseKeywords)
|
|
if !mtree.InKeywordSlice("type", tmpKeywords) {
|
|
tmpKeywords = append([]mtree.Keyword{"type"}, tmpKeywords...)
|
|
}
|
|
} else {
|
|
if *flTar != "" {
|
|
tmpKeywords = mtree.DefaultTarKeywords[:]
|
|
} else {
|
|
tmpKeywords = mtree.DefaultKeywords[:]
|
|
}
|
|
}
|
|
|
|
// -K <keywords>
|
|
if *flAddKeywords != "" {
|
|
for _, kw := range splitKeywordsArg(*flAddKeywords) {
|
|
if !mtree.InKeywordSlice(kw, tmpKeywords) {
|
|
tmpKeywords = append(tmpKeywords, kw)
|
|
}
|
|
}
|
|
}
|
|
|
|
// -bsd-keywords
|
|
if *flBsdKeywords {
|
|
for _, k := range tmpKeywords {
|
|
if mtree.Keyword(k).Bsd() {
|
|
currentKeywords = append(currentKeywords, k)
|
|
} else {
|
|
fmt.Fprintf(os.Stderr, "INFO: ignoring %q as it is not an upstream keyword\n", k)
|
|
}
|
|
}
|
|
} else {
|
|
currentKeywords = tmpKeywords
|
|
}
|
|
|
|
// Check mutual exclusivity of keywords.
|
|
// TODO(cyphar): Abstract this inside keywords.go.
|
|
if mtree.InKeywordSlice("tar_time", currentKeywords) && mtree.InKeywordSlice("time", currentKeywords) {
|
|
return fmt.Errorf("tar_time and time are mutually exclusive keywords")
|
|
}
|
|
|
|
// If we're doing a comparison, we always are comparing between a spec and
|
|
// state DH. If specDh is nil, we are generating a new one.
|
|
var (
|
|
specDh *mtree.DirectoryHierarchy
|
|
stateDh *mtree.DirectoryHierarchy
|
|
specKeywords []mtree.Keyword
|
|
)
|
|
|
|
// -f <file>
|
|
if *flFile != "" && !*flCreate {
|
|
// load the hierarchy, if we're not creating a new spec
|
|
fh, err := os.Open(*flFile)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
specDh, err = mtree.ParseSpec(fh)
|
|
fh.Close()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// We can't check against more fields than in the specKeywords list, so
|
|
// currentKeywords can only have a subset of specKeywords.
|
|
specKeywords = specDh.UsedKeywords()
|
|
}
|
|
|
|
// -list-used
|
|
if *flListUsedKeywords {
|
|
if specDh == nil {
|
|
return fmt.Errorf("no specification provided. please provide a validation manifest")
|
|
}
|
|
|
|
if *flResultFormat == "json" {
|
|
// if they're asking for json, give it to them
|
|
data := map[string][]mtree.Keyword{*flFile: specKeywords}
|
|
buf, err := json.MarshalIndent(data, "", " ")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
fmt.Println(string(buf))
|
|
} else {
|
|
fmt.Printf("Keywords used in [%s]:\n", *flFile)
|
|
for _, kw := range specKeywords {
|
|
fmt.Printf(" %s", kw)
|
|
if _, ok := mtree.KeywordFuncs[kw]; !ok {
|
|
fmt.Print(" (unsupported)")
|
|
}
|
|
fmt.Printf("\n")
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
if specKeywords != nil {
|
|
// If we didn't actually change the set of keywords, we can just use specKeywords.
|
|
if *flUseKeywords == "" && *flAddKeywords == "" {
|
|
currentKeywords = specKeywords
|
|
}
|
|
|
|
for _, keyword := range currentKeywords {
|
|
// As always, time is a special case.
|
|
// TODO: Fix that.
|
|
if (keyword == "time" && mtree.InKeywordSlice("tar_time", specKeywords)) || (keyword == "tar_time" && mtree.InKeywordSlice("time", specKeywords)) {
|
|
continue
|
|
}
|
|
}
|
|
}
|
|
|
|
// -p and -T are mutually exclusive
|
|
if *flPath != "" && *flTar != "" {
|
|
return fmt.Errorf("options -T and -p are mutually exclusive")
|
|
}
|
|
|
|
// -p <path>
|
|
var rootPath = "."
|
|
if *flPath != "" {
|
|
rootPath = *flPath
|
|
}
|
|
|
|
excludes := []mtree.ExcludeFunc{}
|
|
// -d
|
|
if *flDirectoryOnly {
|
|
excludes = append(excludes, mtree.ExcludeNonDirectories)
|
|
}
|
|
|
|
// -u
|
|
// Failing early here. Processing is done below.
|
|
if *flUpdateAttributes && *flTar != "" {
|
|
return fmt.Errorf("ERROR: -u can not be used with -T")
|
|
}
|
|
|
|
// -T <tar file>
|
|
if *flTar != "" {
|
|
var input io.Reader
|
|
if *flTar == "-" {
|
|
input = os.Stdin
|
|
} else {
|
|
fh, err := os.Open(*flTar)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer fh.Close()
|
|
input = fh
|
|
}
|
|
ts := mtree.NewTarStreamer(input, excludes, currentKeywords)
|
|
|
|
if _, err := io.Copy(ioutil.Discard, ts); err != nil && err != io.EOF {
|
|
return err
|
|
}
|
|
if err := ts.Close(); err != nil {
|
|
return err
|
|
}
|
|
var err error
|
|
stateDh, err = ts.Hierarchy()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
} else {
|
|
// with a root directory
|
|
stateDh, err = mtree.Walk(rootPath, excludes, currentKeywords, nil)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
// -u
|
|
if *flUpdateAttributes && stateDh != nil {
|
|
// -u
|
|
// this comes before the next case, intentionally.
|
|
result, err := mtree.Update(rootPath, specDh, mtree.DefaultUpdateKeywords, nil)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if result != nil && len(result) > 0 {
|
|
fmt.Printf("%#v\n", result)
|
|
}
|
|
|
|
var res []mtree.InodeDelta
|
|
// only check the keywords that we just updated
|
|
res, err = mtree.Check(rootPath, specDh, mtree.DefaultUpdateKeywords, nil)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if res != nil {
|
|
out := formatFunc(res)
|
|
if _, err := os.Stdout.Write([]byte(out)); err != nil {
|
|
return err
|
|
}
|
|
|
|
// TODO: This should be a flag. Allowing files to be added and
|
|
// removed and still returning "it's all good" is simply
|
|
// unsafe IMO.
|
|
for _, diff := range res {
|
|
if diff.Type() == mtree.Modified {
|
|
return fmt.Errorf("mainfest validation failed")
|
|
}
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// -c
|
|
if *flCreate {
|
|
fh := os.Stdout
|
|
if *flFile != "" {
|
|
fh, err = os.Create(*flFile)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
// output stateDh
|
|
stateDh.WriteTo(fh)
|
|
return nil
|
|
}
|
|
|
|
// no spec manifest has been provided yet, so look for it on stdin
|
|
if specDh == nil {
|
|
// load the hierarchy
|
|
specDh, err = mtree.ParseSpec(os.Stdin)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// We can't check against more fields than in the specKeywords list, so
|
|
// currentKeywords can only have a subset of specKeywords.
|
|
specKeywords = specDh.UsedKeywords()
|
|
}
|
|
|
|
// This is a validation.
|
|
if specDh != nil && stateDh != nil {
|
|
var res []mtree.InodeDelta
|
|
res, err = mtree.Compare(specDh, stateDh, currentKeywords)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if res != nil {
|
|
if isTarSpec(specDh) || *flTar != "" {
|
|
res = filterMissingKeywords(res)
|
|
}
|
|
|
|
out := formatFunc(res)
|
|
if _, err := os.Stdout.Write([]byte(out)); err != nil {
|
|
return err
|
|
}
|
|
|
|
// TODO: This should be a flag. Allowing files to be added and
|
|
// removed and still returning "it's all good" is simply
|
|
// unsafe IMO.
|
|
for _, diff := range res {
|
|
if diff.Type() == mtree.Modified {
|
|
return fmt.Errorf("mainfest validation failed")
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
return fmt.Errorf("neither validating or creating a manifest. Please provide additional arguments")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
var formats = map[string]func([]mtree.InodeDelta) string{
|
|
// Outputs the errors in the BSD format.
|
|
"bsd": func(d []mtree.InodeDelta) string {
|
|
var buffer bytes.Buffer
|
|
for _, delta := range d {
|
|
fmt.Fprintln(&buffer, delta)
|
|
}
|
|
return buffer.String()
|
|
},
|
|
|
|
// Outputs the full result struct in JSON.
|
|
"json": func(d []mtree.InodeDelta) string {
|
|
var buffer bytes.Buffer
|
|
if err := json.NewEncoder(&buffer).Encode(d); err != nil {
|
|
panic(err)
|
|
}
|
|
return buffer.String()
|
|
},
|
|
|
|
// Outputs only the paths which failed to validate.
|
|
"path": func(d []mtree.InodeDelta) string {
|
|
var buffer bytes.Buffer
|
|
for _, delta := range d {
|
|
if delta.Type() == mtree.Modified {
|
|
fmt.Fprintln(&buffer, delta.Path())
|
|
}
|
|
}
|
|
return buffer.String()
|
|
},
|
|
}
|
|
|
|
// isDirEntry returns wheter an mtree.Entry describes a directory.
|
|
func isDirEntry(e mtree.Entry) bool {
|
|
for _, kw := range e.Keywords {
|
|
kv := mtree.KeyVal(kw)
|
|
if kv.Keyword() == "type" {
|
|
return kv.Value() == "dir"
|
|
}
|
|
}
|
|
// Shouldn't be reached.
|
|
return false
|
|
}
|
|
|
|
// filterMissingKeywords is a fairly annoying hack to get around the fact that
|
|
// tar archive manifest generation has certain unsolveable problems regarding
|
|
// certain keywords. For example, the size=... keyword cannot be implemented
|
|
// for directories in a tar archive (which causes Missing errors for that
|
|
// keyword).
|
|
//
|
|
// This function just removes all instances of Missing errors for keywords.
|
|
// This makes certain assumptions about the type of issues tar archives have.
|
|
// Only call this on tar archive manifest comparisons.
|
|
func filterMissingKeywords(diffs []mtree.InodeDelta) []mtree.InodeDelta {
|
|
newDiffs := []mtree.InodeDelta{}
|
|
loop:
|
|
for _, diff := range diffs {
|
|
if diff.Type() == mtree.Modified {
|
|
// We only apply this filtering to directories.
|
|
// NOTE: This will probably break if someone drops the size keyword.
|
|
if isDirEntry(*diff.Old()) || isDirEntry(*diff.New()) {
|
|
// If this applies to '.' then we just filter everything
|
|
// (meaning we remove this entry). This is because note all tar
|
|
// archives include a '.' entry. Which makes checking this not
|
|
// practical.
|
|
if diff.Path() == "." {
|
|
continue
|
|
}
|
|
|
|
// Only filter out the size keyword.
|
|
// NOTE: This currently takes advantage of the fact the
|
|
// diff.Diff() returns the actual slice to diff.keys.
|
|
keys := diff.Diff()
|
|
for idx, k := range keys {
|
|
// Delete the key if it's "size". Unfortunately in Go you
|
|
// can't delete from a slice without reassigning it. So we
|
|
// just overwrite it with the last value.
|
|
if k.Name() == "size" {
|
|
if len(keys) < 2 {
|
|
continue loop
|
|
}
|
|
keys[idx] = keys[len(keys)-1]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// If we got here, append to the new set.
|
|
newDiffs = append(newDiffs, diff)
|
|
}
|
|
return newDiffs
|
|
}
|
|
|
|
// isTarSpec returns whether the spec provided came from the tar generator.
|
|
// This takes advantage of an unsolveable problem in tar generation.
|
|
func isTarSpec(spec *mtree.DirectoryHierarchy) bool {
|
|
// Find a directory and check whether it's missing size=...
|
|
// NOTE: This will definitely break if someone drops the size=... keyword.
|
|
for _, e := range spec.Entries {
|
|
if !isDirEntry(e) {
|
|
continue
|
|
}
|
|
|
|
for _, kw := range e.Keywords {
|
|
kv := mtree.KeyVal(kw)
|
|
if kv.Keyword() == "size" {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|
|
|
|
// Should never be reached.
|
|
return false
|
|
}
|
|
|
|
func splitKeywordsArg(str string) []mtree.Keyword {
|
|
keywords := []mtree.Keyword{}
|
|
for _, kw := range strings.Fields(strings.Replace(str, ",", " ", -1)) {
|
|
keywords = append(keywords, mtree.KeywordSynonym(kw))
|
|
}
|
|
return keywords
|
|
}
|