filesystem.go: add warning when path matches device

coreos · Jun 29, 2022 · 6c7921a · 6c7921a
1 parent ed8f87b
commit 6c7921a
Show file tree

Hide file tree

Showing 11 changed files with 251 additions and 4 deletions.
diff --git a/config/shared/errors/errors.go b/config/shared/errors/errors.go
@@ -70,6 +70,7 @@ var (
 	ErrNoPath                    = errors.New("path not specified")
 	ErrPathRelative              = errors.New("path not absolute")
 	ErrDirtyPath                 = errors.New("path is not fully simplified")
+	ErrPathCollision             = errors.New("path is the same as device name")
 	ErrRaidLevelRequired         = errors.New("raid level is required")
 	ErrSparesUnsupportedForLevel = errors.New("spares unsupported for linear and raid0 arrays")
 	ErrUnrecognizedRaidLevel     = errors.New("unrecognized raid level")

diff --git a/config/v3_0/types/filesystem.go b/config/v3_0/types/filesystem.go
@@ -37,6 +37,7 @@ func (f Filesystem) Validate(c path.ContextPath) (r report.Report) {
 	r.AddOnError(c.Append("device"), validatePath(f.Device))
 	r.AddOnError(c.Append("format"), f.validateFormat())
 	r.AddOnError(c.Append("label"), f.validateLabel())
+	r.AddOnWarn(c.Append("path"), f.warnOnPathSameAsDevice())
 	return
 }
 
@@ -102,3 +103,13 @@ func (f Filesystem) validateLabel() error {
 	}
 	return nil
 }
+
+func (f Filesystem) warnOnPathSameAsDevice() error {
+	if f.Path == nil || *f.Path == "" || f.Device == "" {
+		return nil
+	}
+	if f.Device == *f.Path {
+		return errors.ErrPathCollision
+	}
+	return nil
+}
diff --git a/config/v3_0/types/filesystem_test.go b/config/v3_0/types/filesystem_test.go
@@ -188,3 +188,42 @@ func TestLabelValidate(t *testing.T) {
 		}
 	}
 }
+
+func TestFilesystemwarnOnPathSameAsDevice(t *testing.T) {
+	tests := []struct {
+		in  Filesystem
+		out error
+	}{
+		{
+			Filesystem{Device: "/dev/sda", Path: util.StrToPtr("/dev/sda")},
+			errors.ErrPathCollision,
+		},
+		{
+			Filesystem{Path: util.StrToPtr("/dev/sda/part1"), Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: util.StrToPtr(""), Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: nil, Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: util.StrToPtr("/foo"), Device: ""},
+			nil,
+		},
+		{
+			Filesystem{Path: nil},
+			nil,
+		},
+	}
+
+	for i, test := range tests {
+		err := test.in.warnOnPathSameAsDevice()
+		if test.out != err {
+			t.Errorf("#%d: bad error: want %v, got %v", i, test.out, err)
+		}
+	}
+}
diff --git a/config/v3_1/types/filesystem.go b/config/v3_1/types/filesystem.go
@@ -38,13 +38,24 @@ func (f Filesystem) Validate(c path.ContextPath) (r report.Report) {
 	r.AddOnError(c.Append("device"), validatePath(f.Device))
 	r.AddOnError(c.Append("format"), f.validateFormat())
 	r.AddOnError(c.Append("label"), f.validateLabel())
+	r.AddOnWarn(c.Append("path"), f.warnOnPathSameAsDevice())
 	return
 }
 
 func (f Filesystem) validatePath() error {
 	return validatePathNilOK(f.Path)
 }
 
