Skip to content

pkg/config: rework testing and add new containers.rootless.conf search location #2499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Aug 7, 2025
Merged

pkg/config: rework testing and add new containers.rootless.conf search location #2499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
40e22ba
pkg/config: simplify addConfigs()
Luap99 Aug 4, 2025
37e9def
pkg/config: unexport config paths
Luap99 Aug 4, 2025
85ac702
pkg/config: add systemd wide rootless search locations
Luap99 Aug 4, 2025
a11d41e
pkg/config: make newLocked() unit testable
Luap99 Aug 5, 2025
2aaff5f
pkg/config: use newLocked() for tests
Luap99 Aug 5, 2025
5d22b5a
pkg/config: fix modules path lookup
Luap99 Aug 5, 2025
6c30f0c
pkg/config: remove NewConfig()
Luap99 Aug 5, 2025
f0ed5ca
pkg/config: remove additionalConfigs field
Luap99 Aug 5, 2025
527d275
pkg/config: add config file search order test
Luap99 Aug 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/containers.conf.5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ a TOML format that can be easily modified and versioned.

Container engines read the __/usr/share/containers/containers.conf__,
__/etc/containers/containers.conf__, and __/etc/containers/containers.conf.d/\*.conf__
for global configuration that effects all users.
for global configuration that affects all users.
For global configuration that only affects rootless users use __/etc/containers/containers.rootless.conf__,
__/etc/containers/containers.rootless.d/\*.conf__ and __/etc/containers/containers.rootless.d/\$UID/\*.conf__. The UID is the user's uid which podman runs under so it can be used to specify a certain config for only a single user without having to put the config into the user's home directory.
Copy link
Member

@mheon mheon Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you should split $UID out into a separate sentence. containers.rootless.conf and containers.rootless.conf.d are global configuration. the $UID bit is not, and should be discussed separately.

Copy link
Member Author

@Luap99 Luap99 Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mhh I read globally different here. Globally to me == system directories in this context.

How should this be worded instead then? tbf I think the entire paragraph is just pointless noise and hard to parse. I think just listing each location in the right order like I have in the design docs is likely the most logical.

For user specific configuration it reads __\$XDG_CONFIG_HOME/containers/containers.conf__ and
__\$XDG_CONFIG_HOME/containers/containers.conf.d/\*.conf__ files. When `$XDG_CONFIG_HOME` is not set it falls back to using `$HOME/.config` instead.

Expand Down
4 changes: 2 additions & 2 deletions pkg/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ import (
)

const (
// UserOverrideContainersConfig holds the containers config path overridden by the rootless user
UserOverrideContainersConfig = ".config/" + _configPath
// userOverrideContainersConfig holds the containers config path overridden by the rootless user.
userOverrideContainersConfig = ".config/" + _configPath
// Token prefix for looking for helper binary under $BINDIR
bindirPrefix = "$BINDIR"
)
Expand Down
8 changes: 4 additions & 4 deletions pkg/config/config_bsd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
package config

