Artifacts may contain other files types, not just YAML files, meaning the
semantic YAML diff provided by `dyff` is not a safe default.
This change implements purely textual diffing using the `diff` command line
tool. This tool can be overridden by users using the `FLUX_EXTERNAL_DIFF`
environment variable.
Users that store Kubernetes resource manifests in the artifact can re-enable
the semantic YAML diff behavior using the `--semantic-diff yaml` flag.
The arguments to the diff subcommand may be:
* A directory
* A .tar.gz or .tgz file
* An OCI url
* An individual file
The two arguments to the command are treated the same way, allowing users to
diff in either direction.
Signed-off-by: Florian Forster <fforster@gitlab.com>
Also updates the list of options passed to `dyff.CompareInputFiles` to be the
same as in the internal `build` package.
Signed-off-by: Florian Forster <fforster@gitlab.com>
I was hoping to use `flux diff artifact` as part of a CI pipeline to show the
difference between the merge request and the currently deployed artifact. The
existing implementation doesn't work for us, since it only compares the
checksums.
This commit changes the output produced by `flux diff artifact` to a list of
changes in human readable form. The code is using the `dyff` package to produce
a semantic diff of the YAML files. That means, for example, that changes in the
order of map fields are ignored, while changes in the order of lists are not.
Example output:
```
$ ./bin/flux diff artifact "oci://${IMAGE}" --path=example-service/
spec.replicas (apps/v1/Deployment/example-service-t205j6/backend-production)
± value change
- 1
+ 7
✗ "oci://registry.gitlab.com/${REDACTED}/example-service-t205j6/deploy:production" and "example-service/" differ
```
The new `--brief` / `-q` flag enables users to revert to the previous behavior
of only printing a has changed/has not changed line.
Signed-off-by: Florian Forster <fforster@gitlab.com>
Florian Forster
Stefan Prodan
Sanskar Jaiswal
Max Jonas Werner
Batuhan Apaydın