mirrors/go-mtree
1
0
Fork 0
mirror of https://github.com/vbatts/go-mtree.git synced 2025-10-04 12:31:00 +00:00
Code Releases Activity

cmd: validate: add --strict mode

Browse source 
Due to FreeBSD compatibility, we have so far been forced into some
unfortunate behaviour with regards to which comparison errors we
actually return an error code for. FreeBSD generally does not return
errors if a file or keyword only exists in one of the manifests being
compared.

Some users do not care about FreeBSD compatibility and just want to get
errors if there is any difference between a manifest and directory tree.
Commit 9cdd9152b3 ("cmd: gomtree: re-enable errors when there is a
Modified entry") added a TODO to implement this, but I've only just got
around to implementing it.

This patch adds a new --strict flag to "gomtree validate", which causes
it to error out if any changes were detected and also disables the
FreeBSD compatibility keyword delta filters. This is more akin to what
modern users would expect from a manifest validation tool.

Fixes: 21723a3974 ("*: fix comparison of missing keywords")
Fixes: 9cdd9152b3 ("cmd: gomtree: re-enable errors when there is a Modified entry")
Signed-off-by: Aleksa Sarai <cyphar@cyphar.com>
This commit is contained in:
Aleksa Sarai 2025-09-16 23:57:31 +10:00
parent 1ce6aa8db5
commit b06e4de597
No known key found for this signature in database
GPG key ID: 2897FAD2B7E9446F
2 changed files with 136 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

43
cmd/gomtree/cmd/validate.go
View file

@ -3,6 +3,7 @@ package cmd
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"os"
@ -81,10 +82,16 @@ func NewValidateCommand() *cli.Command {
Value: "bsd",
Usage: "output the validation results using the given format (bsd, json, path)",
},
&cli.BoolFlag{
Name: "strict",
Usage: "enable strict validation of manifests (any discrepancy will result in an error)",
},
},
}
}
var errValidate = errors.New("manifest validation failed")
func validateAction(c *cli.Context) error {
// -list-keywords
if c.Bool("list-keywords") {
@ -307,18 +314,14 @@ func validateAction(c *cli.Context) error {
if err != nil {
return err
}
if res != nil {
out := formatFunc(res)
if len(res) > 0 {
out := formatFunc(res, c.Bool("strict"))
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("manifest validation failed")
if c.Bool("strict") || diff.Type() == mtree.Modified {
return errValidate
}
}
}
@ -368,21 +371,19 @@ func validateAction(c *cli.Context) error {
if isTarSpec(specDh) || c.String("tar") != "" {
filters = append(filters, tarKeywordFilter)
}
filters = append(filters, freebsdCompatKeywordFilter)
if !c.Bool("strict") {
filters = append(filters, freebsdCompatKeywordFilter)
}
res = filterDeltas(res, filters...)
if len(res) > 0 {
out := formatFunc(res)
out := formatFunc(res, c.Bool("strict"))
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("manifest validation failed")
if c.Bool("strict") || diff.Type() == mtree.Modified {
return errValidate
}
}
}
@ -392,9 +393,9 @@ func validateAction(c *cli.Context) error {
return nil
}
var formats = map[string]func([]mtree.InodeDelta) string{
var formats = map[string]func([]mtree.InodeDelta, bool) string{
// Outputs the errors in the BSD format.
"bsd": func(d []mtree.InodeDelta) string {
"bsd": func(d []mtree.InodeDelta, strict bool) string {
var buffer bytes.Buffer
for _, delta := range d {
fmt.Fprintln(&buffer, delta)
@ -403,7 +404,7 @@ var formats = map[string]func([]mtree.InodeDelta) string{
},
// Outputs the full result struct in JSON.
"json": func(d []mtree.InodeDelta) string {
"json": func(d []mtree.InodeDelta, strict bool) string {
var buffer bytes.Buffer
if err := json.NewEncoder(&buffer).Encode(d); err != nil {
panic(err)
@ -412,10 +413,10 @@ var formats = map[string]func([]mtree.InodeDelta) string{
},
// Outputs only the paths which failed to validate.
"path": func(d []mtree.InodeDelta) string {
"path": func(d []mtree.InodeDelta, strict bool) string {
var buffer bytes.Buffer
for _, delta := range d {
if delta.Type() == mtree.Modified {
if strict || delta.Type() == mtree.Modified {
fmt.Fprintln(&buffer, delta.Path())
}
}