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
49 changes: 49 additions & 0 deletions cmd/feature/discover.go
Original file line number Diff line number Diff line change
@@ -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
}
49 changes: 8 additions & 41 deletions cmd/feature/generatedocs.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand All @@ -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 {
Expand Down Expand Up @@ -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"`
Expand All @@ -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{
Expand All @@ -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
Expand All @@ -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 != "" {
Expand Down Expand Up @@ -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")
Expand Down
43 changes: 5 additions & 38 deletions cmd/feature/package.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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
}
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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)

Expand Down
21 changes: 9 additions & 12 deletions cmd/feature/package_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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")
}
Expand All @@ -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)

Expand Down Expand Up @@ -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},
}
Expand All @@ -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"},
}
Expand All @@ -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"},
}
Expand All @@ -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"},
}
Expand All @@ -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)

Expand Down
Loading
Loading