diff --git a/cmd/feature/discover.go b/cmd/feature/discover.go new file mode 100644 index 0000000000..0801bd7980 --- /dev/null +++ b/cmd/feature/discover.go @@ -0,0 +1,49 @@ +package feature + +import ( + "fmt" + "os" + "path/filepath" + + "github.com/devsy-org/devsy/pkg/devcontainer/config" +) + +type localFeature struct { + dir string + config *config.FeatureConfig +} + +func discoverLocalFeatures( + root, readErrPrefix string, + onSkip func(name string, err error), +) ([]localFeature, error) { + entries, err := os.ReadDir(root) + if err != nil { + return nil, fmt.Errorf("%s: %w", readErrPrefix, err) + } + + var features []localFeature + for _, entry := range entries { + if !entry.IsDir() { + continue + } + + featureCfg, parseErr := config.ParseDevContainerFeature(filepath.Join(root, entry.Name())) + if parseErr != nil { + if onSkip != nil { + onSkip(entry.Name(), parseErr) + } + continue + } + + features = append(features, localFeature{ + dir: entry.Name(), + config: featureCfg, + }) + } + + if len(features) == 0 { + return nil, fmt.Errorf("no features found in %s", root) + } + return features, nil +} diff --git a/cmd/feature/generatedocs.go b/cmd/feature/generatedocs.go index ea21284f1c..df97852440 100644 --- a/cmd/feature/generatedocs.go +++ b/cmd/feature/generatedocs.go @@ -86,7 +86,9 @@ func (cmd *GenerateDocsCmd) Run() error { return err } - features, err := scanFeatures(filepath.Join(projectFolder, "src")) + features, err := discoverLocalFeatures( + filepath.Join(projectFolder, "src"), "read src/ directory", nil, + ) if err != nil { return err } @@ -113,38 +115,8 @@ func (cmd *GenerateDocsCmd) resolveOutputFolder( return out, nil } -func scanFeatures(srcDir string) ([]*featureDoc, error) { - entries, err := os.ReadDir(srcDir) - if err != nil { - return nil, fmt.Errorf("read src/ directory: %w", err) - } - - var features []*featureDoc - for _, entry := range entries { - if !entry.IsDir() { - continue - } - - featureDir := filepath.Join(srcDir, entry.Name()) - featureCfg, parseErr := config.ParseDevContainerFeature(featureDir) - if parseErr != nil { - continue - } - - features = append(features, &featureDoc{ - dir: entry.Name(), - config: featureCfg, - }) - } - - if len(features) == 0 { - return nil, fmt.Errorf("no features found in %s", srcDir) - } - return features, nil -} - func (cmd *GenerateDocsCmd) writeDocs( - features []*featureDoc, outputFolder string, + features []localFeature, outputFolder string, ) error { // #nosec G301 if err := os.MkdirAll(outputFolder, 0o755); err != nil { @@ -172,11 +144,6 @@ func (cmd *GenerateDocsCmd) writeDocs( return nil } -type featureDoc struct { - dir string - config *config.FeatureConfig -} - type featureDocJSON struct { ID string `json:"id"` Name string `json:"name,omitempty"` @@ -187,7 +154,7 @@ type featureDocJSON struct { Options map[string]config.FeatureConfigOption `json:"options,omitempty"` } -func (cmd *GenerateDocsCmd) writeJSON(features []*featureDoc) error { +func (cmd *GenerateDocsCmd) writeJSON(features []localFeature) error { docs := make([]featureDocJSON, 0, len(features)) for _, f := range features { docs = append(docs, featureDocJSON{ @@ -208,7 +175,7 @@ func (cmd *GenerateDocsCmd) writeJSON(features []*featureDoc) error { return err } -func (cmd *GenerateDocsCmd) generateFeatureDoc(f *featureDoc) string { +func (cmd *GenerateDocsCmd) generateFeatureDoc(f localFeature) string { var sb strings.Builder name := f.config.Name @@ -230,7 +197,7 @@ func (cmd *GenerateDocsCmd) generateFeatureDoc(f *featureDoc) string { } func (cmd *GenerateDocsCmd) writeMetadataTable( - sb *strings.Builder, f *featureDoc, + sb *strings.Builder, f localFeature, ) { rows := [][]string{{"ID", fmt.Sprintf("`%s`", f.config.ID)}} if f.config.Version != "" { @@ -304,7 +271,7 @@ func writeDependenciesSection(sb *strings.Builder, cfg *config.FeatureConfig) { } } -func (cmd *GenerateDocsCmd) generateIndex(features []*featureDoc) string { +func (cmd *GenerateDocsCmd) generateIndex(features []localFeature) string { var sb strings.Builder sb.WriteString("# Dev Container Features\n\n") diff --git a/cmd/feature/package.go b/cmd/feature/package.go index 4bb115119e..927f159d57 100644 --- a/cmd/feature/package.go +++ b/cmd/feature/package.go @@ -7,7 +7,6 @@ import ( "regexp" "github.com/devsy-org/devsy/cmd/flags" - "github.com/devsy-org/devsy/pkg/devcontainer/config" "github.com/devsy-org/devsy/pkg/extract" cliflags "github.com/devsy-org/devsy/pkg/flags" "github.com/devsy-org/devsy/pkg/flags/names" @@ -90,7 +89,7 @@ func (cmd *PackageCmd) Run() error { return err } - features, err := cmd.discoverFeatures(target) + features, err := discoverLocalFeatures(target, "read target directory", warnSkippedFeature) if err != nil { return err } @@ -133,43 +132,11 @@ func (cmd *PackageCmd) prepareOutputFolder() (string, error) { var validFeatureID = regexp.MustCompile(`^[a-z0-9][a-z0-9-]*$`) -type featureSource struct { - dir string - config *config.FeatureConfig +func warnSkippedFeature(name string, err error) { + log.Warnf("skipping %s: %v", name, err) } -func (cmd *PackageCmd) discoverFeatures(targetDir string) ([]featureSource, error) { - entries, err := os.ReadDir(targetDir) - if err != nil { - return nil, fmt.Errorf("read target directory: %w", err) - } - - var features []featureSource - for _, entry := range entries { - if !entry.IsDir() { - continue - } - - featureDir := filepath.Join(targetDir, entry.Name()) - featureCfg, parseErr := config.ParseDevContainerFeature(featureDir) - if parseErr != nil { - log.Warnf("skipping %s: %v", entry.Name(), parseErr) - continue - } - - features = append(features, featureSource{ - dir: entry.Name(), - config: featureCfg, - }) - } - - if len(features) == 0 { - return nil, fmt.Errorf("no features found in %s", targetDir) - } - return features, nil -} - -func validateFeatureSource(feat featureSource, featureDir string) error { +func validateFeatureSource(feat localFeature, featureDir string) error { if !validFeatureID.MatchString(feat.config.ID) { return fmt.Errorf( "invalid feature ID %q: must match [a-z0-9][a-z0-9-]*", feat.config.ID, @@ -203,7 +170,7 @@ func validateFeatureSource(feat featureSource, featureDir string) error { } func (cmd *PackageCmd) packageFeature( - feat featureSource, targetDir, outputFolder string, + feat localFeature, targetDir, outputFolder string, ) (packageResult, error) { featureDir := filepath.Join(targetDir, feat.dir) diff --git a/cmd/feature/package_test.go b/cmd/feature/package_test.go index 76b84ed0ca..c7253987eb 100644 --- a/cmd/feature/package_test.go +++ b/cmd/feature/package_test.go @@ -71,8 +71,7 @@ func TestPackageCmd_DiscoverFeatures(t *testing.T) { 0o600, )) - cmd := &PackageCmd{} - features, err := cmd.discoverFeatures(targetDir) + features, err := discoverLocalFeatures(targetDir, "read target directory", nil) require.NoError(t, err) assert.Len(t, features, 2) @@ -87,15 +86,13 @@ func TestPackageCmd_DiscoverFeatures(t *testing.T) { func TestPackageCmd_DiscoverFeatures_EmptyDir(t *testing.T) { targetDir := t.TempDir() - cmd := &PackageCmd{} - _, err := cmd.discoverFeatures(targetDir) + _, err := discoverLocalFeatures(targetDir, "read target directory", nil) require.Error(t, err) assert.Contains(t, err.Error(), "no features found") } func TestPackageCmd_DiscoverFeatures_NonexistentDir(t *testing.T) { - cmd := &PackageCmd{} - _, err := cmd.discoverFeatures("/nonexistent/path") + _, err := discoverLocalFeatures("/nonexistent/path", "read target directory", nil) require.Error(t, err) assert.Contains(t, err.Error(), "read target directory") } @@ -119,7 +116,7 @@ func TestPackageCmd_PackageFeature(t *testing.T) { cmd := &PackageCmd{} - features, err := cmd.discoverFeatures(targetDir) + features, err := discoverLocalFeatures(targetDir, "read target directory", nil) require.NoError(t, err) require.Len(t, features, 1) @@ -193,7 +190,7 @@ func TestPackageCmd_InvalidFeatureID(t *testing.T) { for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - feat := featureSource{ + feat := localFeature{ dir: "some-dir", config: &config.FeatureConfig{ID: tt.id}, } @@ -209,7 +206,7 @@ func TestPackageCmd_IDMustMatchDirectory(t *testing.T) { targetDir := t.TempDir() outputDir := t.TempDir() - feat := featureSource{ + feat := localFeature{ dir: "actual-dir", config: &config.FeatureConfig{ID: "different-id", Version: "1.0.0", Name: "Test"}, } @@ -223,7 +220,7 @@ func TestPackageCmd_MissingVersion(t *testing.T) { targetDir := t.TempDir() outputDir := t.TempDir() - feat := featureSource{ + feat := localFeature{ dir: testFeatureIDPkg, config: &config.FeatureConfig{ID: testFeatureIDPkg, Name: "Test"}, } @@ -237,7 +234,7 @@ func TestPackageCmd_MissingName(t *testing.T) { targetDir := t.TempDir() outputDir := t.TempDir() - feat := featureSource{ + feat := localFeature{ dir: testFeatureIDPkg, config: &config.FeatureConfig{ID: testFeatureIDPkg, Version: "1.0.0"}, } @@ -259,7 +256,7 @@ func TestPackageCmd_MissingInstallSh(t *testing.T) { )) cmd := &PackageCmd{} - features, err := cmd.discoverFeatures(targetDir) + features, err := discoverLocalFeatures(targetDir, "read target directory", nil) require.NoError(t, err) require.Len(t, features, 1) diff --git a/cmd/feature/test.go b/cmd/feature/test.go index 7cb5df0fb7..7e0030b915 100644 --- a/cmd/feature/test.go +++ b/cmd/feature/test.go @@ -9,7 +9,6 @@ import ( "strings" "github.com/devsy-org/devsy/cmd/flags" - "github.com/devsy-org/devsy/pkg/devcontainer/config" cliflags "github.com/devsy-org/devsy/pkg/flags" "github.com/devsy-org/devsy/pkg/flags/names" "github.com/devsy-org/devsy/pkg/table" @@ -86,7 +85,7 @@ func (cmd *TestCmd) Run() error { srcDir := filepath.Join(projectFolder, "src") testDir := filepath.Join(projectFolder, "test") - features, err := cmd.discoverFeatures(srcDir) + features, err := discoverLocalFeatures(srcDir, "read src/ directory", nil) if err != nil { return err } @@ -112,28 +111,7 @@ func (cmd *TestCmd) Run() error { return nil } -type featureEntry struct { - id string - config *config.FeatureConfig -} - -func (cmd *TestCmd) discoverFeatures(srcDir string) ([]featureEntry, error) { - docs, err := scanFeatures(srcDir) - if err != nil { - return nil, err - } - - features := make([]featureEntry, 0, len(docs)) - for _, doc := range docs { - features = append(features, featureEntry{ - id: doc.dir, - config: doc.config, - }) - } - return features, nil -} - -func (cmd *TestCmd) filterFeatures(features []featureEntry) []featureEntry { +func (cmd *TestCmd) filterFeatures(features []localFeature) []localFeature { if cmd.Features == "" { return features } @@ -143,9 +121,9 @@ func (cmd *TestCmd) filterFeatures(features []featureEntry) []featureEntry { filter[strings.TrimSpace(f)] = true } - var filtered []featureEntry + var filtered []localFeature for _, feat := range features { - if filter[feat.id] { + if filter[feat.dir] { filtered = append(filtered, feat) } } @@ -159,11 +137,11 @@ type testCase struct { } func (cmd *TestCmd) testFeature( - feat featureEntry, projectFolder, testDir string, + feat localFeature, projectFolder, testDir string, ) []testResult { var results []testResult - featureTestDir := filepath.Join(testDir, feat.id) + featureTestDir := filepath.Join(testDir, feat.dir) globalTestScript := filepath.Join(featureTestDir, "test.sh") if _, err := os.Stat(globalTestScript); err == nil { @@ -221,10 +199,10 @@ func (cmd *TestCmd) loadScenarioOptions(scenarioDir string) map[string]string { } func (cmd *TestCmd) runTest( - feat featureEntry, projectFolder string, tc testCase, + feat localFeature, projectFolder string, tc testCase, ) testResult { result := testResult{ - FeatureID: feat.id, + FeatureID: feat.dir, Scenario: tc.scenario, } @@ -237,9 +215,9 @@ func (cmd *TestCmd) runTest( dockerfile := cmd.generateDockerfileWithTest(feat, tc.options, testScriptRel) - containerName := fmt.Sprintf("devsy-test-%s", feat.id) + containerName := fmt.Sprintf("devsy-test-%s", feat.dir) if tc.scenario != "" { - containerName = fmt.Sprintf("devsy-test-%s-%s", feat.id, tc.scenario) + containerName = fmt.Sprintf("devsy-test-%s-%s", feat.dir, tc.scenario) } imageName := containerName + ":latest" @@ -267,24 +245,24 @@ func (cmd *TestCmd) runTest( } func (cmd *TestCmd) generateDockerfileWithTest( - feat featureEntry, options map[string]string, testScriptRelPath string, + feat localFeature, options map[string]string, testScriptRelPath string, ) string { var b strings.Builder fmt.Fprintf(&b, "FROM %s\n", cmd.BaseImage) - featureSrcDir := filepath.Join("src", feat.id) - fmt.Fprintf(&b, "COPY %s /tmp/build-features/%s\n", featureSrcDir, feat.id) + featureSrcDir := filepath.Join("src", feat.dir) + fmt.Fprintf(&b, "COPY %s /tmp/build-features/%s\n", featureSrcDir, feat.dir) for k, v := range options { - envKey := strings.ReplaceAll(strings.ToUpper(feat.id), "-", "_") + "_" + strings.ToUpper(k) + envKey := strings.ReplaceAll(strings.ToUpper(feat.dir), "-", "_") + "_" + strings.ToUpper(k) fmt.Fprintf(&b, "ENV %s=%q\n", envKey, v) } fmt.Fprintf( &b, "RUN chmod +x /tmp/build-features/%s/install.sh && /tmp/build-features/%s/install.sh\n", - feat.id, feat.id, + feat.dir, feat.dir, ) if testScriptRelPath != "" { diff --git a/cmd/feature/test_test.go b/cmd/feature/test_test.go index 97779ab861..106f8bc3cc 100644 --- a/cmd/feature/test_test.go +++ b/cmd/feature/test_test.go @@ -90,14 +90,13 @@ func TestTestCmd_DiscoverFeatures(t *testing.T) { 0o600, )) - cmd := &TestCmd{} - features, err := cmd.discoverFeatures(srcDir) + features, err := discoverLocalFeatures(srcDir, "read src/ directory", nil) require.NoError(t, err) assert.Len(t, features, 2) ids := make(map[string]bool) for _, f := range features { - ids[f.id] = true + ids[f.dir] = true } assert.True(t, ids["feature-a"]) assert.True(t, ids["feature-b"]) @@ -108,24 +107,22 @@ func TestTestCmd_DiscoverFeatures_EmptyDir(t *testing.T) { srcDir := filepath.Join(projectDir, "src") require.NoError(t, os.MkdirAll(srcDir, 0o700)) - cmd := &TestCmd{} - _, err := cmd.discoverFeatures(srcDir) + _, err := discoverLocalFeatures(srcDir, "read src/ directory", nil) require.Error(t, err) assert.Contains(t, err.Error(), "no features found") } func TestTestCmd_DiscoverFeatures_NonexistentDir(t *testing.T) { - cmd := &TestCmd{} - _, err := cmd.discoverFeatures("/nonexistent/path/src") + _, err := discoverLocalFeatures("/nonexistent/path/src", "read src/ directory", nil) require.Error(t, err) assert.Contains(t, err.Error(), "read src/ directory") } func TestTestCmd_FilterFeatures(t *testing.T) { - features := []featureEntry{ - {id: "go", config: nil}, - {id: "node", config: nil}, - {id: "python", config: nil}, + features := []localFeature{ + {dir: "go", config: nil}, + {dir: "node", config: nil}, + {dir: "python", config: nil}, } t.Run("empty filter returns all", func(t *testing.T) { @@ -138,7 +135,7 @@ func TestTestCmd_FilterFeatures(t *testing.T) { cmd := &TestCmd{Features: "go"} result := cmd.filterFeatures(features) assert.Len(t, result, 1) - assert.Equal(t, "go", result[0].id) + assert.Equal(t, "go", result[0].dir) }) t.Run("multi filter", func(t *testing.T) { @@ -163,7 +160,7 @@ func TestTestCmd_FilterFeatures(t *testing.T) { func TestTestCmd_GenerateDockerfile(t *testing.T) { t.Run("basic dockerfile", func(t *testing.T) { cmd := &TestCmd{BaseImage: testBaseImage, RemoteUser: defaultRemoteUser} - feat := featureEntry{id: testFeatureID} + feat := localFeature{dir: testFeatureID} df := generateDockerfileForTest(cmd, feat, nil) assert.Contains(t, df, "FROM "+testBaseImage) assert.Contains(t, df, "COPY src/my-feature /tmp/build-features/my-feature") @@ -173,14 +170,14 @@ func TestTestCmd_GenerateDockerfile(t *testing.T) { t.Run("with remote user", func(t *testing.T) { cmd := &TestCmd{BaseImage: testBaseImage, RemoteUser: "vscode"} - feat := featureEntry{id: testFeatureID} + feat := localFeature{dir: testFeatureID} df := generateDockerfileForTest(cmd, feat, nil) assert.Contains(t, df, "USER vscode") }) t.Run("with options", func(t *testing.T) { cmd := &TestCmd{BaseImage: testBaseImage, RemoteUser: defaultRemoteUser} - feat := featureEntry{id: "go"} + feat := localFeature{dir: "go"} opts := map[string]string{"version": "1.21"} df := generateDockerfileForTest(cmd, feat, opts) assert.Contains(t, df, "ENV GO_VERSION=\"1.21\"") @@ -188,7 +185,7 @@ func TestTestCmd_GenerateDockerfile(t *testing.T) { t.Run("default base image", func(t *testing.T) { cmd := &TestCmd{BaseImage: defaultBaseImage, RemoteUser: defaultRemoteUser} - feat := featureEntry{id: "feat"} + feat := localFeature{dir: "feat"} df := generateDockerfileForTest(cmd, feat, nil) assert.Contains(t, df, "FROM "+defaultBaseImage) }) @@ -267,13 +264,13 @@ func TestTestCmd_TestDiscovery(t *testing.T) { 0o600, )) - feat := featureEntry{id: testFeatureID, config: nil} + feat := localFeature{dir: testFeatureID, config: nil} cmd := &TestCmd{ BaseImage: defaultBaseImage, RemoteUser: defaultRemoteUser, } - featureTestDir := filepath.Join(projectDir, "test", feat.id) + featureTestDir := filepath.Join(projectDir, "test", feat.dir) globalTestScript := filepath.Join(featureTestDir, "test.sh") _, err := os.Stat(globalTestScript) @@ -293,6 +290,6 @@ func TestTestCmd_TestDiscovery(t *testing.T) { assert.Contains(t, df, `MY_FEATURE_VERSION="3.11"`) } -func generateDockerfileForTest(cmd *TestCmd, feat featureEntry, options map[string]string) string { +func generateDockerfileForTest(cmd *TestCmd, feat localFeature, options map[string]string) string { return cmd.generateDockerfileWithTest(feat, options, "") }