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

Fix scalar plugin parsing #2264

Merged
merged 1 commit into from
Aug 2, 2023
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
71 changes: 71 additions & 0 deletions internal/pipeline/parser_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1092,6 +1092,77 @@ steps:
}
}

func TestParserParsesScalarPlugins(t *testing.T) {
input := strings.NewReader(`---
steps:
- name: ":s3: xxx"
command: "script/buildkite/xxx.sh"
plugins:
- example-plugin#v1.0.0
- another-plugin#v0.0.1-beta43
- docker-compose#v2.5.1:
config: .buildkite/docker/docker-compose.yml
`)

got, err := Parse(input)
if err != nil {
t.Fatalf("Parse(input) error = %v", err)
}

want := &Pipeline{
Steps: Steps{
&CommandStep{
Command: "script/buildkite/xxx.sh",
Plugins: Plugins{
{
Name: "example-plugin#v1.0.0",
},
{
Name: "another-plugin#v0.0.1-beta43",
},
{
Name: "docker-compose#v2.5.1",
Config: ordered.MapFromItems(
ordered.TupleSA{Key: "config", Value: ".buildkite/docker/docker-compose.yml"},
),
},
},
RemainingFields: map[string]any{
"name": ":s3: xxx",
},
},
},
}
if diff := cmp.Diff(got, want, cmp.Comparer(ordered.EqualSA)); diff != "" {
t.Errorf("parsed pipeline diff (-got +want):\n%s", diff)
}

gotJSON, err := json.MarshalIndent(got, "", " ")
if err != nil {
t.Fatalf(`json.MarshalIndent(got, "", " ") error = %v`, err)
}
const wantJSON = `{
"steps": [
{
"command": "script/buildkite/xxx.sh",
"name": ":s3: xxx",
"plugins": [
"example-plugin#v1.0.0",
"another-plugin#v0.0.1-beta43",
{
"docker-compose#v2.5.1": {
"config": ".buildkite/docker/docker-compose.yml"
}
}
]
}
]
}`
if diff := cmp.Diff(string(gotJSON), wantJSON); diff != "" {
t.Errorf("marshalled JSON diff (-got +want):\n%s", diff)
}
}

func TestParserParsesConditionalWithEndOfLineAnchorDollarSign(t *testing.T) {
tests := []struct {
desc string
Expand Down
10 changes: 8 additions & 2 deletions internal/pipeline/plugin.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,21 @@ type Plugin struct {
Config any
}

// MarshalJSON returns the plugin in "one-key object" form.
// MarshalJSON returns the plugin in "one-key object" form, or "single string"
// form (no config, only plugin name).
func (p *Plugin) MarshalJSON() ([]byte, error) {
// NB: MarshalYAML (as seen below) never returns an error.
o, _ := p.MarshalYAML()
return json.Marshal(o)
}

// MarshalYAML returns the plugin in "one-item map" form.
// MarshalYAML returns the plugin in either "one-item map" form, or "scalar"
// form (no config, only plugin name).
func (p *Plugin) MarshalYAML() (any, error) {
if p.Config == nil {
return p.Name, nil
}

return map[string]any{
p.Name: p.Config,
}, nil
Expand Down
37 changes: 31 additions & 6 deletions internal/pipeline/plugins.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,41 @@ func (p *Plugins) unmarshalAny(o any) error {
switch o := o.(type) {
case []any:
for _, c := range o {
m, ok := c.(*ordered.MapSA)
if !ok {
return fmt.Errorf("unmarshaling plugins: plugin type %T, want *ordered.Map[string, any]", c)
}
if err := unmarshalMap(m); err != nil {
return err
switch ct := c.(type) {
case *ordered.MapSA:
// Typical case:
//
// plugins:
// - plugin#1.0.0:
// config: config, etc
if err := unmarshalMap(ct); err != nil {
return err
}

case string:
// Less typical, but supported:
//
// plugins:
// - plugin#1.0.0
// (no config, only plugin)
*p = append(*p, &Plugin{
Name: ct,
Config: nil,
})

default:
return fmt.Errorf("unmarshaling plugins: plugin type %T, want *ordered.Map[string, any] or string", c)
}
}

case *ordered.MapSA:
// Legacy form:
//
// plugins:
// plugin#1.0.0:
// config: config, etc
// otherplugin#2.0.0:
// etc
if err := unmarshalMap(o); err != nil {
return err
}
Expand Down