podman/test/e2e/diff_test.go

//go:build linux || freebsd

package integration

import (
	"fmt"
	"sort"

	. "github.com/containers/podman/v5/test/utils"
	"github.com/containers/storage/pkg/stringid"
	. "github.com/onsi/ginkgo/v2"
	. "github.com/onsi/gomega"
)

var _ = Describe("Podman diff", func() {

	It("podman diff of image", func() {
		session := podmanTest.Podman([]string{"diff", ALPINE})
		session.WaitWithDefaultTimeout()
		Expect(session).Should(ExitCleanly())
		Expect(session.OutputToStringArray()).ToNot(BeEmpty())
	})

	It("podman diff bogus image", func() {
		session := podmanTest.Podman([]string{"diff", "1234"})
		session.WaitWithDefaultTimeout()
		Expect(session).Should(ExitWithError(125, "1234 not found: layer not known"))
	})

	It("podman diff image with json output", func() {
		session := podmanTest.Podman([]string{"diff", "--format=json", ALPINE})
		session.WaitWithDefaultTimeout()
		Expect(session).Should(ExitCleanly())
		Expect(session.OutputToString()).To(BeValidJSON())
	})

	It("podman diff container and committed image", func() {
		session := podmanTest.Podman([]string{"run", "--name=diff-test", ALPINE, "touch", "/tmp/diff-test"})
		session.WaitWithDefaultTimeout()
		Expect(session).Should(ExitCleanly())
		session = podmanTest.Podman([]string{"diff", "diff-test"})
		session.WaitWithDefaultTimeout()
		containerDiff := session.OutputToStringArray()
		sort.Strings(containerDiff)
		Expect(session.OutputToString()).To(ContainSubstring("C /tmp"))
		Expect(session.OutputToString()).To(ContainSubstring("A /tmp/diff-test"))
		session = podmanTest.Podman([]string{"commit", "-q", "diff-test", "diff-test-img"})
		session.WaitWithDefaultTimeout()
		Expect(session).Should(ExitCleanly())
		session = podmanTest.Podman([]string{"diff", "diff-test-img"})
		session.WaitWithDefaultTimeout()
		imageDiff := session.OutputToStringArray()
		sort.Strings(imageDiff)
		Expect(imageDiff).To(Equal(containerDiff))
	})

	It("podman diff latest container", func() {
		session := podmanTest.Podman([]string{"run", "--name", "diff-test", ALPINE, "touch", "/tmp/diff-test"})
		session.WaitWithDefaultTimeout()
		Expect(session).Should(ExitCleanly())
		if !IsRemote() {
			session = podmanTest.Podman([]string{"diff", "-l"})
		} else {
			session = podmanTest.Podman([]string{"diff", "diff-test"})
		}
		session.WaitWithDefaultTimeout()
		containerDiff := session.OutputToStringArray()
		sort.Strings(containerDiff)
		Expect(session.OutputToString()).To(ContainSubstring("C /tmp"))
		Expect(session.OutputToString()).To(ContainSubstring("A /tmp/diff-test"))
		Expect(session).Should(ExitCleanly())
	})

	It("podman image diff", func() {
		file1 := "/" + stringid.GenerateRandomID()
		file2 := "/" + stringid.GenerateRandomID()
		file3 := "/" + stringid.GenerateRandomID()

		// Create container image with the files
		containerfile := fmt.Sprintf(`
FROM  %s
RUN touch %s
RUN touch %s
RUN touch %s`, ALPINE, file1, file2, file3)

		image := "podman-diff-test"
		podmanTest.BuildImage(containerfile, image, "true")

		// build a second image which used as base to compare against
		// using ALPINE does not work in CI, most likely due the extra vfs.imagestore
		containerfile = fmt.Sprintf(`
FROM  %s
RUN echo test
`, ALPINE)
		baseImage := "base-image"
		podmanTest.BuildImage(containerfile, baseImage, "true")

		session := podmanTest.Podman([]string{"image", "diff", image})
		session.WaitWithDefaultTimeout()
		Expect(session).Should(ExitCleanly())
		Expect(session.OutputToStringArray()).To(HaveLen(1))
		Expect(session.OutputToString()).To(Equal("A " + file3))

		session = podmanTest.Podman([]string{"image", "diff", image, baseImage})
		session.WaitWithDefaultTimeout()
		Expect(session).Should(ExitCleanly())
		// Comment out https://github.com/containers/podman/issues/26680.
		//		Expect(session.OutputToStringArray()).To(HaveLen(4))
		//		Expect(session.OutputToString()).To(ContainSubstring("A " + file1))
		//		Expect(session.OutputToString()).To(ContainSubstring("A " + file2))
		//		Expect(session.OutputToString()).To(ContainSubstring("A " + file3))
	})

	It("podman image diff of single image", func() {
		session := podmanTest.Podman([]string{"image", "diff", BB})
		session.WaitWithDefaultTimeout()
		Expect(session).Should(ExitCleanly())
		Expect(session.OutputToStringArray()).ToNot(BeEmpty())
	})

	It("podman image diff bogus image", func() {
		session := podmanTest.Podman([]string{"image", "diff", "1234", ALPINE})
		session.WaitWithDefaultTimeout()
		Expect(session).Should(ExitWithError(125, "1234 not found: 1234: image not known"))
	})

	It("podman image diff of the same image", func() {
		session := podmanTest.Podman([]string{"image", "diff", ALPINE, ALPINE})
		session.WaitWithDefaultTimeout()
		Expect(session).Should(ExitCleanly())
		Expect(session.OutputToStringArray()).To(BeEmpty())
	})

	// Commented out on July 23, 2025 to avoid issue noted in
	// https://github.com/containers/podman/issues/26680.  Uncomment
	// once that is addressed.
	//
	//	It("podman diff container and image with same name", func() {
	//		imagefile := "/" + stringid.GenerateRandomID()
	//		confile := "/" + stringid.GenerateRandomID()
	//
	//		// Create container image with the files
	//		containerfile := fmt.Sprintf(`
	// FROM  %s
	// RUN touch %s`, ALPINE, imagefile)
	//
	//		name := "podman-diff-test"
	//		podmanTest.BuildImage(containerfile, name, "false")
	//
	//		session := podmanTest.Podman([]string{"run", "--name", name, ALPINE, "touch", confile})
	//		session.WaitWithDefaultTimeout()
	//		Expect(session).Should(ExitCleanly())
	//
	//		// podman diff prefers image over container when they have the same name
	//		session = podmanTest.Podman([]string{"diff", name})
	//		session.WaitWithDefaultTimeout()
	//		Expect(session).Should(ExitCleanly())
	//		Expect(session.OutputToStringArray()).To(HaveLen(1))
	//		Expect(session.OutputToString()).To(ContainSubstring(imagefile))
	//
	//		session = podmanTest.Podman([]string{"image", "diff", name})
	//		session.WaitWithDefaultTimeout()
	//		Expect(session).Should(ExitCleanly())
	//		Expect(session.OutputToStringArray()).To(HaveLen(1))
	//		Expect(session.OutputToString()).To(ContainSubstring(imagefile))
	//
	//		// container diff has to show the container
	//		session = podmanTest.Podman([]string{"container", "diff", name})
	//		session.WaitWithDefaultTimeout()
	//		Expect(session).Should(ExitCleanly())
	//		Expect(session.OutputToStringArray()).To(HaveLen(2))
	//		Expect(session.OutputToString()).To(ContainSubstring(confile))
	//	})

	It("podman diff without args", func() {
		session := podmanTest.Podman([]string{"diff"})
		session.WaitWithDefaultTimeout()
		if IsRemote() {
			Expect(session).Should(ExitWithError(125, " requires a name or id"))
		} else {
			Expect(session).Should(ExitWithError(125, " requires a name, id, or the \"--latest\" flag"))
		}
	})
})