Define dockerfile instructions set centrally.

Signed-off-by: Ernst von Oelsen <ernst.vonoelsen@tngtech.com>

Author: ernstvonoelsen

pkg/docker/dockerfile/ast/line_parsers.go

@@ -12,11 +12,10 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	df "github.com/mintoolkit/mint/pkg/docker/dockerfile"
 	"strings"
 	"unicode"
 	"unicode/utf8"
-
-	"github.com/mintoolkit/mint/pkg/docker/instruction"
 )
 
 type NameValError struct {
@@ -76,8 +75,8 @@ func parseSubCommand(rest string, d *Directive) (*Node, map[string]bool, error)
 	return &Node{Children: []*Node{child}}, nil, nil
 }
 
-// helper to parse words (i.e space delimited or quoted strings) in a statement.
-// The quotes are preserved as part of this function and they are stripped later
+// helper to parse words (i.e. space delimited or quoted strings) in a statement.
+// The quotes are preserved as part of this function, and they are stripped later
 // as part of processWords().
 func parseWords(rest string, d *Directive) []string {
 	const (
@@ -224,12 +223,12 @@ func appendKeyValueNode(node, rootNode, prevNode *Node) (*Node, *Node) {
 }
 
 func parseEnv(rest string, d *Directive) (*Node, map[string]bool, error) {
-	node, err := parseNameVal(rest, instruction.Env, d)
+	node, err := parseNameVal(rest, df.InstTypeEnv, d)
 	return node, nil, err
 }
 
 func parseLabel(rest string, d *Directive) (*Node, map[string]bool, error) {
-	node, err := parseNameVal(rest, instruction.Label, d)
+	node, err := parseNameVal(rest, df.InstTypeLabel, d)
 	return node, nil, err
 }
 

pkg/docker/dockerfile/ast/parser.go

@@ -7,13 +7,13 @@ import (
 	"bufio"
 	"bytes"
 	"fmt"
+	df "github.com/mintoolkit/mint/pkg/docker/dockerfile"
 	"io"
 	"regexp"
 	"strconv"
 	"strings"
 	"unicode"
 
-	"github.com/mintoolkit/mint/pkg/docker/instruction"
 	"github.com/pkg/errors"
 )
 
@@ -190,24 +190,24 @@ func init() {
 	// functions. Errors are propagated up by Parse() and the resulting AST can
 	// be incorporated directly into the existing AST as a next.
 	dispatch = map[string]func(string, *Directive) (*Node, map[string]bool, error){
-		instruction.Add:         parseMaybeJSONToList,
-		instruction.Arg:         parseNameOrNameVal,
-		instruction.Cmd:         parseMaybeJSON,
-		instruction.Copy:        parseMaybeJSONToList,
-		instruction.Entrypoint:  parseMaybeJSON,
-		instruction.Env:         parseEnv,
-		instruction.Expose:      parseStringsWhitespaceDelimited,
-		instruction.From:        parseStringsWhitespaceDelimited,
-		instruction.Healthcheck: parseHealthConfig,
-		instruction.Label:       parseLabel,
-		instruction.Maintainer:  parseString,
-		instruction.Onbuild:     parseSubCommand,
-		instruction.Run:         parseMaybeJSON,
-		instruction.Shell:       parseMaybeJSON,
-		instruction.StopSignal:  parseString,
-		instruction.User:        parseString,
-		instruction.Volume:      parseMaybeJSONToList,
-		instruction.Workdir:     parseString,
+		df.InstTypeAdd:         parseMaybeJSONToList,
+		df.InstTypeArg:         parseNameOrNameVal,
+		df.InstTypeCmd:         parseMaybeJSON,
+		df.InstTypeCopy:        parseMaybeJSONToList,
+		df.InstTypeEntrypoint:  parseMaybeJSON,
+		df.InstTypeEnv:         parseEnv,
+		df.InstTypeExpose:      parseStringsWhitespaceDelimited,
+		df.InstTypeFrom:        parseStringsWhitespaceDelimited,
+		df.InstTypeHealthcheck: parseHealthConfig,
+		df.InstTypeLabel:       parseLabel,
+		df.InstTypeMaintainer:  parseString,
+		df.InstTypeOnbuild:     parseSubCommand,
+		df.InstTypeRun:         parseMaybeJSON,
+		df.InstTypeShell:       parseMaybeJSON,
+		df.InstTypeStopSignal:  parseString,
+		df.InstTypeUser:        parseString,
+		df.InstTypeVolume:      parseMaybeJSONToList,
+		df.InstTypeWorkdir:     parseString,
 	}
 }
 

pkg/docker/dockerfile/ast/split_command.go

@@ -15,7 +15,7 @@ func splitCommand(line string) (string, []string, string, error) {
 
 	// Make sure we get the same results irrespective of leading/trailing spaces
 	cmdline := tokenWhitespace.Split(strings.TrimSpace(line), 2)
-	cmd := strings.ToLower(cmdline[0])
+	cmd := strings.ToUpper(cmdline[0])
 
 	if len(cmdline) == 2 {
 		var err error

pkg/docker/dockerfile/dockerfile.go

@@ -15,37 +15,47 @@ import (
 	v "github.com/mintoolkit/mint/pkg/version"
 )
 
-// note: dup (todo: refactor)
 const (
+	//FROM
+	InstTypeFrom = "FROM"
 	//MAINTAINER:
-	instPrefixMaintainer = "MAINTAINER "
+	InstTypeMaintainer   = "MAINTAINER"
+	InstPrefixMaintainer = "MAINTAINER "
 	//ENTRYPOINT:
-	instTypeEntrypoint   = "ENTRYPOINT"
-	instPrefixEntrypoint = "ENTRYPOINT "
+	InstTypeEntrypoint   = "ENTRYPOINT"
+	InstPrefixEntrypoint = "ENTRYPOINT "
 	//CMD:
-	instTypeCmd   = "CMD"
-	instPrefixCmd = "CMD "
+	InstTypeCmd   = "CMD"
+	InstPrefixCmd = "CMD "
 	//USER:
-	instTypeUser   = "USER"
-	instPrefixUser = "USER "
+	InstTypeUser   = "USER"
+	InstPrefixUser = "USER "
 	//EXPOSE:
-	instTypeExpose   = "EXPOSE"
-	instPrefixExpose = "EXPOSE "
+	InstTypeExpose   = "EXPOSE"
+	InstPrefixExpose = "EXPOSE "
 	//WORKDIR:
-	instTypeWorkdir   = "WORKDIR"
-	instPrefixWorkdir = "WORKDIR "
+	InstTypeWorkdir   = "WORKDIR"
+	InstPrefixWorkdir = "WORKDIR "
 	//HEALTHCHECK:
-	instTypeHealthcheck   = "HEALTHCHECK"
-	instPrefixHealthcheck = "HEALTHCHECK "
+	InstTypeHealthcheck           = "HEALTHCHECK"
+	InstPrefixHealthcheck         = "HEALTHCHECK "
+	InstPrefixBasicEncHealthcheck = "HEALTHCHECK --"
 	//ONBUILD:
-	instTypeOnbuild = "ONBUILD"
+	InstTypeOnbuild = "ONBUILD"
 	//RUN:
-	instTypeRun   = "RUN"
-	instPrefixRun = "RUN "
+	InstTypeRun   = "RUN"
+	InstPrefixRun = "RUN "
 	//ADD:
-	instTypeAdd = "ADD"
+	InstTypeAdd = "ADD"
 	//COPY:
-	instTypeCopy = "COPY"
+	InstTypeCopy = "COPY"
+
+	InstTypeVolume     = "VOLUME"
+	InstTypeEnv        = "ENV"
+	InstTypeLabel      = "LABEL"
+	InstTypeStopSignal = "STOPSIGNAL"
+	InstTypeShell      = "SHELL"
+	InstTypeArg        = "ARG" //shouldn't see it as a standalone instruction
 )
 
 // GenerateFromInfo builds and saves a Dockerfile file object
@@ -115,20 +125,20 @@ func GenerateFromInfo(
 	}
 
 	if workingDir != "" {
-		dfData.WriteString(instPrefixWorkdir)
+		dfData.WriteString(InstPrefixWorkdir)
 		dfData.WriteString(workingDir)
 		dfData.WriteByte('\n')
 	}
 
 	if user != "" {
-		dfData.WriteString(instPrefixUser)
+		dfData.WriteString(InstPrefixUser)
 		dfData.WriteString(user)
 		dfData.WriteByte('\n')
 	}
 
 	if len(exposedPorts) > 0 {
 		for portInfo := range exposedPorts {
-			dfData.WriteString(instPrefixExpose)
+			dfData.WriteString(InstPrefixExpose)
 			dfData.WriteString(string(portInfo))
 			dfData.WriteByte('\n')
 		}

pkg/docker/dockerfile/parser/parser.go

@@ -3,6 +3,7 @@ package parser
 
 import (
 	"errors"
+	df "github.com/mintoolkit/mint/pkg/docker/dockerfile"
 	"os"
 	"path/filepath"
 	"strconv"
@@ -71,7 +72,7 @@ func FromFile(fpath string) (*spec.Dockerfile, error) {
 				inst.Errors = append(inst.Errors, node.Errors...)
 			}
 
-			if inst.Name == instruction.Onbuild &&
+			if inst.Name == df.InstTypeOnbuild &&
 				node.Next != nil &&
 				len(node.Next.Children) > 0 {
 				inst.IsOnBuild = true
@@ -89,7 +90,7 @@ func FromFile(fpath string) (*spec.Dockerfile, error) {
 				inst.IsJSONForm = true
 			}
 
-			if inst.Name == instruction.From {
+			if inst.Name == df.InstTypeFrom {
 				currentStage = spec.NewBuildStage()
 				currentStage.FromInstruction = inst
 				currentStage.Index = len(dockerfile.Stages)
@@ -219,9 +220,9 @@ func FromFile(fpath string) (*spec.Dockerfile, error) {
 				inst.StageIndex = instStageIndex
 				currentStage.AllInstructions = append(currentStage.AllInstructions, inst)
 
-				if inst.Name == instruction.Onbuild {
+				if inst.Name == df.InstTypeOnbuild {
 					currentStage.OnBuildInstructions = append(currentStage.OnBuildInstructions, inst)
-				} else if inst.Name == instruction.Copy {
+				} else if inst.Name == df.InstTypeCopy {
 					for _, flag := range inst.Flags {
 						if strings.HasPrefix(flag, "--from=") {
 							fparts := strings.SplitN(flag, "=", 2)
@@ -252,7 +253,7 @@ func FromFile(fpath string) (*spec.Dockerfile, error) {
 
 					if inst.IsValid {
 						switch inst.Name {
-						case instruction.Arg:
+						case df.InstTypeArg:
 							for _, iarg := range inst.Args {
 								if iarg == "" {
 									continue
@@ -268,7 +269,7 @@ func FromFile(fpath string) (*spec.Dockerfile, error) {
 							//only one ARG is supposed to be defined, but we'll use all
 							//the 'ARG' value count lint check will detect the extra values
 							//the k=v ARG values are also not parsed (unlike ENV k=v values)
-						case instruction.Env:
+						case df.InstTypeEnv:
 							for i := 0; i < len(inst.Args) && (i+1) < len(inst.Args); i += 2 {
 								if len(inst.Args[i]) == 0 {
 									continue
@@ -280,7 +281,7 @@ func FromFile(fpath string) (*spec.Dockerfile, error) {
 					}
 				}
 			} else {
-				if inst.Name == instruction.Arg {
+				if inst.Name == df.InstTypeArg {
 					if inst.IsValid && len(inst.Args) > 0 {
 						dockerfile.ArgInstructions = append(dockerfile.ArgInstructions, inst)
 						parts := strings.Split(inst.Args[0], "=")

pkg/docker/dockerfile/parser/parser_test.go

@@ -0,0 +1,25 @@
+package parser
+
+import (
+	"github.com/stretchr/testify/require"
+	"os"
+	"testing"
+)
+
+func TestFromFile(t *testing.T) {
+	tmpFile, err := os.CreateTemp(".", "Dockerfile")
+	require.NoError(t, err)
+	defer os.Remove(tmpFile.Name())
+
+	for _, s := range []string{"MAINTAINER", "Maintainer", "maintainer"} {
+		tmpFile.WriteString(s + " author@example.com")
+		Dockerfile, err := FromFile(tmpFile.Name())
+
+		require.NoError(t, err)
+		require.Equal(t, Dockerfile.AllInstructions[0].Name, "MAINTAINER")
+		for _, inst := range Dockerfile.AllInstructions {
+			require.Equal(t, inst.IsValid, true)
+			require.Equal(t, inst.Errors, []string(nil))
+		}
+	}
+}