github.com/Heebron/moby@v0.0.0-20221111184709-6eab4f55faf7/integration/image/remove_unix_test.go (about)

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