2016-12-23 14:09:12 -05:00
package container
import (
"fmt"
"io/ioutil"
"os"
"runtime"
"strings"
"testing"
"time"
"github.com/docker/docker/api/types/container"
networktypes "github.com/docker/docker/api/types/network"
"github.com/docker/go-connections/nat"
2017-03-09 13:23:45 -05:00
"github.com/pkg/errors"
2016-12-23 14:09:12 -05:00
"github.com/spf13/pflag"
2018-06-08 12:24:26 -04:00
"gotest.tools/assert"
is "gotest.tools/assert/cmp"
2019-01-07 18:34:33 -05:00
"gotest.tools/skip"
2016-12-23 14:09:12 -05:00
)
func TestValidateAttach ( t * testing . T ) {
valid := [ ] string {
"stdin" ,
"stdout" ,
"stderr" ,
"STDIN" ,
"STDOUT" ,
"STDERR" ,
}
if _ , err := validateAttach ( "invalid" ) ; err == nil {
2017-02-21 03:53:29 -05:00
t . Fatal ( "Expected error with [valid streams are STDIN, STDOUT and STDERR], got nothing" )
2016-12-23 14:09:12 -05:00
}
for _ , attach := range valid {
value , err := validateAttach ( attach )
if err != nil {
t . Fatal ( err )
}
if value != strings . ToLower ( attach ) {
t . Fatalf ( "Expected [%v], got [%v]" , attach , value )
}
}
}
func parseRun ( args [ ] string ) ( * container . Config , * container . HostConfig , * networktypes . NetworkingConfig , error ) {
2017-10-25 12:59:32 -04:00
flags , copts := setupRunFlags ( )
2016-12-23 14:09:12 -05:00
if err := flags . Parse ( args ) ; err != nil {
return nil , nil , nil , err
}
2017-03-07 17:19:54 -05:00
// TODO: fix tests to accept ContainerConfig
2019-01-07 18:34:33 -05:00
containerConfig , err := parse ( flags , copts , runtime . GOOS )
2017-03-07 17:19:54 -05:00
if err != nil {
return nil , nil , nil , err
}
return containerConfig . Config , containerConfig . HostConfig , containerConfig . NetworkingConfig , err
2016-12-23 14:09:12 -05:00
}
2017-10-25 12:59:32 -04:00
func setupRunFlags ( ) ( * pflag . FlagSet , * containerOptions ) {
flags := pflag . NewFlagSet ( "run" , pflag . ContinueOnError )
flags . SetOutput ( ioutil . Discard )
flags . Usage = nil
copts := addFlags ( flags )
return flags , copts
}
2017-06-09 17:16:56 -04:00
func parseMustError ( t * testing . T , args string ) {
_ , _ , _ , err := parseRun ( strings . Split ( args + " ubuntu bash" , " " ) )
2017-12-21 16:27:57 -05:00
assert . ErrorContains ( t , err , "" , args )
2016-12-23 14:09:12 -05:00
}
func mustParse ( t * testing . T , args string ) ( * container . Config , * container . HostConfig ) {
2017-06-09 17:16:56 -04:00
config , hostConfig , _ , err := parseRun ( append ( strings . Split ( args , " " ) , "ubuntu" , "bash" ) )
2018-03-06 14:44:13 -05:00
assert . NilError ( t , err )
2016-12-23 14:09:12 -05:00
return config , hostConfig
}
func TestParseRunLinks ( t * testing . T ) {
if _ , hostConfig := mustParse ( t , "--link a:b" ) ; len ( hostConfig . Links ) == 0 || hostConfig . Links [ 0 ] != "a:b" {
t . Fatalf ( "Error parsing links. Expected []string{\"a:b\"}, received: %v" , hostConfig . Links )
}
if _ , hostConfig := mustParse ( t , "--link a:b --link c:d" ) ; len ( hostConfig . Links ) < 2 || hostConfig . Links [ 0 ] != "a:b" || hostConfig . Links [ 1 ] != "c:d" {
t . Fatalf ( "Error parsing links. Expected []string{\"a:b\", \"c:d\"}, received: %v" , hostConfig . Links )
}
if _ , hostConfig := mustParse ( t , "" ) ; len ( hostConfig . Links ) != 0 {
t . Fatalf ( "Error parsing links. No link expected, received: %v" , hostConfig . Links )
}
}
func TestParseRunAttach ( t * testing . T ) {
if config , _ := mustParse ( t , "-a stdin" ) ; ! config . AttachStdin || config . AttachStdout || config . AttachStderr {
t . Fatalf ( "Error parsing attach flags. Expect only Stdin enabled. Received: in: %v, out: %v, err: %v" , config . AttachStdin , config . AttachStdout , config . AttachStderr )
}
if config , _ := mustParse ( t , "-a stdin -a stdout" ) ; ! config . AttachStdin || ! config . AttachStdout || config . AttachStderr {
t . Fatalf ( "Error parsing attach flags. Expect only Stdin and Stdout enabled. Received: in: %v, out: %v, err: %v" , config . AttachStdin , config . AttachStdout , config . AttachStderr )
}
if config , _ := mustParse ( t , "-a stdin -a stdout -a stderr" ) ; ! config . AttachStdin || ! config . AttachStdout || ! config . AttachStderr {
t . Fatalf ( "Error parsing attach flags. Expect all attach enabled. Received: in: %v, out: %v, err: %v" , config . AttachStdin , config . AttachStdout , config . AttachStderr )
}
if config , _ := mustParse ( t , "" ) ; config . AttachStdin || ! config . AttachStdout || ! config . AttachStderr {
t . Fatalf ( "Error parsing attach flags. Expect Stdin disabled. Received: in: %v, out: %v, err: %v" , config . AttachStdin , config . AttachStdout , config . AttachStderr )
}
if config , _ := mustParse ( t , "-i" ) ; ! config . AttachStdin || ! config . AttachStdout || ! config . AttachStderr {
t . Fatalf ( "Error parsing attach flags. Expect Stdin enabled. Received: in: %v, out: %v, err: %v" , config . AttachStdin , config . AttachStdout , config . AttachStderr )
}
2017-06-09 17:16:56 -04:00
}
2016-12-23 14:09:12 -05:00
2017-06-09 17:16:56 -04:00
func TestParseRunWithInvalidArgs ( t * testing . T ) {
parseMustError ( t , "-a" )
parseMustError ( t , "-a invalid" )
parseMustError ( t , "-a invalid -a stdout" )
parseMustError ( t , "-a stdout -a stderr -d" )
parseMustError ( t , "-a stdin -d" )
parseMustError ( t , "-a stdout -d" )
parseMustError ( t , "-a stderr -d" )
parseMustError ( t , "-d --rm" )
2016-12-23 14:09:12 -05:00
}
2017-05-02 16:14:43 -04:00
// nolint: gocyclo
2017-08-29 13:19:28 -04:00
func TestParseWithVolumes ( t * testing . T ) {
2016-12-23 14:09:12 -05:00
// A single volume
arr , tryit := setupPlatformVolume ( [ ] string { ` /tmp ` } , [ ] string { ` c:\tmp ` } )
if config , hostConfig := mustParse ( t , tryit ) ; hostConfig . Binds != nil {
t . Fatalf ( "Error parsing volume flags, %q should not mount-bind anything. Received %v" , tryit , hostConfig . Binds )
} else if _ , exists := config . Volumes [ arr [ 0 ] ] ; ! exists {
t . Fatalf ( "Error parsing volume flags, %q is missing from volumes. Received %v" , tryit , config . Volumes )
}
// Two volumes
arr , tryit = setupPlatformVolume ( [ ] string { ` /tmp ` , ` /var ` } , [ ] string { ` c:\tmp ` , ` c:\var ` } )
if config , hostConfig := mustParse ( t , tryit ) ; hostConfig . Binds != nil {
t . Fatalf ( "Error parsing volume flags, %q should not mount-bind anything. Received %v" , tryit , hostConfig . Binds )
} else if _ , exists := config . Volumes [ arr [ 0 ] ] ; ! exists {
t . Fatalf ( "Error parsing volume flags, %s is missing from volumes. Received %v" , arr [ 0 ] , config . Volumes )
} else if _ , exists := config . Volumes [ arr [ 1 ] ] ; ! exists {
t . Fatalf ( "Error parsing volume flags, %s is missing from volumes. Received %v" , arr [ 1 ] , config . Volumes )
}
2017-08-19 10:13:29 -04:00
// A single bind mount
2016-12-23 14:09:12 -05:00
arr , tryit = setupPlatformVolume ( [ ] string { ` /hostTmp:/containerTmp ` } , [ ] string { os . Getenv ( "TEMP" ) + ` :c:\containerTmp ` } )
if config , hostConfig := mustParse ( t , tryit ) ; hostConfig . Binds == nil || hostConfig . Binds [ 0 ] != arr [ 0 ] {
t . Fatalf ( "Error parsing volume flags, %q should mount-bind the path before the colon into the path after the colon. Received %v %v" , arr [ 0 ] , hostConfig . Binds , config . Volumes )
}
2017-08-19 10:13:29 -04:00
// Two bind mounts.
2016-12-23 14:09:12 -05:00
arr , tryit = setupPlatformVolume ( [ ] string { ` /hostTmp:/containerTmp ` , ` /hostVar:/containerVar ` } , [ ] string { os . Getenv ( "ProgramData" ) + ` :c:\ContainerPD ` , os . Getenv ( "TEMP" ) + ` :c:\containerTmp ` } )
if _ , hostConfig := mustParse ( t , tryit ) ; hostConfig . Binds == nil || compareRandomizedStrings ( hostConfig . Binds [ 0 ] , hostConfig . Binds [ 1 ] , arr [ 0 ] , arr [ 1 ] ) != nil {
t . Fatalf ( "Error parsing volume flags, `%s and %s` did not mount-bind correctly. Received %v" , arr [ 0 ] , arr [ 1 ] , hostConfig . Binds )
}
2017-08-19 10:13:29 -04:00
// Two bind mounts, first read-only, second read-write.
2016-12-23 14:09:12 -05:00
// TODO Windows: The Windows version uses read-write as that's the only mode it supports. Can change this post TP4
2017-05-03 18:14:30 -04:00
arr , tryit = setupPlatformVolume (
[ ] string { ` /hostTmp:/containerTmp:ro ` , ` /hostVar:/containerVar:rw ` } ,
[ ] string { os . Getenv ( "TEMP" ) + ` :c:\containerTmp:rw ` , os . Getenv ( "ProgramData" ) + ` :c:\ContainerPD:rw ` } )
2016-12-23 14:09:12 -05:00
if _ , hostConfig := mustParse ( t , tryit ) ; hostConfig . Binds == nil || compareRandomizedStrings ( hostConfig . Binds [ 0 ] , hostConfig . Binds [ 1 ] , arr [ 0 ] , arr [ 1 ] ) != nil {
t . Fatalf ( "Error parsing volume flags, `%s and %s` did not mount-bind correctly. Received %v" , arr [ 0 ] , arr [ 1 ] , hostConfig . Binds )
}
// Similar to previous test but with alternate modes which are only supported by Linux
if runtime . GOOS != "windows" {
arr , tryit = setupPlatformVolume ( [ ] string { ` /hostTmp:/containerTmp:ro,Z ` , ` /hostVar:/containerVar:rw,Z ` } , [ ] string { } )
if _ , hostConfig := mustParse ( t , tryit ) ; hostConfig . Binds == nil || compareRandomizedStrings ( hostConfig . Binds [ 0 ] , hostConfig . Binds [ 1 ] , arr [ 0 ] , arr [ 1 ] ) != nil {
t . Fatalf ( "Error parsing volume flags, `%s and %s` did not mount-bind correctly. Received %v" , arr [ 0 ] , arr [ 1 ] , hostConfig . Binds )
}
arr , tryit = setupPlatformVolume ( [ ] string { ` /hostTmp:/containerTmp:Z ` , ` /hostVar:/containerVar:z ` } , [ ] string { } )
if _ , hostConfig := mustParse ( t , tryit ) ; hostConfig . Binds == nil || compareRandomizedStrings ( hostConfig . Binds [ 0 ] , hostConfig . Binds [ 1 ] , arr [ 0 ] , arr [ 1 ] ) != nil {
t . Fatalf ( "Error parsing volume flags, `%s and %s` did not mount-bind correctly. Received %v" , arr [ 0 ] , arr [ 1 ] , hostConfig . Binds )
}
}
// One bind mount and one volume
arr , tryit = setupPlatformVolume ( [ ] string { ` /hostTmp:/containerTmp ` , ` /containerVar ` } , [ ] string { os . Getenv ( "TEMP" ) + ` :c:\containerTmp ` , ` c:\containerTmp ` } )
if config , hostConfig := mustParse ( t , tryit ) ; hostConfig . Binds == nil || len ( hostConfig . Binds ) > 1 || hostConfig . Binds [ 0 ] != arr [ 0 ] {
t . Fatalf ( "Error parsing volume flags, %s and %s should only one and only one bind mount %s. Received %s" , arr [ 0 ] , arr [ 1 ] , arr [ 0 ] , hostConfig . Binds )
} else if _ , exists := config . Volumes [ arr [ 1 ] ] ; ! exists {
t . Fatalf ( "Error parsing volume flags %s and %s. %s is missing from volumes. Received %v" , arr [ 0 ] , arr [ 1 ] , arr [ 1 ] , config . Volumes )
}
// Root to non-c: drive letter (Windows specific)
if runtime . GOOS == "windows" {
arr , tryit = setupPlatformVolume ( [ ] string { } , [ ] string { os . Getenv ( "SystemDrive" ) + ` \:d: ` } )
if config , hostConfig := mustParse ( t , tryit ) ; hostConfig . Binds == nil || len ( hostConfig . Binds ) > 1 || hostConfig . Binds [ 0 ] != arr [ 0 ] || len ( config . Volumes ) != 0 {
t . Fatalf ( "Error parsing %s. Should have a single bind mount and no volumes" , arr [ 0 ] )
}
}
}
// setupPlatformVolume takes two arrays of volume specs - a Unix style
// spec and a Windows style spec. Depending on the platform being unit tested,
// it returns one of them, along with a volume string that would be passed
// on the docker CLI (e.g. -v /bar -v /foo).
func setupPlatformVolume ( u [ ] string , w [ ] string ) ( [ ] string , string ) {
var a [ ] string
if runtime . GOOS == "windows" {
a = w
} else {
a = u
}
s := ""
for _ , v := range a {
s = s + "-v " + v + " "
}
return a , s
}
// check if (a == c && b == d) || (a == d && b == c)
// because maps are randomized
func compareRandomizedStrings ( a , b , c , d string ) error {
if a == c && b == d {
return nil
}
if a == d && b == c {
return nil
}
2017-03-09 13:23:45 -05:00
return errors . Errorf ( "strings don't match" )
2016-12-23 14:09:12 -05:00
}
// Simple parse with MacAddress validation
func TestParseWithMacAddress ( t * testing . T ) {
invalidMacAddress := "--mac-address=invalidMacAddress"
validMacAddress := "--mac-address=92:d0:c6:0a:29:33"
if _ , _ , _ , err := parseRun ( [ ] string { invalidMacAddress , "img" , "cmd" } ) ; err != nil && err . Error ( ) != "invalidMacAddress is not a valid mac address" {
t . Fatalf ( "Expected an error with %v mac-address, got %v" , invalidMacAddress , err )
}
if config , _ := mustParse ( t , validMacAddress ) ; config . MacAddress != "92:d0:c6:0a:29:33" {
t . Fatalf ( "Expected the config to have '92:d0:c6:0a:29:33' as MacAddress, got '%v'" , config . MacAddress )
}
}
2017-10-25 12:59:32 -04:00
func TestRunFlagsParseWithMemory ( t * testing . T ) {
flags , _ := setupRunFlags ( )
args := [ ] string { "--memory=invalid" , "img" , "cmd" }
err := flags . Parse ( args )
2018-03-06 14:03:47 -05:00
assert . ErrorContains ( t , err , ` invalid argument "invalid" for "-m, --memory" flag ` )
2017-03-06 16:01:04 -05:00
_ , hostconfig := mustParse ( t , "--memory=1G" )
2018-03-05 18:53:52 -05:00
assert . Check ( t , is . Equal ( int64 ( 1073741824 ) , hostconfig . Memory ) )
2016-12-23 14:09:12 -05:00
}
func TestParseWithMemorySwap ( t * testing . T ) {
2017-10-25 12:59:32 -04:00
flags , _ := setupRunFlags ( )
args := [ ] string { "--memory-swap=invalid" , "img" , "cmd" }
err := flags . Parse ( args )
2018-03-06 14:03:47 -05:00
assert . ErrorContains ( t , err , ` invalid argument "invalid" for "--memory-swap" flag ` )
2017-03-06 16:01:04 -05:00
_ , hostconfig := mustParse ( t , "--memory-swap=1G" )
2018-03-05 18:53:52 -05:00
assert . Check ( t , is . Equal ( int64 ( 1073741824 ) , hostconfig . MemorySwap ) )
2017-03-06 16:01:04 -05:00
_ , hostconfig = mustParse ( t , "--memory-swap=-1" )
2018-03-05 18:53:52 -05:00
assert . Check ( t , is . Equal ( int64 ( - 1 ) , hostconfig . MemorySwap ) )
2016-12-23 14:09:12 -05:00
}
func TestParseHostname ( t * testing . T ) {
validHostnames := map [ string ] string {
"hostname" : "hostname" ,
"host-name" : "host-name" ,
"hostname123" : "hostname123" ,
"123hostname" : "123hostname" ,
"hostname-of-63-bytes-long-should-be-valid-and-without-any-error" : "hostname-of-63-bytes-long-should-be-valid-and-without-any-error" ,
}
hostnameWithDomain := "--hostname=hostname.domainname"
hostnameWithDomainTld := "--hostname=hostname.domainname.tld"
for hostname , expectedHostname := range validHostnames {
if config , _ := mustParse ( t , fmt . Sprintf ( "--hostname=%s" , hostname ) ) ; config . Hostname != expectedHostname {
2018-06-18 07:58:23 -04:00
t . Fatalf ( "Expected the config to have 'hostname' as %q, got %q" , expectedHostname , config . Hostname )
2016-12-23 14:09:12 -05:00
}
}
2018-06-18 07:58:23 -04:00
if config , _ := mustParse ( t , hostnameWithDomain ) ; config . Hostname != "hostname.domainname" || config . Domainname != "" {
t . Fatalf ( "Expected the config to have 'hostname' as hostname.domainname, got %q" , config . Hostname )
2016-12-23 14:09:12 -05:00
}
2018-06-18 07:58:23 -04:00
if config , _ := mustParse ( t , hostnameWithDomainTld ) ; config . Hostname != "hostname.domainname.tld" || config . Domainname != "" {
t . Fatalf ( "Expected the config to have 'hostname' as hostname.domainname.tld, got %q" , config . Hostname )
}
}
func TestParseHostnameDomainname ( t * testing . T ) {
validDomainnames := map [ string ] string {
"domainname" : "domainname" ,
"domain-name" : "domain-name" ,
"domainname123" : "domainname123" ,
"123domainname" : "123domainname" ,
"domainname-63-bytes-long-should-be-valid-and-without-any-errors" : "domainname-63-bytes-long-should-be-valid-and-without-any-errors" ,
}
for domainname , expectedDomainname := range validDomainnames {
if config , _ := mustParse ( t , "--domainname=" + domainname ) ; config . Domainname != expectedDomainname {
t . Fatalf ( "Expected the config to have 'domainname' as %q, got %q" , expectedDomainname , config . Domainname )
}
}
if config , _ := mustParse ( t , "--hostname=some.prefix --domainname=domainname" ) ; config . Hostname != "some.prefix" || config . Domainname != "domainname" {
t . Fatalf ( "Expected the config to have 'hostname' as 'some.prefix' and 'domainname' as 'domainname', got %q and %q" , config . Hostname , config . Domainname )
}
if config , _ := mustParse ( t , "--hostname=another-prefix --domainname=domainname.tld" ) ; config . Hostname != "another-prefix" || config . Domainname != "domainname.tld" {
t . Fatalf ( "Expected the config to have 'hostname' as 'another-prefix' and 'domainname' as 'domainname.tld', got %q and %q" , config . Hostname , config . Domainname )
2016-12-23 14:09:12 -05:00
}
}
func TestParseWithExpose ( t * testing . T ) {
invalids := map [ string ] string {
":" : "invalid port format for --expose: :" ,
"8080:9090" : "invalid port format for --expose: 8080:9090" ,
"/tcp" : "invalid range format for --expose: /tcp, error: Empty string specified for ports." ,
"/udp" : "invalid range format for --expose: /udp, error: Empty string specified for ports." ,
"NaN/tcp" : ` invalid range format for --expose: NaN/tcp, error: strconv.ParseUint: parsing "NaN": invalid syntax ` ,
"NaN-NaN/tcp" : ` invalid range format for --expose: NaN-NaN/tcp, error: strconv.ParseUint: parsing "NaN": invalid syntax ` ,
"8080-NaN/tcp" : ` invalid range format for --expose: 8080-NaN/tcp, error: strconv.ParseUint: parsing "NaN": invalid syntax ` ,
"1234567890-8080/tcp" : ` invalid range format for --expose: 1234567890-8080/tcp, error: strconv.ParseUint: parsing "1234567890": value out of range ` ,
}
valids := map [ string ] [ ] nat . Port {
"8080/tcp" : { "8080/tcp" } ,
"8080/udp" : { "8080/udp" } ,
"8080/ncp" : { "8080/ncp" } ,
"8080-8080/udp" : { "8080/udp" } ,
"8080-8082/tcp" : { "8080/tcp" , "8081/tcp" , "8082/tcp" } ,
}
for expose , expectedError := range invalids {
if _ , _ , _ , err := parseRun ( [ ] string { fmt . Sprintf ( "--expose=%v" , expose ) , "img" , "cmd" } ) ; err == nil || err . Error ( ) != expectedError {
t . Fatalf ( "Expected error '%v' with '--expose=%v', got '%v'" , expectedError , expose , err )
}
}
for expose , exposedPorts := range valids {
config , _ , _ , err := parseRun ( [ ] string { fmt . Sprintf ( "--expose=%v" , expose ) , "img" , "cmd" } )
if err != nil {
t . Fatal ( err )
}
if len ( config . ExposedPorts ) != len ( exposedPorts ) {
t . Fatalf ( "Expected %v exposed port, got %v" , len ( exposedPorts ) , len ( config . ExposedPorts ) )
}
for _ , port := range exposedPorts {
if _ , ok := config . ExposedPorts [ port ] ; ! ok {
t . Fatalf ( "Expected %v, got %v" , exposedPorts , config . ExposedPorts )
}
}
}
// Merge with actual published port
config , _ , _ , err := parseRun ( [ ] string { "--publish=80" , "--expose=80-81/tcp" , "img" , "cmd" } )
if err != nil {
t . Fatal ( err )
}
if len ( config . ExposedPorts ) != 2 {
t . Fatalf ( "Expected 2 exposed ports, got %v" , config . ExposedPorts )
}
ports := [ ] nat . Port { "80/tcp" , "81/tcp" }
for _ , port := range ports {
if _ , ok := config . ExposedPorts [ port ] ; ! ok {
t . Fatalf ( "Expected %v, got %v" , ports , config . ExposedPorts )
}
}
}
func TestParseDevice ( t * testing . T ) {
2019-01-07 18:34:33 -05:00
skip . If ( t , runtime . GOOS == "windows" ) // Windows validates server-side
2016-12-23 14:09:12 -05:00
valids := map [ string ] container . DeviceMapping {
"/dev/snd" : {
PathOnHost : "/dev/snd" ,
PathInContainer : "/dev/snd" ,
CgroupPermissions : "rwm" ,
} ,
"/dev/snd:rw" : {
PathOnHost : "/dev/snd" ,
PathInContainer : "/dev/snd" ,
CgroupPermissions : "rw" ,
} ,
"/dev/snd:/something" : {
PathOnHost : "/dev/snd" ,
PathInContainer : "/something" ,
CgroupPermissions : "rwm" ,
} ,
"/dev/snd:/something:rw" : {
PathOnHost : "/dev/snd" ,
PathInContainer : "/something" ,
CgroupPermissions : "rw" ,
} ,
}
for device , deviceMapping := range valids {
_ , hostconfig , _ , err := parseRun ( [ ] string { fmt . Sprintf ( "--device=%v" , device ) , "img" , "cmd" } )
if err != nil {
t . Fatal ( err )
}
if len ( hostconfig . Devices ) != 1 {
t . Fatalf ( "Expected 1 devices, got %v" , hostconfig . Devices )
}
if hostconfig . Devices [ 0 ] != deviceMapping {
t . Fatalf ( "Expected %v, got %v" , deviceMapping , hostconfig . Devices )
}
}
}
func TestParseModes ( t * testing . T ) {
// pid ko
2017-10-25 12:59:32 -04:00
flags , copts := setupRunFlags ( )
args := [ ] string { "--pid=container:" , "img" , "cmd" }
2018-03-05 18:53:52 -05:00
assert . NilError ( t , flags . Parse ( args ) )
2019-01-07 18:34:33 -05:00
_ , err := parse ( flags , copts , runtime . GOOS )
2018-03-06 14:03:47 -05:00
assert . ErrorContains ( t , err , "--pid: invalid PID mode" )
2017-05-09 19:21:17 -04:00
2016-12-23 14:09:12 -05:00
// pid ok
2017-07-20 17:42:51 -04:00
_ , hostconfig , _ , err := parseRun ( [ ] string { "--pid=host" , "img" , "cmd" } )
2018-03-05 18:53:52 -05:00
assert . NilError ( t , err )
2016-12-23 14:09:12 -05:00
if ! hostconfig . PidMode . Valid ( ) {
t . Fatalf ( "Expected a valid PidMode, got %v" , hostconfig . PidMode )
}
2017-05-09 19:21:17 -04:00
2016-12-23 14:09:12 -05:00
// uts ko
2017-05-09 19:21:17 -04:00
_ , _ , _ , err = parseRun ( [ ] string { "--uts=container:" , "img" , "cmd" } )
2018-03-06 14:03:47 -05:00
assert . ErrorContains ( t , err , "--uts: invalid UTS mode" )
2017-05-09 19:21:17 -04:00
2016-12-23 14:09:12 -05:00
// uts ok
_ , hostconfig , _ , err = parseRun ( [ ] string { "--uts=host" , "img" , "cmd" } )
2018-03-05 18:53:52 -05:00
assert . NilError ( t , err )
2016-12-23 14:09:12 -05:00
if ! hostconfig . UTSMode . Valid ( ) {
t . Fatalf ( "Expected a valid UTSMode, got %v" , hostconfig . UTSMode )
}
2017-10-25 12:59:32 -04:00
}
2017-05-09 19:21:17 -04:00
2017-10-25 12:59:32 -04:00
func TestRunFlagsParseShmSize ( t * testing . T ) {
2016-12-23 14:09:12 -05:00
// shm-size ko
2017-10-25 12:59:32 -04:00
flags , _ := setupRunFlags ( )
args := [ ] string { "--shm-size=a128m" , "img" , "cmd" }
expectedErr := ` invalid argument "a128m" for "--shm-size" flag: invalid size: 'a128m' `
err := flags . Parse ( args )
2018-03-06 14:03:47 -05:00
assert . ErrorContains ( t , err , expectedErr )
2017-05-09 19:21:17 -04:00
2016-12-23 14:09:12 -05:00
// shm-size ok
2017-10-25 12:59:32 -04:00
_ , hostconfig , _ , err := parseRun ( [ ] string { "--shm-size=128m" , "img" , "cmd" } )
2018-03-05 18:53:52 -05:00
assert . NilError ( t , err )
2016-12-23 14:09:12 -05:00
if hostconfig . ShmSize != 134217728 {
t . Fatalf ( "Expected a valid ShmSize, got %d" , hostconfig . ShmSize )
}
}
func TestParseRestartPolicy ( t * testing . T ) {
invalids := map [ string ] string {
"always:2:3" : "invalid restart policy format" ,
"on-failure:invalid" : "maximum retry count must be an integer" ,
}
valids := map [ string ] container . RestartPolicy {
"" : { } ,
"always" : {
Name : "always" ,
MaximumRetryCount : 0 ,
} ,
"on-failure:1" : {
Name : "on-failure" ,
MaximumRetryCount : 1 ,
} ,
}
for restart , expectedError := range invalids {
if _ , _ , _ , err := parseRun ( [ ] string { fmt . Sprintf ( "--restart=%s" , restart ) , "img" , "cmd" } ) ; err == nil || err . Error ( ) != expectedError {
t . Fatalf ( "Expected an error with message '%v' for %v, got %v" , expectedError , restart , err )
}
}
for restart , expected := range valids {
_ , hostconfig , _ , err := parseRun ( [ ] string { fmt . Sprintf ( "--restart=%v" , restart ) , "img" , "cmd" } )
if err != nil {
t . Fatal ( err )
}
if hostconfig . RestartPolicy != expected {
t . Fatalf ( "Expected %v, got %v" , expected , hostconfig . RestartPolicy )
}
}
}
Don't use AutoRemove on older daemons
Docker 1.13 moves the `--rm` flag to the daemon,
through an AutoRemove option in HostConfig.
When using API 1.24 and under, AutoRemove should not be
used, even if the daemon is version 1.13 or above and
"supports" this feature.
This patch fixes a situation where an 1.13 client,
talking to an 1.13 daemon, but using the 1.24 API
version, still set the AutoRemove property.
As a result, both the client _and_ the daemon
were attempting to remove the container, resulting
in an error:
ERRO[0000] error removing container: Error response from daemon:
removal of container ce0976ad22495c7cbe9487752ea32721a282164862db036b2f3377bd07461c3a
is already in progress
In addition, the validation of conflicting options
is moved from `docker run` to `opts.parse()`, so
that conflicting options are also detected when
running `docker create` and `docker start` separately.
To resolve the issue, the `AutoRemove` option is now
always set to `false` both by the client and the
daemon, if API version 1.24 or under is used.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-01-12 19:05:39 -05:00
func TestParseRestartPolicyAutoRemove ( t * testing . T ) {
expected := "Conflicting options: --restart and --rm"
_ , _ , _ , err := parseRun ( [ ] string { "--rm" , "--restart=always" , "img" , "cmd" } )
if err == nil || err . Error ( ) != expected {
t . Fatalf ( "Expected error %v, but got none" , expected )
}
}
2016-12-23 14:09:12 -05:00
func TestParseHealth ( t * testing . T ) {
checkOk := func ( args ... string ) * container . HealthConfig {
config , _ , _ , err := parseRun ( args )
if err != nil {
t . Fatalf ( "%#v: %v" , args , err )
}
return config . Healthcheck
}
checkError := func ( expected string , args ... string ) {
config , _ , _ , err := parseRun ( args )
if err == nil {
t . Fatalf ( "Expected error, but got %#v" , config )
}
if err . Error ( ) != expected {
t . Fatalf ( "Expected %#v, got %#v" , expected , err )
}
}
health := checkOk ( "--no-healthcheck" , "img" , "cmd" )
if health == nil || len ( health . Test ) != 1 || health . Test [ 0 ] != "NONE" {
t . Fatalf ( "--no-healthcheck failed: %#v" , health )
}
health = checkOk ( "--health-cmd=/check.sh -q" , "img" , "cmd" )
if len ( health . Test ) != 2 || health . Test [ 0 ] != "CMD-SHELL" || health . Test [ 1 ] != "/check.sh -q" {
t . Fatalf ( "--health-cmd: got %#v" , health . Test )
}
if health . Timeout != 0 {
2017-02-20 21:26:06 -05:00
t . Fatalf ( "--health-cmd: timeout = %s" , health . Timeout )
2016-12-23 14:09:12 -05:00
}
checkError ( "--no-healthcheck conflicts with --health-* options" ,
"--no-healthcheck" , "--health-cmd=/check.sh -q" , "img" , "cmd" )
2016-11-29 04:58:47 -05:00
health = checkOk ( "--health-timeout=2s" , "--health-retries=3" , "--health-interval=4.5s" , "--health-start-period=5s" , "img" , "cmd" )
if health . Timeout != 2 * time . Second || health . Retries != 3 || health . Interval != 4500 * time . Millisecond || health . StartPeriod != 5 * time . Second {
2016-12-23 14:09:12 -05:00
t . Fatalf ( "--health-*: got %#v" , health )
}
}
func TestParseLoggingOpts ( t * testing . T ) {
// logging opts ko
if _ , _ , _ , err := parseRun ( [ ] string { "--log-driver=none" , "--log-opt=anything" , "img" , "cmd" } ) ; err == nil || err . Error ( ) != "invalid logging opts for driver none" {
t . Fatalf ( "Expected an error with message 'invalid logging opts for driver none', got %v" , err )
}
// logging opts ok
_ , hostconfig , _ , err := parseRun ( [ ] string { "--log-driver=syslog" , "--log-opt=something" , "img" , "cmd" } )
if err != nil {
t . Fatal ( err )
}
if hostconfig . LogConfig . Type != "syslog" || len ( hostconfig . LogConfig . Config ) != 1 {
t . Fatalf ( "Expected a 'syslog' LogConfig with one config, got %v" , hostconfig . RestartPolicy )
}
}
func TestParseEnvfileVariables ( t * testing . T ) {
e := "open nonexistent: no such file or directory"
if runtime . GOOS == "windows" {
e = "open nonexistent: The system cannot find the file specified."
}
// env ko
if _ , _ , _ , err := parseRun ( [ ] string { "--env-file=nonexistent" , "img" , "cmd" } ) ; err == nil || err . Error ( ) != e {
t . Fatalf ( "Expected an error with message '%s', got %v" , e , err )
}
// env ok
config , _ , _ , err := parseRun ( [ ] string { "--env-file=testdata/valid.env" , "img" , "cmd" } )
if err != nil {
t . Fatal ( err )
}
if len ( config . Env ) != 1 || config . Env [ 0 ] != "ENV1=value1" {
t . Fatalf ( "Expected a config with [ENV1=value1], got %v" , config . Env )
}
config , _ , _ , err = parseRun ( [ ] string { "--env-file=testdata/valid.env" , "--env=ENV2=value2" , "img" , "cmd" } )
if err != nil {
t . Fatal ( err )
}
if len ( config . Env ) != 2 || config . Env [ 0 ] != "ENV1=value1" || config . Env [ 1 ] != "ENV2=value2" {
t . Fatalf ( "Expected a config with [ENV1=value1 ENV2=value2], got %v" , config . Env )
}
}
func TestParseEnvfileVariablesWithBOMUnicode ( t * testing . T ) {
// UTF8 with BOM
config , _ , _ , err := parseRun ( [ ] string { "--env-file=testdata/utf8.env" , "img" , "cmd" } )
if err != nil {
t . Fatal ( err )
}
env := [ ] string { "FOO=BAR" , "HELLO=" + string ( [ ] byte { 0xe6 , 0x82 , 0xa8 , 0xe5 , 0xa5 , 0xbd } ) , "BAR=FOO" }
if len ( config . Env ) != len ( env ) {
t . Fatalf ( "Expected a config with %d env variables, got %v: %v" , len ( env ) , len ( config . Env ) , config . Env )
}
for i , v := range env {
if config . Env [ i ] != v {
t . Fatalf ( "Expected a config with [%s], got %v" , v , [ ] byte ( config . Env [ i ] ) )
}
}
// UTF16 with BOM
e := "contains invalid utf8 bytes at line"
if _ , _ , _ , err := parseRun ( [ ] string { "--env-file=testdata/utf16.env" , "img" , "cmd" } ) ; err == nil || ! strings . Contains ( err . Error ( ) , e ) {
t . Fatalf ( "Expected an error with message '%s', got %v" , e , err )
}
// UTF16BE with BOM
if _ , _ , _ , err := parseRun ( [ ] string { "--env-file=testdata/utf16be.env" , "img" , "cmd" } ) ; err == nil || ! strings . Contains ( err . Error ( ) , e ) {
t . Fatalf ( "Expected an error with message '%s', got %v" , e , err )
}
}
func TestParseLabelfileVariables ( t * testing . T ) {
e := "open nonexistent: no such file or directory"
if runtime . GOOS == "windows" {
e = "open nonexistent: The system cannot find the file specified."
}
// label ko
if _ , _ , _ , err := parseRun ( [ ] string { "--label-file=nonexistent" , "img" , "cmd" } ) ; err == nil || err . Error ( ) != e {
t . Fatalf ( "Expected an error with message '%s', got %v" , e , err )
}
// label ok
config , _ , _ , err := parseRun ( [ ] string { "--label-file=testdata/valid.label" , "img" , "cmd" } )
if err != nil {
t . Fatal ( err )
}
if len ( config . Labels ) != 1 || config . Labels [ "LABEL1" ] != "value1" {
t . Fatalf ( "Expected a config with [LABEL1:value1], got %v" , config . Labels )
}
config , _ , _ , err = parseRun ( [ ] string { "--label-file=testdata/valid.label" , "--label=LABEL2=value2" , "img" , "cmd" } )
if err != nil {
t . Fatal ( err )
}
if len ( config . Labels ) != 2 || config . Labels [ "LABEL1" ] != "value1" || config . Labels [ "LABEL2" ] != "value2" {
t . Fatalf ( "Expected a config with [LABEL1:value1 LABEL2:value2], got %v" , config . Labels )
}
}
func TestParseEntryPoint ( t * testing . T ) {
config , _ , _ , err := parseRun ( [ ] string { "--entrypoint=anything" , "cmd" , "img" } )
if err != nil {
t . Fatal ( err )
}
if len ( config . Entrypoint ) != 1 && config . Entrypoint [ 0 ] != "anything" {
t . Fatalf ( "Expected entrypoint 'anything', got %v" , config . Entrypoint )
}
}
func TestValidateDevice ( t * testing . T ) {
2019-01-07 18:34:33 -05:00
skip . If ( t , runtime . GOOS == "windows" ) // Windows validates server-side
2016-12-23 14:09:12 -05:00
valid := [ ] string {
"/home" ,
"/home:/home" ,
"/home:/something/else" ,
"/with space" ,
"/home:/with space" ,
"relative:/absolute-path" ,
"hostPath:/containerPath:r" ,
"/hostPath:/containerPath:rw" ,
"/hostPath:/containerPath:mrw" ,
}
invalid := map [ string ] string {
"" : "bad format for path: " ,
"./" : "./ is not an absolute path" ,
"../" : "../ is not an absolute path" ,
"/:../" : "../ is not an absolute path" ,
"/:path" : "path is not an absolute path" ,
":" : "bad format for path: :" ,
"/tmp:" : " is not an absolute path" ,
":test" : "bad format for path: :test" ,
":/test" : "bad format for path: :/test" ,
"tmp:" : " is not an absolute path" ,
":test:" : "bad format for path: :test:" ,
"::" : "bad format for path: ::" ,
":::" : "bad format for path: :::" ,
"/tmp:::" : "bad format for path: /tmp:::" ,
":/tmp::" : "bad format for path: :/tmp::" ,
"path:ro" : "ro is not an absolute path" ,
"path:rr" : "rr is not an absolute path" ,
"a:/b:ro" : "bad mode specified: ro" ,
"a:/b:rr" : "bad mode specified: rr" ,
}
for _ , path := range valid {
2019-01-07 18:34:33 -05:00
if _ , err := validateDevice ( path , runtime . GOOS ) ; err != nil {
2016-12-23 14:09:12 -05:00
t . Fatalf ( "ValidateDevice(`%q`) should succeed: error %q" , path , err )
}
}
for path , expectedError := range invalid {
2019-01-07 18:34:33 -05:00
if _ , err := validateDevice ( path , runtime . GOOS ) ; err == nil {
2016-12-23 14:09:12 -05:00
t . Fatalf ( "ValidateDevice(`%q`) should have failed validation" , path )
} else {
if err . Error ( ) != expectedError {
t . Fatalf ( "ValidateDevice(`%q`) error should contain %q, got %q" , path , expectedError , err . Error ( ) )
}
}
}
}