github.com/Prakhar-Agarwal-byte/moby@v0.0.0-20231027092010-a14e3e8ab87e/integration/image/remove_unix_test.go (about)

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