Skip to content
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
4 changes: 0 additions & 4 deletions cmd/feature/publish.go
Original file line number Diff line number Diff line change
Expand Up @@ -143,10 +143,6 @@ func validatePublishTarget(target string) (*config.FeatureConfig, error) {
return nil, fmt.Errorf("parse feature metadata: %w", err)
}

if featureCfg.ID == "" {
return nil, fmt.Errorf("feature metadata missing required 'id' field")
}

return featureCfg, nil
}

Expand Down
2 changes: 1 addition & 1 deletion cmd/feature/publish_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ func TestValidatePublishTarget_MissingID(t *testing.T) {

_, err := validatePublishTarget(tmpDir)
require.Error(t, err)
assert.Contains(t, err.Error(), "missing required 'id' field")
assert.Contains(t, err.Error(), "missing required property \"id\"")
}

func TestValidatePublishTarget_Valid(t *testing.T) {
Expand Down
42 changes: 42 additions & 0 deletions pkg/devcontainer/config/feature_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ package config

import (
"encoding/json"
"os"
"path/filepath"
"reflect"
"testing"
)
Expand Down Expand Up @@ -69,3 +71,43 @@ func TestFeatureConfig_DependsOnKeysEmpty(t *testing.T) {
t.Errorf("DependsOnKeys() = %v, want empty", got)
}
}

func TestParseDevContainerFeatureRequiresID(t *testing.T) {
cases := []struct {
name string
raw string
}{
{"missing id", `{"version":"1.0.0","name":"Go"}`},
{"empty id", `{"id":"","version":"1.0.0","name":"Go"}`},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
dir := t.TempDir()
if err := os.WriteFile(
filepath.Join(dir, DevContainerFeatureFileName), []byte(tc.raw), 0o600,
); err != nil {
t.Fatalf("write feature file: %v", err)
}
if _, err := ParseDevContainerFeature(dir); err == nil {
t.Fatalf("ParseDevContainerFeature expected error for %s, got nil", tc.name)
}
})
}
}

func TestParseDevContainerFeatureAcceptsID(t *testing.T) {
dir := t.TempDir()
raw := `{"id":"go","version":"1.0.0","name":"Go"}`
if err := os.WriteFile(
filepath.Join(dir, DevContainerFeatureFileName), []byte(raw), 0o600,
); err != nil {
t.Fatalf("write feature file: %v", err)
}
cfg, err := ParseDevContainerFeature(dir)
if err != nil {
t.Fatalf("ParseDevContainerFeature: %v", err)
}
if cfg.ID != "go" {
t.Errorf("ID = %q, want %q", cfg.ID, "go")
}
}
7 changes: 7 additions & 0 deletions pkg/devcontainer/config/parse.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,13 @@ func ParseDevContainerFeature(folder string) (*FeatureConfig, error) {
return nil, err
}

if featureConfig.ID == "" {
// "id" is required by the devcontainer Feature schema.
return nil, fmt.Errorf(
"%s is missing required property \"id\"", DevContainerFeatureFileName,
)
}

featureConfig.Origin = path
return featureConfig, nil
}
Expand Down
Loading