kernel_mount_options_test.go

package smbdriver_test

import (
	"code.cloudfoundry.org/smbdriver"
	. "github.com/onsi/ginkgo/v2"
	. "github.com/onsi/gomega"
)

var _ = Describe("KernelMountOptions", func() {
	Describe("#ToKernelMountOptionFlagsAndEnvVars", func() {
		var (
			mountOpts          map[string]interface{}
			kernelMountOptions string
			kernelMountEnvVars []string
		)

		BeforeEach(func() {
			mountOpts = make(map[string]interface{})
		})

		JustBeforeEach(func() {
			kernelMountOptions, kernelMountEnvVars = smbdriver.ToKernelMountOptionFlagsAndEnvVars(mountOpts)
		})

		Context("given an empty mount opts", func() {
			It("should return an empty mount opts string and empty env vars", func() {
				Expect(kernelMountOptions).To(BeEmpty())
				Expect(kernelMountEnvVars).To(BeEmpty())
			})
		})

		Context("given a mount opts", func() {
			BeforeEach(func() {
				mountOpts = map[string]interface{}{
					"opt1": "val1",
					"opt2": "val2",
				}
			})

			It("should return a valid mount opts string", func() {
				Expect(kernelMountOptions).To(Equal("opt1=val1,opt2=val2"))
				Expect(kernelMountEnvVars).To(BeEmpty())
			})
		})

		Context("given an integer option value with a leading zero", func() {
			BeforeEach(func() {
				mountOpts = map[string]interface{}{
					"opt1": "0123",
				}
			})

			It("strips the leading zero from the mount option string", func() {
				Expect(kernelMountOptions).To(Equal("opt1=123"))
			})
		})

		Context("given a mount option with no value", func() {
			BeforeEach(func() {
				mountOpts = map[string]interface{}{
					"does-not-matter": "",
				}
			})

			It("contains the mount option", func() {
				Expect(kernelMountOptions).To(ContainSubstring("does-not-matter"))
			})
		})

		Context("given a mount option with nil value", func() {
			BeforeEach(func() {
				mountOpts = map[string]interface{}{
					"does-not-matter": nil,
				}
			})

			It("omits the mount option", func() {
				Expect(kernelMountOptions).NotTo(ContainSubstring("does-not-matter"))
			})
		})

		Context("given a 'Domain' mount option with no value", func() {
			BeforeEach(func() {
				mountOpts = map[string]interface{}{
					"domain": "",
					"Domain": "",
				}
			})

			It("omits the mount option", func() {
				Expect(kernelMountOptions).NotTo(ContainSubstring("domain"))
				Expect(kernelMountOptions).NotTo(ContainSubstring("Domain"))
			})
		})

		Context("given a 'Domain' mount option with nil value", func() {
			BeforeEach(func() {
				mountOpts = map[string]interface{}{
					"domain": nil,
				}
			})

			It("omits the mount option", func() {
				Expect(kernelMountOptions).NotTo(ContainSubstring("domain"))
			})
		})

		Context("username and password", func() {
			BeforeEach(func() {
				mountOpts = map[string]interface{}{
					"ro":       "true",
					"username": "user",
					"password": "secret",
				}
			})

			It("converts them to environment variables", func() {
				Expect(kernelMountOptions).To(ContainSubstring("ro"))
				Expect(kernelMountOptions).NotTo(ContainSubstring("username"))
				Expect(kernelMountOptions).NotTo(ContainSubstring("password"))
				Expect(kernelMountEnvVars).To(Equal([]string{"PASSWD=secret", "USER=user"}))
			})
		})

		Context("given a readonly mount option with a string boolean value", func() {
			BeforeEach(func() {
				mountOpts = map[string]interface{}{
					"ro": "true",
				}
			})

			It("includes the mount option", func() {
				Expect(kernelMountOptions).To(ContainSubstring("ro"))
			})
		})

		Context("given a nodfs mount option with an empty string value", func() {
			Context("true", func() {
				BeforeEach(func() {
					mountOpts = map[string]interface{}{
						"nodfs": "",
					}
				})

				It("includes the mount option", func() {
					Expect(kernelMountOptions).To(ContainSubstring("nodfs"))
					Expect(kernelMountOptions).NotTo(ContainSubstring("nodfs="))
				})
			})
		})
		Context("given a nodfs mount option with a string boolean value", func() {
			Context("true", func() {
				BeforeEach(func() {
					mountOpts = map[string]interface{}{
						"nodfs": "true",
					}
				})

				It("includes the mount option", func() {
					Expect(kernelMountOptions).To(ContainSubstring("nodfs"))
					Expect(kernelMountOptions).NotTo(ContainSubstring("nodfs=true"))
				})
			})

			Context("false", func() {
				BeforeEach(func() {
					mountOpts = map[string]interface{}{
						"nodfs": "false",
					}
				})

				It("does not include the mount option", func() {
					Expect(kernelMountOptions).NotTo(ContainSubstring("nodfs"))
				})
			})
		})
		Context("given a mfsymlinks mount option with a string boolean value", func() {
			Context("true", func() {
				BeforeEach(func() {
					mountOpts = map[string]interface{}{
						"mfsymlinks": "true",
					}
				})

				It("includes the mount option", func() {
					Expect(kernelMountOptions).To(ContainSubstring("mfsymlinks"))
					Expect(kernelMountOptions).NotTo(ContainSubstring("mfsymlinks=true"))
				})
			})

			Context("false", func() {
				BeforeEach(func() {
					mountOpts = map[string]interface{}{
						"mfsymlinks": "false",
					}
				})

				It("includes the mount option", func() {
					Expect(kernelMountOptions).NotTo(ContainSubstring("mfsymlinks"))
				})
			})

		})

	})
})