From 476f099b2fd1330df0c88dd913339cf141d023fe Mon Sep 17 00:00:00 2001 From: PJ Date: Sat, 6 Jun 2026 23:10:00 +0530 Subject: [PATCH] test(ioscompanion): add hierarchy-map golden and unit tests --- .../driver/ioscompanion/hierarchymap_test.go | 224 ++++++++++++++++++ .../testdata/accounts-describe.json | 1 + .../ioscompanion/testdata/login-describe.json | 1 + 3 files changed, 226 insertions(+) create mode 100644 internal/driver/ioscompanion/hierarchymap_test.go create mode 100644 internal/driver/ioscompanion/testdata/accounts-describe.json create mode 100644 internal/driver/ioscompanion/testdata/login-describe.json diff --git a/internal/driver/ioscompanion/hierarchymap_test.go b/internal/driver/ioscompanion/hierarchymap_test.go new file mode 100644 index 0000000..e633669 --- /dev/null +++ b/internal/driver/ioscompanion/hierarchymap_test.go @@ -0,0 +1,224 @@ +package ioscompanion + +import ( + "encoding/json" + "os" + "path/filepath" + "testing" + + "github.com/priyanshujain/sanderling/internal/hierarchy" +) + +func mapAndParse(t *testing.T, dump []byte, width, height int) *hierarchy.Tree { + t.Helper() + treeJSON, err := MapHierarchy(dump, width, height) + if err != nil { + t.Fatalf("MapHierarchy: %v", err) + } + tree, err := hierarchy.Parse(string(treeJSON)) + if err != nil { + t.Fatalf("hierarchy.Parse: %v", err) + } + return tree +} + +func readDump(t *testing.T, name string) []byte { + t.Helper() + data, err := os.ReadFile(filepath.Join("testdata", name)) + if err != nil { + t.Fatalf("read %s: %v", name, err) + } + return data +} + +func TestGoldenLoginResolvesIdentifier(t *testing.T) { + tree := mapAndParse(t, readDump(t, "login-describe.json"), 402, 874) + + element := tree.Find("id:LoginEmail") + if element == nil { + t.Fatal("id:LoginEmail did not resolve") + } + if element.ResourceID != "LoginEmail" { + t.Fatalf("ResourceID = %q, want LoginEmail", element.ResourceID) + } + if element.Class != "TextArea" { + t.Fatalf("Class = %q, want TextArea", element.Class) + } + // LoginEmail is an empty field, so its placeholder is the hintText. + if element.Attributes["hintText"] != "Email" { + t.Fatalf("hintText = %q, want Email", element.Attributes["hintText"]) + } + if !element.Editable { + t.Fatal("LoginEmail should be editable") + } + wantBounds := hierarchy.Bounds{Left: 34, Top: 125, Right: 368, Bottom: 173} + if element.Bounds != wantBounds { + t.Fatalf("Bounds = %+v, want %+v", element.Bounds, wantBounds) + } +} + +func TestGoldenScopedQueryUsesSpatialFallback(t *testing.T) { + tree := mapAndParse(t, readDump(t, "accounts-describe.json"), 402, 874) + + // The Application node spans the full screen but the flat tree gives it no + // descendants. A scoped query for content inside it must resolve through the + // hierarchy package's spatial-containment fallback. + container := tree.FindNode("class:Application") + if container == nil { + t.Fatal("class:Application did not resolve") + } + if len(container.Children) != 0 { + t.Fatalf("expected a flat tree with no Application descendants, got %d", len(container.Children)) + } + + scoped := container.Find("desc:Accounts") + if scoped == nil { + t.Fatal("scoped desc:Accounts did not resolve via spatial fallback") + } + if scoped.Description != "Accounts" { + t.Fatalf("scoped Description = %q, want Accounts", scoped.Description) + } + + // Smallest-area ranking should put the compact label ahead of any larger + // spatially-contained match. + scopedButton := container.Find("id:AddAccountButton") + if scopedButton == nil { + t.Fatal("scoped id:AddAccountButton did not resolve via spatial fallback") + } + if scopedButton.ResourceID != "AddAccountButton" { + t.Fatalf("scoped ResourceID = %q, want AddAccountButton", scopedButton.ResourceID) + } +} + +func parseSingle(t *testing.T, dump string) *hierarchy.Element { + t.Helper() + tree := mapAndParse(t, []byte(dump), 400, 800) + if len(tree.Elements) < 2 { + t.Fatalf("expected root plus one child, got %d elements", len(tree.Elements)) + } + // Element 0 is the synthesized root; element 1 is the mapped child. + return tree.Elements[1] +} + +func TestPlaceholderMapsToHintText(t *testing.T) { + dump := `[{"type":"TextField","frame":{"x":10,"y":20,"width":100,"height":40}, + "AXUniqueId":"Search","AXLabel":"Search accounts","AXValue":null,"enabled":true}]` + element := parseSingle(t, dump) + if element.Attributes["hintText"] != "Search accounts" { + t.Fatalf("hintText = %q, want Search accounts", element.Attributes["hintText"]) + } + if element.Attributes["accessibilityText"] != "" { + t.Fatalf("accessibilityText = %q, want empty", element.Attributes["accessibilityText"]) + } + if element.Text != "" { + t.Fatalf("text = %q, want empty", element.Text) + } +} + +func TestNonEmptyValueMapsToText(t *testing.T) { + dump := `[{"type":"TextField","frame":{"x":0,"y":0,"width":10,"height":10}, + "AXUniqueId":"Search","AXLabel":"Search accounts","AXValue":"groceries","enabled":true}]` + element := parseSingle(t, dump) + if element.Text != "groceries" { + t.Fatalf("text = %q, want groceries", element.Text) + } + // With a value present, the label is a real accessibility label, not a hint. + if element.Attributes["accessibilityText"] != "Search accounts" { + t.Fatalf("accessibilityText = %q, want Search accounts", element.Attributes["accessibilityText"]) + } + if element.Attributes["hintText"] != "" { + t.Fatalf("hintText = %q, want empty", element.Attributes["hintText"]) + } +} + +func TestEditableAndClickableFlags(t *testing.T) { + cases := []struct { + elementType string + wantEditable bool + wantClickable bool + }{ + {"TextField", true, false}, + {"TextArea", true, false}, + {"Button", false, true}, + {"StaticText", false, false}, + } + for _, testCase := range cases { + dump := `[{"type":"` + testCase.elementType + `","frame":{"x":0,"y":0,"width":10,"height":10},"enabled":true}]` + element := parseSingle(t, dump) + if element.Editable != testCase.wantEditable { + t.Errorf("%s editable = %v, want %v", testCase.elementType, element.Editable, testCase.wantEditable) + } + if element.Clickable != testCase.wantClickable { + t.Errorf("%s clickable = %v, want %v", testCase.elementType, element.Clickable, testCase.wantClickable) + } + } +} + +func TestEnabledMapsToTopLevelBool(t *testing.T) { + dump := `[{"type":"Button","frame":{"x":0,"y":0,"width":10,"height":10},"enabled":false}]` + element := parseSingle(t, dump) + if element.Enabled { + t.Fatal("element should be disabled") + } + if element.Attributes["enabled"] != "false" { + t.Fatalf("enabled attr = %q, want false", element.Attributes["enabled"]) + } +} + +func TestBoundsArithmetic(t *testing.T) { + dump := `[{"type":"Button","frame":{"x":34,"y":125.33333,"width":334,"height":48.00001},"enabled":true}]` + element := parseSingle(t, dump) + want := hierarchy.Bounds{Left: 34, Top: 125, Right: 368, Bottom: 173} + if element.Bounds != want { + t.Fatalf("Bounds = %+v, want %+v", element.Bounds, want) + } +} + +func TestMalformedElementsSkipped(t *testing.T) { + // First element has no type and must be skipped; second has a NaN frame and + // must be skipped; third is valid. + dump := `[ + {"frame":{"x":0,"y":0,"width":10,"height":10},"enabled":true}, + {"type":"Button","frame":{"x":0,"y":0,"width":1e999,"height":10},"enabled":true}, + {"type":"Button","frame":{"x":0,"y":0,"width":10,"height":10},"AXUniqueId":"OK","enabled":true} + ]` + tree := mapAndParse(t, []byte(dump), 400, 800) + // Root plus exactly one valid child. + if len(tree.Elements) != 2 { + t.Fatalf("expected 2 elements (root + 1 valid), got %d", len(tree.Elements)) + } + if tree.Find("id:OK") == nil { + t.Fatal("valid element OK should resolve") + } +} + +func TestEmptyAndGarbageInputAreTotal(t *testing.T) { + for _, dump := range [][]byte{nil, {}, []byte("not json"), []byte("{}"), []byte("[]")} { + treeJSON, err := MapHierarchy(dump, 100, 200) + if err != nil { + t.Fatalf("MapHierarchy(%q) error: %v", dump, err) + } + var node treeNode + if err := json.Unmarshal(treeJSON, &node); err != nil { + t.Fatalf("result not valid TreeNode JSON for %q: %v", dump, err) + } + if node.Attributes["bounds"] != "[0,0][100,200]" { + t.Fatalf("root bounds = %q, want [0,0][100,200]", node.Attributes["bounds"]) + } + } +} + +func TestRootIsFlatWithAllChildren(t *testing.T) { + tree := mapAndParse(t, readDump(t, "login-describe.json"), 402, 874) + if tree.Root == nil { + t.Fatal("nil root") + } + // The login dump has 10 elements; all map to direct children of the root. + if len(tree.Root.Children) != 10 { + t.Fatalf("root children = %d, want 10", len(tree.Root.Children)) + } + wantRoot := hierarchy.Bounds{Left: 0, Top: 0, Right: 402, Bottom: 874} + if tree.Root.Bounds != wantRoot { + t.Fatalf("root bounds = %+v, want %+v", tree.Root.Bounds, wantRoot) + } +} diff --git a/internal/driver/ioscompanion/testdata/accounts-describe.json b/internal/driver/ioscompanion/testdata/accounts-describe.json new file mode 100644 index 0000000..9a9fa09 --- /dev/null +++ b/internal/driver/ioscompanion/testdata/accounts-describe.json @@ -0,0 +1 @@ +[{"AXFrame":"{{0, 0}, {402, 874}}","AXUniqueId":null,"frame":{"y":0,"x":0,"width":402,"height":874},"role_description":"application","AXLabel":"Folio","content_required":false,"type":"Application","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXApplication","subrole":null},{"AXFrame":"{{20, 76}, {97.333335876464844, 24}}","AXUniqueId":null,"frame":{"y":76,"x":20,"width":97.333335876464844,"height":24},"role_description":"text","AXLabel":"Accounts","content_required":false,"type":"StaticText","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXStaticText","subrole":null},{"AXFrame":"{{340, 71.333335876464844}, {48, 48}}","AXUniqueId":"LogoutButton","frame":{"y":71.333335876464844,"x":340,"width":48,"height":48},"role_description":"button","AXLabel":"Log out","content_required":false,"type":"Button","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXButton","subrole":null},{"AXFrame":"{{20, 100}, {104, 14.333335876464844}}","AXUniqueId":null,"frame":{"y":100,"x":20,"width":104,"height":14.333335876464844},"role_description":"text","AXLabel":"demo@folio.app","content_required":false,"type":"StaticText","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXStaticText","subrole":null},{"AXFrame":"{{131.33332824707031, 248.33332824707031}, {139.33332824707031, 17.999984741210938}}","AXUniqueId":null,"frame":{"y":248.33332824707031,"x":131.33332824707031,"width":139.33332824707031,"height":17.999984741210938},"role_description":"text","AXLabel":"No accounts yet","content_required":false,"type":"StaticText","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXStaticText","subrole":null},{"AXFrame":"{{36, 272.33334350585938}, {330, 28.666656494140625}}","AXUniqueId":null,"frame":{"y":272.33334350585938,"x":36,"width":330,"height":28.666656494140625},"role_description":"text","AXLabel":"Create your first account to start tracking transactions.","content_required":false,"type":"StaticText","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXStaticText","subrole":null},{"AXFrame":"{{20, 716.33331298828125}, {105.66666412353516, 14.33331298828125}}","AXUniqueId":null,"frame":{"y":716.33331298828125,"x":20,"width":105.66666412353516,"height":14.33331298828125},"role_description":"text","AXLabel":"TOTAL BALANCE","content_required":false,"type":"StaticText","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXStaticText","subrole":null},{"AXFrame":"{{20, 730.66668701171875}, {85.333335876464844, 33.33331298828125}}","AXUniqueId":null,"frame":{"y":730.66668701171875,"x":20,"width":85.333335876464844,"height":33.33331298828125},"role_description":"text","AXLabel":"$0.00","content_required":false,"type":"StaticText","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXStaticText","subrole":null},{"AXFrame":"{{307.66665649414062, 749.66668701171875}, {74.333343505859375, 14.33331298828125}}","AXUniqueId":null,"frame":{"y":749.66668701171875,"x":307.66665649414062,"width":74.333343505859375,"height":14.33331298828125},"role_description":"text","AXLabel":"0 accounts","content_required":false,"type":"StaticText","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXStaticText","subrole":null},{"AXFrame":"{{20, 777}, {362, 48}}","AXUniqueId":"AddAccountButton","frame":{"y":777,"x":20,"width":362,"height":48},"role_description":"button","AXLabel":"+ Add account","content_required":false,"type":"Button","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXButton","subrole":null}] diff --git a/internal/driver/ioscompanion/testdata/login-describe.json b/internal/driver/ioscompanion/testdata/login-describe.json new file mode 100644 index 0000000..0d3382f --- /dev/null +++ b/internal/driver/ioscompanion/testdata/login-describe.json @@ -0,0 +1 @@ +[{"AXFrame":"{{0, 0}, {0, 0}}","AXUniqueId":null,"frame":{"y":0,"x":0,"width":0,"height":0},"role_description":"application","AXLabel":null,"content_required":false,"type":"Application","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXApplication","subrole":null},{"AXFrame":"{{20, 106}, {40.666667938232422, 14.333335876464844}}","AXUniqueId":null,"frame":{"y":106,"x":20,"width":40.666667938232422,"height":14.333335876464844},"role_description":"text","AXLabel":"EMAIL","content_required":false,"type":"StaticText","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXStaticText","subrole":null},{"AXFrame":"{{34, 125.33333587646484}, {334, 48.000007629394531}}","AXUniqueId":"LoginEmail","frame":{"y":125.33333587646484,"x":34,"width":334,"height":48.000007629394531},"role_description":"text entry area","AXLabel":"Email","content_required":false,"type":"TextArea","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXTextArea","subrole":null},{"AXFrame":"{{20, 186.33332824707031}, {65, 14.333328247070312}}","AXUniqueId":null,"frame":{"y":186.33332824707031,"x":20,"width":65,"height":14.333328247070312},"role_description":"text","AXLabel":"PASSWORD","content_required":false,"type":"StaticText","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXStaticText","subrole":null},{"AXFrame":"{{34, 205.66667175292969}, {334, 48}}","AXUniqueId":"LoginPassword","frame":{"y":205.66667175292969,"x":34,"width":334,"height":48},"role_description":"text entry area","AXLabel":"Password","content_required":false,"type":"TextArea","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXTextArea","subrole":null},{"AXFrame":"{{20, 266.66665649414062}, {362, 18}}","AXUniqueId":null,"frame":{"y":266.66665649414062,"x":20,"width":362,"height":18},"role_description":"text","AXLabel":"","content_required":false,"type":"StaticText","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXStaticText","subrole":null},{"AXFrame":"{{20, 297.66665649414062}, {362, 48}}","AXUniqueId":"LoginSubmit","frame":{"y":297.66665649414062,"x":20,"width":362,"height":48},"role_description":"button","AXLabel":"Sign in","content_required":false,"type":"Button","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXButton","subrole":null},{"AXFrame":"{{36, 392.66665649414062}, {119, 14.333343505859375}}","AXUniqueId":null,"frame":{"y":392.66665649414062,"x":36,"width":119,"height":14.333343505859375},"role_description":"text","AXLabel":"Demo credentials","content_required":false,"type":"StaticText","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXStaticText","subrole":null},{"AXFrame":"{{36, 413}, {195, 18}}","AXUniqueId":null,"frame":{"y":413,"x":36,"width":195,"height":18},"role_description":"text","AXLabel":"email: demo@folio.app","content_required":false,"type":"StaticText","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXStaticText","subrole":null},{"AXFrame":"{{36, 437}, {176.33332824707031, 18}}","AXUniqueId":null,"frame":{"y":437,"x":36,"width":176.33332824707031,"height":18},"role_description":"text","AXLabel":"password: ledger123","content_required":false,"type":"StaticText","title":null,"help":null,"custom_actions":[],"AXValue":null,"enabled":true,"role":"AXStaticText","subrole":null}]