steve/databricks-cli
steve
/
databricks-cli
mirror of https://github.com/databricks/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
databricks-cli/libs/dyn/yamlloader/yaml_mix_test.go

27 lines
623 B
Go
Raw Normal View History

New YAML loader to support configuration location (#828) ## Changes In order to support variable interpolation on fields that aren't a string in the resource types, we need a separate representation of the bundle configuration tree with the type equivalent of Go's `any`. But instead of using `any` directly, we can do better and use a custom type equivalent to `any` that captures additional metadata. In this PR, the additional metadata is limited to the origin of the configuration value (file, line number, and column). The YAML in this commit uses the upstream YAML parser's `yaml.Node` type to get access to location information. It reimplements the loader that takes the `yaml.Node` structure and turns it into the configuration tree we need. Next steps after this PR: * Implement configuration tree type checking (against a Go type) * Implement configuration tree merging (to replace the current merge functionality) * Implement conversion to and from the bundle configuration struct * Perform variable interpolation against this configuration tree (to support variable interpolation for ints) * (later) Implement a `jsonloader` that produces the same tree and includes location information ## Tests The tests in `yamlloader` perform an equality check on the untyped output of loading a YAML file between the upstream YAML loader and this loader. The YAML examples were generated by prompting ChatGPT for examples that showcase anchors, primitive values, edge cases, etc.
2023-10-20 12:56:59 +00:00
package yamlloader_test
import (
"testing"
Rename libs/config -> libs/dyn (#1086) ## Changes The name "dynamic value", or "dyn" for short, is more descriptive than the opaque "config". Also, it conveniently does not alias with other packages in the repository, or (popular ones) elsewhere. (discussed with @andrewnester) ## Tests n/a
2023-12-22 13:20:45 +00:00
"github.com/databricks/cli/libs/dyn"
Define `dyn.Mapping` to represent maps (#1301) ## Changes Before this change maps were stored as a regular Go map with string keys. This didn't let us capture metadata (location information) for map keys. To address this, this change replaces the use of the regular Go map with a dedicated type for a dynamic map. This type stores the `dyn.Value` for both the key and the value. It uses a map to still allow O(1) lookups and redirects those into a slice. ## Tests * All existing unit tests pass (some with minor modifications due to interface change). * Equality assertions with `assert.Equal` no longer worked because the new `dyn.Mapping` persists the order in which keys are set and is therefore susceptible to map ordering issues. To fix this, I added a `dynassert` package that forwards all assertions to `testify/assert` but intercepts equality for `dyn.Value` arguments.
2024-03-25 11:01:09 +00:00
assert "github.com/databricks/cli/libs/dyn/dynassert"
New YAML loader to support configuration location (#828) ## Changes In order to support variable interpolation on fields that aren't a string in the resource types, we need a separate representation of the bundle configuration tree with the type equivalent of Go's `any`. But instead of using `any` directly, we can do better and use a custom type equivalent to `any` that captures additional metadata. In this PR, the additional metadata is limited to the origin of the configuration value (file, line number, and column). The YAML in this commit uses the upstream YAML parser's `yaml.Node` type to get access to location information. It reimplements the loader that takes the `yaml.Node` structure and turns it into the configuration tree we need. Next steps after this PR: * Implement configuration tree type checking (against a Go type) * Implement configuration tree merging (to replace the current merge functionality) * Implement conversion to and from the bundle configuration struct * Perform variable interpolation against this configuration tree (to support variable interpolation for ints) * (later) Implement a `jsonloader` that produces the same tree and includes location information ## Tests The tests in `yamlloader` perform an equality check on the untyped output of loading a YAML file between the upstream YAML loader and this loader. The YAML examples were generated by prompting ChatGPT for examples that showcase anchors, primitive values, edge cases, etc.
2023-10-20 12:56:59 +00:00
)
func TestYAMLMix01(t *testing.T) {
file := "testdata/mix_01.yml"
self := loadYAML(t, file)
Rename libs/config -> libs/dyn (#1086) ## Changes The name "dynamic value", or "dyn" for short, is more descriptive than the opaque "config". Also, it conveniently does not alias with other packages in the repository, or (popular ones) elsewhere. (discussed with @andrewnester) ## Tests n/a
2023-12-22 13:20:45 +00:00
assert.NotEqual(t, dyn.NilValue, self)
New YAML loader to support configuration location (#828) ## Changes In order to support variable interpolation on fields that aren't a string in the resource types, we need a separate representation of the bundle configuration tree with the type equivalent of Go's `any`. But instead of using `any` directly, we can do better and use a custom type equivalent to `any` that captures additional metadata. In this PR, the additional metadata is limited to the origin of the configuration value (file, line number, and column). The YAML in this commit uses the upstream YAML parser's `yaml.Node` type to get access to location information. It reimplements the loader that takes the `yaml.Node` structure and turns it into the configuration tree we need. Next steps after this PR: * Implement configuration tree type checking (against a Go type) * Implement configuration tree merging (to replace the current merge functionality) * Implement conversion to and from the bundle configuration struct * Perform variable interpolation against this configuration tree (to support variable interpolation for ints) * (later) Implement a `jsonloader` that produces the same tree and includes location information ## Tests The tests in `yamlloader` perform an equality check on the untyped output of loading a YAML file between the upstream YAML loader and this loader. The YAML examples were generated by prompting ChatGPT for examples that showcase anchors, primitive values, edge cases, etc.
2023-10-20 12:56:59 +00:00
assert.True(t, self.Get("base_address").IsAnchor())
assert.False(t, self.Get("office_address").IsAnchor())
}
func TestYAMLMix02(t *testing.T) {
file := "testdata/mix_02.yml"
self := loadYAML(t, file)
Rename libs/config -> libs/dyn (#1086) ## Changes The name "dynamic value", or "dyn" for short, is more descriptive than the opaque "config". Also, it conveniently does not alias with other packages in the repository, or (popular ones) elsewhere. (discussed with @andrewnester) ## Tests n/a
2023-12-22 13:20:45 +00:00
assert.NotEqual(t, dyn.NilValue, self)
New YAML loader to support configuration location (#828) ## Changes In order to support variable interpolation on fields that aren't a string in the resource types, we need a separate representation of the bundle configuration tree with the type equivalent of Go's `any`. But instead of using `any` directly, we can do better and use a custom type equivalent to `any` that captures additional metadata. In this PR, the additional metadata is limited to the origin of the configuration value (file, line number, and column). The YAML in this commit uses the upstream YAML parser's `yaml.Node` type to get access to location information. It reimplements the loader that takes the `yaml.Node` structure and turns it into the configuration tree we need. Next steps after this PR: * Implement configuration tree type checking (against a Go type) * Implement configuration tree merging (to replace the current merge functionality) * Implement conversion to and from the bundle configuration struct * Perform variable interpolation against this configuration tree (to support variable interpolation for ints) * (later) Implement a `jsonloader` that produces the same tree and includes location information ## Tests The tests in `yamlloader` perform an equality check on the untyped output of loading a YAML file between the upstream YAML loader and this loader. The YAML examples were generated by prompting ChatGPT for examples that showcase anchors, primitive values, edge cases, etc.
2023-10-20 12:56:59 +00:00
assert.True(t, self.Get("base_colors").IsAnchor())
assert.False(t, self.Get("theme").IsAnchor())
}