1package scanner
2
3import (
4 "os"
5 "os/exec"
6 "path/filepath"
7 "strings"
8 "testing"
9)
10
11func TestResolution(t *testing.T) {
12 p := filepath.Join(t.TempDir(), "fixture.xml")
13 xml := `<protocol name="sample"><interface name="wl_surface" version="1"><event name="done"><arg name="value" type="uint"/></event></interface><interface name="custom_thing" version="1"><request name="make"><arg name="id" type="new_id" interface="wl_surface"/><arg name="output" type="object" interface="wl_output"/></request></interface></protocol>`
14 if err := os.WriteFile(p, []byte(xml), 0600); err != nil {
15 t.Fatal(err)
16 }
17 s := NewScanner()
18 if err := s.ParseXML(p); err != nil {
19 t.Fatal(err)
20 }
21 s.CrossPackage = map[string]string{"wl_surface": "github.com/bnema/wlturbo/protocol/core", "wl_output": "github.com/bnema/wlturbo/protocol/core"}
22 b, err := s.Generate("fixture")
23 if err != nil {
24 t.Fatal(err)
25 }
26 text := string(b)
27 if !strings.Contains(text, "(*Surface, error)") || !strings.Contains(text, "output *cross_wl_output.Output") || strings.Contains(text, "cross_wl_surface") {
28 t.Fatalf("wrong resolution: %s", text)
29 }
30}
31func TestCoreGeneration(t *testing.T) {
32 s := NewScanner()
33 if err := s.ParseXML("../../protocol/wayland.xml"); err != nil {
34 t.Fatal(err)
35 }
36 b, err := s.Generate("core")
37 if err != nil {
38 t.Fatal(err)
39 }
40 for _, want := range []string{"type Keyboard struct", "type Subsurface struct", "type Buffer struct", "type Callback struct", "return \"uint,fd,uint,\", true", "child := &Keyboard{}"} {
41 if !strings.Contains(string(b), want) {
42 t.Errorf("missing %s", want)
43 }
44 }
45 if strings.Contains(string(b), "type Display struct") || strings.Contains(string(b), "type Registry struct") {
46 t.Fatal("bootstrap generated twice")
47 }
48}
49
50// Extension protocols use wl_buffer as both an event-created child and a request-created child.
51// Verify the generated code uses the public constructor instead of embedding
52// an inaccessible BaseProxy context field across package boundaries.
53func TestExternalChildFactory(t *testing.T) {
54 path := filepath.Join(t.TempDir(), "external.xml")
55 xml := `<protocol name="fixture"><interface name="ext_params" version="1"><request name="create"><arg name="id" type="new_id" interface="wl_buffer"/></request><event name="created"><arg name="id" type="new_id" interface="wl_buffer"/></event></interface></protocol>`
56 if err := os.WriteFile(path, []byte(xml), 0600); err != nil {
57 t.Fatal(err)
58 }
59 s := NewScanner()
60 if err := s.ParseXML(path); err != nil {
61 t.Fatal(err)
62 }
63 s.CrossPackage = map[string]string{"wl_buffer": "github.com/bnema/wlturbo/protocol/core"}
64 generated, err := s.Generate("ext")
65 if err != nil {
66 t.Fatal(err)
67 }
68 for _, part := range []string{"cross_wl_buffer.NewBuffer(o.Context())", "(*cross_wl_buffer.Buffer, error)", "idObject.SetID(idID)"} {
69 if !strings.Contains(string(generated), part) {
70 t.Errorf("generated code missing %q", part)
71 }
72 }
73 if strings.Contains(string(generated), "&cross_wl_buffer.Buffer{}") {
74 t.Fatal("foreign child was constructed without its package factory")
75 }
76}
77
78func TestUnresolvedExternalInterface(t *testing.T) {
79 path := filepath.Join(t.TempDir(), "extension.xml")
80 xml := `<protocol name="ext"><interface name="ext_parent" version="1"><request name="make"><arg name="id" type="new_id" interface="wl_surface"/></request></interface></protocol>`
81 if err := os.WriteFile(path, []byte(xml), 0600); err != nil {
82 t.Fatal(err)
83 }
84 s := NewScanner()
85 if err := s.ParseXML(path); err != nil {
86 t.Fatal(err)
87 }
88 if _, err := s.Generate("ext"); err == nil || !strings.Contains(err.Error(), "wl_surface") {
89 t.Fatalf("unmapped external reference: %v", err)
90 }
91}
92
93func TestMappedExtensionCompilesAndDispatchesChild(t *testing.T) {
94 goBin, err := exec.LookPath("go")
95 if err != nil {
96 t.Skip("go unavailable: generated extension compilation requires go")
97 }
98 root, err := filepath.Abs("../..")
99 if err != nil {
100 t.Fatal(err)
101 }
102 dir := t.TempDir()
103 xml := `<protocol name="ext"><interface name="ext_parent" version="1"><event name="child"><arg name="id" type="new_id" interface="wl_buffer"/></event></interface></protocol>`
104 path := filepath.Join(dir, "ext.xml")
105 if err := os.WriteFile(path, []byte(xml), 0600); err != nil {
106 t.Fatal(err)
107 }
108 s := NewScanner()
109 if err := s.ParseXML(path); err != nil {
110 t.Fatal(err)
111 }
112 s.CrossPackage = map[string]string{"wl_buffer": "github.com/bnema/wlturbo/protocol/core"}
113 generated, err := s.Generate("ext")
114 if err != nil {
115 t.Fatal(err)
116 }
117 if err := os.WriteFile(filepath.Join(dir, "ext.go"), generated, 0600); err != nil {
118 t.Fatal(err)
119 }
120 mod := "module example.com/ext\n\ngo 1.27\n\nrequire github.com/bnema/wlturbo v0.0.0\nreplace github.com/bnema/wlturbo => " + root + "\n"
121 if err := os.WriteFile(filepath.Join(dir, "go.mod"), []byte(mod), 0600); err != nil {
122 t.Fatal(err)
123 }
124 test := `package ext
125import (
126 "encoding/binary"
127 "net"
128 "os"
129 "testing"
130 "github.com/bnema/wlturbo"
131 "github.com/bnema/wlturbo/protocol/core"
132 "golang.org/x/sys/unix"
133)
134func TestTypedChild(t *testing.T) {
135 f, err := unix.Socketpair(unix.AF_UNIX, unix.SOCK_STREAM, 0); if err != nil { t.Fatal(err) }
136 a, b := os.NewFile(uintptr(f[0]), "a"), os.NewFile(uintptr(f[1]), "b")
137 c, err := net.FileConn(a); a.Close(); if err != nil { t.Fatal(err) }; defer c.Close()
138 p, err := net.FileConn(b); b.Close(); if err != nil { t.Fatal(err) }; defer p.Close()
139 d, err := wlturbo.ConnectFromConn(c); if err != nil { t.Fatal(err) }; defer d.Close()
140 parent := NewExtParent(d.Context()); parent.SetID(d.AllocateID()); d.Context().Register(parent)
141 var child *core.Buffer
142 parent.OnChild(func(b *core.Buffer) { child = b })
143 frame := make([]byte, 12); binary.LittleEndian.PutUint32(frame, parent.ID()); binary.LittleEndian.PutUint32(frame[4:], 12<<16); binary.LittleEndian.PutUint32(frame[8:], 0xff000001)
144 if _, err := p.Write(frame); err != nil { t.Fatal(err) }
145 if err := d.Dispatch(); err != nil { t.Fatal(err) }
146 if child == nil || child.ID() != 0xff000001 { t.Fatalf("child: %v", child) }
147 called := false; child.OnRelease(func(){ called = true })
148 frame = frame[:8]; binary.LittleEndian.PutUint32(frame, child.ID()); binary.LittleEndian.PutUint32(frame[4:], 8<<16)
149 if _, err := p.Write(frame); err != nil { t.Fatal(err) }
150 if err := d.Dispatch(); err != nil { t.Fatal(err) }
151 if !called { t.Fatal("typed child did not dispatch release") }
152}
153`
154 if err := os.WriteFile(filepath.Join(dir, "ext_test.go"), []byte(test), 0600); err != nil {
155 t.Fatal(err)
156 }
157 cmd := exec.Command(goBin, "test", "./...")
158 cmd.Dir = dir
159 cmd.Env = append(os.Environ(), "GOWORK=off", "GOFLAGS=-mod=mod")
160 if out, err := cmd.CombinedOutput(); err != nil {
161 t.Fatalf("generated extension test: %v\n%s", err, out)
162 }
163}