added test for parity with macOS's plutil -lint

micromdm · Nov 10, 2022 · 2779718 · 2779718
1 parent 63fa881
commit 2779718
Show file tree

Hide file tree

Showing 20 changed files with 197 additions and 0 deletions.
diff --git a/decode_test.go b/decode_test.go
@@ -8,6 +8,8 @@ import (
 	"log"
 	"net/http"
 	"net/http/httptest"
+	"os"
+	"os/exec"
 	"path/filepath"
 	"reflect"
 	"testing"
@@ -513,3 +515,52 @@ func TestDecodeTagSkip(t *testing.T) {
 		t.Error("field decoded when it was tagged as -")
 	}
 }
+
+// test parity with plutil -lint on macOS
+var xmlParityTestFailures = map[string]struct{}{
+	"empty-plist.plist":          {},
+	"invalid-before-plist.plist": {},
+	"invalid-data.plist":         {},
+	"invalid-middle.plist":       {},
+	"invalid-start.plist":        {},
+	"no-dict-end.plist":          {},
+	"no-plist-end.plist":         {},
+	"unescaped-plist.plist":      {},
+	"unescaped-xml.plist":        {},
+}
+
+func TestXMLPlutilParity(t *testing.T) {
+	type data struct {
+		Key string `plist:"key"`
+	}
+	tests, err := os.ReadDir("testdata/xml/")
+	if err != nil {
+		t.Fatalf("could not open testdata/xml: %v", err)
+	}
+
+	plutil, _ := exec.LookPath("plutil")
+
+	for _, test := range tests {
+		testPath := filepath.Join("testdata/xml/", test.Name())
+		buf, err := os.ReadFile(testPath)
+		if err != nil {
+			t.Errorf("could not read test %s: %v", test.Name(), err)
+			continue
+		}
+		v := new(data)
+		err = Unmarshal(buf, v)
+
+		_, check := xmlParityTestFailures[test.Name()]
+		if plutil != "" {
+			check = exec.Command(plutil, "-lint", testPath).Run() != nil
+		}
+
+		if check && err == nil {
+			t.Errorf("expected error for test %s but got: nil", test.Name())
+		} else if !check && err != nil {
+			t.Errorf("expected no error for test %s but got: %v", test.Name(), err)
+		} else if !check && v.Key != "val" {
+			t.Errorf("expected key=val for test %s but got: key=%s", test.Name(), v.Key)
+		}
+	}
+}
diff --git a/testdata/xml/empty-doctype.plist b/testdata/xml/empty-doctype.plist
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE>
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
diff --git a/testdata/xml/empty-plist.plist b/testdata/xml/empty-plist.plist
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+</plist>
diff --git a/testdata/xml/empty-xml.plist b/testdata/xml/empty-xml.plist
@@ -0,0 +1,8 @@
+<?xml?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
diff --git a/testdata/xml/invalid-before-plist.plist b/testdata/xml/invalid-before-plist.plist
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+invalid
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
diff --git a/testdata/xml/invalid-data.plist b/testdata/xml/invalid-data.plist
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+invalid
+</dict>
+</plist>
diff --git a/testdata/xml/invalid-end.plist b/testdata/xml/invalid-end.plist
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
+invalid
diff --git a/testdata/xml/invalid-middle.plist b/testdata/xml/invalid-middle.plist
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+invalid
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
diff --git a/testdata/xml/invalid-start.plist b/testdata/xml/invalid-start.plist
@@ -0,0 +1,8 @@
+invalid<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
diff --git a/testdata/xml/malformed-xml.plist b/testdata/xml/malformed-xml.plist
@@ -0,0 +1,8 @@
+<?xml version="1.0?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
diff --git a/testdata/xml/no-both.plist b/testdata/xml/no-both.plist
@@ -0,0 +1,6 @@
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
diff --git a/testdata/xml/no-dict-end.plist b/testdata/xml/no-dict-end.plist
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</plist>
diff --git a/testdata/xml/no-doctype.plist b/testdata/xml/no-doctype.plist
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
diff --git a/testdata/xml/no-plist-end.plist b/testdata/xml/no-plist-end.plist
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
diff --git a/testdata/xml/no-plist-version.plist b/testdata/xml/no-plist-version.plist
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist>
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
diff --git a/testdata/xml/no-xml-tag.plist b/testdata/xml/no-xml-tag.plist
@@ -0,0 +1,7 @@
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
diff --git a/testdata/xml/swapped.plist b/testdata/xml/swapped.plist
@@ -0,0 +1,8 @@
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<?xml version="1.0" encoding="UTF-8"?>
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
diff --git a/testdata/xml/unescaped-plist.plist b/testdata/xml/unescaped-plist.plist
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0"
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
diff --git a/testdata/xml/unescaped-xml.plist b/testdata/xml/unescaped-xml.plist
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>
diff --git a/testdata/xml/valid.plist b/testdata/xml/valid.plist
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>key</key>
+	<string>val</string>
+</dict>
+</plist>