Skip to content

Commit

Permalink
adds: line no support
Browse files Browse the repository at this point in the history
  • Loading branch information
@Rchanger
Rchanger committed Jul 15, 2021
1 parent 79a6294 commit bc7a27d
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 77 deletions.
30 changes: 24 additions & 6 deletions pkg/iac-providers/docker/v1/load-dir.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,18 +60,36 @@ func (dc *DockerV1) LoadIacDir(absRootDir string, nonRecursive bool) (output.All
if err != nil {
zap.S().Debug("error while getting the relative path for", zap.String("IAC file", file), zap.Error(err))
}
skipRules := utils.GetSkipRules(comments)

dockerCommand := []string{}
for j := 0; j < len(data); j++ {
dockerCommand = append(dockerCommand, data[j].Cmd)
config := output.ResourceConfig{
Name: *files[i],
Type: data[j].Cmd,
Line: data[j].Line,
ID: data[j].Cmd + "." + GetresourceIdforDockerfile(file, data[j].Value),
Source: sourcePath,
Config: data[j].Value,
SkipRules: skipRules,
MinSeverity: minSeverity,
MaxSeverity: maxSeverity,
}
allResourcesConfig[data[j].Cmd] = append(allResourcesConfig[data[j].Cmd], config)

}
config := output.ResourceConfig{
Name: *files[i],
Type: resourceTypeDockerfile,
Line: 1,
ID: dockerDirectory + "." + GetresourceIdforDockerfile(file),
ID: dockerDirectory + "." + GetresourceIdforDockerfile(file, ""),
Source: sourcePath,
Config: data,
SkipRules: utils.GetSkipRules(comments),
Config: dockerCommand,
SkipRules: skipRules,
MinSeverity: minSeverity,
MaxSeverity: maxSeverity,
}

allResourcesConfig[dockerDirectory] = append(allResourcesConfig[dockerDirectory], config)
}
}
Expand All @@ -81,9 +99,9 @@ func (dc *DockerV1) LoadIacDir(absRootDir string, nonRecursive bool) (output.All
}

