Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add namespace: to the resources YAML #6306

Merged
merged 1 commit into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions runtime/compilers/rillv1/parse_node.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ type commonYAML struct {
Kind *string `yaml:"kind"`
// Name is usually inferred from the filename, but can be specified manually.
Name string `yaml:"name"`
// Namespace is an optional value to group resources by.
// It currently just gets pre-pended to the resource name in the format `<namespace>/<name>`.
Namespace string `yaml:"namespace"`
// Refs are a list of other resources that this resource depends on. They are usually inferred from other fields, but can also be specified manually.
Refs []yaml.Node `yaml:"refs"`
// ParserConfig enables setting file-level parser config.
Expand Down Expand Up @@ -283,6 +286,11 @@ func (p *Parser) parseStem(paths []string, ymlPath, yml, sqlPath, sql string) (*
}
}

// If a namespace was provided in YAML, prepend it to the name.
if cfg != nil && cfg.Namespace != "" {
res.Name = cfg.Namespace + ":" + res.Name
}

// If resource kind is not set in YAML or SQL, try to infer it from the context
if res.Kind == ResourceKindUnspecified {
if strings.HasPrefix(paths[0], "/sources") {
Expand Down
44 changes: 44 additions & 0 deletions runtime/compilers/rillv1/parser_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2022,6 +2022,50 @@ refresh:
requireResourcesAndErrors(t, p, []*Resource{m1, m2}, nil)
}

func TestNamespace(t *testing.T) {
ctx := context.Background()
repo := makeRepo(t, map[string]string{
`rill.yaml`: ``,
`models/m1.yaml`: `
type: model
sql: SELECT 1
`,
`explores/e1.yaml`: `
type: explore
namespace: foo
metrics_view: missing
`,
})

resources := []*Resource{
{
Name: ResourceName{Kind: ResourceKindModel, Name: "m1"},
Paths: []string{"/models/m1.yaml"},
ModelSpec: &runtimev1.ModelSpec{
RefreshSchedule: &runtimev1.Schedule{RefUpdate: true},
InputConnector: "duckdb",
InputProperties: must(structpb.NewStruct(map[string]any{"sql": `SELECT 1`})),
OutputConnector: "duckdb",
},
},
{
Name: ResourceName{Kind: ResourceKindExplore, Name: "foo:e1"},
Paths: []string{"/explores/e1.yaml"},
Refs: []ResourceName{{Kind: ResourceKindMetricsView, Name: "missing"}},
ExploreSpec: &runtimev1.ExploreSpec{
DisplayName: "Foo: E1",
MetricsView: "missing",
DimensionsSelector: &runtimev1.FieldSelector{Selector: &runtimev1.FieldSelector_All{All: true}},
MeasuresSelector: &runtimev1.FieldSelector{Selector: &runtimev1.FieldSelector_All{All: true}},
},
},
}

p, err := Parse(ctx, repo, "", "", "duckdb")
require.NoError(t, err)
requireResourcesAndErrors(t, p, resources, nil)
}

func requireResourcesAndErrors(t testing.TB, p *Parser, wantResources []*Resource, wantErrors []*runtimev1.ParseError) {
// Check errors
// NOTE: Assumes there's at most one parse error per file path
Expand Down
3 changes: 3 additions & 0 deletions runtime/compilers/rillv1/util.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ func ToDisplayName(name string) string {
name = strings.ReplaceAll(name, "_", " ")
name = strings.ReplaceAll(name, "-", " ")

// Replace colons with colon-space.
name = strings.ReplaceAll(name, ":", ": ")

// Capitalize the first letter.
name = cases.Title(language.English).String(name)

Expand Down
Loading