+func (f Filesystem) warnOnPathSameAsDevice() error {
+	if f.Path == nil || *f.Path == "" || f.Device == "" {
+		return nil
+	}
+	if f.Device == *f.Path {
+		return errors.ErrPathCollision
+	}
+	return nil
+}
+
 func (f Filesystem) validateFormat() error {
 	if util.NilOrEmpty(f.Format) {
 		if util.NotEmpty(f.Path) ||

diff --git a/config/v3_1/types/filesystem_test.go b/config/v3_1/types/filesystem_test.go
@@ -97,10 +97,6 @@ func TestFilesystemValidatePath(t *testing.T) {
 			Filesystem{Path: nil},
 			nil,
 		},
-		{
-			Filesystem{Path: util.StrToPtr("foo")},
-			errors.ErrPathRelative,
-		},
 	}
 
 	for i, test := range tests {
@@ -192,3 +188,42 @@ func TestLabelValidate(t *testing.T) {
 		}
 	}
 }
+
+func TestFilesystemwarnOnPathSameAsDevice(t *testing.T) {
+	tests := []struct {
+		in  Filesystem
+		out error
+	}{
+		{
+			Filesystem{Device: "/dev/sda", Path: util.StrToPtr("/dev/sda")},
+			errors.ErrPathCollision,
+		},
+		{
+			Filesystem{Path: util.StrToPtr("/dev/sda/part1"), Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: util.StrToPtr(""), Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: nil, Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: util.StrToPtr("/foo"), Device: ""},
+			nil,
+		},
+		{
+			Filesystem{Path: nil},
+			nil,
+		},
+	}
+
+	for i, test := range tests {
+		err := test.in.warnOnPathSameAsDevice()
+		if test.out != err {
+			t.Errorf("#%d: bad error: want %v, got %v", i, test.out, err)
+		}
+	}
+}
diff --git a/config/v3_2/types/filesystem.go b/config/v3_2/types/filesystem.go
@@ -38,6 +38,7 @@ func (f Filesystem) Validate(c path.ContextPath) (r report.Report) {
 	r.AddOnError(c.Append("device"), validatePath(f.Device))
 	r.AddOnError(c.Append("format"), f.validateFormat())
 	r.AddOnError(c.Append("label"), f.validateLabel())
+	r.AddOnWarn(c.Append("path"), f.warnOnPathSameAsDevice())
 	return
 }
 
@@ -104,3 +105,13 @@ func (f Filesystem) validateLabel() error {
 	}
 	return nil
 }
+
+func (f Filesystem) warnOnPathSameAsDevice() error {
+	if f.Path == nil || *f.Path == "" || f.Device == "" {
+		return nil
+	}
+	if f.Device == *f.Path {
+		return errors.ErrPathCollision
+	}
+	return nil
+}
diff --git a/config/v3_2/types/filesystem_test.go b/config/v3_2/types/filesystem_test.go
@@ -192,3 +192,42 @@ func TestLabelValidate(t *testing.T) {
 		}
 	}
 }
+
+func TestFilesystemwarnOnPathSameAsDevice(t *testing.T) {
+	tests := []struct {
+		in  Filesystem
+		out error
+	}{
+		{
+			Filesystem{Device: "/dev/sda", Path: util.StrToPtr("/dev/sda")},
+			errors.ErrPathCollision,
+		},
+		{
+			Filesystem{Path: util.StrToPtr("/dev/sda/part1"), Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: util.StrToPtr(""), Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: nil, Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: util.StrToPtr("/foo"), Device: ""},
+			nil,
+		},
+		{
+			Filesystem{Path: nil},
+			nil,
+		},
+	}
+
+	for i, test := range tests {
+		err := test.in.warnOnPathSameAsDevice()
+		if test.out != err {
+			t.Errorf("#%d: bad error: want %v, got %v", i, test.out, err)
+		}
+	}
+}
diff --git a/config/v3_3/types/filesystem.go b/config/v3_3/types/filesystem.go
@@ -38,6 +38,7 @@ func (f Filesystem) Validate(c path.ContextPath) (r report.Report) {
 	r.AddOnError(c.Append("device"), validatePath(f.Device))
 	r.AddOnError(c.Append("format"), f.validateFormat())
 	r.AddOnError(c.Append("label"), f.validateLabel())
+	r.AddOnWarn(c.Append("path"), f.warnOnPathSameAsDevice())
 	return
 }
 
