1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
|
package instructions
import (
"bytes"
"strings"
"testing"
"github.com/moby/buildkit/frontend/dockerfile/command"
"github.com/moby/buildkit/frontend/dockerfile/parser"
"github.com/stretchr/testify/require"
)
func TestCommandsExactlyOneArgument(t *testing.T) {
commands := []string{
"MAINTAINER",
"WORKDIR",
"USER",
"STOPSIGNAL",
}
for _, cmd := range commands {
ast, err := parser.Parse(strings.NewReader(cmd))
require.NoError(t, err)
_, err = ParseInstruction(ast.AST.Children[0])
require.EqualError(t, err, errExactlyOneArgument(cmd).Error())
}
}
func TestCommandsAtLeastOneArgument(t *testing.T) {
commands := []string{
"ENV",
"LABEL",
"ONBUILD",
"HEALTHCHECK",
"EXPOSE",
"VOLUME",
}
for _, cmd := range commands {
ast, err := parser.Parse(strings.NewReader(cmd))
require.NoError(t, err)
_, err = ParseInstruction(ast.AST.Children[0])
require.EqualError(t, err, errAtLeastOneArgument(cmd).Error())
}
}
func TestCommandsNoDestinationArgument(t *testing.T) {
commands := []string{
"ADD",
"COPY",
}
for _, cmd := range commands {
ast, err := parser.Parse(strings.NewReader(cmd + " arg1"))
require.NoError(t, err)
_, err = ParseInstruction(ast.AST.Children[0])
require.EqualError(t, err, errNoDestinationArgument(cmd).Error())
}
}
func TestCommandsTooManyArguments(t *testing.T) {
commands := []string{
"ENV",
"LABEL",
}
for _, cmd := range commands {
node := &parser.Node{
Original: cmd + "arg1 arg2 arg3",
Value: strings.ToLower(cmd),
Next: &parser.Node{
Value: "arg1",
Next: &parser.Node{
Value: "arg2",
Next: &parser.Node{
Value: "arg3",
},
},
},
}
_, err := ParseInstruction(node)
require.EqualError(t, err, errTooManyArguments(cmd).Error())
}
}
func TestCommandsBlankNames(t *testing.T) {
commands := []string{
"ENV",
"LABEL",
}
for _, cmd := range commands {
node := &parser.Node{
Original: cmd + " =arg2",
Value: strings.ToLower(cmd),
Next: &parser.Node{
Value: "",
Next: &parser.Node{
Value: "arg2",
},
},
}
_, err := ParseInstruction(node)
require.EqualError(t, err, errBlankCommandNames(cmd).Error())
}
}
func TestHealthCheckCmd(t *testing.T) {
node := &parser.Node{
Value: command.Healthcheck,
Next: &parser.Node{
Value: "CMD",
Next: &parser.Node{
Value: "hello",
Next: &parser.Node{
Value: "world",
},
},
},
}
cmd, err := ParseInstruction(node)
require.NoError(t, err)
hc, ok := cmd.(*HealthCheckCommand)
require.Equal(t, true, ok)
expected := []string{"CMD-SHELL", "hello world"}
require.Equal(t, expected, hc.Health.Test)
}
func TestParseOptInterval(t *testing.T) {
flInterval := &Flag{
name: "interval",
flagType: stringType,
Value: "50ns",
}
_, err := parseOptInterval(flInterval)
require.Error(t, err)
require.Contains(t, err.Error(), "cannot be less than 1ms")
flInterval.Value = "0ms"
_, err = parseOptInterval(flInterval)
require.NoError(t, err)
flInterval.Value = "1ms"
_, err = parseOptInterval(flInterval)
require.NoError(t, err)
}
func TestCommentsDetection(t *testing.T) {
dt := `# foo sets foo
ARG foo=bar
# base defines first stage
FROM busybox AS base
# this is irrelevant
ARG foo
# bar defines bar
# baz is something else
ARG bar baz=123
`
ast, err := parser.Parse(bytes.NewBuffer([]byte(dt)))
require.NoError(t, err)
stages, meta, err := Parse(ast.AST)
require.NoError(t, err)
require.Equal(t, "defines first stage", stages[0].Comment)
require.Equal(t, "foo", meta[0].Args[0].Key)
require.Equal(t, "sets foo", meta[0].Args[0].Comment)
st := stages[0]
require.Equal(t, "foo", st.Commands[0].(*ArgCommand).Args[0].Key)
require.Equal(t, "", st.Commands[0].(*ArgCommand).Args[0].Comment)
require.Equal(t, "bar", st.Commands[1].(*ArgCommand).Args[0].Key)
require.Equal(t, "defines bar", st.Commands[1].(*ArgCommand).Args[0].Comment)
require.Equal(t, "baz", st.Commands[1].(*ArgCommand).Args[1].Key)
require.Equal(t, "is something else", st.Commands[1].(*ArgCommand).Args[1].Comment)
}
func TestErrorCases(t *testing.T) {
cases := []struct {
name string
dockerfile string
expectedError string
}{
{
name: "copyEmptyWhitespace",
dockerfile: `COPY
quux \
bar`,
expectedError: "COPY requires at least two arguments",
},
{
name: "ONBUILD forbidden FROM",
dockerfile: "ONBUILD FROM scratch",
expectedError: "FROM isn't allowed as an ONBUILD trigger",
},
{
name: "MAINTAINER unknown flag",
dockerfile: "MAINTAINER --boo joe@example.com",
expectedError: "unknown flag: boo",
},
{
name: "Chaining ONBUILD",
dockerfile: `ONBUILD ONBUILD RUN touch foobar`,
expectedError: "Chaining ONBUILD via `ONBUILD ONBUILD` isn't allowed",
},
{
name: "Invalid instruction",
dockerfile: `FOO bar`,
expectedError: "unknown instruction: FOO",
},
{
name: "Invalid instruction",
dockerfile: `foo bar`,
expectedError: "unknown instruction: foo",
},
}
for _, c := range cases {
r := strings.NewReader(c.dockerfile)
ast, err := parser.Parse(r)
if err != nil {
t.Fatalf("Error when parsing Dockerfile: %s", err)
}
n := ast.AST.Children[0]
_, err = ParseInstruction(n)
require.ErrorContains(t, err, c.expectedError)
}
}
func TestRunCmdFlagsUsed(t *testing.T) {
dockerfile := "RUN --mount=type=tmpfs,target=/foo/ echo hello"
r := strings.NewReader(dockerfile)
ast, err := parser.Parse(r)
require.NoError(t, err)
n := ast.AST.Children[0]
c, err := ParseInstruction(n)
require.NoError(t, err)
require.IsType(t, c, &RunCommand{})
require.Equal(t, []string{"mount"}, c.(*RunCommand).FlagsUsed)
}
func BenchmarkParseBuildStageName(b *testing.B) {
b.ReportAllocs()
stageNames := []string{"STAGE_NAME", "StageName", "St4g3N4m3"}
for i := 0; i < b.N; i++ {
for _, s := range stageNames {
_, _ = parseBuildStageName([]string{"foo", "as", s})
}
}
}
|