Skip to content

Commit ba86eb2

Browse files
ajoshua2004ajoshua2004
committed
podman buildx inspect support
Added support for "podman buildx inspect". The goal was to replicate the default output from "docker buildx inspect" as much as possible but a problem encountered was podman not supporting BuildKit. To replicate the output I resorted to printing the statements with default values but only changed the driver name to use podman instead of docker. Since there was no buildkit, gave it the value of "N/A" to depict it's not supported. For Platforms, I resorted to using the emulated architectures found on your linux system + the host architecture of your local machine or podman server. The bootstrap flag was also added but is considered a NOP since there is no buildkit container to run before running inspect. An extra field was added to the HostInfo struct so when you run "podman info" the emulated architectures will show, this was used so you can grab the information from the podman engine. Fixes #13014 Signed-off-by: Joshua Arrevillaga <[email protected]>
1 parent 7aa4baa commit ba86eb2

File tree

4 files changed

+304
-0
lines changed

4 files changed

+304
-0
lines changed

‎cmd/podman/images/buildx_inspect.go‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
package images
2+
3+
import (
4+
"fmt"
5+
"strings"
6+
7+
"github.com/containers/podman/v5/cmd/podman/registry"
8+
"github.com/spf13/cobra"
9+
)
10+
11+
type buildNode struct {
12+
Name string
13+
Endpoint string
14+
Status string
15+
BuildkitVersion string
16+
Platforms []string
17+
}
18+
19+
type buildxInspectOutput struct {
20+
builderName string
21+
driverName string
22+
Nodes []buildNode
23+
}
24+
25+
var buildxInspectCmd = &cobra.Command{
26+
Use: "inspect",
27+
Short: "Inspects the current buildx builder instance",
28+
Long: "Displays information about the current builder instance (compatibility with Docker buildx inspect)",
29+
RunE: runBuildxInspect,
30+
Example: `podman buildx inspect
31+
podman buildx inspect --bootstrap`,
32+
}
33+
34+
func init() {
35+
buildxInspectCmd.Flags().Bool("bootstrap", false, "Currently a No Op for podman")
36+
registry.Commands = append(registry.Commands, registry.CliCommand{
37+
Command: buildxInspectCmd,
38+
Parent: buildxCmd,
39+
})
40+
}
41+
42+
func runBuildxInspect(cmd *cobra.Command, args []string) error {
43+
// Constants are based on default values for Docker buildx inspect.
44+
defaultNode := buildNode{
45+
Name: "default",
46+
Endpoint: "default",
47+
Status: "running",
48+
BuildkitVersion: "N/A",
49+
Platforms: []string{"unknown/unknown"},
50+
}
51+
52+
ctx := cmd.Context()
53+
54+
infoReport, infoErr := registry.ContainerEngine().Info(ctx)
55+
56+
if infoErr != nil {
57+
return fmt.Errorf("retrieving podman engine information: %w", infoErr)
58+
}
59+
60+
if registry.IsRemote() {
61+
runtimeOS := infoReport.Host.OS
62+
runtimeArch := infoReport.Host.Arch
63+
defaultNode.Platforms = []string{fmt.Sprintf("%s/%s", runtimeOS, runtimeArch)}
64+
} else {
65+
platforms := infoReport.Host.EmulatedArchitectures
66+
platforms = append(platforms, fmt.Sprintf("%s/%s", infoReport.Host.OS, infoReport.Host.Arch))
67+
defaultNode.Platforms = platforms
68+
}
69+
70+
out := buildxInspectOutput{
71+
builderName: "default",
72+
driverName: "podman",
73+
Nodes: []buildNode{defaultNode},
74+
}
75+
76+
fmt.Printf("Name: %s\n", out.builderName)
77+
fmt.Printf("Driver: %s\n", out.driverName)
78+
fmt.Println()
79+
80+
fmt.Println("Nodes:")
81+
fmt.Printf("Name: %s\n", out.Nodes[0].Name)
82+
fmt.Printf("Endpoint: %s\n", out.Nodes[0].Endpoint)
83+
fmt.Printf("Status: %s\n", out.Nodes[0].Status)
84+
fmt.Printf("Buildkit version: %s\n", out.Nodes[0].BuildkitVersion)
85+
86+
fmt.Printf("Platforms: %s\n", strings.Join(out.Nodes[0].Platforms, ", "))
87+
fmt.Println("Labels: ")
88+
return nil
89+
}

