opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-05-22 01:27:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

quadlet should exit non zero on failures

Browse Source 
Fixes: #18778

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
This commit is contained in:
Daniel J Walsh
2023-06-15 19:12:17 -04:00
parent 189a74d345
commit bfe61af6d7
2 changed files with 170 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
cmd/quadlet/main.go
View File

@ -77,8 +77,7 @@ func Logf(format string, a ...interface{}) {
s := fmt.Sprintf(format, a...) s := fmt.Sprintf(format, a...)
line := fmt.Sprintf("quadlet-generator[%d]: %s", os.Getpid(), s) line := fmt.Sprintf("quadlet-generator[%d]: %s", os.Getpid(), s)
if !logToKmsg(line) { if !logToKmsg(line) || dryRunFlag {
// If we can't log, print to stderr
fmt.Fprintf(os.Stderr, "%s\n", line) fmt.Fprintf(os.Stderr, "%s\n", line)
os.Stderr.Sync() os.Stderr.Sync()
} }
@ -133,13 +132,14 @@ func isExtSupported(filename string) bool {
return ok return ok
} }
func loadUnitsFromDir(sourcePath string, units map[string]*parser.UnitFile) { func loadUnitsFromDir(sourcePath string, units map[string]*parser.UnitFile) error {
var prevError error
files, err := os.ReadDir(sourcePath) files, err := os.ReadDir(sourcePath)
if err != nil { if err != nil {
if !errors.Is(err, os.ErrNotExist) { if !errors.Is(err, os.ErrNotExist) {
Logf("Can't read \"%s\": %s", sourcePath, err) return err
} }
return return nil
} }
for _, file := range files { for _, file := range files {
@ -150,16 +150,20 @@ func loadUnitsFromDir(sourcePath string, units map[string]*parser.UnitFile) {
Debugf("Loading source unit file %s", path) Debugf("Loading source unit file %s", path)
if f, err := parser.ParseUnitFile(path); err != nil { if f, err := parser.ParseUnitFile(path); err != nil {
Logf("Error loading '%s', ignoring: %s", path, err) err = fmt.Errorf("error loading %q, %w", path, err)
if prevError != nil {
prevError = fmt.Errorf("%s\n%s", prevError, err)
}
} else { } else {
units[name] = f units[name] = f
} }
} }
} }
return prevError
} }
func generateServiceFile(service *parser.UnitFile) error { func generateServiceFile(service *parser.UnitFile) error {
Debugf("writing '%s'", service.Path) Debugf("writing %q", service.Path)
service.PrependComment("", service.PrependComment("",
fmt.Sprintf("Automatically generated by %s", os.Args[0]), fmt.Sprintf("Automatically generated by %s", os.Args[0]),
@ -303,7 +307,16 @@ func warnIfAmbiguousName(container *parser.UnitFile) {
} }
func main() { func main() {
exitCode := 0 if err := process(); err != nil {
Logf("%s", err.Error())
os.Exit(1)
}
os.Exit(0)
}
func process() error {
var prevError error
prgname := path.Base(os.Args[0]) prgname := path.Base(os.Args[0])
isUserFlag = strings.Contains(prgname, "user") isUserFlag = strings.Contains(prgname, "user")
@ -311,7 +324,7 @@ func main() {
if versionFlag { if versionFlag {
fmt.Printf("%s\n", rawversion.RawVersion) fmt.Printf("%s\n", rawversion.RawVersion)
return return prevError
} }
if verboseFlag || dryRunFlag { if verboseFlag || dryRunFlag {
@ -322,9 +335,16 @@ func main() {
noKmsg = true noKmsg = true
} }
reportError := func(err error) {
if prevError != nil {
err = fmt.Errorf("%s\n%s", prevError, err)
}
prevError = err
}
if !dryRunFlag && flag.NArg() < 1 { if !dryRunFlag && flag.NArg() < 1 {
Logf("Missing output directory argument") reportError(errors.New("missing output directory argument"))
os.Exit(1) return prevError
} }
var outputPath string var outputPath string
@ -339,21 +359,23 @@ func main() {
units := make(map[string]*parser.UnitFile) units := make(map[string]*parser.UnitFile)
for _, d := range sourcePaths { for _, d := range sourcePaths {
loadUnitsFromDir(d, units) if err := loadUnitsFromDir(d, units); err != nil {
reportError(err)
}
} }
if len(units) == 0 { if len(units) == 0 {
// containers/podman/issues/17374: exit cleanly but log that we // containers/podman/issues/17374: exit cleanly but log that we
// had nothing to do // had nothing to do
Debugf("No files to parse from %s", sourcePaths) Debugf("No files parsed from %s", sourcePaths)
os.Exit(0) return prevError
} }
if !dryRunFlag { if !dryRunFlag {
err := os.MkdirAll(outputPath, os.ModePerm) err := os.MkdirAll(outputPath, os.ModePerm)
if err != nil { if err != nil {
Logf("Can't create dir %s: %s", outputPath, err) reportError(err)
os.Exit(1) return prevError
} }
} }
@ -372,33 +394,31 @@ func main() {
case strings.HasSuffix(name, ".network"): case strings.HasSuffix(name, ".network"):
service, err = quadlet.ConvertNetwork(unit, name) service, err = quadlet.ConvertNetwork(unit, name)
default: default:
Logf("Unsupported file type '%s'", name) Logf("Unsupported file type %q", name)
continue continue
} }
if err != nil { if err != nil {
Logf("Error converting '%s', ignoring: %s", name, err) reportError(fmt.Errorf("converting %q: %w", name, err))
} else { continue
service.Path = path.Join(outputPath, service.Filename)
if dryRunFlag {
data, err := service.ToString()
if err != nil {
Debugf("Error parsing %s\n---\n", service.Path)
exitCode = 1
} else {
fmt.Printf("---%s---\n%s\n", service.Path, data)
}
} else {
if err := generateServiceFile(service); err != nil {
Logf("Error writing '%s'o: %s", service.Path, err)
}
enableServiceFile(outputPath, service)
}
} }
} service.Path = path.Join(outputPath, service.Filename)
os.Exit(exitCode) if dryRunFlag {
data, err := service.ToString()
if err != nil {
reportError(fmt.Errorf("parsing %s: %w", service.Path, err))
continue
}
fmt.Printf("---%s---\n%s\n", service.Path, data)
continue
}
if err := generateServiceFile(service); err != nil {
reportError(fmt.Errorf("generating service file %s: %w", service.Path, err))
}
enableServiceFile(outputPath, service)
}
return prevError
} }
func init() { func init() {

210
test/e2e/quadlet_test.go
View File

@ -451,11 +451,26 @@ var _ = Describe("quadlet system generator", func() {
Expect(session).Should(Exit(0)) Expect(session).Should(Exit(0))
current := session.ErrorToStringArray() current := session.ErrorToStringArray()
expected := "No files to parse from [/something]" expected := "No files parsed from [/something]"
Expect(current[0]).To(ContainSubstring(expected)) Expect(current[0]).To(ContainSubstring(expected))
}) })
It("Should fail on bad quadlet", func() {
quadletfile := fmt.Sprintf(`[Container]
Image=%s
BOGUS=foo
`, ALPINE)
quadletfilePath := filepath.Join(podmanTest.TempDir, "bogus.container")
err = os.WriteFile(quadletfilePath, []byte(quadletfile), 0644)
Expect(err).ToNot(HaveOccurred())
defer os.Remove(quadletfilePath)
session := podmanTest.Quadlet([]string{"-dryrun"}, podmanTest.TempDir)
session.WaitWithDefaultTimeout()
Expect(session).Should(Exit(1))
})
It("Should parse a kube file and print it to stdout", func() { It("Should parse a kube file and print it to stdout", func() {
fileName := "basic.kube" fileName := "basic.kube"
testcase := loadQuadletTestcase(filepath.Join("quadlet", fileName)) testcase := loadQuadletTestcase(filepath.Join("quadlet", fileName))
@ -511,7 +526,7 @@ var _ = Describe("quadlet system generator", func() {
}) })
DescribeTable("Running quadlet test case", DescribeTable("Running quadlet test case",
func(fileName string) { func(fileName string, exitCode int, errString string) {
testcase := loadQuadletTestcase(filepath.Join("quadlet", fileName)) testcase := loadQuadletTestcase(filepath.Join("quadlet", fileName))
// Write the tested file to the quadlet dir // Write the tested file to the quadlet dir
@ -519,114 +534,115 @@ var _ = Describe("quadlet system generator", func() {
Expect(err).ToNot(HaveOccurred()) Expect(err).ToNot(HaveOccurred())
// Run quadlet to convert the file // Run quadlet to convert the file
session := podmanTest.Quadlet([]string{"--user", "-no-kmsg-log", generatedDir}, quadletDir) session := podmanTest.Quadlet([]string{"--user", "--no-kmsg-log", generatedDir}, quadletDir)
session.WaitWithDefaultTimeout() session.WaitWithDefaultTimeout()
Expect(session).Should(Exit(0)) Expect(session).Should(Exit(exitCode))
// Print any stderr output // Print any stderr output
errs := session.ErrorToString() errs := session.ErrorToString()
if errs != "" { if errs != "" {
GinkgoWriter.Println("error:", session.ErrorToString()) GinkgoWriter.Println("error:", session.ErrorToString())
} }
Expect(errs).Should(ContainSubstring(errString))
testcase.check(generatedDir, session) testcase.check(generatedDir, session)
}, },
Entry("Basic container", "basic.container"), Entry("Basic container", "basic.container", 0, ""),
Entry("annotation.container", "annotation.container"), Entry("annotation.container", "annotation.container", 0, ""),
Entry("autoupdate.container", "autoupdate.container"), Entry("autoupdate.container", "autoupdate.container", 0, ""),
Entry("basepodman.container", "basepodman.container"), Entry("basepodman.container", "basepodman.container", 0, ""),
Entry("capabilities.container", "capabilities.container"), Entry("capabilities.container", "capabilities.container", 0, ""),
Entry("capabilities2.container", "capabilities2.container"), Entry("capabilities2.container", "capabilities2.container", 0, ""),
Entry("devices.container", "devices.container"), Entry("devices.container", "devices.container", 0, ""),
Entry("disableselinux.container", "disableselinux.container"), Entry("disableselinux.container", "disableselinux.container", 0, ""),
Entry("env-file.container", "env-file.container"), Entry("env-file.container", "env-file.container", 0, ""),
Entry("env-host-false.container", "env-host-false.container"), Entry("env-host-false.container", "env-host-false.container", 0, ""),
Entry("env-host.container", "env-host.container"), Entry("env-host.container", "env-host.container", 0, ""),
Entry("env.container", "env.container"), Entry("env.container", "env.container", 0, ""),
Entry("escapes.container", "escapes.container"), Entry("escapes.container", "escapes.container", 0, ""),
Entry("exec.container", "exec.container"), Entry("exec.container", "exec.container", 0, ""),
Entry("health.container", "health.container"), Entry("health.container", "health.container", 0, ""),
Entry("hostname.container", "hostname.container"), Entry("hostname.container", "hostname.container", 0, ""),
Entry("image.container", "image.container"), Entry("image.container", "image.container", 0, ""),
Entry("install.container", "install.container"), Entry("install.container", "install.container", 0, ""),
Entry("ip.container", "ip.container"), Entry("ip.container", "ip.container", 0, ""),
Entry("label.container", "label.container"), Entry("label.container", "label.container", 0, ""),
Entry("logdriver.container", "logdriver.container"), Entry("logdriver.container", "logdriver.container", 0, ""),
Entry("mask.container", "mask.container"), Entry("mask.container", "mask.container", 0, ""),
Entry("mount.container", "mount.container"), Entry("mount.container", "mount.container", 0, ""),
Entry("name.container", "name.container"), Entry("name.container", "name.container", 0, ""),
Entry("nestedselinux.container", "nestedselinux.container"), Entry("nestedselinux.container", "nestedselinux.container", 0, ""),
Entry("network.container", "network.container"), Entry("network.container", "network.container", 0, ""),
Entry("network.quadlet.container", "network.quadlet.container"), Entry("network.quadlet.container", "network.quadlet.container", 0, ""),
Entry("noimage.container", "noimage.container"), Entry("noimage.container", "noimage.container", 1, "converting \"noimage.container\": no Image or Rootfs key specified"),
Entry("notify.container", "notify.container"), Entry("notify.container", "notify.container", 0, ""),
Entry("oneshot.container", "oneshot.container"), Entry("oneshot.container", "oneshot.container", 0, ""),
Entry("other-sections.container", "other-sections.container"), Entry("other-sections.container", "other-sections.container", 0, ""),
Entry("podmanargs.container", "podmanargs.container"), Entry("podmanargs.container", "podmanargs.container", 0, ""),
Entry("ports.container", "ports.container"), Entry("ports.container", "ports.container", 0, ""),
Entry("ports_ipv6.container", "ports_ipv6.container"), Entry("ports_ipv6.container", "ports_ipv6.container", 0, ""),
Entry("pull.container", "pull.container"), Entry("pull.container", "pull.container", 0, ""),
Entry("readonly-notmpfs.container", "readonly-notmpfs.container"), Entry("readonly-notmpfs.container", "readonly-notmpfs.container", 0, ""),
Entry("readwrite-notmpfs.container", "readwrite-notmpfs.container"), Entry("readwrite-notmpfs.container", "readwrite-notmpfs.container", 0, ""),
Entry("readwrite.container", "readwrite.container"), Entry("readwrite.container", "readwrite.container", 0, ""),
Entry("remap-auto.container", "remap-auto.container"), Entry("remap-auto.container", "remap-auto.container", 0, ""),
Entry("remap-auto2.container", "remap-auto2.container"), Entry("remap-auto2.container", "remap-auto2.container", 0, ""),
Entry("remap-keep-id.container", "remap-keep-id.container"), Entry("remap-keep-id.container", "remap-keep-id.container", 0, ""),
Entry("remap-keep-id2.container", "remap-keep-id2.container"), Entry("remap-keep-id2.container", "remap-keep-id2.container", 0, ""),
Entry("remap-manual.container", "remap-manual.container"), Entry("remap-manual.container", "remap-manual.container", 0, ""),
Entry("rootfs.container", "rootfs.container"), Entry("rootfs.container", "rootfs.container", 0, ""),
Entry("seccomp.container", "seccomp.container"), Entry("seccomp.container", "seccomp.container", 0, ""),
Entry("secrets.container", "secrets.container"), Entry("secrets.container", "secrets.container", 0, ""),
Entry("selinux.container", "selinux.container"), Entry("selinux.container", "selinux.container", 0, ""),
Entry("shortname.container", "shortname.container"), Entry("shortname.container", "shortname.container", 0, "Warning: shortname.container specifies the image \"shortname\" which not a fully qualified image name. This is not ideal for performance and security reasons. See the podman-pull manpage discussion of short-name-aliases.conf for details."),
Entry("sysctl.container", "sysctl.container"), Entry("sysctl.container", "sysctl.container", 0, ""),
Entry("timezone.container", "timezone.container"), Entry("timezone.container", "timezone.container", 0, ""),
Entry("unmask.container", "unmask.container"), Entry("unmask.container", "unmask.container", 0, ""),
Entry("user.container", "user.container"), Entry("user.container", "user.container", 0, ""),
Entry("volume.container", "volume.container"), Entry("volume.container", "volume.container", 0, ""),
Entry("workingdir.container", "workingdir.container"), Entry("workingdir.container", "workingdir.container", 0, ""),
Entry("basic.volume", "basic.volume"), Entry("basic.volume", "basic.volume", 0, ""),
Entry("label.volume", "label.volume"), Entry("device-copy.volume", "device-copy.volume", 0, ""),
Entry("uid.volume", "uid.volume"), Entry("device.volume", "device.volume", 0, ""),
Entry("device-copy.volume", "device-copy.volume"), Entry("label.volume", "label.volume", 0, ""),
Entry("device.volume", "device.volume"), Entry("podmanargs.volume", "podmanargs.volume", 0, ""),
Entry("podmanargs.volume", "podmanargs.volume"), Entry("uid.volume", "uid.volume", 0, ""),
Entry("Basic kube", "basic.kube"), Entry("Absolute Path", "absolute.path.kube", 0, ""),
Entry("Syslog Identifier", "syslog.identifier.kube"), Entry("Basic kube", "basic.kube", 0, ""),
Entry("Absolute Path", "absolute.path.kube"), Entry("Kube - ConfigMap", "configmap.kube", 0, ""),
Entry("Kube - User Remap Manual", "remap-manual.kube"), Entry("Kube - Exit Code Propagation", "exit_code_propagation.kube", 0, ""),
Entry("Kube - User Remap Auto", "remap-auto.kube"), Entry("Kube - Logdriver", "logdriver.kube", 0, ""),
Entry("Kube - User Remap Auto with IDs", "remap-auto2.kube"), Entry("Kube - Network", "network.kube", 0, ""),
Entry("Kube - Network", "network.kube"), Entry("Kube - PodmanArgs", "podmanargs.kube", 0, ""),
Entry("Kube - Quadlet Network", "network.quadlet.kube"), Entry("Kube - Publish IPv4 ports", "ports.kube", 0, ""),
Entry("Kube - ConfigMap", "configmap.kube"), Entry("Kube - Publish IPv6 ports", "ports_ipv6.kube", 0, ""),
Entry("Kube - Publish IPv4 ports", "ports.kube"), Entry("Kube - Quadlet Network", "network.quadlet.kube", 0, ""),
Entry("Kube - Publish IPv6 ports", "ports_ipv6.kube"), Entry("Kube - User Remap Auto with IDs", "remap-auto2.kube", 0, ""),
Entry("Kube - Logdriver", "logdriver.kube"), Entry("Kube - User Remap Auto", "remap-auto.kube", 0, ""),
Entry("Kube - PodmanArgs", "podmanargs.kube"), Entry("Kube - User Remap Manual", "remap-manual.kube", 1, "converting \"remap-manual.kube\": RemapUsers=manual is not supported"),
Entry("Kube - Exit Code Propagation", "exit_code_propagation.kube"), Entry("Syslog Identifier", "syslog.identifier.kube", 0, ""),
Entry("Network - Basic", "basic.network"), Entry("Network - Basic", "basic.network", 0, ""),
Entry("Network - Label", "label.network"), Entry("Network - Disable DNS", "disable-dns.network", 0, ""),
Entry("Network - Disable DNS", "disable-dns.network"), Entry("Network - Driver", "driver.network", 0, ""),
Entry("Network - Driver", "driver.network"), Entry("Network - Gateway not enough Subnet", "gateway.less-subnet.network", 1, "converting \"gateway.less-subnet.network\": cannot set more gateways than subnets"),
Entry("Network - Subnets", "subnets.network"), Entry("Network - Gateway without Subnet", "gateway.no-subnet.network", 1, "converting \"gateway.no-subnet.network\": cannot set gateway or range without subnet"),
Entry("Network - Gateway", "gateway.network"), Entry("Network - Gateway", "gateway.network", 0, ""),
Entry("Network - Gateway without Subnet", "gateway.no-subnet.network"), Entry("Network - IPAM Driver", "ipam-driver.network", 0, ""),
Entry("Network - Gateway not enough Subnet", "gateway.less-subnet.network"), Entry("Network - IPv6", "ipv6.network", 0, ""),
Entry("Network - Range", "range.network"), Entry("Network - Internal network", "internal.network", 0, ""),
Entry("Network - Range without Subnet", "range.no-subnet.network"), Entry("Network - Label", "label.network", 0, ""),
Entry("Network - Range not enough Subnet", "range.less-subnet.network"), Entry("Network - Multiple Options", "options.multiple.network", 0, ""),
Entry("Network - subnet, gateway and range", "subnet-trio.network"), Entry("Network - Options", "options.network", 0, ""),
Entry("Network - multiple subnet, gateway and range", "subnet-trio.multiple.network"), Entry("Network - PodmanArgs", "podmanargs.network", 0, ""),
Entry("Network - Internal network", "internal.network"), Entry("Network - Range not enough Subnet", "range.less-subnet.network", 1, "converting \"range.less-subnet.network\": cannot set more ranges than subnets"),
Entry("Network - IPAM Driver", "ipam-driver.network"), Entry("Network - Range without Subnet", "range.no-subnet.network", 1, "converting \"range.no-subnet.network\": cannot set gateway or range without subnet"),
Entry("Network - IPv6", "ipv6.network"), Entry("Network - Range", "range.network", 0, ""),
Entry("Network - Options", "options.network"), Entry("Network - Subnets", "subnets.network", 0, ""),
Entry("Network - Multiple Options", "options.multiple.network"), Entry("Network - multiple subnet, gateway and range", "subnet-trio.multiple.network", 0, ""),
Entry("Network - PodmanArgs", "podmanargs.network"), Entry("Network - subnet, gateway and range", "subnet-trio.network", 0, ""),
) )
}) })