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.

Sign up for GitHub

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

feat: Accept custom LookupEnv function in SubstituteVars #206

Merged
merged 1 commit into from
May 23, 2024
Merged

feat: Accept custom LookupEnv function in SubstituteVars #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 11 additions & 7 deletions devcontainer/devcontainer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ type Compiled struct {
RemoteEnv map[string]string
}

func SubstituteVars(s string, workspaceFolder string) string {
func SubstituteVars(s string, workspaceFolder string, lookupEnv func(string) (string, bool)) string {
var buf string
for {
beforeOpen, afterOpen, ok := strings.Cut(s, "${")
Expand All @@ -85,14 +85,14 @@ func SubstituteVars(s string, workspaceFolder string) string {
return buf + s
}

buf += beforeOpen + substitute(varExpr, workspaceFolder)
buf += beforeOpen + substitute(varExpr, workspaceFolder, lookupEnv)
s = afterClose
}
}

// Spec for variable substitutions:
// https://containers.dev/implementors/json_reference/#variables-in-devcontainerjson
func substitute(varExpr string, workspaceFolder string) string {
func substitute(varExpr string, workspaceFolder string, lookupEnv func(string) (string, bool)) string {
parts := strings.Split(varExpr, ":")
if len(parts) == 1 {
switch varExpr {
Expand All @@ -101,12 +101,16 @@ func substitute(varExpr string, workspaceFolder string) string {
case "localWorkspaceFolderBasename", "containerWorkspaceFolderBasename":
return filepath.Base(workspaceFolder)
default:
return os.Getenv(varExpr)
val, ok := lookupEnv(varExpr)
if ok {
return val
}
return ""
}
}
switch parts[0] {
case "env", "localEnv", "containerEnv":
if val, ok := os.LookupEnv(parts[1]); ok {
if val, ok := lookupEnv(parts[1]); ok {
return val
}
if len(parts) == 3 {
Expand All @@ -131,7 +135,7 @@ func (s Spec) HasDockerfile() bool {
// devcontainerDir is the path to the directory where the devcontainer.json file
// is located. scratchDir is the path to the directory where the Dockerfile will
// be written to if one doesn't exist.
func (s *Spec) Compile(fs billy.Filesystem, devcontainerDir, scratchDir string, fallbackDockerfile, workspaceFolder string, useBuildContexts bool) (*Compiled, error) {
func (s *Spec) Compile(fs billy.Filesystem, devcontainerDir, scratchDir string, fallbackDockerfile, workspaceFolder string, useBuildContexts bool, lookupEnv func(string) (string, bool)) (*Compiled, error) {
params := &Compiled{
User: s.ContainerUser,
ContainerEnv: s.ContainerEnv,
Expand Down Expand Up @@ -178,7 +182,7 @@ func (s *Spec) Compile(fs billy.Filesystem, devcontainerDir, scratchDir string,

buildArgs := make([]string, 0)
for _, key := range buildArgkeys {
val := SubstituteVars(s.Build.Args[key], workspaceFolder)
val := SubstituteVars(s.Build.Args[key], workspaceFolder, lookupEnv)
buildArgs = append(buildArgs, key+"="+val)
}
params.BuildArgs = buildArgs
Expand Down
6 changes: 3 additions & 3 deletions devcontainer/devcontainer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ func TestCompileWithFeatures(t *testing.T) {
dc, err := devcontainer.Parse([]byte(raw))
require.NoError(t, err)
fs := memfs.New()
params, err := dc.Compile(fs, "", magicDir, "", "", false)
params, err := dc.Compile(fs, "", magicDir, "", "", false, os.LookupEnv)
require.NoError(t, err)

// We have to SHA because we get a different MD5 every time!
Expand Down Expand Up @@ -118,7 +118,7 @@ func TestCompileDevContainer(t *testing.T) {
dc := &devcontainer.Spec{
Image: "localhost:5000/envbuilder-test-ubuntu:latest",
}
params, err := dc.Compile(fs, "", magicDir, "", "", false)
params, err := dc.Compile(fs, "", magicDir, "", "", false, os.LookupEnv)
require.NoError(t, err)
require.Equal(t, filepath.Join(magicDir, "Dockerfile"), params.DockerfilePath)
require.Equal(t, magicDir, params.BuildContext)
Expand All @@ -144,7 +144,7 @@ func TestCompileDevContainer(t *testing.T) {
_, err = io.WriteString(file, "FROM localhost:5000/envbuilder-test-ubuntu:latest")
require.NoError(t, err)
_ = file.Close()
params, err := dc.Compile(fs, dcDir, magicDir, "", "/var/workspace", false)
params, err := dc.Compile(fs, dcDir, magicDir, "", "/var/workspace", false, os.LookupEnv)
require.NoError(t, err)
require.Equal(t, "ARG1=value1", params.BuildArgs[0])
require.Equal(t, "ARG2=workspace", params.BuildArgs[1])
Expand Down
4 changes: 2 additions & 2 deletions envbuilder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ func Run(ctx context.Context, options Options) error {
options.Logger(notcodersdk.LogLevelInfo, "No Dockerfile or image specified; falling back to the default image...")
fallbackDockerfile = defaultParams.DockerfilePath
}
buildParams, err = devContainer.Compile(options.Filesystem, devcontainerDir, MagicDir, fallbackDockerfile, options.WorkspaceFolder, false)
buildParams, err = devContainer.Compile(options.Filesystem, devcontainerDir, MagicDir, fallbackDockerfile, options.WorkspaceFolder, false, os.LookupEnv)
if err != nil {
return fmt.Errorf("compile devcontainer.json: %w", err)
}
Expand Down Expand Up @@ -669,7 +669,7 @@ func Run(ctx context.Context, options Options) error {
}
sort.Strings(envKeys)
for _, envVar := range envKeys {
value := devcontainer.SubstituteVars(env[envVar], options.WorkspaceFolder)
value := devcontainer.SubstituteVars(env[envVar], options.WorkspaceFolder, os.LookupEnv)
os.Setenv(envVar, value)
}
}
Expand Down