Add oem to accepted url schemes

prestist · prestist · commit b3190d9a4905 · 2025-11-06T15:04:58.000-05:00
Flatcar docs talk about `oem` url add it so ignition-validate does not fail. see: coreos/butane#634
diff --git a/config/v3_0/types/url.go b/config/v3_0/types/url.go
@@ -30,7 +30,7 @@ func validateURL(s string) error {
 	}
 
 	switch u.Scheme {
-	case "http", "https", "tftp":
+	case "http", "https", "tftp", "oem":
 		return nil
 	case "s3":
 		if v, ok := u.Query()["versionId"]; ok {
diff --git a/config/v3_0/types/url_test.go b/config/v3_0/types/url_test.go
@@ -66,6 +66,18 @@ func TestURLValidate(t *testing.T) {
 			util.StrToPtr("s3://bucket/key?versionId=aVersionHash"),
 			nil,
 		},
+		{
+			util.StrToPtr("oem:///example.txt"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///scripts/setup.sh"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///etc/custom.conf"),
+			nil,
+		},
 	}
 
 	for i, test := range tests {
diff --git a/config/v3_1/types/url.go b/config/v3_1/types/url.go
@@ -30,7 +30,7 @@ func validateURL(s string) error {
 	}
 
 	switch u.Scheme {
-	case "http", "https", "tftp":
+	case "http", "https", "tftp", "oem":
 		return nil
 	case "s3":
 		if v, ok := u.Query()["versionId"]; ok {
diff --git a/config/v3_1/types/url_test.go b/config/v3_1/types/url_test.go
@@ -66,6 +66,18 @@ func TestURLValidate(t *testing.T) {
 			util.StrToPtr("s3://bucket/key?versionId=aVersionHash"),
 			nil,
 		},
+		{
+			util.StrToPtr("oem:///example.txt"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///scripts/setup.sh"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///etc/custom.conf"),
+			nil,
+		},
 	}
 
 	for i, test := range tests {
diff --git a/config/v3_2/types/url.go b/config/v3_2/types/url.go
@@ -30,7 +30,7 @@ func validateURL(s string) error {
 	}
 
 	switch u.Scheme {
-	case "http", "https", "tftp", "gs":
+	case "http", "https", "tftp", "gs", "oem":
 		return nil
 	case "s3":
 		if v, ok := u.Query()["versionId"]; ok {
diff --git a/config/v3_2/types/url_test.go b/config/v3_2/types/url_test.go
@@ -70,6 +70,18 @@ func TestURLValidate(t *testing.T) {
 			util.StrToPtr("gs://bucket/object"),
 			nil,
 		},
+		{
+			util.StrToPtr("oem:///example.txt"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///scripts/setup.sh"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///etc/custom.conf"),
+			nil,
+		},
 	}
 
 	for i, test := range tests {
diff --git a/config/v3_3/types/url.go b/config/v3_3/types/url.go
@@ -30,7 +30,7 @@ func validateURL(s string) error {
 	}
 
 	switch u.Scheme {
-	case "http", "https", "tftp", "gs":
+	case "http", "https", "tftp", "gs", "oem":
 		return nil
 	case "s3":
 		if v, ok := u.Query()["versionId"]; ok {
diff --git a/config/v3_3/types/url_test.go b/config/v3_3/types/url_test.go
@@ -70,6 +70,18 @@ func TestURLValidate(t *testing.T) {
 			util.StrToPtr("gs://bucket/object"),
 			nil,
 		},
+		{
+			util.StrToPtr("oem:///example.txt"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///scripts/setup.sh"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///etc/custom.conf"),
+			nil,
+		},
 	}
 
 	for i, test := range tests {
diff --git a/config/v3_4/types/url.go b/config/v3_4/types/url.go
@@ -32,7 +32,7 @@ func validateURL(s string) error {
 	}
 
 	switch u.Scheme {
-	case "http", "https", "tftp", "gs":
+	case "http", "https", "tftp", "gs", "oem":
 		return nil
 	case "s3":
 		if v, ok := u.Query()["versionId"]; ok {
diff --git a/config/v3_4/types/url_test.go b/config/v3_4/types/url_test.go
@@ -126,6 +126,18 @@ func TestURLValidate(t *testing.T) {
 			util.StrToPtr("gs://bucket/object"),
 			nil,
 		},
+		{
+			util.StrToPtr("oem:///example.txt"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///scripts/setup.sh"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///etc/custom.conf"),
+			nil,
+		},
 	}
 
 	for i, test := range tests {
diff --git a/config/v3_5/types/url.go b/config/v3_5/types/url.go
@@ -32,7 +32,7 @@ func validateURL(s string) error {
 	}
 
 	switch u.Scheme {
-	case "http", "https", "tftp", "gs":
+	case "http", "https", "tftp", "gs", "oem":
 		return nil
 	case "s3":
 		if v, ok := u.Query()["versionId"]; ok {
diff --git a/config/v3_5/types/url_test.go b/config/v3_5/types/url_test.go
@@ -126,6 +126,18 @@ func TestURLValidate(t *testing.T) {
 			util.StrToPtr("gs://bucket/object"),
 			nil,
 		},
+		{
+			util.StrToPtr("oem:///example.txt"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///scripts/setup.sh"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///etc/custom.conf"),
+			nil,
+		},
 	}
 
 	for i, test := range tests {
diff --git a/config/v3_6_experimental/types/url.go b/config/v3_6_experimental/types/url.go
@@ -32,7 +32,7 @@ func validateURL(s string) error {
 	}
 
 	switch u.Scheme {
-	case "http", "https", "tftp", "gs":
+	case "http", "https", "tftp", "gs", "oem":
 		return nil
 	case "s3":
 		if v, ok := u.Query()["versionId"]; ok {
diff --git a/config/v3_6_experimental/types/url_test.go b/config/v3_6_experimental/types/url_test.go
@@ -126,6 +126,18 @@ func TestURLValidate(t *testing.T) {
 			util.StrToPtr("gs://bucket/object"),
 			nil,
 		},
+		{
+			util.StrToPtr("oem:///example.txt"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///scripts/setup.sh"),
+			nil,
+		},
+		{
+			util.StrToPtr("oem:///etc/custom.conf"),
+			nil,
+		},
 	}
 
 	for i, test := range tests {
diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -12,6 +12,8 @@ nav_order: 9
 
 ### Changes
 
+- Add `oem` scheme to url's relates to [Butane #634](https://github.com/coreos/butane/issues/634)
+
 ### Bug fixes
 
 

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ func validateURL(s string) error {`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`switch u.Scheme {`
`33`		`- case "http", "https", "tftp":`
	`33`	`+ case "http", "https", "tftp", "oem":`
`34`	`34`	`return nil`
`35`	`35`	`case "s3":`
`36`	`36`	`if v, ok := u.Query()["versionId"]; ok {`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ func validateURL(s string) error {`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`switch u.Scheme {`
`35`		`- case "http", "https", "tftp", "gs":`
	`35`	`+ case "http", "https", "tftp", "gs", "oem":`
`36`	`36`	`return nil`
`37`	`37`	`case "s3":`
`38`	`38`	`if v, ok := u.Query()["versionId"]; ok {`