Compare commits

...

8 Commits

Author SHA1 Message Date
Gleb Kanterov 5f4bb73671
Merge 96a6cef0d6 into dedec58e41 2024-10-17 14:19:52 +00:00
Pieter Noordhuis dedec58e41
Add behavioral tests for examples from the YAML spec (#1835)
## Changes

I took the examples from https://yaml.org/spec/1.2.2.

The required modifications to the loader are:
* Correctly parse floating point infinities and NaN
* Correctly parse octal numbers per the YAML 1.2 spec
* Treat "null" keys in a map as valid

## Tests

Existing and new unit tests pass.
2024-10-17 13:13:30 +00:00
Pieter Noordhuis e4d039a1aa
Handle normalization of `dyn.KindTime` into an any type (#1836)
## Changes

The issue reported in #1828 illustrates how using a YAML timestamp-like
value (a date in this case) causes an issue during conversion to and
from the typed configuration tree.

We use the `AsAny()` function on the `dyn.Value` when normalizing for
the `any` type. We only use the `any` type for variable values, because
they can assume every type. The `AsAny()` function returns a `time.Time`
for the time value during conversion **to** the typed configuration
tree. Upon conversion **from** the typed configuration tree back into
the dynamic configuration tree, we cannot distinguish a `time.Time`
struct from any other struct.

To address this, we use the underlying string value of the time value
when we normalize for the `any` type.

Fixes #1828.

## Tests

Existing unit tests pass
2024-10-17 10:00:40 +00:00
Gleb Kanterov 96a6cef0d6
Address feedbacK 2024-10-08 10:28:51 +02:00
Gleb Kanterov bfb13afa8e
Address more feedback 2024-10-08 10:26:53 +02:00
Gleb Kanterov 43ce278299
Rename bundle root path 2024-10-08 10:18:52 +02:00
Gleb Kanterov df61375995
Address CR comments 2024-10-08 10:18:37 +02:00
Gleb Kanterov 3438455459
PythonMutator: propagate source locations 2024-10-08 10:18:36 +02:00
41 changed files with 1808 additions and 60 deletions

View File

@ -45,6 +45,12 @@ type PyDABs struct {
// These packages are imported to discover resources, resource generators, and mutators.
// This list can include namespace packages, which causes the import of nested packages.
Import []string `json:"import,omitempty"`
// LoadLocations is a flag to enable loading Python source locations from the PyDABs.
//
// Locations are only supported since PyDABs 0.6.0, and because of that,
// this flag is disabled by default.
LoadLocations bool `json:"load_locations,omitempty"`
}
type Command string

View File

@ -9,6 +9,7 @@ import (
"github.com/databricks/cli/libs/dyn"
)
// pythonDiagnostic is a single entry in diagnostics.json
type pythonDiagnostic struct {
Severity pythonSeverity `json:"severity"`
Summary string `json:"summary"`

View File

@ -0,0 +1,181 @@
package python
import (
"encoding/json"
"fmt"
"io"
"path/filepath"
"github.com/databricks/cli/libs/dyn"
)
// generatedFileName is used as the virtual file name for YAML generated by PyDABs.
//
// mergePythonLocations replaces dyn.Location with generatedFileName with locations loaded
// from locations.json
const generatedFileName = "__generated_by_pydabs__.yml"
// pythonLocations is data structure for efficient location lookup for a given path
//
// Locations form a tree, and we assign locations of the closest ancestor to each dyn.Value based on its path.
// We implement it as a trie (prefix tree) where keys are components of the path. With that, lookups are O(n)
// where n is the number of components in the path.
//
// For example, with locations.json:
//
// {"path": "resources.jobs.job_0", "file": "src/examples/job_0.py", "line": 3, "column": 5}
// {"path": "resources.jobs.job_0.tasks[0].task_key", "file": "src/examples/job_0.py", "line": 10, "column": 5}
// {"path": "resources.jobs.job_1", "file": "src/examples/job_1.py", "line": 5, "column": 7}
//
// - resources.jobs.job_0.tasks[0].task_key is located at job_0.py:10:5
//
// - resources.jobs.job_0.tasks[0].email_notifications is located at job_0.py:3:5,
// because we use the location of the job as the most precise approximation.
type pythonLocations struct {
// descendants referenced by index, e.g. '.foo'
keys map[string]*pythonLocations
// descendants referenced by key, e.g. '[0]'
indexes map[int]*pythonLocations
// location for the current node if it exists
location dyn.Location
// if true, location is present
exists bool
}
// pythonLocationEntry is a single entry in locations.json
type pythonLocationEntry struct {
Path string `json:"path"`
File string `json:"file"`
Line int `json:"line"`
Column int `json:"column"`
}
// mergePythonLocations applies locations from Python mutator into given dyn.Value
//
// The primary use-case is to merge locations.json with output.json, so that any
// validation errors will point to Python source code instead of generated YAML.
func mergePythonLocations(value dyn.Value, locations *pythonLocations) (dyn.Value, error) {
return dyn.Walk(value, func(path dyn.Path, value dyn.Value) (dyn.Value, error) {
newLocation, ok := findPythonLocation(locations, path)
if !ok {
return value, nil
}
var newLocations []dyn.Location
// the first item in the list is the "last" location used for error reporting
newLocations = append(newLocations, newLocation)
for _, location := range value.Locations() {
// When loaded, dyn.Value created by PyDABs use the virtual file path as their location,
// we replace it with newLocation.
if filepath.Base(location.File) == generatedFileName {
continue
}
newLocations = append(newLocations, location)
}
return value.WithLocations(newLocations), nil
})
}
// parsePythonLocations parses locations.json from the Python mutator.
//
// locations file is newline-separated JSON objects with pythonLocationEntry structure.
func parsePythonLocations(input io.Reader) (*pythonLocations, error) {
decoder := json.NewDecoder(input)
locations := newPythonLocations()
for decoder.More() {
var entry pythonLocationEntry
err := decoder.Decode(&entry)
if err != nil {
return nil, fmt.Errorf("failed to parse python location: %s", err)
}
path, err := dyn.NewPathFromString(entry.Path)
if err != nil {
return nil, fmt.Errorf("failed to parse python location: %s", err)
}
location := dyn.Location{
File: entry.File,
Line: entry.Line,
Column: entry.Column,
}
putPythonLocation(locations, path, location)
}
return locations, nil
}
// putPythonLocation puts the location to the trie for the given path
func putPythonLocation(trie *pythonLocations, path dyn.Path, location dyn.Location) {
var currentNode = trie
for _, component := range path {
if key := component.Key(); key != "" {
if _, ok := currentNode.keys[key]; !ok {
currentNode.keys[key] = newPythonLocations()
}
currentNode = currentNode.keys[key]
} else {
index := component.Index()
if _, ok := currentNode.indexes[index]; !ok {
currentNode.indexes[index] = newPythonLocations()
}
currentNode = currentNode.indexes[index]
}
}
currentNode.location = location
currentNode.exists = true
}
// newPythonLocations creates a new trie node
func newPythonLocations() *pythonLocations {
return &pythonLocations{
keys: make(map[string]*pythonLocations),
indexes: make(map[int]*pythonLocations),
}
}
// findPythonLocation finds the location or closest ancestor location in the trie for the given path
// if no ancestor or exact location is found, false is returned.
func findPythonLocation(locations *pythonLocations, path dyn.Path) (dyn.Location, bool) {
var currentNode = locations
var lastLocation = locations.location
var exists = locations.exists
for _, component := range path {
if key := component.Key(); key != "" {
if _, ok := currentNode.keys[key]; !ok {
break
}
currentNode = currentNode.keys[key]
} else {
index := component.Index()
if _, ok := currentNode.indexes[index]; !ok {
break
}
currentNode = currentNode.indexes[index]
}
if currentNode.exists {
lastLocation = currentNode.location
exists = true
}
}
return lastLocation, exists
}

View File

@ -0,0 +1,124 @@
package python
import (
"bytes"
"testing"
"github.com/databricks/cli/libs/dyn"
assert "github.com/databricks/cli/libs/dyn/dynassert"
)
func TestMergeLocations(t *testing.T) {
pythonLocation := dyn.Location{File: "foo.py", Line: 1, Column: 1}
generatedLocation := dyn.Location{File: generatedFileName, Line: 1, Column: 1}
yamlLocation := dyn.Location{File: "foo.yml", Line: 1, Column: 1}
locations := newPythonLocations()
putPythonLocation(locations, dyn.MustPathFromString("foo"), pythonLocation)
input := dyn.NewValue(
map[string]dyn.Value{
"foo": dyn.NewValue(
map[string]dyn.Value{
"baz": dyn.NewValue("baz", []dyn.Location{yamlLocation}),
"qux": dyn.NewValue("baz", []dyn.Location{generatedLocation, yamlLocation}),
},
[]dyn.Location{},
),
"bar": dyn.NewValue("baz", []dyn.Location{generatedLocation}),
},
[]dyn.Location{yamlLocation},
)
expected := dyn.NewValue(
map[string]dyn.Value{
"foo": dyn.NewValue(
map[string]dyn.Value{
// pythonLocation is appended to the beginning of the list if absent
"baz": dyn.NewValue("baz", []dyn.Location{pythonLocation, yamlLocation}),
// generatedLocation is replaced by pythonLocation
"qux": dyn.NewValue("baz", []dyn.Location{pythonLocation, yamlLocation}),
},
[]dyn.Location{pythonLocation},
),
// if location is unknown, we keep it as-is
"bar": dyn.NewValue("baz", []dyn.Location{generatedLocation}),
},
[]dyn.Location{yamlLocation},
)
actual, err := mergePythonLocations(input, locations)
assert.NoError(t, err)
assert.Equal(t, expected, actual)
}
func TestFindLocation(t *testing.T) {
location0 := dyn.Location{File: "foo.py", Line: 1, Column: 1}
location1 := dyn.Location{File: "foo.py", Line: 2, Column: 1}
locations := newPythonLocations()
putPythonLocation(locations, dyn.MustPathFromString("foo"), location0)
putPythonLocation(locations, dyn.MustPathFromString("foo.bar"), location1)
actual, exists := findPythonLocation(locations, dyn.MustPathFromString("foo.bar"))
assert.True(t, exists)
assert.Equal(t, location1, actual)
}
func TestFindLocation_indexPathComponent(t *testing.T) {
location0 := dyn.Location{File: "foo.py", Line: 1, Column: 1}
location1 := dyn.Location{File: "foo.py", Line: 2, Column: 1}
location2 := dyn.Location{File: "foo.py", Line: 3, Column: 1}
locations := newPythonLocations()
putPythonLocation(locations, dyn.MustPathFromString("foo"), location0)
putPythonLocation(locations, dyn.MustPathFromString("foo.bar"), location1)
putPythonLocation(locations, dyn.MustPathFromString("foo.bar[0]"), location2)
actual, exists := findPythonLocation(locations, dyn.MustPathFromString("foo.bar[0]"))
assert.True(t, exists)
assert.Equal(t, location2, actual)
}
func TestFindLocation_closestAncestorLocation(t *testing.T) {
location0 := dyn.Location{File: "foo.py", Line: 1, Column: 1}
location1 := dyn.Location{File: "foo.py", Line: 2, Column: 1}
locations := newPythonLocations()
putPythonLocation(locations, dyn.MustPathFromString("foo"), location0)
putPythonLocation(locations, dyn.MustPathFromString("foo.bar"), location1)
actual, exists := findPythonLocation(locations, dyn.MustPathFromString("foo.bar.baz"))
assert.True(t, exists)
assert.Equal(t, location1, actual)
}
func TestFindLocation_unknownLocation(t *testing.T) {
location0 := dyn.Location{File: "foo.py", Line: 1, Column: 1}
location1 := dyn.Location{File: "foo.py", Line: 2, Column: 1}
locations := newPythonLocations()
putPythonLocation(locations, dyn.MustPathFromString("foo"), location0)
putPythonLocation(locations, dyn.MustPathFromString("foo.bar"), location1)
_, exists := findPythonLocation(locations, dyn.MustPathFromString("bar"))
assert.False(t, exists)
}
func TestParsePythonLocations(t *testing.T) {
expected := dyn.Location{File: "foo.py", Line: 1, Column: 2}
input := `{"path": "foo", "file": "foo.py", "line": 1, "column": 2}`
reader := bytes.NewReader([]byte(input))
locations, err := parsePythonLocations(reader)
assert.NoError(t, err)
assert.True(t, locations.keys["foo"].exists)
assert.Equal(t, expected, locations.keys["foo"].location)
}

View File

@ -7,9 +7,12 @@ import (
"errors"
"fmt"
"io"
"io/fs"
"os"
"path/filepath"
"github.com/databricks/cli/bundle/config/mutator/paths"
"github.com/databricks/databricks-sdk-go/logger"
"github.com/fatih/color"
@ -108,7 +111,12 @@ func (m *pythonMutator) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagno
return dyn.InvalidValue, fmt.Errorf("failed to create cache dir: %w", err)
}
rightRoot, diags := m.runPythonMutator(ctx, cacheDir, b.BundleRootPath, pythonPath, leftRoot)
rightRoot, diags := m.runPythonMutator(ctx, leftRoot, runPythonMutatorOpts{
cacheDir: cacheDir,
bundleRootPath: b.BundleRootPath,
pythonPath: pythonPath,
loadLocations: experimental.PyDABs.LoadLocations,
})
mutateDiags = diags
if diags.HasError() {
return dyn.InvalidValue, mutateDiagsHasError
@ -152,13 +160,21 @@ func createCacheDir(ctx context.Context) (string, error) {
return os.MkdirTemp("", "-pydabs")
}
func (m *pythonMutator) runPythonMutator(ctx context.Context, cacheDir string, rootPath string, pythonPath string, root dyn.Value) (dyn.Value, diag.Diagnostics) {
inputPath := filepath.Join(cacheDir, "input.json")
outputPath := filepath.Join(cacheDir, "output.json")
diagnosticsPath := filepath.Join(cacheDir, "diagnostics.json")
type runPythonMutatorOpts struct {
cacheDir string
bundleRootPath string
pythonPath string
loadLocations bool
}
func (m *pythonMutator) runPythonMutator(ctx context.Context, root dyn.Value, opts runPythonMutatorOpts) (dyn.Value, diag.Diagnostics) {
inputPath := filepath.Join(opts.cacheDir, "input.json")
outputPath := filepath.Join(opts.cacheDir, "output.json")
diagnosticsPath := filepath.Join(opts.cacheDir, "diagnostics.json")
locationsPath := filepath.Join(opts.cacheDir, "locations.json")
args := []string{
pythonPath,
opts.pythonPath,
"-m",
"databricks.bundles.build",
"--phase",
@ -171,6 +187,10 @@ func (m *pythonMutator) runPythonMutator(ctx context.Context, cacheDir string, r
diagnosticsPath,
}
if opts.loadLocations {
args = append(args, "--locations", locationsPath)
}
if err := writeInputFile(inputPath, root); err != nil {
return dyn.InvalidValue, diag.Errorf("failed to write input file: %s", err)
}
@ -185,7 +205,7 @@ func (m *pythonMutator) runPythonMutator(ctx context.Context, cacheDir string, r
_, processErr := process.Background(
ctx,
args,
process.WithDir(rootPath),
process.WithDir(opts.bundleRootPath),
process.WithStderrWriter(stderrWriter),
process.WithStdoutWriter(stdoutWriter),
)
@ -221,7 +241,12 @@ func (m *pythonMutator) runPythonMutator(ctx context.Context, cacheDir string, r
return dyn.InvalidValue, diag.Errorf("failed to load diagnostics: %s", pythonDiagnosticsErr)
}
output, outputDiags := loadOutputFile(rootPath, outputPath)
locations, err := loadLocationsFile(locationsPath)
if err != nil {
return dyn.InvalidValue, diag.Errorf("failed to load locations: %s", err)
}
output, outputDiags := loadOutputFile(opts.bundleRootPath, outputPath, locations)
pythonDiagnostics = pythonDiagnostics.Extend(outputDiags)
// we pass through pythonDiagnostic because it contains warnings
@ -266,7 +291,21 @@ func writeInputFile(inputPath string, input dyn.Value) error {
return os.WriteFile(inputPath, rootConfigJson, 0600)
}
func loadOutputFile(rootPath string, outputPath string) (dyn.Value, diag.Diagnostics) {
// loadLocationsFile loads locations.json containing source locations for generated YAML.
func loadLocationsFile(locationsPath string) (*pythonLocations, error) {
locationsFile, err := os.Open(locationsPath)
if errors.Is(err, fs.ErrNotExist) {
return newPythonLocations(), nil
} else if err != nil {
return nil, fmt.Errorf("failed to open locations file: %w", err)
}
defer locationsFile.Close()
return parsePythonLocations(locationsFile)
}
func loadOutputFile(rootPath string, outputPath string, locations *pythonLocations) (dyn.Value, diag.Diagnostics) {
outputFile, err := os.Open(outputPath)
if err != nil {
return dyn.InvalidValue, diag.FromErr(fmt.Errorf("failed to open output file: %w", err))
@ -277,12 +316,12 @@ func loadOutputFile(rootPath string, outputPath string) (dyn.Value, diag.Diagnos
// we need absolute path because later parts of pipeline assume all paths are absolute
// and this file will be used as location to resolve relative paths.
//
// virtualPath has to stay in rootPath, because locations outside root path are not allowed:
// virtualPath has to stay in bundleRootPath, because locations outside root path are not allowed:
//
// Error: path /var/folders/.../pydabs/dist/*.whl is not contained in bundle root path
//
// for that, we pass virtualPath instead of outputPath as file location
virtualPath, err := filepath.Abs(filepath.Join(rootPath, "__generated_by_pydabs__.yml"))
virtualPath, err := filepath.Abs(filepath.Join(rootPath, generatedFileName))
if err != nil {
return dyn.InvalidValue, diag.FromErr(fmt.Errorf("failed to get absolute path: %w", err))
}
@ -292,7 +331,25 @@ func loadOutputFile(rootPath string, outputPath string) (dyn.Value, diag.Diagnos
return dyn.InvalidValue, diag.FromErr(fmt.Errorf("failed to parse output file: %w", err))
}
return strictNormalize(config.Root{}, generated)
// paths are resolved relative to locations of their values, if we change location
// we have to update each path, until we simplify that, we don't update locations
// for such values, so we don't change how paths are resolved
_, err = paths.VisitJobPaths(generated, func(p dyn.Path, kind paths.PathKind, v dyn.Value) (dyn.Value, error) {
putPythonLocation(locations, p, v.Location())
return v, nil
})
if err != nil {
return dyn.InvalidValue, diag.FromErr(fmt.Errorf("failed to update locations: %w", err))
}
// generated has dyn.Location as if it comes from generated YAML file
// earlier we loaded locations.json with source locations in Python code
generatedWithLocations, err := mergePythonLocations(generated, locations)
if err != nil {
return dyn.InvalidValue, diag.FromErr(fmt.Errorf("failed to update locations: %w", err))
}
return strictNormalize(config.Root{}, generatedWithLocations)
}
func strictNormalize(dst any, generated dyn.Value) (dyn.Value, diag.Diagnostics) {

View File

@ -6,7 +6,6 @@ import (
"os"
"os/exec"
"path/filepath"
"reflect"
"runtime"
"testing"
@ -47,6 +46,7 @@ func TestPythonMutator_load(t *testing.T) {
pydabs:
enabled: true
venv_path: .venv
load_locations: true
resources:
jobs:
job0:
@ -65,7 +65,8 @@ func TestPythonMutator_load(t *testing.T) {
"experimental": {
"pydabs": {
"enabled": true,
"venv_path": ".venv"
"venv_path": ".venv",
"load_locations": true
}
},
"resources": {
@ -80,6 +81,8 @@ func TestPythonMutator_load(t *testing.T) {
}
}`,
`{"severity": "warning", "summary": "job doesn't have any tasks", "location": {"file": "src/examples/file.py", "line": 10, "column": 5}}`,
`{"path": "resources.jobs.job0", "file": "src/examples/job0.py", "line": 3, "column": 5}
{"path": "resources.jobs.job1", "file": "src/examples/job1.py", "line": 5, "column": 7}`,
)
mutator := PythonMutator(PythonMutatorPhaseLoad)
@ -97,6 +100,25 @@ func TestPythonMutator_load(t *testing.T) {
assert.Equal(t, "job_1", job1.Name)
}
// output of locations.json should be applied to underlying dyn.Value
err := b.Config.Mutate(func(v dyn.Value) (dyn.Value, error) {
name1, err := dyn.GetByPath(v, dyn.MustPathFromString("resources.jobs.job1.name"))
if err != nil {
return dyn.InvalidValue, err
}
assert.Equal(t, []dyn.Location{
{
File: "src/examples/job1.py",
Line: 5,
Column: 7,
},
}, name1.Locations())
return v, nil
})
assert.NoError(t, err)
assert.Equal(t, 1, len(diags))
assert.Equal(t, "job doesn't have any tasks", diags[0].Summary)
assert.Equal(t, []dyn.Location{
@ -106,7 +128,6 @@ func TestPythonMutator_load(t *testing.T) {
Column: 5,
},
}, diags[0].Locations)
}
func TestPythonMutator_load_disallowed(t *testing.T) {
@ -146,7 +167,7 @@ func TestPythonMutator_load_disallowed(t *testing.T) {
}
}
}
}`, "")
}`, "", "")
mutator := PythonMutator(PythonMutatorPhaseLoad)
diag := bundle.Apply(ctx, b, mutator)
@ -191,7 +212,7 @@ func TestPythonMutator_init(t *testing.T) {
}
}
}
}`, "")
}`, "", "")
mutator := PythonMutator(PythonMutatorPhaseInit)
diag := bundle.Apply(ctx, b, mutator)
@ -252,7 +273,7 @@ func TestPythonMutator_badOutput(t *testing.T) {
}
}
}
}`, "")
}`, "", "")
mutator := PythonMutator(PythonMutatorPhaseLoad)
diag := bundle.Apply(ctx, b, mutator)
@ -588,7 +609,7 @@ or activate the environment before running CLI commands:
assert.Equal(t, expected, out)
}
func withProcessStub(t *testing.T, args []string, output string, diagnostics string) context.Context {
func withProcessStub(t *testing.T, args []string, output string, diagnostics string, locations string) context.Context {
ctx := context.Background()
ctx, stub := process.WithStub(ctx)
@ -600,32 +621,51 @@ func withProcessStub(t *testing.T, args []string, output string, diagnostics str
inputPath := filepath.Join(cacheDir, "input.json")
outputPath := filepath.Join(cacheDir, "output.json")
locationsPath := filepath.Join(cacheDir, "locations.json")
diagnosticsPath := filepath.Join(cacheDir, "diagnostics.json")
args = append(args, "--input", inputPath)
args = append(args, "--output", outputPath)
args = append(args, "--diagnostics", diagnosticsPath)
stub.WithCallback(func(actual *exec.Cmd) error {
_, err := os.Stat(inputPath)
assert.NoError(t, err)
if reflect.DeepEqual(actual.Args, args) {
err := os.WriteFile(outputPath, []byte(output), 0600)
actualInputPath := getArg(actual.Args, "--input")
actualOutputPath := getArg(actual.Args, "--output")
actualDiagnosticsPath := getArg(actual.Args, "--diagnostics")
actualLocationsPath := getArg(actual.Args, "--locations")
require.Equal(t, inputPath, actualInputPath)
require.Equal(t, outputPath, actualOutputPath)
require.Equal(t, diagnosticsPath, actualDiagnosticsPath)
// locations is an optional argument
if locations != "" {
require.Equal(t, locationsPath, actualLocationsPath)
err = os.WriteFile(locationsPath, []byte(locations), 0600)
require.NoError(t, err)
}
err = os.WriteFile(outputPath, []byte(output), 0600)
require.NoError(t, err)
err = os.WriteFile(diagnosticsPath, []byte(diagnostics), 0600)
require.NoError(t, err)
return nil
} else {
return fmt.Errorf("unexpected command: %v", actual.Args)
}
})
return ctx
}
func getArg(args []string, name string) string {
for i := 0; i < len(args); i++ {
if args[i] == name {
return args[i+1]
}
}
return ""
}
func loadYaml(name string, content string) *bundle.Bundle {
v, diag := config.LoadFromBytes(name, []byte(content))

View File

@ -0,0 +1,33 @@
bundle:
name: issue_1828
variables:
# One entry for each of the underlying YAML (or [dyn.Kind]) types.
# The test confirms we can convert to and from the typed configuration without losing information.
map:
default:
foo: bar
sequence:
default:
- foo
- bar
string:
default: foo
bool:
default: true
int:
default: 42
float:
default: 3.14
time:
default: 2021-01-01
nil:
default:

View File

@ -0,0 +1,48 @@
package config_tests
import (
"testing"
"github.com/stretchr/testify/assert"
)
func TestIssue1828(t *testing.T) {
b := load(t, "./issue_1828")
if assert.Contains(t, b.Config.Variables, "map") {
assert.Equal(t, map[string]any{
"foo": "bar",
}, b.Config.Variables["map"].Default)
}
if assert.Contains(t, b.Config.Variables, "sequence") {
assert.Equal(t, []any{
"foo",
"bar",
}, b.Config.Variables["sequence"].Default)
}
if assert.Contains(t, b.Config.Variables, "string") {
assert.Equal(t, "foo", b.Config.Variables["string"].Default)
}
if assert.Contains(t, b.Config.Variables, "bool") {
assert.Equal(t, true, b.Config.Variables["bool"].Default)
}
if assert.Contains(t, b.Config.Variables, "int") {
assert.Equal(t, 42, b.Config.Variables["int"].Default)
}
if assert.Contains(t, b.Config.Variables, "float") {
assert.Equal(t, 3.14, b.Config.Variables["float"].Default)
}
if assert.Contains(t, b.Config.Variables, "time") {
assert.Equal(t, "2021-01-01", b.Config.Variables["time"].Default)
}
if assert.Contains(t, b.Config.Variables, "nil") {
assert.Equal(t, nil, b.Config.Variables["nil"].Default)
}
}

View File

@ -398,6 +398,34 @@ func (n normalizeOptions) normalizeFloat(typ reflect.Type, src dyn.Value, path d
return dyn.NewValue(out, src.Locations()), diags
}
func (n normalizeOptions) normalizeInterface(typ reflect.Type, src dyn.Value, path dyn.Path) (dyn.Value, diag.Diagnostics) {
func (n normalizeOptions) normalizeInterface(_ reflect.Type, src dyn.Value, path dyn.Path) (dyn.Value, diag.Diagnostics) {
// Deal with every [dyn.Kind] here to ensure completeness.
switch src.Kind() {
case dyn.KindMap:
// Fall through
case dyn.KindSequence:
// Fall through
case dyn.KindString:
// Fall through
case dyn.KindBool:
// Fall through
case dyn.KindInt:
// Fall through
case dyn.KindFloat:
// Fall through
case dyn.KindTime:
// Conversion of a time value to an interface{}.
// The [dyn.Value.AsAny] equivalent for this kind is the [time.Time] struct.
// If we convert to a typed representation and back again, we cannot distinguish
// a [time.Time] struct from any other struct.
//
// Therefore, we normalize the time value to a string.
return dyn.NewValue(src.MustTime().String(), src.Locations()), nil
case dyn.KindNil:
// Fall through
default:
return dyn.InvalidValue, diag.Errorf("unsupported kind: %s", src.Kind())
}
return src, nil
}

View File

@ -858,23 +858,7 @@ func TestNormalizeAnchors(t *testing.T) {
}, vout.AsAny())
}
func TestNormalizeBoolToAny(t *testing.T) {
var typ any
vin := dyn.NewValue(false, []dyn.Location{{File: "file", Line: 1, Column: 1}})
vout, err := Normalize(&typ, vin)
assert.Len(t, err, 0)
assert.Equal(t, dyn.NewValue(false, []dyn.Location{{File: "file", Line: 1, Column: 1}}), vout)
}
func TestNormalizeIntToAny(t *testing.T) {
var typ any
vin := dyn.NewValue(10, []dyn.Location{{File: "file", Line: 1, Column: 1}})
vout, err := Normalize(&typ, vin)
assert.Len(t, err, 0)
assert.Equal(t, dyn.NewValue(10, []dyn.Location{{File: "file", Line: 1, Column: 1}}), vout)
}
func TestNormalizeSliceToAny(t *testing.T) {
func TestNormalizeAnyFromSlice(t *testing.T) {
var typ any
v1 := dyn.NewValue(1, []dyn.Location{{File: "file", Line: 1, Column: 1}})
v2 := dyn.NewValue(2, []dyn.Location{{File: "file", Line: 1, Column: 1}})
@ -883,3 +867,35 @@ func TestNormalizeSliceToAny(t *testing.T) {
assert.Len(t, err, 0)
assert.Equal(t, dyn.NewValue([]dyn.Value{v1, v2}, []dyn.Location{{File: "file", Line: 1, Column: 1}}), vout)
}
func TestNormalizeAnyFromString(t *testing.T) {
var typ any
vin := dyn.NewValue("string", []dyn.Location{{File: "file", Line: 1, Column: 1}})
vout, err := Normalize(&typ, vin)
assert.Len(t, err, 0)
assert.Equal(t, dyn.NewValue("string", []dyn.Location{{File: "file", Line: 1, Column: 1}}), vout)
}
func TestNormalizeAnyFromBool(t *testing.T) {
var typ any
vin := dyn.NewValue(false, []dyn.Location{{File: "file", Line: 1, Column: 1}})
vout, err := Normalize(&typ, vin)
assert.Len(t, err, 0)
assert.Equal(t, dyn.NewValue(false, []dyn.Location{{File: "file", Line: 1, Column: 1}}), vout)
}
func TestNormalizeAnyFromInt(t *testing.T) {
var typ any
vin := dyn.NewValue(10, []dyn.Location{{File: "file", Line: 1, Column: 1}})
vout, err := Normalize(&typ, vin)
assert.Len(t, err, 0)
assert.Equal(t, dyn.NewValue(10, []dyn.Location{{File: "file", Line: 1, Column: 1}}), vout)
}
func TestNormalizeAnyFromTime(t *testing.T) {
var typ any
vin := dyn.NewValue(dyn.MustTime("2024-08-29"), []dyn.Location{{File: "file", Line: 1, Column: 1}})
vout, err := Normalize(&typ, vin)
assert.Empty(t, err)
assert.Equal(t, dyn.NewValue("2024-08-29", vin.Locations()), vout)
}

View File

@ -0,0 +1,60 @@
package dynassert
import (
"fmt"
"strings"
"github.com/databricks/cli/libs/dyn"
)
// Dump returns the Go code to recreate the given value.
func Dump(v dyn.Value) string {
var sb strings.Builder
dump(v, &sb)
return sb.String()
}
func dump(v dyn.Value, sb *strings.Builder) {
sb.WriteString("dyn.NewValue(\n")
switch v.Kind() {
case dyn.KindMap:
sb.WriteString("map[string]dyn.Value{")
m := v.MustMap()
for _, p := range m.Pairs() {
sb.WriteString(fmt.Sprintf("\n%q: ", p.Key.MustString()))
dump(p.Value, sb)
sb.WriteByte(',')
}
sb.WriteString("\n},\n")
case dyn.KindSequence:
sb.WriteString("[]dyn.Value{\n")
for _, e := range v.MustSequence() {
dump(e, sb)
sb.WriteByte(',')
}
sb.WriteString("},\n")
case dyn.KindString:
sb.WriteString(fmt.Sprintf("%q,\n", v.MustString()))
case dyn.KindBool:
sb.WriteString(fmt.Sprintf("%t,\n", v.MustBool()))
case dyn.KindInt:
sb.WriteString(fmt.Sprintf("%d,\n", v.MustInt()))
case dyn.KindFloat:
sb.WriteString(fmt.Sprintf("%f,\n", v.MustFloat()))
case dyn.KindTime:
sb.WriteString(fmt.Sprintf("dyn.NewTime(%q),\n", v.MustTime().String()))
case dyn.KindNil:
sb.WriteString("nil,\n")
default:
panic(fmt.Sprintf("unhandled kind: %v", v.Kind()))
}
// Add location
sb.WriteString("[]dyn.Location{")
for _, l := range v.Locations() {
sb.WriteString(fmt.Sprintf("{File: %q, Line: %d, Column: %d},", l.File, l.Line, l.Column))
}
sb.WriteString("},\n")
sb.WriteString(")")
}

View File

@ -105,6 +105,9 @@ func (d *loader) loadMapping(node *yaml.Node, loc dyn.Location) (dyn.Value, erro
switch st {
case "!!str":
// OK
case "!!null":
// A literal unquoted "null" is treated as a null value by the YAML parser.
// However, when used as a key, it is treated as the string "null".
case "!!merge":
if merge != nil {
panic("merge node already set")
@ -115,10 +118,11 @@ func (d *loader) loadMapping(node *yaml.Node, loc dyn.Location) (dyn.Value, erro
return dyn.InvalidValue, errorf(loc, "invalid key tag: %v", st)
}
k, err := d.load(key)
if err != nil {
return dyn.InvalidValue, err
}
k := dyn.NewValue(key.Value, []dyn.Location{{
File: d.path,
Line: key.Line,
Column: key.Column,
}})
v, err := d.load(val)
if err != nil {
@ -173,6 +177,14 @@ func (d *loader) loadMapping(node *yaml.Node, loc dyn.Location) (dyn.Value, erro
return dyn.NewValue(out, []dyn.Location{loc}), nil
}
func newIntValue(i64 int64, loc dyn.Location) dyn.Value {
// Use regular int type instead of int64 if possible.
if i64 >= math.MinInt32 && i64 <= math.MaxInt32 {
return dyn.NewValue(int(i64), []dyn.Location{loc})
}
return dyn.NewValue(i64, []dyn.Location{loc})
}
func (d *loader) loadScalar(node *yaml.Node, loc dyn.Location) (dyn.Value, error) {
st := node.ShortTag()
switch st {
@ -188,18 +200,44 @@ func (d *loader) loadScalar(node *yaml.Node, loc dyn.Location) (dyn.Value, error
return dyn.InvalidValue, errorf(loc, "invalid bool value: %v", node.Value)
}
case "!!int":
i64, err := strconv.ParseInt(node.Value, 10, 64)
if err != nil {
// Try to parse the an integer value in base 10.
// We trim leading zeros to avoid octal parsing of the "0" prefix.
// See "testdata/spec_example_2.19.yml" for background.
i64, err := strconv.ParseInt(strings.TrimLeft(node.Value, "0"), 10, 64)
if err == nil {
return newIntValue(i64, loc), nil
}
// Let the [ParseInt] function figure out the base.
i64, err = strconv.ParseInt(node.Value, 0, 64)
if err == nil {
return newIntValue(i64, loc), nil
}
return dyn.InvalidValue, errorf(loc, "invalid int value: %v", node.Value)
}
// Use regular int type instead of int64 if possible.
if i64 >= math.MinInt32 && i64 <= math.MaxInt32 {
return dyn.NewValue(int(i64), []dyn.Location{loc}), nil
}
return dyn.NewValue(i64, []dyn.Location{loc}), nil
case "!!float":
f64, err := strconv.ParseFloat(node.Value, 64)
if err != nil {
// Deal with infinity prefixes.
v := strings.ToLower(node.Value)
switch {
case strings.HasPrefix(v, "+"):
v = strings.TrimPrefix(v, "+")
f64 = math.Inf(1)
case strings.HasPrefix(v, "-"):
v = strings.TrimPrefix(v, "-")
f64 = math.Inf(-1)
default:
// No prefix.
f64 = math.Inf(1)
}
// Deal with infinity and NaN values.
switch v {
case ".inf":
return dyn.NewValue(f64, []dyn.Location{loc}), nil
case ".nan":
return dyn.NewValue(math.NaN(), []dyn.Location{loc}), nil
}
return dyn.InvalidValue, errorf(loc, "invalid float value: %v", node.Value)
}
return dyn.NewValue(f64, []dyn.Location{loc}), nil

View File

@ -0,0 +1,5 @@
# Example 2.1 Sequence of Scalars (ball players)
- Mark McGwire
- Sammy Sosa
- Ken Griffey

View File

@ -0,0 +1,10 @@
# Example 2.10 Node for “Sammy Sosa” appears twice in this document
---
hr:
- Mark McGwire
# Following node labeled SS
- &SS Sammy Sosa
rbi:
- *SS # Subsequent occurrence
- Ken Griffey

View File

@ -0,0 +1,10 @@
# Example 2.11 Mapping between Sequences
? - Detroit Tigers
- Chicago cubs
: - 2001-07-23
? [ New York Yankees,
Atlanta Braves ]
: [ 2001-07-02, 2001-08-12,
2001-08-14 ]

View File

@ -0,0 +1,10 @@
# Example 2.12 Compact Nested Mapping
---
# Products purchased
- item : Super Hoop
quantity: 1
- item : Basketball
quantity: 4
- item : Big Shoes
quantity: 1

View File

@ -0,0 +1,6 @@
# Example 2.13 In literals, newlines are preserved
# ASCII Art
--- |
\//||\/||
// || ||__

View File

@ -0,0 +1,6 @@
# Example 2.14 In the folded scalars, newlines become spaces
--- >
Mark McGwire's
year was crippled
by a knee injury.

View File

@ -0,0 +1,10 @@
# Example 2.15 Folded newlines are preserved for “more indented” and blank lines
--- >
Sammy Sosa completed another
fine season with great stats.
63 Home Runs
0.288 Batting Average
What a year!

View File

@ -0,0 +1,9 @@
# Example 2.16 Indentation determines scope
name: Mark McGwire
accomplishment: >
Mark set a major league
home run record in 1998.
stats: |
65 Home Runs
0.278 Batting Average

View File

@ -0,0 +1,9 @@
# Example 2.17 Quoted Scalars
unicode: "Sosa did fine.\u263A"
control: "\b1998\t1999\t2000\n"
hex esc: "\x0d\x0a is \r\n"
single: '"Howdy!" he cried.'
quoted: ' # Not a ''comment''.'
tie-fighter: '|\-*-/|'

View File

@ -0,0 +1,8 @@
# Example 2.18 Multi-line Flow Scalars
plain:
This unquoted scalar
spans many lines.
quoted: "So does this
quoted scalar.\n"

View File

@ -0,0 +1,15 @@
# Example 2.19 Integers
canonical: 12345
decimal: +12345
octal: 0o14
hexadecimal: 0xC
# Note: this example is not part of the spec but added for completeness.
#
# Octal numbers:
# - YAML 1.1: prefix is "0"
# - YAML 1.2: prefix is "0o"
# The "gopkg.in/yaml.v3" package accepts both for backwards compat.
# We accept only the YAML 1.2 prefix "0o".
octal11: 012345

View File

@ -0,0 +1,5 @@
# Example 2.2 Mapping Scalars to Scalars (player statistics)
hr: 65 # Home runs
avg: 0.278 # Batting average
rbi: 147 # Runs Batted In

View File

@ -0,0 +1,7 @@
# Example 2.20 Floating Point
canonical: 1.23015e+3
exponential: 12.3015e+02
fixed: 1230.15
negative infinity: -.inf
not a number: .nan

View File

@ -0,0 +1,5 @@
# Example 2.21 Miscellaneous
null:
booleans: [ true, false ]
string: '012345'

View File

@ -0,0 +1,6 @@
# Example 2.22 Timestamps
canonical: 2001-12-15T02:59:43.1Z
iso8601: 2001-12-14t21:59:43.10-05:00
spaced: 2001-12-14 21:59:43.10 -5
date: 2002-12-14

View File

@ -0,0 +1,15 @@
# Example 2.23 Various Explicit Tags
---
not-date: !!str 2002-04-28
picture: !!binary |
R0lGODlhDAAMAIQAAP//9/X
17unp5WZmZgAAAOfn515eXv
Pz7Y6OjuDg4J+fn5OTk6enp
56enmleECcgggoBADs=
application specific tag: !something |
The semantics of the tag
above may be different for
different documents.

View File

@ -0,0 +1,16 @@
# Example 2.24 Global Tags
%TAG ! tag:clarkevans.com,2002:
--- !shape
# Use the ! handle for presenting
# tag:clarkevans.com,2002:circle
- !circle
center: &ORIGIN {x: 73, y: 129}
radius: 7
- !line
start: *ORIGIN
finish: { x: 89, y: 102 }
- !label
start: *ORIGIN
color: 0xFFEEBB
text: Pretty vector drawing.

View File

@ -0,0 +1,9 @@
# Example 2.25 Unordered Sets
# Sets are represented as a
# Mapping where each key is
# associated with a null value
--- !!set
? Mark McGwire
? Sammy Sosa
? Ken Griffey

View File

@ -0,0 +1,9 @@
# Example 2.26 Ordered Mappings
# Ordered maps are represented as
# A sequence of mappings, with
# each mapping having one key
--- !!omap
- Mark McGwire: 65
- Sammy Sosa: 63
- Ken Griffey: 58

View File

@ -0,0 +1,31 @@
# Example 2.27 Invoice
--- !<tag:clarkevans.com,2002:invoice>
invoice: 34843
date : 2001-01-23
bill-to: &id001
given : Chris
family : Dumars
address:
lines: |
458 Walkman Dr.
Suite #292
city : Royal Oak
state : MI
postal : 48046
ship-to: *id001
product:
- sku : BL394D
quantity : 4
description : Basketball
price : 450.00
- sku : BL4438H
quantity : 1
description : Super Hoop
price : 2392.00
tax : 251.42
total: 4443.52
comments:
Late afternoon is best.
Backup contact is Nancy
Billsmer @ 338-4338.

View File

@ -0,0 +1,28 @@
# Example 2.28 Log File
---
Time: 2001-11-23 15:01:42 -5
User: ed
Warning:
This is an error message
for the log file
---
Time: 2001-11-23 15:02:31 -5
User: ed
Warning:
A slightly different error
message.
---
Date: 2001-11-23 15:03:17 -5
User: ed
Fatal:
Unknown variable "bar"
Stack:
- file: TopClass.py
line: 23
code: |
x = MoreObject("345\n")
- file: MoreClass.py
line: 58
code: |-
foo = bar

View File

@ -0,0 +1,10 @@
# Example 2.3 Mapping Scalars to Sequences (ball clubs in each league)
american:
- Boston Red Sox
- Detroit Tigers
- New York Yankees
national:
- New York Mets
- Chicago Cubs
- Atlanta Braves

View File

@ -0,0 +1,10 @@
# Example 2.4 Sequence of Mappings (players statistics)
-
name: Mark McGwire
hr: 65
avg: 0.278
-
name: Sammy Sosa
hr: 63
avg: 0.288

View File

@ -0,0 +1,5 @@
# Example 2.5 Sequence of Sequences
- [name , hr, avg ]
- [Mark McGwire, 65, 0.278]
- [Sammy Sosa , 63, 0.288]

View File

@ -0,0 +1,7 @@
# Example 2.6 Mapping of Mappings
Mark McGwire: {hr: 65, avg: 0.278}
Sammy Sosa: {
hr: 63,
avg: 0.288,
}

View File

@ -0,0 +1,12 @@
# Example 2.7 Two Documents in a Stream (each with a leading comment)
# Ranking of 1998 home runs
---
- Mark McGwire
- Sammy Sosa
- Ken Griffey
# Team ranking
---
- Chicago Cubs
- St Louis Cardinals

View File

@ -0,0 +1,12 @@
# Example 2.8 Play by Play Feed from a Game
---
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
---
time: 20:03:47
player: Sammy Sosa
action: grand slam
...

View File

@ -0,0 +1,10 @@
# Example 2.9 Single Document with Two Comments
---
hr: # 1998 hr ranking
- Mark McGwire
- Sammy Sosa
# 1998 rbi ranking
rbi:
- Sammy Sosa
- Ken Griffey

View File

@ -0,0 +1,821 @@
package yamlloader_test
import (
"bytes"
"math"
"os"
"testing"
"github.com/databricks/cli/libs/dyn"
assert "github.com/databricks/cli/libs/dyn/dynassert"
"github.com/databricks/cli/libs/dyn/yamlloader"
"github.com/stretchr/testify/require"
)
const NL = "\n"
func loadExample(t *testing.T, file string) dyn.Value {
input, err := os.ReadFile(file)
require.NoError(t, err)
self, err := yamlloader.LoadYAML(file, bytes.NewBuffer(input))
require.NoError(t, err)
return self
}
func TestYAMLSpecExample_2_1(t *testing.T) {
file := "testdata/spec_example_2.1.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
[]dyn.Value{
dyn.NewValue("Mark McGwire", []dyn.Location{{File: file, Line: 3, Column: 3}}),
dyn.NewValue("Sammy Sosa", []dyn.Location{{File: file, Line: 4, Column: 3}}),
dyn.NewValue("Ken Griffey", []dyn.Location{{File: file, Line: 5, Column: 3}}),
},
[]dyn.Location{{File: file, Line: 3, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_2(t *testing.T) {
file := "testdata/spec_example_2.2.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"hr": dyn.NewValue(65, []dyn.Location{{File: file, Line: 3, Column: 6}}),
"avg": dyn.NewValue(0.278, []dyn.Location{{File: file, Line: 4, Column: 6}}),
"rbi": dyn.NewValue(147, []dyn.Location{{File: file, Line: 5, Column: 6}}),
},
[]dyn.Location{{File: file, Line: 3, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_3(t *testing.T) {
file := "testdata/spec_example_2.3.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"american": dyn.NewValue(
[]dyn.Value{
dyn.NewValue("Boston Red Sox", []dyn.Location{{File: file, Line: 4, Column: 3}}),
dyn.NewValue("Detroit Tigers", []dyn.Location{{File: file, Line: 5, Column: 3}}),
dyn.NewValue("New York Yankees", []dyn.Location{{File: file, Line: 6, Column: 3}}),
},
[]dyn.Location{{File: file, Line: 4, Column: 1}},
),
"national": dyn.NewValue(
[]dyn.Value{
dyn.NewValue("New York Mets", []dyn.Location{{File: file, Line: 8, Column: 3}}),
dyn.NewValue("Chicago Cubs", []dyn.Location{{File: file, Line: 9, Column: 3}}),
dyn.NewValue("Atlanta Braves", []dyn.Location{{File: file, Line: 10, Column: 3}}),
},
[]dyn.Location{{File: file, Line: 8, Column: 1}},
),
},
[]dyn.Location{{File: file, Line: 3, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_4(t *testing.T) {
file := "testdata/spec_example_2.4.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
[]dyn.Value{
dyn.NewValue(
map[string]dyn.Value{
"name": dyn.NewValue("Mark McGwire", []dyn.Location{{File: file, Line: 4, Column: 9}}),
"hr": dyn.NewValue(65, []dyn.Location{{File: file, Line: 5, Column: 9}}),
"avg": dyn.NewValue(0.278, []dyn.Location{{File: file, Line: 6, Column: 9}}),
},
[]dyn.Location{{File: file, Line: 4, Column: 3}},
),
dyn.NewValue(
map[string]dyn.Value{
"name": dyn.NewValue("Sammy Sosa", []dyn.Location{{File: file, Line: 8, Column: 9}}),
"hr": dyn.NewValue(63, []dyn.Location{{File: file, Line: 9, Column: 9}}),
"avg": dyn.NewValue(0.288, []dyn.Location{{File: file, Line: 10, Column: 9}}),
},
[]dyn.Location{{File: file, Line: 8, Column: 3}},
),
},
[]dyn.Location{{File: file, Line: 3, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_5(t *testing.T) {
file := "testdata/spec_example_2.5.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
[]dyn.Value{
dyn.NewValue(
[]dyn.Value{
dyn.NewValue("name", []dyn.Location{{File: file, Line: 3, Column: 4}}),
dyn.NewValue("hr", []dyn.Location{{File: file, Line: 3, Column: 18}}),
dyn.NewValue("avg", []dyn.Location{{File: file, Line: 3, Column: 22}}),
},
[]dyn.Location{{File: file, Line: 3, Column: 3}},
),
dyn.NewValue(
[]dyn.Value{
dyn.NewValue("Mark McGwire", []dyn.Location{{File: file, Line: 4, Column: 4}}),
dyn.NewValue(65, []dyn.Location{{File: file, Line: 4, Column: 18}}),
dyn.NewValue(0.278, []dyn.Location{{File: file, Line: 4, Column: 22}}),
},
[]dyn.Location{{File: file, Line: 4, Column: 3}},
),
dyn.NewValue(
[]dyn.Value{
dyn.NewValue("Sammy Sosa", []dyn.Location{{File: file, Line: 5, Column: 4}}),
dyn.NewValue(63, []dyn.Location{{File: file, Line: 5, Column: 18}}),
dyn.NewValue(0.288, []dyn.Location{{File: file, Line: 5, Column: 22}}),
},
[]dyn.Location{{File: file, Line: 5, Column: 3}},
),
},
[]dyn.Location{{File: file, Line: 3, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_6(t *testing.T) {
file := "testdata/spec_example_2.6.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"Mark McGwire": dyn.NewValue(
map[string]dyn.Value{
"hr": dyn.NewValue(65, []dyn.Location{{File: file, Line: 3, Column: 20}}),
"avg": dyn.NewValue(0.278, []dyn.Location{{File: file, Line: 3, Column: 29}}),
},
[]dyn.Location{{File: file, Line: 3, Column: 15}},
),
"Sammy Sosa": dyn.NewValue(
map[string]dyn.Value{
"hr": dyn.NewValue(63, []dyn.Location{{File: file, Line: 5, Column: 9}}),
"avg": dyn.NewValue(0.288, []dyn.Location{{File: file, Line: 6, Column: 10}}),
},
[]dyn.Location{{File: file, Line: 4, Column: 13}},
),
},
[]dyn.Location{{File: file, Line: 3, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_7(t *testing.T) {
file := "testdata/spec_example_2.7.yml"
self := loadExample(t, file)
// Note: we do not support multiple documents in a single YAML file.
assert.Equal(t, dyn.NewValue(
[]dyn.Value{
dyn.NewValue(
"Mark McGwire",
[]dyn.Location{{File: file, Line: 5, Column: 3}},
),
dyn.NewValue(
"Sammy Sosa",
[]dyn.Location{{File: file, Line: 6, Column: 3}},
),
dyn.NewValue(
"Ken Griffey",
[]dyn.Location{{File: file, Line: 7, Column: 3}},
),
},
[]dyn.Location{{File: file, Line: 5, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_8(t *testing.T) {
file := "testdata/spec_example_2.8.yml"
self := loadExample(t, file)
// Note: we do not support multiple documents in a single YAML file.
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"time": dyn.NewValue("20:03:20", []dyn.Location{{File: file, Line: 4, Column: 7}}),
"player": dyn.NewValue("Sammy Sosa", []dyn.Location{{File: file, Line: 5, Column: 9}}),
"action": dyn.NewValue("strike (miss)", []dyn.Location{{File: file, Line: 6, Column: 9}}),
},
[]dyn.Location{{File: file, Line: 4, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_9(t *testing.T) {
file := "testdata/spec_example_2.9.yml"
self := loadExample(t, file)
// Note: we do not support multiple documents in a single YAML file.
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"hr": dyn.NewValue(
[]dyn.Value{
dyn.NewValue("Mark McGwire", []dyn.Location{{File: file, Line: 5, Column: 3}}),
dyn.NewValue("Sammy Sosa", []dyn.Location{{File: file, Line: 6, Column: 3}}),
},
[]dyn.Location{{File: file, Line: 5, Column: 1}},
),
"rbi": dyn.NewValue(
[]dyn.Value{
dyn.NewValue("Sammy Sosa", []dyn.Location{{File: file, Line: 9, Column: 3}}),
dyn.NewValue("Ken Griffey", []dyn.Location{{File: file, Line: 10, Column: 3}}),
},
[]dyn.Location{{File: file, Line: 9, Column: 1}},
),
},
[]dyn.Location{{File: file, Line: 4, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_10(t *testing.T) {
file := "testdata/spec_example_2.10.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"hr": dyn.NewValue(
[]dyn.Value{
dyn.NewValue("Mark McGwire", []dyn.Location{{File: file, Line: 5, Column: 3}}),
dyn.NewValue("Sammy Sosa", []dyn.Location{{File: file, Line: 7, Column: 3}}),
},
[]dyn.Location{{File: file, Line: 5, Column: 1}},
),
"rbi": dyn.NewValue(
[]dyn.Value{
// The location for an anchored value refers to the anchor, not the reference.
// This is the same location as the anchor that appears in the "hr" mapping.
dyn.NewValue("Sammy Sosa", []dyn.Location{{File: file, Line: 7, Column: 3}}),
dyn.NewValue("Ken Griffey", []dyn.Location{{File: file, Line: 10, Column: 3}}),
},
[]dyn.Location{{File: file, Line: 9, Column: 1}},
),
},
[]dyn.Location{{File: file, Line: 4, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_11(t *testing.T) {
file := "testdata/spec_example_2.11.yml"
input, err := os.ReadFile(file)
require.NoError(t, err)
// Note: non-string mapping keys are not supported by "gopkg.in/yaml.v3".
_, err = yamlloader.LoadYAML(file, bytes.NewBuffer(input))
assert.ErrorContains(t, err, `: key is not a scalar`)
}
func TestYAMLSpecExample_2_12(t *testing.T) {
file := "testdata/spec_example_2.12.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
[]dyn.Value{
dyn.NewValue(
map[string]dyn.Value{
"item": dyn.NewValue("Super Hoop", []dyn.Location{{File: file, Line: 5, Column: 13}}),
"quantity": dyn.NewValue(1, []dyn.Location{{File: file, Line: 6, Column: 13}}),
},
[]dyn.Location{{File: file, Line: 5, Column: 3}},
),
dyn.NewValue(
map[string]dyn.Value{
"item": dyn.NewValue("Basketball", []dyn.Location{{File: file, Line: 7, Column: 13}}),
"quantity": dyn.NewValue(4, []dyn.Location{{File: file, Line: 8, Column: 13}}),
},
[]dyn.Location{{File: file, Line: 7, Column: 3}},
),
dyn.NewValue(
map[string]dyn.Value{
"item": dyn.NewValue("Big Shoes", []dyn.Location{{File: file, Line: 9, Column: 13}}),
"quantity": dyn.NewValue(1, []dyn.Location{{File: file, Line: 10, Column: 13}}),
},
[]dyn.Location{{File: file, Line: 9, Column: 3}},
),
},
[]dyn.Location{{File: file, Line: 5, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_13(t *testing.T) {
file := "testdata/spec_example_2.13.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
``+
`\//||\/||`+NL+
"// || ||__"+NL,
[]dyn.Location{{File: file, Line: 4, Column: 5}},
), self)
}
func TestYAMLSpecExample_2_14(t *testing.T) {
file := "testdata/spec_example_2.14.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
`Mark McGwire's year was crippled by a knee injury.`+NL,
[]dyn.Location{{File: file, Line: 3, Column: 5}},
), self)
}
func TestYAMLSpecExample_2_15(t *testing.T) {
file := "testdata/spec_example_2.15.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
``+
`Sammy Sosa completed another fine season with great stats.`+NL+
NL+
` 63 Home Runs`+NL+
` 0.288 Batting Average`+NL+
NL+
`What a year!`+NL,
[]dyn.Location{{File: file, Line: 3, Column: 5}},
), self)
}
func TestYAMLSpecExample_2_16(t *testing.T) {
file := "testdata/spec_example_2.16.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"name": dyn.NewValue(
"Mark McGwire",
[]dyn.Location{{File: file, Line: 3, Column: 7}},
),
"accomplishment": dyn.NewValue(
`Mark set a major league home run record in 1998.`+NL,
[]dyn.Location{{File: file, Line: 4, Column: 17}},
),
"stats": dyn.NewValue(
``+
`65 Home Runs`+NL+
`0.278 Batting Average`+NL,
[]dyn.Location{{File: file, Line: 7, Column: 8}},
),
},
[]dyn.Location{{File: file, Line: 3, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_17(t *testing.T) {
file := "testdata/spec_example_2.17.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"unicode": dyn.NewValue(
`Sosa did fine.`+"\u263A",
[]dyn.Location{{File: file, Line: 3, Column: 10}},
),
"control": dyn.NewValue(
"\b1998\t1999\t2000\n",
[]dyn.Location{{File: file, Line: 4, Column: 10}},
),
"hex esc": dyn.NewValue(
"\x0d\x0a is \r\n",
[]dyn.Location{{File: file, Line: 5, Column: 10}},
),
"single": dyn.NewValue(
`"Howdy!" he cried.`,
[]dyn.Location{{File: file, Line: 7, Column: 9}},
),
"quoted": dyn.NewValue(
` # Not a 'comment'.`,
[]dyn.Location{{File: file, Line: 8, Column: 9}},
),
"tie-fighter": dyn.NewValue(
`|\-*-/|`,
[]dyn.Location{{File: file, Line: 9, Column: 14}},
),
},
[]dyn.Location{{File: file, Line: 3, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_18(t *testing.T) {
file := "testdata/spec_example_2.18.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"plain": dyn.NewValue(
`This unquoted scalar spans many lines.`,
[]dyn.Location{{File: file, Line: 4, Column: 3}},
),
"quoted": dyn.NewValue(
`So does this quoted scalar.`+NL,
[]dyn.Location{{File: file, Line: 7, Column: 9}},
),
},
[]dyn.Location{{File: file, Line: 3, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_19(t *testing.T) {
file := "testdata/spec_example_2.19.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"canonical": dyn.NewValue(
12345,
[]dyn.Location{{File: file, Line: 3, Column: 12}},
),
"decimal": dyn.NewValue(
12345,
[]dyn.Location{{File: file, Line: 4, Column: 10}},
),
"octal": dyn.NewValue(
12,
[]dyn.Location{{File: file, Line: 5, Column: 8}},
),
"hexadecimal": dyn.NewValue(
12,
[]dyn.Location{{File: file, Line: 6, Column: 14}},
),
"octal11": dyn.NewValue(
12345,
[]dyn.Location{{File: file, Line: 15, Column: 10}},
),
},
[]dyn.Location{{File: file, Line: 3, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_20(t *testing.T) {
file := "testdata/spec_example_2.20.yml"
self := loadExample(t, file)
// Equality assertion doesn't work with NaNs.
// See https://github.com/stretchr/testify/issues/624.
//
// Remove the NaN entry.
self, _ = dyn.Walk(self, func(p dyn.Path, v dyn.Value) (dyn.Value, error) {
if f, ok := v.AsFloat(); ok && math.IsNaN(f) {
return dyn.InvalidValue, dyn.ErrDrop
}
return v, nil
})
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"canonical": dyn.NewValue(
1230.15,
[]dyn.Location{{File: file, Line: 3, Column: 12}},
),
"exponential": dyn.NewValue(
1230.15,
[]dyn.Location{{File: file, Line: 4, Column: 14}},
),
"fixed": dyn.NewValue(
1230.15,
[]dyn.Location{{File: file, Line: 5, Column: 8}},
),
"negative infinity": dyn.NewValue(
math.Inf(-1),
[]dyn.Location{{File: file, Line: 6, Column: 20}},
),
},
[]dyn.Location{{File: file, Line: 3, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_21(t *testing.T) {
file := "testdata/spec_example_2.21.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"null": dyn.NewValue(
nil,
[]dyn.Location{{File: file, Line: 3, Column: 6}},
),
"booleans": dyn.NewValue(
[]dyn.Value{
dyn.NewValue(true, []dyn.Location{{File: file, Line: 4, Column: 13}}),
dyn.NewValue(false, []dyn.Location{{File: file, Line: 4, Column: 19}}),
},
[]dyn.Location{{File: file, Line: 4, Column: 11}},
),
"string": dyn.NewValue(
"012345",
[]dyn.Location{{File: file, Line: 5, Column: 9}},
),
},
[]dyn.Location{{File: file, Line: 3, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_22(t *testing.T) {
file := "testdata/spec_example_2.22.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"canonical": dyn.NewValue(
dyn.MustTime("2001-12-15T02:59:43.1Z"),
[]dyn.Location{{File: file, Line: 3, Column: 12}},
),
"iso8601": dyn.NewValue(
dyn.MustTime("2001-12-14t21:59:43.10-05:00"),
[]dyn.Location{{File: file, Line: 4, Column: 10}},
),
"spaced": dyn.NewValue(
// This is parsed as a string, not a timestamp,
// both by "gopkg.in/yaml.v3" and by our implementation.
"2001-12-14 21:59:43.10 -5",
[]dyn.Location{{File: file, Line: 5, Column: 9}},
),
"date": dyn.NewValue(
dyn.MustTime("2002-12-14"),
[]dyn.Location{{File: file, Line: 6, Column: 7}},
),
},
[]dyn.Location{{File: file, Line: 3, Column: 1}},
), self)
}
func TestYAMLSpecExample_2_23(t *testing.T) {
file := "testdata/spec_example_2.23.yml"
input, err := os.ReadFile(file)
require.NoError(t, err)
// Note: the !!binary tag is not supported by us.
_, err = yamlloader.LoadYAML(file, bytes.NewBuffer(input))
assert.ErrorContains(t, err, `: unknown tag: !!binary`)
}
func TestYAMLSpecExample_2_24(t *testing.T) {
file := "testdata/spec_example_2.24.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
[]dyn.Value{
dyn.NewValue(
map[string]dyn.Value{
"center": dyn.NewValue(
map[string]dyn.Value{
"x": dyn.NewValue(73, []dyn.Location{{File: file, Line: 8, Column: 23}}),
"y": dyn.NewValue(129, []dyn.Location{{File: file, Line: 8, Column: 30}}),
},
[]dyn.Location{{File: file, Line: 8, Column: 11}},
),
"radius": dyn.NewValue(7, []dyn.Location{{File: file, Line: 9, Column: 11}}),
},
[]dyn.Location{{File: file, Line: 7, Column: 3}},
),
dyn.NewValue(
map[string]dyn.Value{
"start": dyn.NewValue(
map[string]dyn.Value{
"x": dyn.NewValue(73, []dyn.Location{{File: file, Line: 8, Column: 23}}),
"y": dyn.NewValue(129, []dyn.Location{{File: file, Line: 8, Column: 30}}),
},
[]dyn.Location{{File: file, Line: 8, Column: 11}},
),
"finish": dyn.NewValue(
map[string]dyn.Value{
"x": dyn.NewValue(89, []dyn.Location{{File: file, Line: 12, Column: 16}}),
"y": dyn.NewValue(102, []dyn.Location{{File: file, Line: 12, Column: 23}}),
},
[]dyn.Location{{File: file, Line: 12, Column: 11}},
),
},
[]dyn.Location{{File: file, Line: 10, Column: 3}},
),
dyn.NewValue(
map[string]dyn.Value{
"start": dyn.NewValue(
map[string]dyn.Value{
"x": dyn.NewValue(73, []dyn.Location{{File: file, Line: 8, Column: 23}}),
"y": dyn.NewValue(129, []dyn.Location{{File: file, Line: 8, Column: 30}}),
},
[]dyn.Location{{File: file, Line: 8, Column: 11}},
),
"color": dyn.NewValue(16772795, []dyn.Location{{File: file, Line: 15, Column: 10}}),
"text": dyn.NewValue("Pretty vector drawing.", []dyn.Location{{File: file, Line: 16, Column: 9}}),
},
[]dyn.Location{{File: file, Line: 13, Column: 3}},
),
},
[]dyn.Location{{File: file, Line: 4, Column: 5}},
), self)
}
func TestYAMLSpecExample_2_25(t *testing.T) {
file := "testdata/spec_example_2.25.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"Mark McGwire": dyn.NewValue(nil, []dyn.Location{{File: file, Line: 8, Column: 1}}),
"Sammy Sosa": dyn.NewValue(nil, []dyn.Location{{File: file, Line: 9, Column: 1}}),
"Ken Griffey": dyn.NewValue(nil, []dyn.Location{{File: file, Line: 10, Column: 1}}),
},
[]dyn.Location{{File: file, Line: 6, Column: 5}},
), self)
}
func TestYAMLSpecExample_2_26(t *testing.T) {
file := "testdata/spec_example_2.26.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
[]dyn.Value{
dyn.NewValue(
map[string]dyn.Value{
"Mark McGwire": dyn.NewValue(65, []dyn.Location{{File: file, Line: 7, Column: 17}}),
},
[]dyn.Location{{File: file, Line: 7, Column: 3}},
),
dyn.NewValue(
map[string]dyn.Value{
"Sammy Sosa": dyn.NewValue(63, []dyn.Location{{File: file, Line: 8, Column: 15}}),
},
[]dyn.Location{{File: file, Line: 8, Column: 3}},
),
dyn.NewValue(
map[string]dyn.Value{
"Ken Griffey": dyn.NewValue(58, []dyn.Location{{File: file, Line: 9, Column: 16}}),
},
[]dyn.Location{{File: file, Line: 9, Column: 3}},
),
},
[]dyn.Location{{File: file, Line: 6, Column: 5}},
), self)
}
func TestYAMLSpecExample_2_27(t *testing.T) {
file := "testdata/spec_example_2.27.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"invoice": dyn.NewValue(
34843,
[]dyn.Location{{File: file, Line: 4, Column: 10}},
),
"date": dyn.NewValue(
dyn.MustTime("2001-01-23"),
[]dyn.Location{{File: file, Line: 5, Column: 10}},
),
"bill-to": dyn.NewValue(
map[string]dyn.Value{
"given": dyn.NewValue(
"Chris",
[]dyn.Location{{File: file, Line: 7, Column: 12}},
),
"family": dyn.NewValue(
"Dumars",
[]dyn.Location{{File: file, Line: 8, Column: 12}},
),
"address": dyn.NewValue(
map[string]dyn.Value{
"lines": dyn.NewValue(
"458 Walkman Dr.\nSuite #292\n",
[]dyn.Location{{File: file, Line: 10, Column: 12}},
),
"city": dyn.NewValue(
"Royal Oak",
[]dyn.Location{{File: file, Line: 13, Column: 15}},
),
"state": dyn.NewValue(
"MI",
[]dyn.Location{{File: file, Line: 14, Column: 15}},
),
"postal": dyn.NewValue(
48046,
[]dyn.Location{{File: file, Line: 15, Column: 15}},
),
},
[]dyn.Location{{File: file, Line: 10, Column: 5}},
),
},
[]dyn.Location{{File: file, Line: 6, Column: 10}},
),
"ship-to": dyn.NewValue(
map[string]dyn.Value{
"given": dyn.NewValue(
"Chris",
[]dyn.Location{{File: file, Line: 7, Column: 12}},
),
"family": dyn.NewValue(
"Dumars",
[]dyn.Location{{File: file, Line: 8, Column: 12}},
),
"address": dyn.NewValue(
map[string]dyn.Value{
"lines": dyn.NewValue(
"458 Walkman Dr.\nSuite #292\n",
[]dyn.Location{{File: file, Line: 10, Column: 12}},
),
"city": dyn.NewValue(
"Royal Oak",
[]dyn.Location{{File: file, Line: 13, Column: 15}},
),
"state": dyn.NewValue(
"MI",
[]dyn.Location{{File: file, Line: 14, Column: 15}},
),
"postal": dyn.NewValue(
48046,
[]dyn.Location{{File: file, Line: 15, Column: 15}},
),
},
[]dyn.Location{{File: file, Line: 10, Column: 5}},
),
},
[]dyn.Location{{File: file, Line: 6, Column: 10}},
),
"product": dyn.NewValue(
[]dyn.Value{
dyn.NewValue(
map[string]dyn.Value{
"sku": dyn.NewValue(
"BL394D",
[]dyn.Location{{File: file, Line: 18, Column: 17}},
),
"quantity": dyn.NewValue(
4,
[]dyn.Location{{File: file, Line: 19, Column: 17}},
),
"description": dyn.NewValue(
"Basketball",
[]dyn.Location{{File: file, Line: 20, Column: 17}},
),
"price": dyn.NewValue(
450.0,
[]dyn.Location{{File: file, Line: 21, Column: 17}},
),
},
[]dyn.Location{{File: file, Line: 18, Column: 3}},
), dyn.NewValue(
map[string]dyn.Value{
"sku": dyn.NewValue(
"BL4438H",
[]dyn.Location{{File: file, Line: 22, Column: 17}},
),
"quantity": dyn.NewValue(
1,
[]dyn.Location{{File: file, Line: 23, Column: 17}},
),
"description": dyn.NewValue(
"Super Hoop",
[]dyn.Location{{File: file, Line: 24, Column: 17}},
),
"price": dyn.NewValue(
2392.0,
[]dyn.Location{{File: file, Line: 25, Column: 17}},
),
},
[]dyn.Location{{File: file, Line: 22, Column: 3}},
)},
[]dyn.Location{{File: file, Line: 18, Column: 1}},
),
"tax": dyn.NewValue(
251.42,
[]dyn.Location{{File: file, Line: 26, Column: 8}},
),
"total": dyn.NewValue(
4443.52,
[]dyn.Location{{File: file, Line: 27, Column: 8}},
),
"comments": dyn.NewValue(
"Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338.",
[]dyn.Location{{File: file, Line: 29, Column: 3}},
),
},
[]dyn.Location{{File: file, Line: 3, Column: 5}},
), self)
}
func TestYAMLSpecExample_2_28(t *testing.T) {
file := "testdata/spec_example_2.28.yml"
self := loadExample(t, file)
assert.Equal(t, dyn.NewValue(
map[string]dyn.Value{
"Time": dyn.NewValue(
"2001-11-23 15:01:42 -5",
[]dyn.Location{{File: file, Line: 4, Column: 7}},
),
"User": dyn.NewValue(
"ed",
[]dyn.Location{{File: file, Line: 5, Column: 7}},
),
"Warning": dyn.NewValue(
"This is an error message for the log file",
[]dyn.Location{{File: file, Line: 7, Column: 3}},
),
},
[]dyn.Location{{File: file, Line: 4, Column: 1}},
), self)
}