package config import ( "os" "path/filepath" "testing" . "github.com/onsi/gomega" ) func TestExportfileRoundtrip(t *testing.T) { RegisterTestingT(t) env, err := newEnvFromString("HI='ho'\nFoo='Bar'\n\nBaz='BOFF'") Expect(err).NotTo(HaveOccurred()) Expect(env.Map()).To(Equal(pairs("Baz", "BOFF", "Foo", "Bar", "HI", "ho"))) Expect(env.String()).To(Equal("Baz=\"BOFF\"\nFoo=\"Bar\"\nHI=\"ho\"")) env, err = newEnvFromString(`export HI="h\no"`) Expect(err).NotTo(HaveOccurred()) Expect(env.Map()).To(Equal(pairs("HI", "h\no"))) Expect(env.String()).To(Equal(`HI="h\no"`)) env, err = newEnvFromString("HI='ho'\nFOO=\"'\\nBAR=''\"") Expect(err).NotTo(HaveOccurred()) Expect(env.Map()).To(Equal(pairs("HI", "ho", "FOO", "'\nBAR=''"))) Expect(env.String()).To(Equal("FOO=\"'\\nBAR=''\"\nHI=\"ho\"")) env, err = newEnvFromString("FOO='bar' ") Expect(err).NotTo(HaveOccurred()) Expect(env.Map()).To(Equal(pairs("FOO", "bar"))) Expect(env.String()).To(Equal(`FOO="bar"`)) } func TestExportfileErrors(t *testing.T) { RegisterTestingT(t) _, err := newEnvFromString("F\nOO='bar'") //keys cannot have embedded newlines Expect(err).To(HaveOccurred()) } func TestMerge(t *testing.T) { RegisterTestingT(t) e, _ := newEnvFromString("FOO='bar'") e2, _ := newEnvFromString("BAR='baz'") e.Merge(e2) Expect(e.Map()).To(Equal(pairs("BAR", "baz", "FOO", "bar"))) e3, err := newEnvFromString("FOO=\"ba \\nz\"") Expect(err).NotTo(HaveOccurred()) e.Merge(e3) Expect(e.Map()).To(Equal(pairs("BAR", "baz", "FOO", "ba \nz"))) } func TestExport(t *testing.T) { RegisterTestingT(t) e, err := newEnvFromString("BAR='BAZ'\nFOO=\"b'ar \"\nBAZ=\"a\\nb\"") Expect(err).NotTo(HaveOccurred()) Expect(e.Export(ExportFormatEnvfile)).To(Equal("BAR=\"BAZ\"\nBAZ=\"a\\nb\"\nFOO=\"b'ar \"")) Expect(e.Export(ExportFormatDockerArgs)).To(Equal("--env=BAR='BAZ' --env=BAZ='a\nb' --env=FOO='b'\\''ar '")) Expect(e.Export(ExportFormatDockerArgsKeys)).To(Equal("--env=BAR --env=BAZ --env=FOO")) Expect(e.Export(ExportFormatShell)).To(Equal("BAR='BAZ' BAZ='a\nb' FOO='b'\\''ar '")) Expect(e.Export(ExportFormatExports)).To(Equal("export BAR='BAZ'\nexport BAZ='a\nb'\nexport FOO='b'\\''ar '")) Expect(e.Export(ExportFormatPretty)).To(Equal("BAR: BAZ\nBAZ: a\nb\nFOO: b'ar")) } func TestGet(t *testing.T) { RegisterTestingT(t) e, err := newEnvFromString("BAR='BAZ'\nFOO='ba\\nr '\nGO='1'\nNOGO='0'") Expect(err).To(Succeed()) v, ok := e.Get("GO") Expect(ok).To(Equal(true)) Expect(v).To(Equal("1")) v = e.GetDefault("GO", "default") Expect(v).To(Equal("1")) v = e.GetDefault("dne", "default") Expect(v).To(Equal("default")) b := e.GetBoolDefault("dne", true) Expect(b).To(Equal(true)) b = e.GetBoolDefault("dne", false) Expect(b).To(Equal(false)) b = e.GetBoolDefault("GO", false) Expect(b).To(Equal(true)) b = e.GetBoolDefault("NOGO", true) Expect(b).To(Equal(false)) b = e.GetBoolDefault("BAR", false) Expect(b).To(Equal(true)) //anything but "0" is true } // TestWriteSetsRestrictivePermissions covers an Env written over a file left // behind at a mode other users can read, which is what every app ENV file // created before this was fixed looks like on disk. func TestWriteSetsRestrictivePermissions(t *testing.T) { RegisterTestingT(t) setupIsolatedEnv(t) filename := filepath.Join(t.TempDir(), "ENV") Expect(os.WriteFile(filename, []byte("export testKey=TESTING\n"), 0644)).To(Succeed()) env, err := loadFromFile("alpha", filename) Expect(err).To(Succeed()) env.Set("testKey", "updated") Expect(env.Write()).To(Succeed()) info, err := os.Stat(filename) Expect(err).To(Succeed()) Expect(info.Mode().Perm()).To(Equal(os.FileMode(0600))) expectFileValue(filename, "testKey", "updated") } func TestWriteFailsWhenDirectoryIsMissing(t *testing.T) { RegisterTestingT(t) setupIsolatedEnv(t) env, err := loadFromFile("alpha", filepath.Join(t.TempDir(), "missing", "ENV")) Expect(err).To(Succeed()) env.Set("testKey", "value") Expect(env.Write()).ToNot(Succeed()) } // TestWriteLeavesFileIntactOnFailure covers the guarantee that makes a reported // failure safe to act on: the environment is staged in a temporary file and // renamed into place, so a failure never leaves a truncated ENV file behind. // The permission step is what is made to fail here, because it is the last // thing that happens before the rename. func TestWriteLeavesFileIntactOnFailure(t *testing.T) { RegisterTestingT(t) setupIsolatedEnv(t) filename := filepath.Join(t.TempDir(), "ENV") Expect(os.WriteFile(filename, []byte("export testKey=TESTING\n"), 0600)).To(Succeed()) original, err := os.ReadFile(filename) Expect(err).To(Succeed()) env, err := loadFromFile("alpha", filename) Expect(err).To(Succeed()) env.Set("testKey", "updated") t.Setenv("DOKKU_SYSTEM_USER", "dokku-no-such-user") Expect(env.Write()).ToNot(Succeed()) Expect(os.ReadFile(filename)).To(Equal(original)) } // TestWriteFollowsSymlinks covers an ENV file an operator has pointed at // storage of their own. Renaming the staged file over the symlink would replace // it with a regular file and orphan the original. func TestWriteFollowsSymlinks(t *testing.T) { RegisterTestingT(t) setupIsolatedEnv(t) dir := t.TempDir() target := filepath.Join(dir, "elsewhere", "ENV") Expect(os.MkdirAll(filepath.Dir(target), 0755)).To(Succeed()) Expect(os.WriteFile(target, []byte("export testKey=TESTING\n"), 0600)).To(Succeed()) filename := filepath.Join(dir, "ENV") Expect(os.Symlink(target, filename)).To(Succeed()) env, err := loadFromFile("alpha", filename) Expect(err).To(Succeed()) env.Set("testKey", "updated") Expect(env.Write()).To(Succeed()) info, err := os.Lstat(filename) Expect(err).To(Succeed()) Expect(info.Mode() & os.ModeSymlink).ToNot(Equal(os.FileMode(0))) expectFileValue(target, "testKey", "updated") } // expectFileValue asserts the ENV file at filename holds the given value func expectFileValue(filename string, key string, expected string) { env, err := loadFromFile("expected", filename) Expect(err).To(Succeed()) value, ok := env.Get(key) Expect(ok).To(Equal(true)) Expect(value).To(Equal(expected)) } func pairs(vars ...string) map[string]string { res := map[string]string{} var i = 0 for i < len(vars)-1 { key := vars[i] value := vars[i+1] res[key] = value i += 2 } return res }