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.

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

Support for buildArgs on Docker builds #2266

Merged
merged 5 commits into from
Jun 1, 2023
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
62 changes: 4 additions & 58 deletions cli/azd/pkg/exec/command_runner.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import (
"os"
"os/exec"
"path/filepath"
"regexp"
"runtime"
"strings"
)
Expand Down Expand Up @@ -135,8 +134,8 @@ func (r *commandRunner) Run(ctx context.Context, args RunArgs) (RunResult, error

logTitle.WriteString(fmt.Sprintf("Run exec: '%s %s' ",
args.Cmd,
redactSensitiveData(
strings.Join(redactSensitiveArgs(args.Args, args.SensitiveData), " "))))
RedactSensitiveData(
strings.Join(RedactSensitiveArgs(args.Args, args.SensitiveData), " "))))

debugLogEnabled := r.debugLogging
if args.DebugLogging != nil {
Expand Down Expand Up @@ -174,13 +173,13 @@ func (r *commandRunner) Run(ctx context.Context, args RunArgs) (RunResult, error
}
} else {
if debugLogEnabled {
logStdOut := strings.TrimSuffix(redactSensitiveData(stdout.String()), "\n")
logStdOut := strings.TrimSuffix(RedactSensitiveData(stdout.String()), "\n")
if len(logStdOut) > 0 {
logBody.WriteString(fmt.Sprintf(
"-------------------------------------stdout-------------------------------------------\n%s\n",
logStdOut))
}
logStdErr := strings.TrimSuffix(redactSensitiveData(stderr.String()), "\n")
logStdErr := strings.TrimSuffix(RedactSensitiveData(stderr.String()), "\n")
if len(logStdErr) > 0 {
logBody.WriteString(fmt.Sprintf(
"-------------------------------------stderr-------------------------------------------\n%s\n",
Expand Down Expand Up @@ -317,56 +316,3 @@ func newCmdTree(ctx context.Context, cmd string, args []string, useShell bool, i
Cmd: exec.Command(shellName, allArgs...),
}, nil
}

type redactData struct {
matchString *regexp.Regexp
replaceString string
}

const cRedacted = "<redacted>"

func redactSensitiveArgs(args []string, sensitiveDataMatch []string) []string {
if len(sensitiveDataMatch) == 0 {
return args
}
redactedArgs := make([]string, len(args))
for i, arg := range args {
redacted := arg
for _, sensitiveData := range sensitiveDataMatch {
redacted = strings.ReplaceAll(redacted, sensitiveData, cRedacted)
}
redactedArgs[i] = redacted
}
return redactedArgs
}

func redactSensitiveData(msg string) string {
var regexpRedactRules = map[string]redactData{
"access token": {
regexp.MustCompile("\"accessToken\": \".*\""),
"\"accessToken\": \"" + cRedacted + "\"",
},
"deployment token": {
regexp.MustCompile(`--deployment-token \S+`),
"--deployment-token " + cRedacted,
},
"username": {
regexp.MustCompile(`--username \S+`),
"--username " + cRedacted,
},
"password": {
regexp.MustCompile(`--password \S+`),
"--password " + cRedacted,
},
"kubectl-from-literal": {
regexp.MustCompile(`--from-literal=([^=]+)=(\S+)`),
"--from-literal=$1=" + cRedacted,
},
}

for _, redactRule := range regexpRedactRules {
regMatchString := redactRule.matchString
msg = regMatchString.ReplaceAllString(msg, redactRule.replaceString)
}
return msg
}
63 changes: 63 additions & 0 deletions cli/azd/pkg/exec/sanitizer.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
package exec

import (
"regexp"
"strings"
)

type redactData struct {
matchString *regexp.Regexp
replaceString string
}

const cRedacted = "<redacted>"

func RedactSensitiveArgs(args []string, sensitiveDataMatch []string) []string {
if len(sensitiveDataMatch) == 0 {
return args
}
redactedArgs := make([]string, len(args))
for i, arg := range args {
redacted := arg
for _, sensitiveData := range sensitiveDataMatch {
redacted = strings.ReplaceAll(redacted, sensitiveData, cRedacted)
}
redactedArgs[i] = redacted
}
return redactedArgs
}

func RedactSensitiveData(msg string) string {
var regexpRedactRules = map[string]redactData{
"access token": {
regexp.MustCompile("\"accessToken\": \".*\""),
"\"accessToken\": \"" + cRedacted + "\"",
},
"deployment token": {
regexp.MustCompile(`--deployment-token \S+`),
"--deployment-token " + cRedacted,
},
"username": {
regexp.MustCompile(`--username \S+`),
"--username " + cRedacted,
},
"password": {
regexp.MustCompile(`--password \S+`),
"--password " + cRedacted,
},
"kubectl-from-literal": {
regexp.MustCompile(`--from-literal=([^=]+)=(\S+)`),
"--from-literal=$1=" + cRedacted,
},
"combined-arg": {
regexp.MustCompile(`(.*)=(\S+)`),
"$1=" + cRedacted,
},
}

for _, redactRule := range regexpRedactRules {
regMatchString := redactRule.matchString
msg = regMatchString.ReplaceAllString(msg, redactRule.replaceString)
}
return msg
}
2 changes: 1 addition & 1 deletion cli/azd/pkg/exec/util_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ func TestRedactSensitiveData(t *testing.T) {

for _, test := range tests {
t.Run(test.scenario, func(t *testing.T) {
actual := redactSensitiveData(test.input)
actual := RedactSensitiveData(test.input)
require.Equal(t, test.expected, actual)
})
}
Expand Down
19 changes: 14 additions & 5 deletions cli/azd/pkg/project/framework_service_docker.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,18 @@ import (

"github.com/azure/azure-dev/cli/azd/pkg/async"
"github.com/azure/azure-dev/cli/azd/pkg/environment"
"github.com/azure/azure-dev/cli/azd/pkg/exec"
"github.com/azure/azure-dev/cli/azd/pkg/output"
"github.com/azure/azure-dev/cli/azd/pkg/tools"
"github.com/azure/azure-dev/cli/azd/pkg/tools/docker"
)

type DockerProjectOptions struct {
Path string `json:"path"`
Context string `json:"context"`
Platform string `json:"platform"`
Tag ExpandableString `json:"tag"`
Path string `json:"path"`
Context string `json:"context"`
Platform string `json:"platform"`
Tag ExpandableString `json:"tag"`
BuildArgs []string `json:"buildArgs"`
}

type dockerBuildResult struct {
Expand Down Expand Up @@ -127,12 +129,18 @@ func (p *dockerProject) Build(
func(task *async.TaskContextWithProgress[*ServiceBuildResult, ServiceProgress]) {
dockerOptions := getDockerOptionsWithDefaults(serviceConfig.Docker)

buildArgs := []string{}
for _, arg := range dockerOptions.BuildArgs {
buildArgs = append(buildArgs, exec.RedactSensitiveData(arg))
}

log.Printf(
"building image for service %s, cwd: %s, path: %s, context: %s)",
"building image for service %s, cwd: %s, path: %s, context: %s, buildArgs: %s)",
wbreza marked this conversation as resolved.
Show resolved Hide resolved
serviceConfig.Name,
serviceConfig.Path(),
dockerOptions.Path,
dockerOptions.Context,
buildArgs,
)

imageName := fmt.Sprintf(
Expand All @@ -150,6 +158,7 @@ func (p *dockerProject) Build(
dockerOptions.Platform,
dockerOptions.Context,
imageName,
dockerOptions.BuildArgs,
)
if err != nil {
task.SetError(fmt.Errorf("building container: %s at %s: %w", serviceConfig.Name, dockerOptions.Context, err))
Expand Down
6 changes: 6 additions & 0 deletions cli/azd/pkg/tools/docker/docker.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ type Docker interface {
platform string,
buildContext string,
name string,
buildArgs []string,
) (string, error)
Tag(ctx context.Context, cwd string, imageName string, tag string) error
Push(ctx context.Context, cwd string, tag string) error
Expand Down Expand Up @@ -67,6 +68,7 @@ func (d *docker) Build(
platform string,
buildContext string,
tagName string,
buildArgs []string,
) (string, error) {
if strings.TrimSpace(platform) == "" {
platform = DefaultPlatform
Expand All @@ -82,6 +84,10 @@ func (d *docker) Build(
args = append(args, "-t", tagName)
}

for _, arg := range buildArgs {
args = append(args, "--build-arg", arg)
}

args = append(args, buildContext)

res, err := d.executeCommand(ctx, cwd, args...)
Expand Down