cmd/cue/cmd: add fix command for new-style definitions
This adds a new fix command. As converting configurations to
new-style defintions can no longer be done syntactically and is
not guaranteed to succeed, this could no longer be piggybacked
on fmt.
This changes adds the implementation of converting new-style
definitions. The conversion is not complete. Firstly, not all
old configurations can be converted to new-style definitions.
The converter detects this and suggests changes to the user.
Also, due to API limitations, not all convertable cases are
handled by the converter. These cases are also detected and
reported.
Change-Id: I88c4010b15ea07250dc456fd84b2603b473ae5c1
Reviewed-on: https://cue-review.googlesource.com/c/cue/+/6067
Reviewed-by: Marcel van Lohuizen <mpvl@golang.org>
diff --git a/internal/cuetxtar/txtar.go b/internal/cuetxtar/txtar.go
new file mode 100644
index 0000000..0164605
--- /dev/null
+++ b/internal/cuetxtar/txtar.go
@@ -0,0 +1,260 @@
+// Copyright 2020 CUE Authors
+//
+// 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 cuetxtar
+
+import (
+ "bufio"
+ "bytes"
+ "io/ioutil"
+ "os"
+ "path"
+ "path/filepath"
+ "strings"
+ "testing"
+
+ "cuelang.org/go/cue/build"
+ "cuelang.org/go/cue/errors"
+ "cuelang.org/go/cue/load"
+ "github.com/google/go-cmp/cmp"
+ "github.com/rogpeppe/testscript/txtar"
+)
+
+// A TxTarTest represents a test run that process all CUE tests in the txtar
+// format rooted in a given directory.
+type TxTarTest struct {
+ // Run TxTarTest on this directory.
+ Root string
+
+ // Name is a unique name for this test. The golden file for this test is
+ // derived from the out/<name> file in the .txtar file.
+ //
+ // TODO: by default derive from the current base directory name.
+ Name string
+
+ // If Update is true, TestTxTar will update the out/Name file if it differs
+ // from the original input. The user must set the output in Gold for this
+ // to be detected.
+ Update bool
+
+ // Skip is a map of tests to skip to their skip message.
+ Skip map[string]string
+
+ // ToDo is a map of tests that should be skipped now, but should be fixed.
+ ToDo map[string]string
+}
+
+// A Test represents a single test based on a .txtar file.
+//
+// A Test embeds *testing.T and should be used to report errors.
+//
+// A Test also embeds a *bytes.Buffer which is used to report test results,
+// which are compared against the golden file for the test in the TxTar archive.
+// If the test fails and the update flag is set to true, the Archive will be
+// updated and written to disk.
+type Test struct {
+ // Allow Test to be used as a T.
+ *testing.T
+
+ // Buffer is used to write the test results that will be compared to the
+ // golden file.
+ *bytes.Buffer
+
+ Archive *txtar.Archive
+
+ // The absolute path of the current test directory.
+ Dir string
+
+ hasGold bool
+}
+
+func (t *Test) HasTag(key string) bool {
+ prefix := []byte("#" + key)
+ s := bufio.NewScanner(bytes.NewReader(t.Archive.Comment))
+ for s.Scan() {
+ b := s.Bytes()
+ if bytes.Equal(bytes.TrimSpace(b), prefix) {
+ return true
+ }
+ }
+ return false
+}
+
+func (t *Test) Value(key string) (value string, ok bool) {
+ prefix := []byte("#" + key + ":")
+ s := bufio.NewScanner(bytes.NewReader(t.Archive.Comment))
+ for s.Scan() {
+ b := s.Bytes()
+ if bytes.HasPrefix(b, prefix) {
+ return string(bytes.TrimSpace(b[len(prefix):])), true
+ }
+ }
+ return "", false
+}
+
+// Bool searchs for a line starting with #key: value in the comment and
+// returns true if the key exists and the value is true.
+func (t *Test) Bool(key string) bool {
+ s, ok := t.Value(key)
+ return ok && s == "true"
+}
+
+// Rel converts filename to a normalized form so that it will given the same
+// output across different runs and OSes.
+func (t *Test) Rel(filename string) string {
+ rel, err := filepath.Rel(t.Dir, filename)
+ if err != nil {
+ return filepath.Base(filename)
+ }
+ return rel
+}
+
+// WriteErrors writes strings and
+func (t *Test) WriteErrors(err errors.Error) {
+ if err != nil {
+ errors.Print(t, err, &errors.Config{
+ Cwd: t.Dir,
+ ToSlash: true,
+ })
+ }
+}
+
+// ValidInstances returns the valid instances for this .txtar file or skips the
+// test if there is an error loading the instances.
+func (t *Test) ValidInstances(args ...string) []*build.Instance {
+ a := t.RawInstances(args...)
+ for _, i := range a {
+ if i.Err != nil {
+ if t.hasGold {
+ t.Fatal("Parse error: ", i.Err)
+ }
+ t.Skip("Parse error: ", i.Err)
+ }
+ }
+ return a
+}
+
+// RawInstances returns the intstances represented by this .txtar file. The
+// returned instances are not checked for errors.
+func (t *Test) RawInstances(args ...string) []*build.Instance {
+ if len(args) == 0 {
+ args = []string{"in.cue"}
+ }
+ overlay := map[string]load.Source{}
+ for _, f := range t.Archive.Files {
+ overlay[filepath.Join(t.Dir, f.Name)] = load.FromBytes(f.Data)
+ }
+
+ cfg := &load.Config{
+ Dir: t.Dir,
+ Overlay: overlay,
+ }
+
+ return load.Instances(args, cfg)
+}
+
+// Run runs tests defined in txtar files in root or its subdirectories.
+// Only tests for which an `old/name` test output file exists are run.
+func (x *TxTarTest) Run(t *testing.T, f func(tc *Test)) {
+ dir, err := os.Getwd()
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ root := x.Root
+
+ err = filepath.Walk(root, func(fullpath string, info os.FileInfo, err error) error {
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ if info.IsDir() || filepath.Ext(fullpath) != ".txtar" {
+ return nil
+ }
+
+ a, err := txtar.ParseFile(fullpath)
+ if err != nil {
+ t.Fatalf("error parsing txtar file: %v", err)
+ }
+
+ p := strings.Index(fullpath, "/testdata/")
+ testName := fullpath[p+len("/testdata/") : len(fullpath)-len(".txtar")]
+
+ t.Run(testName, func(t *testing.T) {
+ outFile := path.Join("out", x.Name)
+
+ var gold *txtar.File
+ for i, f := range a.Files {
+ if f.Name == outFile {
+ gold = &a.Files[i]
+ }
+ }
+
+ tc := &Test{
+ T: t,
+ Buffer: &bytes.Buffer{},
+ Archive: a,
+ Dir: filepath.Dir(filepath.Join(dir, fullpath)),
+
+ hasGold: gold != nil,
+ }
+
+ if tc.HasTag("skip") {
+ t.Skip()
+ }
+
+ if msg, ok := x.Skip[testName]; ok {
+ t.Skip(msg)
+ }
+ if msg, ok := x.ToDo[testName]; ok {
+ t.Skip(msg)
+ }
+
+ f(tc)
+
+ result := tc.Bytes()
+ if len(result) == 0 {
+ return
+ }
+
+ if gold == nil {
+ a.Files = append(a.Files, txtar.File{Name: outFile})
+ gold = &a.Files[len(a.Files)-1]
+ }
+
+ if bytes.Equal(gold.Data, result) {
+ return
+ }
+
+ if !x.Update {
+ t.Fatal(cmp.Diff(string(gold.Data), string(result)))
+ }
+
+ gold.Data = result
+
+ // Update and write file.
+
+ err := ioutil.WriteFile(fullpath, txtar.Format(a), 0644)
+ if err != nil {
+ t.Fatal(err)
+ }
+ })
+
+ return nil
+ })
+
+ if err != nil {
+ t.Fatal(err)
+ }
+}
