@ -1,99 +1,107 @@
package docker
import (
"context"
"crypto/sha256"
"encoding/json"
"fmt"
"io/ioutil"
"os"
"os/exec"
"strings"
"testing"
"github.com/hashicorp/packer/packer "
builderT "github.com/hashicorp/packer/packer -plugin-sdk/acctest "
packersdk "github.com/hashicorp/packer/packer-plugin-sdk/packer"
"github.com/hashicorp/packer/packer-plugin-sdk/template"
"github.com/hashicorp/packer/provisioner/file"
"github.com/hashicorp/packer/provisioner/shell"
)
// TestUploadDownload verifies that basic upload / download functionality works
func TestUploadDownload ( t * testing . T ) {
ui := packersdk . TestUi ( t )
tpl , err := template . Parse ( strings . NewReader ( dockerBuilderConfig ) )
if err != nil {
t . Fatalf ( "Unable to parse config: %s" , err )
// RenderConfig helps create dynamic packer template configs for parsing by
// builderT without having to write the config to a file.
func RenderConfig ( builderConfig map [ string ] interface { } , provisionerConfig [ ] map [ string ] interface { } ) string {
// set up basic build template
t := map [ string ] [ ] map [ string ] interface { } {
"builders" : {
// Setup basic docker config
map [ string ] interface { } {
"type" : "test" ,
"image" : "ubuntu" ,
"discard" : true ,
} ,
} ,
"provisioners" : [ ] map [ string ] interface { } { } ,
}
if os . Getenv ( "PACKER_ACC" ) == "" {
t . Skip ( "This test is only run with PACKER_ACC=1" )
// apply special builder overrides
for k , v := range builderConfig {
t ["builders" ] [ 0 ] [ k ] = v
}
cmd := exec . Command ( "docker" , "-v" )
cmd . Run ( )
if ! cmd . ProcessState . Success ( ) {
t . Error ( "docker command not found; please make sure docker is installed" )
// Apply special provisioner overrides
for _ , v := range provisionerConfig {
t [ "provisioners" ] = append ( t [ "provisioners" ] , v )
}
// Setup the builder
builder := & Builder { }
_ , warnings , err := builder . Prepare ( tpl . Builders [ "docker" ] . Config )
if err != nil {
t . Fatalf ( "Error preparing configuration %s" , err )
}
if len ( warnings ) > 0 {
t . Fatal ( "Encountered configuration warnings; aborting" )
}
j , _ := json . Marshal ( t )
return string ( j )
}
// Setup the provisioners
upload := & file . Provisioner { }
err = upload . Prepare ( tpl . Provisioners [ 0 ] . Config )
if err != nil {
t . Fatalf ( "Error preparing upload: %s" , err )
// TestUploadDownload verifies that basic upload / download functionality works
func TestUploadDownload ( t * testing . T ) {
if os . Getenv ( "PACKER_ACC" ) == "" {
t . Skip ( "This test is only run with PACKER_ACC=1" )
}
download := & file . Provisioner { }
err = download . Prepare ( tpl . Provisioners [ 1 ] . Config )
if err != nil {
t . Fatalf ( "Error preparing download: %s" , err )
dockerBuilderExtraConfig := map [ string ] interface { } {
"run_command" : [ ] string { "-d" , "-i" , "-t" , "{{.Image}}" , "/bin/sh" } ,
}
// Preemptive cleanup. Honestly I don't know why you would want to get rid
// of my strawberry cake. It's so tasty! Do you not like cake? Are you a
// cake-hater? Or are you keeping all the cake all for yourself? So selfish!
defer os . Remove ( "my-strawberry-cake" )
// Add hooks so the provisioners run during the build
hooks := map [ string ] [ ] packersdk . Hook { }
hooks [ packersdk . HookProvision ] = [ ] packersdk . Hook {
& packer . ProvisionHook {
Provisioners : [ ] * packer . HookedProvisioner {
{ Provisioner : upload , Config : nil , TypeName : "" } ,
{ Provisioner : download , Config : nil , TypeName : "" } ,
} ,
dockerProvisionerConfig := [ ] map [ string ] interface { } {
{
"type" : "file" ,
"source" : "test-fixtures/onecakes/strawberry" ,
"destination" : "/strawberry-cake" ,
} ,
{
"type" : "file" ,
"source" : "/strawberry-cake" ,
"destination" : "my-strawberry-cake" ,
"direction" : "download" ,
} ,
}
hook := & packersdk . DispatchHook { Mapping : hooks }
// Run things
artifact , err := builder . Run ( context . Background ( ) , ui , hook )
if err != nil {
t . Fatalf ( "Error running build %s" , err )
}
// Preemptive cleanup
defer artifact . Destroy ( )
configString := RenderConfig ( dockerBuilderExtraConfig , dockerProvisionerConfig )
// Verify that the thing we downloaded is the same thing we sent up.
// Complain loudly if it isn't.
inputFile , err := ioutil . ReadFile ( "test-fixtures/onecakes/strawberry" )
if err != nil {
t . Fatalf ( "Unable to read input file: %s" , err )
}
outputFile , err := ioutil . ReadFile ( "my-strawberry-cake" )
// this should be a precheck
cmd := exec . Command ( "docker" , "-v" )
err := cmd . Run ( )
if err != nil {
t . Fatalf ( "Unable to read output file: %s" , err )
}
if sha256 . Sum256 ( inputFile ) != sha256 . Sum256 ( outputFile ) {
t . Fatalf ( "Input and output files do not match\n" +
"Input:\n%s\nOutput:\n%s\n" , inputFile , outputFile )
t . Error ( "docker command not found; please make sure docker is installed" )
}
builderT . Test ( t , builderT . TestCase {
Builder : & Builder { } ,
Template : configString ,
Check : func ( a [ ] packersdk . Artifact ) error {
// Verify that the thing we downloaded is the same thing we sent up.
// Complain loudly if it isn't.
inputFile , err := ioutil . ReadFile ( "test-fixtures/onecakes/strawberry" )
if err != nil {
return fmt . Errorf ( "Unable to read input file: %s" , err )
}
outputFile , err := ioutil . ReadFile ( "my-strawberry-cake" )
if err != nil {
return fmt . Errorf ( "Unable to read output file: %s" , err )
}
if sha256 . Sum256 ( inputFile ) != sha256 . Sum256 ( outputFile ) {
return fmt . Errorf ( "Input and output files do not match\n" +
"Input:\n%s\nOutput:\n%s\n" , inputFile , outputFile )
}
return nil
} ,
Teardown : func ( ) error {
// Cleanup. Honestly I don't know why you would want to get rid
// of my strawberry cake. It's so tasty! Do you not like cake? Are you a
// cake-hater? Or are you keeping all the cake all for yourself? So selfish!
os . Remove ( "my-strawberry-cake" )
return nil
} ,
} )
}
// TestLargeDownload verifies that files are the appropriate size after being
@ -101,276 +109,133 @@ func TestUploadDownload(t *testing.T) {
// need to use github.com/cbednarski/rerun to verify since this problem occurs
// only intermittently.
func TestLargeDownload ( t * testing . T ) {
ui := packersdk . TestUi ( t )
tpl , err := template . Parse ( strings . NewReader ( dockerLargeBuilderConfig ) )
if err != nil {
t . Fatalf ( "Unable to parse config: %s" , err )
}
if os . Getenv ( "PACKER_ACC" ) == "" {
t . Skip ( "This test is only run with PACKER_ACC=1" )
}
cmd := exec . Command ( "docker" , "-v" )
cmd . Run ( )
if ! cmd . ProcessState . Success ( ) {
t . Error ( "docker command not found; please make sure docker is installed" )
}
// Setup the builder
builder := & Builder { }
_ , warnings , err := builder . Prepare ( tpl . Builders [ "docker" ] . Config )
if err != nil {
t . Fatalf ( "Error preparing configuration %s" , err )
}
if len ( warnings ) > 0 {
t . Fatal ( "Encountered configuration warnings; aborting" )
}
// Setup the provisioners
shell := & shell . Provisioner { }
err = shell . Prepare ( tpl . Provisioners [ 0 ] . Config )
if err != nil {
t . Fatalf ( "Error preparing shell provisioner: %s" , err )
}
downloadCupcake := & file . Provisioner { }
err = downloadCupcake . Prepare ( tpl . Provisioners [ 1 ] . Config )
if err != nil {
t . Fatalf ( "Error preparing downloadCupcake: %s" , err )
}
downloadBigcake := & file . Provisioner { }
err = downloadBigcake . Prepare ( tpl . Provisioners [ 2 ] . Config )
if err != nil {
t . Fatalf ( "Error preparing downloadBigcake: %s" , err )
}
// Preemptive cleanup.
defer os . Remove ( "cupcake" )
defer os . Remove ( "bigcake" )
// Add hooks so the provisioners run during the build
hooks := map [ string ] [ ] packersdk . Hook { }
hooks [ packersdk . HookProvision ] = [ ] packersdk . Hook {
& packer . ProvisionHook {
Provisioners : [ ] * packer . HookedProvisioner {
{ Provisioner : shell , Config : nil , TypeName : "" } ,
{ Provisioner : downloadCupcake , Config : nil , TypeName : "" } ,
{ Provisioner : downloadBigcake , Config : nil , TypeName : "" } ,
dockerProvisionerConfig := [ ] map [ string ] interface { } {
{
"type" : "shell" ,
"inline" : [ ] string {
"dd if=/dev/urandom of=/tmp/cupcake bs=1M count=2" ,
"dd if=/dev/urandom of=/tmp/bigcake bs=1M count=100" ,
"sync" ,
"md5sum /tmp/cupcake /tmp/bigcake" ,
} ,
} ,
{
"type" : "file" ,
"source" : "/tmp/cupcake" ,
"destination" : "cupcake" ,
"direction" : "download" ,
} ,
{
"type" : "file" ,
"source" : "/tmp/bigcake" ,
"destination" : "bigcake" ,
"direction" : "download" ,
} ,
}
hook := & packersdk . DispatchHook { Mapping : hooks }
// Run things
artifact , err := builder . Run ( context . Background ( ) , ui , hook )
if err != nil {
t . Fatalf ( "Error running build %s" , err )
}
// Preemptive cleanup
defer artifact . Destroy ( )
// Verify that the things we downloaded are the right size. Complain loudly
// if they are not.
//
// cupcake should be 2097152 bytes
// bigcake should be 104857600 bytes
cupcake , err := os . Stat ( "cupcake" )
if err != nil {
t . Fatalf ( "Unable to stat cupcake file: %s" , err )
}
cupcakeExpected := int64 ( 2097152 )
if cupcake . Size ( ) != cupcakeExpected {
t . Errorf ( "Expected cupcake to be %d bytes; found %d" , cupcakeExpected , cupcake . Size ( ) )
}
configString := RenderConfig ( map [ string ] interface { } { } , dockerProvisionerConfig )
bigcake , err := os . Stat ( "bigcake" )
// this should be a precheck
cmd := exec . Command ( "docker" , "-v" )
err := cmd . Run ( )
if err != nil {
t . Fatalf ( "Unable to stat bigcake file: %s" , err )
}
bigcakeExpected := int64 ( 104857600 )
if bigcake . Size ( ) != bigcakeExpected {
t . Errorf ( "Expected bigcake to be %d bytes; found %d" , bigcakeExpected , bigcake . Size ( ) )
t . Error ( "docker command not found; please make sure docker is installed" )
}
// TODO if we can, calculate a sha inside the container and compare to the
// one we get after we pull it down. We will probably have to parse the log
// or ui output to do this because we use /dev/urandom to create the file.
// if sha256.Sum256(inputFile) != sha256.Sum256(outputFile) {
// t.Fatalf("Input and output files do not match\n"+
// "Input:\n%s\nOutput:\n%s\n", inputFile, outputFile)
// }
builderT . Test ( t , builderT . TestCase {
Builder : & Builder { } ,
Template : configString ,
Check : func ( a [ ] packersdk . Artifact ) error {
// Verify that the things we downloaded are the right size. Complain loudly
// if they are not.
//
// cupcake should be 2097152 bytes
// bigcake should be 104857600 bytes
cupcake , err := os . Stat ( "cupcake" )
if err != nil {
t . Fatalf ( "Unable to stat cupcake file: %s" , err )
}
cupcakeExpected := int64 ( 2097152 )
if cupcake . Size ( ) != cupcakeExpected {
t . Errorf ( "Expected cupcake to be %d bytes; found %d" , cupcakeExpected , cupcake . Size ( ) )
}
bigcake , err := os . Stat ( "bigcake" )
if err != nil {
t . Fatalf ( "Unable to stat bigcake file: %s" , err )
}
bigcakeExpected := int64 ( 104857600 )
if bigcake . Size ( ) != bigcakeExpected {
t . Errorf ( "Expected bigcake to be %d bytes; found %d" , bigcakeExpected , bigcake . Size ( ) )
}
// TODO if we can, calculate a sha inside the container and compare to the
// one we get after we pull it down. We will probably have to parse the log
// or ui output to do this because we use /dev/urandom to create the file.
// if sha256.Sum256(inputFile) != sha256.Sum256(outputFile) {
// t.Fatalf("Input and output files do not match\n"+
// "Input:\n%s\nOutput:\n%s\n", inputFile, outputFile)
// }
return nil
} ,
Teardown : func ( ) error {
os . Remove ( "cupcake" )
os . Remove ( "bigcake" )
return nil
} ,
} )
}
// TestFixUploadOwner verifies that owner of uploaded files is the user the container is running as.
func TestFixUploadOwner ( t * testing . T ) {
ui := packersdk . TestUi ( t )
tpl , err := template . Parse ( strings . NewReader ( testFixUploadOwnerTemplate ) )
if err != nil {
t . Fatalf ( "Unable to parse config: %s" , err )
}
if os . Getenv ( "PACKER_ACC" ) == "" {
t . Skip ( "This test is only run with PACKER_ACC=1" )
}
cmd := exec . Command ( "docker" , "-v" )
cmd . Run ( )
if ! cmd . ProcessState . Success ( ) {
t . Error ( "docker command not found; please make sure docker is installed" )
}
// Setup the builder
builder := & Builder { }
_ , warnings , err := builder . Prepare ( tpl . Builders [ "docker" ] . Config )
if err != nil {
t . Fatalf ( "Error preparing configuration %s" , err )
}
if len ( warnings ) > 0 {
t . Fatal ( "Encountered configuration warnings; aborting" )
}
// Setup the provisioners
fileProvisioner := & file . Provisioner { }
err = fileProvisioner . Prepare ( tpl . Provisioners [ 0 ] . Config )
if err != nil {
t . Fatalf ( "Error preparing single file upload provisioner: %s" , err )
}
dirProvisioner := & file . Provisioner { }
err = dirProvisioner . Prepare ( tpl . Provisioners [ 1 ] . Config )
if err != nil {
t . Fatalf ( "Error preparing directory upload provisioner: %s" , err )
}
shellProvisioner := & shell . Provisioner { }
err = shellProvisioner . Prepare ( tpl . Provisioners [ 2 ] . Config )
cmd := exec . Command ( "docker" , "-v" )
err := cmd . Run ( )
if err != nil {
t . Fatalf( "Error preparing shell provisioner: %s" , err )
t . Error ( "docker command not found; please make sure docker is installed" )
}
verifyProvisioner := & shell . Provisioner { }
err = verifyProvisioner . Prepare ( tpl . Provisioners [ 3 ] . Config )
if err != nil {
t . Fatalf ( "Error preparing verification provisioner: %s" , err )
dockerBuilderExtraConfig := map [ string ] interface { } {
"run_command" : [ ] string { "-d" , "-i" , "-t" , "-u" , "42" , "{{.Image}}" , "/bin/sh" } ,
}
// Add hooks so the provisioners run during the build
hooks := map [ string ] [ ] packersdk . Hook { }
hooks [ packersdk . HookProvision ] = [ ] packersdk . Hook {
& packer . ProvisionHook {
Provisioners : [ ] * packer . HookedProvisioner {
{ Provisioner : fileProvisioner , Config : nil , TypeName : "" } ,
{ Provisioner : dirProvisioner , Config : nil , TypeName : "" } ,
{ Provisioner : shellProvisioner , Config : nil , TypeName : "" } ,
{ Provisioner : verifyProvisioner , Config : nil , TypeName : "" } ,
testFixUploadOwnerProvisionersTemplate := [ ] map [ string ] interface { } {
{
"type" : "file" ,
"source" : "test-fixtures/onecakes/strawberry" ,
"destination" : "/tmp/strawberry-cake" ,
} ,
{
"type" : "file" ,
"source" : "test-fixtures/manycakes" ,
"destination" : "/tmp/" ,
} ,
{
"type" : "shell" ,
"inline" : "touch /tmp/testUploadOwner" ,
} ,
{
"type" : "shell" ,
"inline" : [ ] string {
"[ $(stat -c %u /tmp/strawberry-cake) -eq 42 ] || (echo 'Invalid owner of /tmp/strawberry-cake' && exit 1)" ,
"[ $(stat -c %u /tmp/testUploadOwner) -eq 42 ] || (echo 'Invalid owner of /tmp/testUploadOwner' && exit 1)" ,
"find /tmp/manycakes | xargs -n1 -IFILE /bin/sh -c '[ $(stat -c %u FILE) -eq 42 ] || (echo \"Invalid owner of FILE\" && exit 1)'" ,
} ,
} ,
}
hook := & packersdk . DispatchHook { Mapping : hooks }
artifact , err := builder . Run ( context . Background ( ) , ui , hook )
if err != nil {
t . Fatalf ( "Error running build %s" , err )
}
defer artifact . Destroy ( )
}
const dockerBuilderConfig = `
{
"builders" : [
{
"type" : "docker" ,
"image" : "ubuntu" ,
"discard" : true ,
"run_command" : [ "-d" , "-i" , "-t" , "{{.Image}}" , "/bin/sh" ]
}
] ,
"provisioners" : [
{
"type" : "file" ,
"source" : "test-fixtures/onecakes/strawberry" ,
"destination" : "/strawberry-cake"
} ,
{
"type" : "file" ,
"source" : "/strawberry-cake" ,
"destination" : "my-strawberry-cake" ,
"direction" : "download"
}
]
}
`
const dockerLargeBuilderConfig = `
{
"builders" : [
{
"type" : "docker" ,
"image" : "ubuntu" ,
"discard" : true
}
] ,
"provisioners" : [
{
"type" : "shell" ,
"inline" : [
"dd if=/dev/urandom of=/tmp/cupcake bs=1M count=2" ,
"dd if=/dev/urandom of=/tmp/bigcake bs=1M count=100" ,
"sync" ,
"md5sum /tmp/cupcake /tmp/bigcake"
]
} ,
{
"type" : "file" ,
"source" : "/tmp/cupcake" ,
"destination" : "cupcake" ,
"direction" : "download"
} ,
{
"type" : "file" ,
"source" : "/tmp/bigcake" ,
"destination" : "bigcake" ,
"direction" : "download"
}
]
}
`
const testFixUploadOwnerTemplate = `
{
"builders" : [
{
"type" : "docker" ,
"image" : "ubuntu" ,
"discard" : true ,
"run_command" : [ "-d" , "-i" , "-t" , "-u" , "42" , "{{.Image}}" , "/bin/sh" ]
}
] ,
"provisioners" : [
{
"type" : "file" ,
"source" : "test-fixtures/onecakes/strawberry" ,
"destination" : "/tmp/strawberry-cake"
} ,
{
"type" : "file" ,
"source" : "test-fixtures/manycakes" ,
"destination" : "/tmp/"
} ,
{
"type" : "shell" ,
"inline" : "touch /tmp/testUploadOwner"
} ,
{
"type" : "shell" ,
"inline" : [
"[ $(stat -c %u /tmp/strawberry-cake) -eq 42 ] || (echo 'Invalid owner of /tmp/strawberry-cake' && exit 1)" ,
"[ $(stat -c %u /tmp/testUploadOwner) -eq 42 ] || (echo 'Invalid owner of /tmp/testUploadOwner' && exit 1)" ,
"find /tmp/manycakes | xargs -n1 -IFILE /bin/sh -c '[ $(stat -c %u FILE) -eq 42 ] || (echo \"Invalid owner of FILE\" && exit 1)'"
]
}
]
configString := RenderConfig ( dockerBuilderExtraConfig , testFixUploadOwnerProvisionersTemplate )
builderT . Test ( t , builderT . TestCase {
Builder : & Builder { } ,
Template : configString ,
} )
}
`
Megan Marsh
5 years ago