const (
// OverrideContainersConfig holds the default config path overridden by the root user
OverrideContainersConfig = "/usr/local/etc/" + _configPath
// overrideContainersConfig holds the default config path overridden by the root user.
overrideContainersConfig = "/usr/local/etc/" + _configPath

// DefaultContainersConfig holds the default containers config path
DefaultContainersConfig = "/usr/local/share/" + _configPath
// defaultContainersConfig holds the default containers config path.
defaultContainersConfig = "/usr/local/share/" + _configPath

// DefaultSignaturePolicyPath is the default value for the
// policy.json file.
Expand Down
8 changes: 4 additions & 4 deletions pkg/config/config_darwin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
package config

const (
// OverrideContainersConfig holds the default config path overridden by the root user
OverrideContainersConfig = "/etc/" + _configPath
// overrideContainersConfig holds the default config path overridden by the root user.
overrideContainersConfig = "/etc/" + _configPath

// DefaultContainersConfig holds the default containers config path
DefaultContainersConfig = "/usr/share/" + _configPath
// defaultContainersConfig holds the default containers config path.
defaultContainersConfig = "/usr/share/" + _configPath

// DefaultSignaturePolicyPath is the default value for the
// policy.json file.
Expand Down
8 changes: 4 additions & 4 deletions pkg/config/config_linux.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ import (
)

const (
// OverrideContainersConfig holds the default config path overridden by the root user
OverrideContainersConfig = "/etc/" + _configPath
// overrideContainersConfig holds the default config path overridden by the root user.
overrideContainersConfig = "/etc/" + _configPath

// DefaultContainersConfig holds the default containers config path
DefaultContainersConfig = "/usr/share/" + _configPath
// defaultContainersConfig holds the default containers config path.
defaultContainersConfig = "/usr/share/" + _configPath

// DefaultSignaturePolicyPath is the default value for the
// policy.json file.
Expand Down
80 changes: 40 additions & 40 deletions pkg/config/config_local_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ var _ = Describe("Config Local", func() {
})

It("parse network subnet pool", func() {
config, err := NewConfig("testdata/containers_default.conf")
config, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
net1, _ := types.ParseCIDR("10.89.0.0/16")
Expand All @@ -108,47 +108,47 @@ var _ = Describe("Config Local", func() {

It("parse dns port", func() {
// Given
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Network.DNSBindPort).To(gomega.Equal(uint16(0)))
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Network.DNSBindPort).To(gomega.Equal(uint16(1153)))
})

It("test firewall", func() {
// Given
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Network.FirewallDriver).To(gomega.Equal(string("")))
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Network.FirewallDriver).To(gomega.Equal("none"))
})

It("parse pasta_options", func() {
// Given
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Network.PastaOptions.Get()).To(gomega.BeEmpty())
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Network.PastaOptions.Get()).To(gomega.Equal([]string{"-t", "auto"}))
})

It("parse default_rootless_network_cmd", func() {
// Given
config, err := NewConfig("")
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Network.DefaultRootlessNetworkCmd).To(gomega.Equal("pasta"))
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Network.DefaultRootlessNetworkCmd).To(gomega.Equal("slirp4netns"))
Expand Down Expand Up @@ -338,7 +338,7 @@ var _ = Describe("Config Local", func() {
// Given
expectedEnv := []string{"super=duper", "foo=bar"}
// When
config, err := NewConfig("testdata/containers_default.conf")
config, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Engine.Env.Get()).To(gomega.BeEquivalentTo(expectedEnv))
Expand All @@ -348,25 +348,25 @@ var _ = Describe("Config Local", func() {

It("should override cdi_spec_dirs if provided", func() {
// Given
config1, err := New(nil)
config1, err := newLocked(&Options{}, &paths{})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config1.Engine.CdiSpecDirs.Get()).To(gomega.Equal([]string{"/etc/cdi", "/var/run/cdi"}))

// Given default just get default
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Engine.CdiSpecDirs.Get()).To(gomega.Equal([]string{"/etc/cdi", "/var/run/cdi"}))

// Given override just get override
config3, err := NewConfig("testdata/containers_override.conf")
config3, err := newLocked(&Options{}, &paths{etc: "testdata/containers_override.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config3.Engine.CdiSpecDirs.Get()).To(gomega.Equal([]string{"/somepath"}))

// Given override just get override
config4, err := NewConfig("testdata/containers_override2.conf")
config4, err := newLocked(&Options{}, &paths{etc: "testdata/containers_override2.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config4.Engine.CdiSpecDirs.Get()).To(gomega.Equal([]string{"/somepath", "/some_other_path"}))
Expand All @@ -375,7 +375,7 @@ var _ = Describe("Config Local", func() {
It("Expect Remote to be False", func() {
// Given
// When
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Engine.Remote).To(gomega.BeFalse())
Expand All @@ -390,7 +390,7 @@ var _ = Describe("Config Local", func() {
t.Setenv(containersConfEnv, "/dev/null")

// When
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})

// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
Expand All @@ -412,15 +412,15 @@ var _ = Describe("Config Local", func() {
It("Default Umask", func() {
// Given
// When
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Containers.Umask).To(gomega.Equal("0022"))
})
It("Set Umask", func() {
// Given
// When
config, err := NewConfig("testdata/containers_default.conf")
config, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Containers.Umask).To(gomega.Equal("0002"))
Expand All @@ -442,11 +442,11 @@ var _ = Describe("Config Local", func() {

It("default netns", func() {
// Given
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Containers.NetNS).To(gomega.Equal("private"))
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Containers.NetNS).To(gomega.Equal("bridge"))
Expand All @@ -456,7 +456,7 @@ var _ = Describe("Config Local", func() {
// Given
path := ""
// When
config, err := NewConfig(path)
config, err := newLocked(&Options{}, &paths{etc: path})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
// Then
gomega.Expect(config.Secrets.Driver).To(gomega.Equal("file"))
Expand All @@ -466,7 +466,7 @@ var _ = Describe("Config Local", func() {
// Given
path := "testdata/containers_override.conf"
// When
config, err := NewConfig(path)
config, err := newLocked(&Options{}, &paths{etc: path})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
// Then
gomega.Expect(config.Secrets.Driver).To(gomega.Equal("pass"))
Expand All @@ -478,11 +478,11 @@ var _ = Describe("Config Local", func() {

It("Set machine image path", func() {
// Given
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Machine.Image).To(gomega.Equal(""))
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
path := "https://example.com/$OS/$ARCH/foobar.ami"
Expand All @@ -493,59 +493,59 @@ var _ = Describe("Config Local", func() {

It("CompatAPIEnforceDockerHub", func() {
// Given
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Engine.CompatAPIEnforceDockerHub).To(gomega.BeTrue())
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Engine.CompatAPIEnforceDockerHub).To(gomega.BeFalse())
})

It("ComposeProviders", func() {
// Given
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Engine.ComposeProviders.Get()).To(gomega.Equal(getDefaultComposeProviders())) // no hard-coding to work on all platforms
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Engine.ComposeProviders.Get()).To(gomega.Equal([]string{"/some/thing/else", "/than/before"}))
})

It("AddCompression", func() {
// Given
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Engine.AddCompression.Get()).To(gomega.BeEmpty()) // no hard-coding to work on all platforms
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Engine.AddCompression.Get()).To(gomega.Equal([]string{"zstd", "zstd:chunked"}))
})

It("ComposeWarningLogs", func() {
// Given
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Engine.ComposeWarningLogs).To(gomega.BeTrue())
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Engine.ComposeWarningLogs).To(gomega.BeFalse())
})

It("Set machine disk", func() {
// Given
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Machine.DiskSize).To(gomega.Equal(uint64(100)))
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Machine.DiskSize).To(gomega.Equal(uint64(20)))
Expand All @@ -557,33 +557,33 @@ var _ = Describe("Config Local", func() {
cpus = 1
}

config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Machine.CPUs).To(gomega.Equal(uint64(cpus)))
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Machine.CPUs).To(gomega.Equal(uint64(1)))
})
It("Set machine memory", func() {
// Given
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Machine.Memory).To(gomega.Equal(uint64(2048)))
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Machine.Memory).To(gomega.Equal(uint64(1024)))
})
It("Get Rosetta value", func() {
// Given
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config.Machine.Rosetta).To(gomega.BeTrue())
// When
config2, err := NewConfig("testdata/containers_default.conf")
config2, err := newLocked(&Options{}, &paths{etc: "testdata/containers_default.conf"})
// Then
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(config2.Machine.Rosetta).To(gomega.BeFalse())
Expand Down
2 changes: 1 addition & 1 deletion pkg/config/config_remote_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ var _ = Describe("Config Remote", func() {
It("Expect Remote to be true", func() {
// Given
// When
config, err := New(nil)
config, err := newLocked(&Options{}, &paths{})
// Then
gomega.Expect(err).To(gomega.BeNil())
gomega.Expect(config.Engine.Remote).To(gomega.BeTrue())
Expand Down
Loading