@@ -104,3 +105,13 @@ func (f Filesystem) validateLabel() error {
 	}
 	return nil
 }
+
+func (f Filesystem) warnOnPathSameAsDevice() error {
+	if f.Path == nil || *f.Path == "" || f.Device == "" {
+		return nil
+	}
+	if f.Device == *f.Path {
+		return errors.ErrPathCollision
+	}
+	return nil
+}
diff --git a/config/v3_3/types/filesystem_test.go b/config/v3_3/types/filesystem_test.go
@@ -192,3 +192,42 @@ func TestLabelValidate(t *testing.T) {
 		}
 	}
 }
+
+func TestFilesystemwarnOnPathSameAsDevice(t *testing.T) {
+	tests := []struct {
+		in  Filesystem
+		out error
+	}{
+		{
+			Filesystem{Device: "/dev/sda", Path: util.StrToPtr("/dev/sda")},
+			errors.ErrPathCollision,
+		},
+		{
+			Filesystem{Path: util.StrToPtr("/dev/sda/part1"), Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: util.StrToPtr(""), Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: nil, Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: util.StrToPtr("/foo"), Device: ""},
+			nil,
+		},
+		{
+			Filesystem{Path: nil},
+			nil,
+		},
+	}
+
+	for i, test := range tests {
+		err := test.in.warnOnPathSameAsDevice()
+		if test.out != err {
+			t.Errorf("#%d: bad error: want %v, got %v", i, test.out, err)
+		}
+	}
+}
diff --git a/config/v3_4_experimental/types/filesystem.go b/config/v3_4_experimental/types/filesystem.go
@@ -38,6 +38,7 @@ func (f Filesystem) Validate(c path.ContextPath) (r report.Report) {
 	r.AddOnError(c.Append("device"), validatePath(f.Device))
 	r.AddOnError(c.Append("format"), f.validateFormat())
 	r.AddOnError(c.Append("label"), f.validateLabel())
+	r.AddOnWarn(c.Append("path"), f.warnOnPathSameAsDevice())
 	return
 }
 
@@ -104,3 +105,13 @@ func (f Filesystem) validateLabel() error {
 	}
 	return nil
 }
+
+func (f Filesystem) warnOnPathSameAsDevice() error {
+	if f.Path == nil || *f.Path == "" || f.Device == "" {
+		return nil
+	}
+	if f.Device == *f.Path {
+		return errors.ErrPathCollision
+	}
+	return nil
+}
diff --git a/config/v3_4_experimental/types/filesystem_test.go b/config/v3_4_experimental/types/filesystem_test.go
@@ -192,3 +192,42 @@ func TestLabelValidate(t *testing.T) {
 		}
 	}
 }
+
+func TestFilesystemwarnOnPathSameAsDevice(t *testing.T) {
+	tests := []struct {
+		in  Filesystem
+		out error
+	}{
+		{
+			Filesystem{Device: "/dev/sda", Path: util.StrToPtr("/dev/sda")},
+			errors.ErrPathCollision,
+		},
+		{
+			Filesystem{Path: util.StrToPtr("/dev/sda/part1"), Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: util.StrToPtr(""), Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: nil, Device: "/dev/sda"},
+			nil,
+		},
+		{
+			Filesystem{Path: util.StrToPtr("/foo"), Device: ""},
+			nil,
+		},
+		{
+			Filesystem{Path: nil},
+			nil,
+		},
+	}
+
+	for i, test := range tests {
+		err := test.in.warnOnPathSameAsDevice()
+		if test.out != err {
+			t.Errorf("#%d: bad error: want %v, got %v", i, test.out, err)
+		}
+	}
+}