‎libpod/define/info.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ type HostInfo struct {
6666
Uptime string `json:"uptime"`
6767
Variant string `json:"variant"`
6868
Linkmode string `json:"linkmode"`
69+
70+
EmulatedArchitectures []string `json:"emulatedArchitectures,omitempty"`
6971
}
7072

7173
// RemoteSocket describes information about the API socket

‎pkg/domain/infra/abi/system.go‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import (
1515
"github.com/containers/podman/v5/libpod/define"
1616
"github.com/containers/podman/v5/pkg/domain/entities"
1717
"github.com/containers/podman/v5/pkg/domain/entities/reports"
18+
"github.com/containers/podman/v5/pkg/emulation"
1819
"github.com/containers/podman/v5/pkg/util"
1920
"github.com/containers/storage"
2021
"github.com/containers/storage/pkg/directory"
@@ -27,6 +28,9 @@ func (ic *ContainerEngine) Info(ctx context.Context) (*define.Info, error) {
2728
if err != nil {
2829
return nil, err
2930
}
31+
32+
info.Host.EmulatedArchitectures = emulation.Registered()
33+
3034
info.Host.RemoteSocket = &define.RemoteSocket{Path: ic.Libpod.RemoteURI()}
3135

3236
// `podman system connection add` invokes podman via ssh to fill in connection string. Here

‎test/e2e/buildx_inspect_test.go‎

Lines changed: 209 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,209 @@
1+
//go:build linux || freebsd
2+
3+
package integration
4+
5+
import (
6+
"fmt"
7+
"regexp"
8+
"strings"
9+
10+
"github.com/containers/podman/v5/cmd/podman/registry"
11+
. "github.com/onsi/ginkgo/v2"
12+
. "github.com/onsi/gomega"
13+
)
14+
15+
var _ = Describe("Podman buildx inspect", func() {
16+
It("podman-remote buildx inspect", func() {
17+
if !registry.IsRemote() {
18+
Skip("This test is only applicable for remote podman")
19+
}
20+
21+
session := podmanTest.PodmanExitCleanly("buildx", "inspect")
22+
output := session.OutputToString()
23+
24+
infoSession := podmanTest.PodmanExitCleanly("info", "--format", "{{.Host.OS}}/{{.Host.Arch}}")
25+
expectedNativePlatform := strings.TrimSpace(infoSession.OutputToString())
26+
27+
Expect(output).To(MatchRegexp(`Platforms:\s+.*\b` + regexp.QuoteMeta(expectedNativePlatform) + `\b`))
28+
})
29+
30+
It("podman-remote buildx inspect --bootstrap", func() {
31+
if !registry.IsRemote() {
32+
Skip("This test is only applicable for remote podman")
33+
}
34+
35+
session := podmanTest.PodmanExitCleanly("buildx", "inspect", "--bootstrap")
36+
output := session.OutputToString()
37+
38+
infoSession := podmanTest.PodmanExitCleanly("info", "--format", "{{.Host.OS}}/{{.Host.Arch}}")
39+
expectedNativePlatform := strings.TrimSpace(infoSession.OutputToString())
40+
41+
Expect(output).To(MatchRegexp(`Platforms:\s+.*\b` + regexp.QuoteMeta(expectedNativePlatform) + `\b`))
42+
})
43+
44+
It("podman buildx inspect", func() {
45+
if registry.IsRemote() {
46+
Skip("This test is only applicable for local podman")
47+
}
48+
49+
session := podmanTest.PodmanExitCleanly("buildx", "inspect")
50+
stdErr := session.ErrorToString()
51+
Expect(stdErr).ToNot(MatchRegexp(`(?i)error starting|fail|fatal|panic`), "stderr should not contain critical error keywords, got: %s", stdErr)
52+
53+
buildxOutput := session.OutputToString()
54+
55+
nativeInfoSession := podmanTest.PodmanExitCleanly("info", "--format", "{{.Host.OS}}/{{.Host.Arch}}")
56+
expectedNativePlatform := strings.TrimSpace(nativeInfoSession.OutputToString())
57+
Expect(expectedNativePlatform).ToNot(BeEmpty())
58+
59+
hostOSSession := podmanTest.PodmanExitCleanly("info", "--format", "{{.Host.OS}}")
60+
backendHostOS := strings.TrimSpace(hostOSSession.OutputToString())
61+
Expect(backendHostOS).ToNot(BeEmpty())
62+
63+
emulatedArchsNamesSession := podmanTest.PodmanExitCleanly("info", "--format", "{{.Host.EmulatedArchitectures}}")
64+
emulatedArchsOutputString := strings.TrimSpace(emulatedArchsNamesSession.OutputToString())
65+
66+
var emulatedArchNames []string
67+
if strings.HasPrefix(emulatedArchsOutputString, "[") && strings.HasSuffix(emulatedArchsOutputString, "]") {
68+
content := strings.Trim(emulatedArchsOutputString, "[]")
69+
if content != "" {
70+
emulatedArchNames = strings.Fields(content)
71+
}
72+
}
73+
74+
allExpectedPlatformsSet := make(map[string]bool)
75+
allExpectedPlatformsSlice := []string{}
76+
77+
if expectedNativePlatform != "" && expectedNativePlatform != "unknown/unknown" {
78+
allExpectedPlatformsSlice = append(allExpectedPlatformsSlice, expectedNativePlatform)
79+
allExpectedPlatformsSet[expectedNativePlatform] = true
80+
}
81+
82+
for _, archName := range emulatedArchNames {
83+
formattedEmuPlatform := archName
84+
if !allExpectedPlatformsSet[formattedEmuPlatform] {
85+
allExpectedPlatformsSlice = append(allExpectedPlatformsSlice, formattedEmuPlatform)
86+
allExpectedPlatformsSet[formattedEmuPlatform] = true
87+
}
88+
}
89+
90+
if len(allExpectedPlatformsSlice) == 0 {
91+
allExpectedPlatformsSlice = append(allExpectedPlatformsSlice, "unknown/unknown")
92+
}
93+
94+
platformsLineRegex := regexp.MustCompile(`Platforms:\s+(.*)`)
95+
matches := platformsLineRegex.FindStringSubmatch(buildxOutput)
96+
Expect(matches).ToNot(BeNil())
97+
Expect(len(matches)).To(BeNumerically(">", 1))
98+
actualPlatformsListedString := strings.TrimSpace(matches[1])
99+
100+
for _, expectedPlatform := range allExpectedPlatformsSlice {
101+
if expectedPlatform == "unknown/unknown" && len(allExpectedPlatformsSlice) > 1 {
102+
continue
103+
}
104+
Expect(actualPlatformsListedString).To(ContainSubstring(expectedPlatform))
105+
106+
actualPlatformParts := strings.Split(actualPlatformsListedString, ", ")
107+
var cleanActualListedPlatforms []string
108+
for _, p := range actualPlatformParts {
109+
trimmedP := strings.TrimSpace(p)
110+
if trimmedP != "" {
111+
cleanActualListedPlatforms = append(cleanActualListedPlatforms, trimmedP)
112+
}
113+
}
114+
115+
Expect(cleanActualListedPlatforms).To(HaveLen(len(allExpectedPlatformsSlice)), fmt.Sprintf("Number of listed platforms should match. Got: '%s' (%d platforms), Expected: '%v' (%d platforms)",
116+
actualPlatformsListedString, len(cleanActualListedPlatforms), allExpectedPlatformsSlice, len(allExpectedPlatformsSlice)))
117+
118+
if expectedNativePlatform != "" && expectedNativePlatform != "unknown/unknown" {
119+
if len(allExpectedPlatformsSlice) == 1 && allExpectedPlatformsSlice[0] == "unknown/unknown" {
120+
} else {
121+
Expect(actualPlatformsListedString).NotTo(Equal("unknown/unknown"))
122+
}
123+
}
124+
}
125+
})
126+
127+
It("podman buildx inspect --bootstrap", func() {
128+
if registry.IsRemote() {
129+
Skip("This test is only applicable for local podman")
130+
}
131+
132+
session := podmanTest.PodmanExitCleanly("buildx", "inspect", "--bootstrap")
133+
stdErr := session.ErrorToString()
134+
Expect(stdErr).ToNot(MatchRegexp(`(?i)error starting|fail|fatal|panic`), "stderr should not contain critical error keywords, got: %s", stdErr)
135+
136+
buildxOutput := session.OutputToString()
137+
138+
nativeInfoSession := podmanTest.PodmanExitCleanly("info", "--format", "{{.Host.OS}}/{{.Host.Arch}}")
139+
expectedNativePlatform := strings.TrimSpace(nativeInfoSession.OutputToString())
140+
Expect(expectedNativePlatform).ToNot(BeEmpty())
141+
142+
hostOSSession := podmanTest.PodmanExitCleanly("info", "--format", "{{.Host.OS}}")
143+
backendHostOS := strings.TrimSpace(hostOSSession.OutputToString())
144+
Expect(backendHostOS).ToNot(BeEmpty())
145+
146+
emulatedArchsNamesSession := podmanTest.PodmanExitCleanly("info", "--format", "{{.Host.EmulatedArchitectures}}")
147+
emulatedArchsOutputString := strings.TrimSpace(emulatedArchsNamesSession.OutputToString())
148+
149+
var emulatedArchNames []string
150+
if strings.HasPrefix(emulatedArchsOutputString, "[") && strings.HasSuffix(emulatedArchsOutputString, "]") {
151+
content := strings.Trim(emulatedArchsOutputString, "[]")
152+
if content != "" {
153+
emulatedArchNames = strings.Fields(content)
154+
}
155+
}
156+
157+
allExpectedPlatformsSet := make(map[string]bool)
158+
allExpectedPlatformsSlice := []string{}
159+
160+
if expectedNativePlatform != "" && expectedNativePlatform != "unknown/unknown" {
161+
allExpectedPlatformsSlice = append(allExpectedPlatformsSlice, expectedNativePlatform)
162+
allExpectedPlatformsSet[expectedNativePlatform] = true
163+
}
164+
165+
for _, archName := range emulatedArchNames {
166+
formattedEmuPlatform := archName
167+
if !allExpectedPlatformsSet[formattedEmuPlatform] {
168+
allExpectedPlatformsSlice = append(allExpectedPlatformsSlice, formattedEmuPlatform)
169+
allExpectedPlatformsSet[formattedEmuPlatform] = true
170+
}
171+
}
172+
173+
if len(allExpectedPlatformsSlice) == 0 {
174+
allExpectedPlatformsSlice = append(allExpectedPlatformsSlice, "unknown/unknown")
175+
}
176+
177+
platformsLineRegex := regexp.MustCompile(`Platforms:\s+(.*)`)
178+
matches := platformsLineRegex.FindStringSubmatch(buildxOutput)
179+
Expect(matches).ToNot(BeNil())
180+
Expect(len(matches)).To(BeNumerically(">", 1))
181+
actualPlatformsListedString := strings.TrimSpace(matches[1])
182+
183+
for _, expectedPlatform := range allExpectedPlatformsSlice {
184+
if expectedPlatform == "unknown/unknown" && len(allExpectedPlatformsSlice) > 1 {
185+
continue
186+
}
187+
Expect(actualPlatformsListedString).To(ContainSubstring(expectedPlatform))
188+
189+
actualPlatformParts := strings.Split(actualPlatformsListedString, ", ")
190+
var cleanActualListedPlatforms []string
191+
for _, p := range actualPlatformParts {
192+
trimmedP := strings.TrimSpace(p)
193+
if trimmedP != "" {
194+
cleanActualListedPlatforms = append(cleanActualListedPlatforms, trimmedP)
195+
}
196+
}
197+
198+
Expect(cleanActualListedPlatforms).To(HaveLen(len(allExpectedPlatformsSlice)), fmt.Sprintf("Number of listed platforms should match. Got: '%s' (%d platforms), Expected: '%v' (%d platforms)",
199+
actualPlatformsListedString, len(cleanActualListedPlatforms), allExpectedPlatformsSlice, len(allExpectedPlatformsSlice)))
200+
201+
if expectedNativePlatform != "" && expectedNativePlatform != "unknown/unknown" {
202+
if len(allExpectedPlatformsSlice) == 1 && allExpectedPlatformsSlice[0] == "unknown/unknown" {
203+
} else {
204+
Expect(actualPlatformsListedString).NotTo(Equal("unknown/unknown"))
205+
}
206+
}
207+
}
208+
})
209+
})

0 commit comments

Comments
 (0)