Merge pull request #339 from Bedrock-OSS/develop

Update 1.7.0

Author: Nusiq

main.go

@@ -166,6 +166,7 @@ the new filter is available in the Regolith.
 `
 
 func main() {
+
 	// Schedule error handling
 	var err error
 	defer func() {
@@ -220,14 +221,19 @@ func main() {
 	}
 	subcommands := make([]*cobra.Command, 0)
 
+	// Add --env flag to root command
+	var envFile string
+	rootCmd.PersistentFlags().StringVar(&envFile, "env", "", "Path to a custom .env file to load")
+
 	var force bool
 	// regolith init
 	cmdInit := &cobra.Command{
 		Use:   "init",
 		Short: "Initializes a Regolith project in current directory",
 		Long:  regolithInitDesc,
 		Run: func(cmd *cobra.Command, _ []string) {
-			err = regolith.Init(burrito.PrintStackTrace, force)
+			env, _ := cmd.Flags().GetString("env")
+			err = regolith.Init(burrito.PrintStackTrace, force, env)
 		},
 	}
 	cmdInit.Flags().BoolVarP(
@@ -249,7 +255,8 @@ func main() {
 			if cmd.Flags().Lookup("profile").Changed && len(profiles) == 0 {
 				profiles = append(profiles, "default")
 			}
-			err = regolith.Install(filters, force || update, resolverRefresh, filterRefresh, profiles, burrito.PrintStackTrace)
+			env, _ := cmd.Flags().GetString("env")
+			err = regolith.Install(filters, force || update, resolverRefresh, filterRefresh, profiles, burrito.PrintStackTrace, env)
 		},
 	}
 	cmdInstall.Flags().BoolVarP(
@@ -270,7 +277,8 @@ func main() {
 		Short: "Installs all nonexistent or outdated filters defined in filterDefinitions list",
 		Long:  regolithInstallAllDesc,
 		Run: func(cmd *cobra.Command, _ []string) {
-			err = regolith.InstallAll(force, update, burrito.PrintStackTrace, filterRefresh)
+			env, _ := cmd.Flags().GetString("env")
+			err = regolith.InstallAll(force, update, burrito.PrintStackTrace, filterRefresh, env)
 		},
 	}
 	cmdInstallAll.Flags().BoolVarP(
@@ -288,10 +296,13 @@ func main() {
 		Long:  regolithRunDesc,
 		Run: func(cmd *cobra.Command, args []string) {
 			var profile string
+			var extraFilterArgs []string
 			if len(args) != 0 {
 				profile = args[0]
+				extraFilterArgs = args[1:]
 			}
-			err = regolith.Run(profile, burrito.PrintStackTrace)
+			env, _ := cmd.Flags().GetString("env")
+			err = regolith.Run(profile, extraFilterArgs, burrito.PrintStackTrace, env)
 		},
 	}
 	subcommands = append(subcommands, cmdRun)
@@ -303,10 +314,13 @@ func main() {
 		Long:  regolithWatchDesc,
 		Run: func(cmd *cobra.Command, args []string) {
 			var profile string
+			var extraFilterArgs []string
 			if len(args) != 0 {
 				profile = args[0]
+				extraFilterArgs = args[1:]
 			}
-			err = regolith.Watch(profile, burrito.PrintStackTrace)
+			env, _ := cmd.Flags().GetString("env")
+			err = regolith.Watch(profile, extraFilterArgs, burrito.PrintStackTrace, env)
 		},
 	}
 	subcommands = append(subcommands, cmdWatch)
@@ -323,7 +337,8 @@ func main() {
 			}
 			filter := args[0]
 			filterArgs := args[1:] // First arg is the filter name
-			err = regolith.ApplyFilter(filter, filterArgs, burrito.PrintStackTrace)
+			env, _ := cmd.Flags().GetString("env")
+			err = regolith.ApplyFilter(filter, filterArgs, burrito.PrintStackTrace, env)
 		},
 	}
 	subcommands = append(subcommands, cmdApplyFilter)
@@ -334,13 +349,12 @@ func main() {
 		Short: " Print or modify the user configuration.",
 		Long:  regolithConfigDesc,
 		Run: func(cmd *cobra.Command, args []string) {
-			regolith.InitLogging(burrito.PrintStackTrace)
-			defer regolith.ShutdownLogging()
 			full, _ := cmd.Flags().GetBool("full")
 			delete, _ := cmd.Flags().GetBool("delete")
 			append, _ := cmd.Flags().GetBool("append")
 			index, _ := cmd.Flags().GetInt("index")
-			err = regolith.ManageConfig(burrito.PrintStackTrace, full, delete, append, index, args)
+			env, _ := cmd.Flags().GetString("env")
+			err = regolith.ManageConfig(burrito.PrintStackTrace, full, delete, append, index, args, env)
 		},
 	}
 	cmdConfig.Flags().BoolP("full", "f", false, "When printing, prints the full configuration including default values.")
@@ -356,7 +370,8 @@ func main() {
 		Short: "Cleans Regolith cache",
 		Long:  regolithCleanDesc,
 		Run: func(cmd *cobra.Command, _ []string) {
-			err = regolith.Clean(burrito.PrintStackTrace, userCache, filterCache)
+			env, _ := cmd.Flags().GetString("env")
+			err = regolith.Clean(burrito.PrintStackTrace, userCache, filterCache, env)
 		},
 	}
 	cmdClean.Flags().BoolVarP(
@@ -373,7 +388,8 @@ func main() {
 		Short: "Updates cached resolver repositories",
 		Long:  regolithUpdateResolversDesc,
 		Run: func(cmd *cobra.Command, _ []string) {
-			err = regolith.UpdateResolvers(burrito.PrintStackTrace)
+			env, _ := cmd.Flags().GetString("env")
+			err = regolith.UpdateResolvers(burrito.PrintStackTrace, env)
 		},
 	}
 	subcommands = append(subcommands, cmdUpdateResolvers)

regolith/config.go

@@ -7,7 +7,7 @@ import (
 	"golang.org/x/mod/semver"
 )
 
-const latestCompatibleVersion = "1.6.0"
+const latestCompatibleVersion = "1.7.0"
 
 const StandardLibraryUrl = "github.com/Bedrock-OSS/regolith-filters"
 const ConfigFilePath = "config.json"

regolith/env_loader.go

@@ -0,0 +1,96 @@
+package regolith
+
+import (
+	"bufio"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/Bedrock-OSS/go-burrito/burrito"
+)
+
+// loadEnvFileFromArg loads environment variables from a .env file specified by the env argument.
+// If env is empty, loads from ".env" in the current directory.
+// Variables already present in the environment are not overwritten (standard priority).
+// Returns an error if the file cannot be read (other than not existing).
+func loadEnvFileFromArg(env string) error {
+	envPath := ".env"
+	if env != "" {
+		envPath = env
+	}
+	return LoadEnvFileFromPath(envPath)
+}
+
+// LoadEnvFileFromPath loads environment variables from a .env file at a specified path.
+// Variables already present in the environment are not overwritten (standard priority).
+// Returns an error if the file cannot be read (other than not existing).
+func LoadEnvFileFromPath(envFilePath string) error {
+	// Resolve the path to be absolute
+	absPath, err := filepath.Abs(envFilePath)
+	if err != nil {
+		return burrito.WrapErrorf(err, filepathAbsError, envFilePath)
+	}
+
+	// Check if the file exists
+	if _, err := os.Stat(absPath); os.IsNotExist(err) {
+		// File doesn't exist, which is fine - silently return
+		return nil
+	} else if err != nil {
+		return burrito.WrapErrorf(err, osStatErrorAny, absPath)
+	}
+
+	// Open the .env file
+	file, err := os.Open(absPath)
+	if err != nil {
+		return burrito.WrapErrorf(err, osOpenError, absPath)
+	}
+	defer file.Close()
+
+	// Parse and load environment variables
+	scanner := bufio.NewScanner(file)
+
+	for scanner.Scan() {
+		line := scanner.Text()
+
+		// Skip empty lines and comments
+		line = strings.TrimSpace(line)
+		if line == "" || strings.HasPrefix(line, "#") {
+			continue
+		}
+
+		// Parse key=value pair
+		parts := strings.SplitN(line, "=", 2)
+		if len(parts) != 2 {
+			continue // Skip malformed lines
+		}
+
+		key := strings.TrimSpace(parts[0])
+		value := strings.TrimSpace(parts[1])
+
+		// Remove quotes if present
+		if len(value) >= 2 {
+			if (strings.HasPrefix(value, "\"") && strings.HasSuffix(value, "\"")) ||
+				(strings.HasPrefix(value, "'") && strings.HasSuffix(value, "'")) {
+				value = value[1 : len(value)-1]
+			}
+		}
+
+		// Only set the variable if it's not already set (standard priority)
+		if _, exists := os.LookupEnv(key); !exists {
+			err := os.Setenv(key, value)
+			if err != nil {
+				return burrito.WrapErrorf(
+					err,
+					"Failed to set environment variable:\nKey: %s\nValue: %s",
+					key, value,
+				)
+			}
+		}
+	}
+
+	if err := scanner.Err(); err != nil {
+		return burrito.WrapErrorf(err, fileReadError, absPath)
+	}
+
+	return nil
+}

regolith/errors.go

@@ -261,4 +261,11 @@ const (
 
 	updatedFilesDumpError = "Failed to update the list of the files edited by Regolith." +
 		"This may cause the next run to fail."
+
+	invalidArgumentModeError = "The extraArguments property of a filter is invalid:\n" +
+		"Current value: %q\n" +
+		"Valid values are: %s"
+
+	loadEnvFileFromArgError = "Failed to the file with environment variables:\n" +
+		"File path: %s"
 )

regolith/evaluator.go

@@ -1,7 +1,9 @@
 package regolith
 
 import (
+	"os"
 	"runtime"
+	"strings"
 
 	"github.com/Bedrock-OSS/go-burrito/burrito"
 	"github.com/stirante/go-simple-eval/eval"
@@ -51,6 +53,13 @@ func prepareScope(ctx RunContext) map[string]any {
 	if ctx.IsInWatchMode() {
 		mode = "watch"
 	}
+	// Collect all environment variables
+	envVars := make(map[string]any)
+	for _, env := range os.Environ() {
+		if pair := strings.SplitN(env, "=", 2); len(pair) == 2 {
+			envVars[pair[0]] = pair[1]
+		}
+	}
 	return map[string]any{
 		"os":             runtime.GOOS,
 		"arch":           runtime.GOARCH,
@@ -61,6 +70,8 @@ func prepareScope(ctx RunContext) map[string]any {
 		"settings":       ctx.Settings,
 		"project":        projectData,
 		"mode":           mode,
+		"nested":         ctx.Parent != nil,
 		"initial":        ctx.Initial,
+		"env":            envVars,
 	}
 }

regolith/export.go

@@ -26,7 +26,7 @@ func GetExportPaths(
 	if semver.Compare(vFormatVersion, "v1.4.0") < 0 {
 		bpPath, rpPath, err = getExportPathsV1_2_0(
 			exportTarget, bpName, rpName)
-	} else if semver.Compare(vFormatVersion, "v1.6.0") <= 0 {
+	} else if semver.Compare(vFormatVersion, "v1.7.0") <= 0 {
 		bpPath, rpPath, err = getExportPathsV1_4_0(
 			exportTarget, bpName, rpName)
 	} else {

regolith/filter.go

@@ -12,12 +12,13 @@ type FilterDefinition struct {
 }
 
 type Filter struct {
-	Id          string         `json:"filter,omitempty"`
-	Description string         `json:"name,omitempty"`
-	Disabled    bool           `json:"disabled,omitempty"`
-	Arguments   []string       `json:"arguments,omitempty"`
-	Settings    map[string]any `json:"settings,omitempty"`
-	When        string         `json:"when,omitempty"`
+	Id                 string         `json:"filter,omitempty"`
+	Description        string         `json:"name,omitempty"`
+	Disabled           bool           `json:"disabled,omitempty"`
+	Arguments          []string       `json:"arguments,omitempty"`
+	Settings           map[string]any `json:"settings,omitempty"`
+	When               string         `json:"when,omitempty"`
+	ExtraArgumentsMode string         `json:"extraArguments,omitempty"`
 }
 
 type RunContext struct {
@@ -28,6 +29,7 @@ type RunContext struct {
 	Parent           *RunContext
 	DotRegolithPath  string
 	Settings         map[string]any
+	ExtraArguments   []string
 
 	// interruption is a channel used to receive notifications about changes
 	// in the source files, in order to trigger a restart of the program in
@@ -154,6 +156,17 @@ func filterFromObject(obj map[string]any, id string) (*Filter, error) {
 		id = parsedId
 	}
 	filter.Id = id
+
+	// extraArguments mode
+	extraArguments, ok := obj["extraArguments"]
+	if ok {
+		extraArguments, ok := extraArguments.(string)
+		if !ok {
+			return nil, burrito.WrappedErrorf(jsonPropertyTypeError, "extraArguments", "string")
+		}
+		filter.ExtraArgumentsMode = extraArguments
+	}
+
 	return filter, nil
 }
 
@@ -190,6 +203,10 @@ type FilterRunner interface {
 	// IsUsingDataExport returns whether the filter wants its data to be
 	// exported back to the data folder after running the profile.
 	IsUsingDataExport(dotRegolithPath string, ctx RunContext) (bool, error)
+
+	// AddExtraArguments adds additional arguments to the filter according to
+	// the method provided in the filter runner settings
+	AddExtraArguments(extraArguments []string) error
 }
 
 func (f *Filter) CopyArguments(parent *RemoteFilter) {
@@ -234,6 +251,22 @@ func (f *Filter) IsUsingDataExport(_ string, _ RunContext) (bool, error) {
 	return false, nil
 }
 
+func (f *Filter) AddExtraArguments(extraArguments []string) error {
+	switch f.ExtraArgumentsMode {
+	case "", "ignore":
+	case "override":
+		f.Arguments = extraArguments
+	case "append":
+		f.Arguments = append(f.Arguments, extraArguments...)
+	default:
+		return burrito.WrappedErrorf(
+			invalidArgumentModeError,
+			// current value; valid values
+			f.ExtraArgumentsMode, "ignore, override, append")
+	}
+	return nil
+}
+
 type filterInstallerFactory struct {
 	constructor func(string, map[string]any) (FilterInstaller, error)
 	name        string
@@ -317,11 +350,31 @@ func FilterInstallerFromObject(id string, obj map[string]any) (FilterInstaller,
 }
 
 func FilterRunnerFromObjectAndDefinitions(
-	obj map[string]any, filterDefinitions map[string]FilterInstaller,
+	obj map[string]any,
+	filterDefinitions map[string]FilterInstaller,
+	isInAsyncFilter bool,
 ) (FilterRunner, error) {
 	profile, ok := obj["profile"].(string)
 	if ok {
-		return &ProfileFilter{Profile: profile}, nil
+		// For profile filters, we pass the profile name as the ID since there's no "filter" property
+		basicFilter, err := filterFromObject(obj, profile)
+		if err != nil {
+			return nil, burrito.WrapError(err, filterFromObjectError)
+		}
+		return &ProfileFilter{
+			Filter:  *basicFilter,
+			Profile: profile,
+		}, nil
+	}
+	if !isInAsyncFilter {
+		_, ok := obj["asyncFilters"]
+		if ok {
+			asyncFilter, err := AsyncFilterFromObject(obj, filterDefinitions)
+			if err != nil {
+				return nil, burrito.PassError(err)
+			}
+			return asyncFilter, nil
+		}
 	}
 	filterObj, ok := obj["filter"]
 	if !ok {