github.com/jfrazelle/docker@v1.1.2-0.20210712172922-bf78e25fe508/integration/image/remove_unix_test.go (about)

     1  // +build !windows
     2  
     3  package image // import "github.com/docker/docker/integration/image"
     4  
     5  import (
     6  	"context"
     7  	"io"
     8  	"io/ioutil"
     9  	"os"
    10  	"path/filepath"
    11  	"runtime"
    12  	"strconv"
    13  	"strings"
    14  	"syscall"
    15  	"testing"
    16  	"unsafe"
    17  
    18  	"github.com/docker/docker/api/types"
    19  	_ "github.com/docker/docker/daemon/graphdriver/register" // register graph drivers
    20  	"github.com/docker/docker/daemon/images"
    21  	"github.com/docker/docker/layer"
    22  	"github.com/docker/docker/pkg/idtools"
    23  	"github.com/docker/docker/testutil/daemon"
    24  	"github.com/docker/docker/testutil/fakecontext"
    25  	"gotest.tools/v3/assert"
    26  	"gotest.tools/v3/skip"
    27  )
    28  
    29  // This is a regression test for #38488
    30  // It ensures that orphan layers can be found and cleaned up
    31  // after unsuccessful image removal
    32  func TestRemoveImageGarbageCollector(t *testing.T) {
    33  	// This test uses very platform specific way to prevent
    34  	// daemon for remove image layer.
    35  	skip.If(t, testEnv.DaemonInfo.OSType != "linux")
    36  	skip.If(t, os.Getenv("DOCKER_ENGINE_GOARCH") != "amd64")
    37  	skip.If(t, testEnv.IsRootless, "rootless mode doesn't support overlay2 on most distros")
    38  
    39  	// Create daemon with overlay2 graphdriver because vfs uses disk differently
    40  	// and this test case would not work with it.
    41  	d := daemon.New(t, daemon.WithStorageDriver("overlay2"))
    42  	d.Start(t)
    43  	defer d.Stop(t)
    44  
    45  	ctx := context.Background()
    46  	client := d.NewClientT(t)
    47  
    48  	layerStore, _ := layer.NewStoreFromOptions(layer.StoreOptions{
    49  		Root:                      d.Root,
    50  		MetadataStorePathTemplate: filepath.Join(d.RootDir(), "image", "%s", "layerdb"),
    51  		GraphDriver:               d.StorageDriver(),
    52  		GraphDriverOptions:        nil,
    53  		IDMapping:                 &idtools.IdentityMapping{},
    54  		PluginGetter:              nil,
    55  		ExperimentalEnabled:       false,
    56  		OS:                        runtime.GOOS,
    57  	})
    58  	i := images.NewImageService(images.ImageServiceConfig{
    59  		LayerStore: layerStore,
    60  	})
    61  
    62  	img := "test-garbage-collector"
    63  
    64  	// Build a image with multiple layers
    65  	dockerfile := `FROM busybox
    66  	RUN echo echo Running... > /run.sh`
    67  	source := fakecontext.New(t, "", fakecontext.WithDockerfile(dockerfile))
    68  	defer source.Close()
    69  	resp, err := client.ImageBuild(ctx,
    70  		source.AsTarReader(t),
    71  		types.ImageBuildOptions{
    72  			Remove:      true,
    73  			ForceRemove: true,
    74  			Tags:        []string{img},
    75  		})
    76  	assert.NilError(t, err)
    77  	_, err = io.Copy(ioutil.Discard, resp.Body)
    78  	resp.Body.Close()
    79  	assert.NilError(t, err)
    80  	image, _, err := client.ImageInspectWithRaw(ctx, img)
    81  	assert.NilError(t, err)
    82  
    83  	// Mark latest image layer to immutable
    84  	data := image.GraphDriver.Data
    85  	file, _ := os.Open(data["UpperDir"])
    86  	attr := 0x00000010
    87  	fsflags := uintptr(0x40086602)
    88  	argp := uintptr(unsafe.Pointer(&attr))
    89  	_, _, errno := syscall.Syscall(syscall.SYS_IOCTL, file.Fd(), fsflags, argp)
    90  	assert.Equal(t, "errno 0", errno.Error())
    91  
    92  	// Try to remove the image, it should generate error
    93  	// but marking layer back to mutable before checking errors (so we don't break CI server)
    94  	_, err = client.ImageRemove(ctx, img, types.ImageRemoveOptions{})
    95  	attr = 0x00000000
    96  	argp = uintptr(unsafe.Pointer(&attr))
    97  	_, _, errno = syscall.Syscall(syscall.SYS_IOCTL, file.Fd(), fsflags, argp)
    98  	assert.Equal(t, "errno 0", errno.Error())
    99  	assert.Assert(t, err != nil)
   100  	errStr := err.Error()
   101  	if !(strings.Contains(errStr, "permission denied") || strings.Contains(errStr, "operation not permitted")) {
   102  		t.Errorf("ImageRemove error not an permission error %s", errStr)
   103  	}
   104  
   105  	// Verify that layer remaining on disk
   106  	dir, _ := os.Stat(data["UpperDir"])
   107  	assert.Equal(t, "true", strconv.FormatBool(dir.IsDir()))
   108  
   109  	// Run imageService.Cleanup() and make sure that layer was removed from disk
   110  	i.Cleanup()
   111  	_, err = os.Stat(data["UpperDir"])
   112  	assert.Assert(t, os.IsNotExist(err))
   113  
   114  	// Make sure that removal pending layers does not exist on layerdb either
   115  	layerdbItems, _ := ioutil.ReadDir(filepath.Join(d.RootDir(), "/image/overlay2/layerdb/sha256"))
   116  	for _, folder := range layerdbItems {
   117  		assert.Equal(t, false, strings.HasSuffix(folder.Name(), "-removing"))
   118  	}
   119  }