// GetresourceIdforDockerfile Generates hash of the string to be used as the reference id for docker file
func GetresourceIdforDockerfile(filepath string) (referenceID string) {
func GetresourceIdforDockerfile(filepath string, value string) (referenceID string) {
hasher := md5.New()
hasher.Write([]byte(filepath))
hasher.Write([]byte(filepath + value))
referenceID = strings.ToLower(hex.EncodeToString(hasher.Sum(nil)))
return
}
25 changes: 22 additions & 3 deletions pkg/iac-providers/docker/v1/load-file.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,33 @@ func (dc *DockerV1) LoadIacFile(absFilePath string) (allResourcesConfig output.A
return allResourcesConfig, errors.New(errMsg)
}
minSeverity, maxSeverity := utils.GetMinMaxSeverity(comments)
skipRules := utils.GetSkipRules(comments)

dockerCommand := []string{}
for i := 0; i < len(data); i++ {
dockerCommand = append(dockerCommand, data[i].Cmd)
config := output.ResourceConfig{
Name: filepath.Base(absFilePath),
Type: data[i].Cmd,
Line: data[i].Line,
ID: data[i].Cmd + "." + GetresourceIdforDockerfile(absFilePath, data[i].Value),
Source: filepath.Base(absFilePath),
Config: data[i].Value,
SkipRules: skipRules,
MinSeverity: minSeverity,
MaxSeverity: maxSeverity,
}
allResourcesConfig[data[i].Cmd] = append(allResourcesConfig[data[i].Cmd], config)

}
config := output.ResourceConfig{
Name: filepath.Base(absFilePath),
Type: resourceTypeDockerfile,
Line: 1,
ID: dockerDirectory + "." + GetresourceIdforDockerfile(absFilePath),
ID: dockerDirectory + "." + GetresourceIdforDockerfile(absFilePath, ""),
Source: filepath.Base(absFilePath),
Config: data,
SkipRules: utils.GetSkipRules(comments),
Config: dockerCommand,
SkipRules: skipRules,
MinSeverity: minSeverity,
MaxSeverity: maxSeverity,
}
Expand Down
82 changes: 16 additions & 66 deletions pkg/iac-providers/docker/v1/parser.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,32 +21,16 @@ import (
"io/ioutil"
"strings"

"github.com/moby/buildkit/frontend/dockerfile/command"
"github.com/moby/buildkit/frontend/dockerfile/instructions"
"github.com/moby/buildkit/frontend/dockerfile/parser"
"go.uber.org/zap"
)

// DockerConfig holds configuration of dockerfile
type DockerConfig struct {
Args []string `json:"args"`
Cmd []string `json:"cmd"`
From []string `json:"from"`
Labels []string `json:"labels"`
Run []string `json:"run"`
Expose []string `json:"expose"`
Env []string `json:"env"`
Add []string `json:"add"`
Copy []string `json:"copy"`
Entrypoint []string `json:"entrypoint"`
Volume []string `json:"volume"`
User []string `json:"user"`
WorkDir []string `json:"work_dir"`
Onbuild []string `json:"onBuild"`
Maintainer []string `json:"maintainer"`
HealthCheck []string `json:"healthCheck"`
Shell []string `json:"shell"`
StopSignal []string `json:"stopSignal"`
// ResourceConfig holds information about individual docker instructions
type ResourceConfig struct {
Cmd string `json:"cmd"`
Value string `json:"value"`
Line int `json:"line"`
}

const (
Expand All @@ -62,26 +46,26 @@ func (dc *DockerV1) ValidateInstruction(node *parser.Node) error {
}

// Parse parses the given dockerfile and gives docker config.
func (dc *DockerV1) Parse(filepath string) (DockerConfig, string, error) {
dockerConfig := DockerConfig{}
func (dc *DockerV1) Parse(filepath string) ([]ResourceConfig, string, error) {
config := []ResourceConfig{}
data, err := ioutil.ReadFile(filepath)
comments := ""
if err != nil {
zap.S().Error("error loading docker file", filepath, zap.Error(err))
return DockerConfig{}, "", err
return []ResourceConfig{}, "", err
}
r := bytes.NewReader(data)
res, err := parser.Parse(r)
if err != nil {
zap.S().Errorf("error while parsing iac file", filepath, zap.Error(err))
return DockerConfig{}, "", err
return []ResourceConfig{}, "", err
}

for _, child := range res.AST.Children {
values := []string{}
err = dc.ValidateInstruction(child)
if err != nil {
return DockerConfig{}, "", err
return []ResourceConfig{}, "", err
}

for _, comment := range child.PrevComment {
Expand All @@ -92,46 +76,12 @@ func (dc *DockerV1) Parse(filepath string) (DockerConfig, string, error) {
values = append(values, i.Value)
}
value := strings.Join(values, stringJoinCharacter)
switch child.Value {
case command.Arg:
dockerConfig.Args = append(dockerConfig.Args, value)
case command.Cmd:
dockerConfig.Cmd = append(dockerConfig.Cmd, value)
case command.From:
dockerConfig.From = append(dockerConfig.From, value)
case command.Label:
dockerConfig.Labels = append(dockerConfig.Labels, value)
case command.Run:
dockerConfig.Run = append(dockerConfig.Run, value)
case command.Expose:
dockerConfig.Expose = append(dockerConfig.Expose, value)
case command.Env:
dockerConfig.Env = append(dockerConfig.Env, value)
case command.Add:
dockerConfig.Add = append(dockerConfig.Add, value)
case command.Copy:
dockerConfig.Copy = append(dockerConfig.Copy, value)
case command.Entrypoint:
dockerConfig.Entrypoint = append(dockerConfig.Entrypoint, value)
case command.Volume:
dockerConfig.Volume = append(dockerConfig.Volume, value)
case command.User:
dockerConfig.User = append(dockerConfig.User, value)
case command.Workdir:
dockerConfig.WorkDir = append(dockerConfig.WorkDir, value)
case command.Onbuild:
dockerConfig.Onbuild = append(dockerConfig.Onbuild, value)
case command.Healthcheck:
dockerConfig.HealthCheck = append(dockerConfig.HealthCheck, value)
case command.Maintainer:
dockerConfig.Maintainer = append(dockerConfig.Maintainer, value)
case command.Shell:
dockerConfig.Shell = append(dockerConfig.Shell, value)
case command.StopSignal:
dockerConfig.StopSignal = append(dockerConfig.StopSignal, value)
default:
zap.S().Errorf("Unknow command %s", child.Value, nil)
tempConfig := ResourceConfig{
Cmd: child.Value,
Value: value,
Line: child.StartLine,
}
config = append(config, tempConfig)
}
return dockerConfig, comments, nil
return config, comments, nil
}
5 changes: 3 additions & 2 deletions pkg/iac-providers/docker/v1/parser_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,21 @@ func TestParse(t *testing.T) {
name string
filePath string
dockerv1 DockerV1
want DockerConfig
want []ResourceConfig
wantErr error
}{
{
name: "valid docker file",
filePath: filepath.Join(fileTestDataDir, "dockerfile-testparse-function"),
dockerv1: DockerV1{},
wantErr: nil,
want: DockerConfig{Args: []string{"name=defaultValue"}, Cmd: []string{"server"}, From: []string{"runatlantis/atlantis:v0.16.1"}, Labels: []string{"key \"value\""}, Run: []string{"mkdir -p /etc/atlantis/ && chmod +x /usr/local/bin/*.sh && /usr/local/bin/setup.sh", "terrascan init"}, Expose: []string{"9090"}, Env: []string{"DEFAULT_TERRASCAN_VERSION 1.5.1", "PLANFILE tfplan"}, Add: []string{"setup.sh terrascan.sh launch-atlantis.sh entrypoint.sh /usr/local/bin/"}, Copy: []string{"terrascan-workflow.yaml /etc/atlantis/workflow.yaml"}, Entrypoint: []string{"/bin/bash entrypoint.sh"}, Volume: []string{"/temp"}, User: []string{"atlantis"}, WorkDir: []string{"test"}, Onbuild: []string{""}, Maintainer: []string{"accurics"}, HealthCheck: []string{"CMD executable"}, Shell: []string{"cd"}, StopSignal: []string{"1"}},
want: []ResourceConfig{{Cmd: "from", Value: "runatlantis/atlantis:v0.16.1", Line: 1}, {Cmd: "maintainer", Value: "accurics", Line: 2}, {Cmd: "label", Value: "key \"value\"", Line: 3}, {Cmd: "workdir", Value: "test", Line: 4}, {Cmd: "env", Value: "DEFAULT_TERRASCAN_VERSION 1.5.1", Line: 5}, {Cmd: "env", Value: "PLANFILE tfplan", Line: 6}, {Cmd: "add", Value: "setup.sh terrascan.sh launch-atlantis.sh entrypoint.sh /usr/local/bin/", Line: 7}, {Cmd: "run", Value: "mkdir -p /etc/atlantis/ && chmod +x /usr/local/bin/*.sh && /usr/local/bin/setup.sh", Line: 8}, {Cmd: "copy", Value: "terrascan-workflow.yaml /etc/atlantis/workflow.yaml", Line: 11}, {Cmd: "user", Value: "atlantis", Line: 13}, {Cmd: "arg", Value: "name=defaultValue", Line: 14}, {Cmd: "run", Value: "terrascan init", Line: 15}, {Cmd: "volume", Value: "/temp", Line: 16}, {Cmd: "healthcheck", Value: "CMD executable", Line: 17}, {Cmd: "entrypoint", Value: "/bin/bash entrypoint.sh", Line: 18}, {Cmd: "shell", Value: "cd", Line: 19}, {Cmd: "onbuild", Value: "", Line: 20}, {Cmd: "expose", Value: "9090", Line: 21}, {Cmd: "stopsignal", Value: "1", Line: 22}, {Cmd: "cmd", Value: "server", Line: 23}},
},
{
name: "invalid docker file path",
filePath: filepath.Join(fileTestDataDir, "dockerfile-testparse-function1"),
dockerv1: DockerV1{},
want: []ResourceConfig{},
wantErr: fmt.Errorf("open %s: no such file or directory", filepath.Join(fileTestDataDir, "dockerfile-testparse-function1")),
},
}
Expand Down
1 change: 1 addition & 0 deletions pkg/iac-providers/docker/v1/testdata/file-test-data/dockerfile-testparse-function
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ RUN mkdir -p /etc/atlantis/ && \
chmod +x /usr/local/bin/*.sh && \
/usr/local/bin/setup.sh
Copy terrascan-workflow.yaml /etc/atlantis/workflow.yaml
# run as non root user
USER atlantis
ARG name=defaultValue
RUN terrascan init
Expand Down

0 comments on commit bc7a27d

Please sign in to comment.