File: varlink_test.go

package info (click to toggle)
golang-github-varlink-go 0.4.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, experimental, forky, sid, trixie
  • size: 272 kB
  • sloc: makefile: 13
file content (280 lines) | stat: -rw-r--r-- 10,346 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
package varlink

// tests with access to internals

import (
	"context"
	"fmt"
	"strings"
	"testing"
)

func expect(t *testing.T, expected string, returned string) {
	if strings.Compare(returned, expected) != 0 {
		t.Fatalf("Expected(%d): `%s`\nGot(%d): `%s`\n",
			len(expected), expected,
			len(returned), strings.Replace(returned, "\000", "`+\"\\000\"+`", -1))
	}
}

type readWriterContextFunc func(context.Context, []byte) (int, error)

func (wcf readWriterContextFunc) Write(ctx context.Context, in []byte) (int, error) {
	return wcf(ctx, in)
}

func (wcf readWriterContextFunc) Read(context.Context, []byte) (int, error) {
	return 0, nil
}

func (wcf readWriterContextFunc) ReadBytes(context.Context, byte) ([]byte, error) {
	return nil, nil
}

func TestService(t *testing.T) {
	service, _ := NewService(
		"Varlink",
		"Varlink Test",
		"1",
		"https://github.com/varlink/go/varlink",
	)

	t.Run("ZeroMessage", func(t *testing.T) {
		wf := readWriterContextFunc(func(ctx context.Context, in []byte) (int, error) {
			return 0, nil
		})
		if err := service.HandleMessage(context.Background(), wf, []byte{0}); err == nil {
			t.Fatal("HandleMessage returned non-error")
		}
	})

	t.Run("InvalidJson", func(t *testing.T) {
		wf := readWriterContextFunc(func(ctx context.Context, in []byte) (int, error) {
			return 0, nil
		})
		msg := []byte(`{"method":"foo.GetInterfaceDescription" fdgdfg}`)
		if err := service.HandleMessage(context.Background(), wf, msg); err == nil {
			t.Fatal("HandleMessage returned no error on invalid json")
		}
	})

	t.Run("WrongInterface", func(t *testing.T) {
		var written []byte
		wf := readWriterContextFunc(func(ctx context.Context, in []byte) (int, error) {
			written = append(written, in...)
			return len(in), nil
		})
		msg := []byte(`{"method":"foo.GetInterfaceDescription"}`)
		if err := service.HandleMessage(context.Background(), wf, msg); err != nil {
			t.Fatal("HandleMessage returned error on wrong interface")
		}
		expect(t, `{"parameters":{"interface":"foo"},"error":"org.varlink.service.InterfaceNotFound"}`+"\000",
			string(written))
	})
	t.Run("InvalidMethod", func(t *testing.T) {
		var written []byte
		wf := readWriterContextFunc(func(ctx context.Context, in []byte) (int, error) {
			written = append(written, in...)
			return len(in), nil
		})
		msg := []byte(`{"method":"InvalidMethod"}`)
		if err := service.HandleMessage(context.Background(), wf, msg); err != nil {
			t.Fatal("HandleMessage returned error on invalid method")
		}
		expect(t, `{"parameters":{"parameter":"method"},"error":"org.varlink.service.InvalidParameter"}`+"\000",
			string(written))
	})

	t.Run("WrongMethod", func(t *testing.T) {
		var written []byte
		wf := readWriterContextFunc(func(ctx context.Context, in []byte) (int, error) {
			written = append(written, in...)
			return len(in), nil
		})
		msg := []byte(`{"method":"org.varlink.service.WrongMethod"}`)
		if err := service.HandleMessage(context.Background(), wf, msg); err != nil {
			t.Fatal("HandleMessage returned error on wrong method")
		}
		expect(t, `{"parameters":{"method":"WrongMethod"},"error":"org.varlink.service.MethodNotFound"}`+"\000",
			string(written))
	})

	t.Run("GetInterfaceDescriptionNullParameters", func(t *testing.T) {
		var written []byte
		wf := readWriterContextFunc(func(ctx context.Context, in []byte) (int, error) {
			written = append(written, in...)
			return len(in), nil
		})
		msg := []byte(`{"method":"org.varlink.service.GetInterfaceDescription","parameters": null}`)
		if err := service.HandleMessage(context.Background(), wf, msg); err != nil {
			t.Fatalf("HandleMessage returned error: %v", err)
		}
		expect(t, `{"parameters":{"parameter":"parameters"},"error":"org.varlink.service.InvalidParameter"}`+"\000",
			string(written))
	})

	t.Run("GetInterfaceDescriptionNoInterface", func(t *testing.T) {
		var written []byte
		wf := readWriterContextFunc(func(ctx context.Context, in []byte) (int, error) {
			written = append(written, in...)
			return len(in), nil
		})
		msg := []byte(`{"method":"org.varlink.service.GetInterfaceDescription","parameters":{}}`)
		if err := service.HandleMessage(context.Background(), wf, msg); err != nil {
			t.Fatalf("HandleMessage returned error: %v", err)
		}
		expect(t, `{"parameters":{"parameter":"interface"},"error":"org.varlink.service.InvalidParameter"}`+"\000",
			string(written))
	})

	t.Run("GetInterfaceDescriptionWrongInterface", func(t *testing.T) {
		var written []byte
		wf := readWriterContextFunc(func(ctx context.Context, in []byte) (int, error) {
			written = append(written, in...)
			return len(in), nil
		})
		msg := []byte(`{"method":"org.varlink.service.GetInterfaceDescription","parameters":{"interface":"foo"}}`)
		if err := service.HandleMessage(context.Background(), wf, msg); err != nil {
			t.Fatalf("HandleMessage returned error: %v", err)
		}
		expect(t, `{"parameters":{"parameter":"interface"},"error":"org.varlink.service.InvalidParameter"}`+"\000",
			string(written))
	})

	t.Run("GetInterfaceDescription", func(t *testing.T) {
		var written []byte
		wf := readWriterContextFunc(func(ctx context.Context, in []byte) (int, error) {
			written = append(written, in...)
			return len(in), nil
		})
		msg := []byte(`{"method":"org.varlink.service.GetInterfaceDescription","parameters":{"interface":"org.varlink.service"}}`)
		if err := service.HandleMessage(context.Background(), wf, msg); err != nil {
			t.Fatalf("HandleMessage returned error: %v", err)
		}
		expect(t, `{"parameters":{"description":"# The Varlink Service Interface is provided by every varlink service. It\n# describes the service and the interfaces it implements.\ninterface org.varlink.service\n\n# Get a list of all the interfaces a service provides and information\n# about the implementation.\nmethod GetInfo() -\u003e (\n  vendor: string,\n  product: string,\n  version: string,\n  url: string,\n  interfaces: []string\n)\n\n# Get the description of an interface that is implemented by this service.\nmethod GetInterfaceDescription(interface: string) -\u003e (description: string)\n\n# The requested interface was not found.\nerror InterfaceNotFound (interface: string)\n\n# The requested method was not found\nerror MethodNotFound (method: string)\n\n# The interface defines the requested method, but the service does not\n# implement it.\nerror MethodNotImplemented (method: string)\n\n# One of the passed parameters is invalid.\nerror InvalidParameter (parameter: string)"}}`+"\000",
			string(written))
	})

	t.Run("GetInfo", func(t *testing.T) {
		var written []byte
		wf := readWriterContextFunc(func(ctx context.Context, in []byte) (int, error) {
			written = append(written, in...)
			return len(in), nil
		})
		msg := []byte(`{"method":"org.varlink.service.GetInfo"}`)
		if err := service.HandleMessage(context.Background(), wf, msg); err != nil {
			t.Fatalf("HandleMessage returned error: %v", err)
		}
		expect(t, `{"parameters":{"vendor":"Varlink","product":"Varlink Test","version":"1","url":"https://github.com/varlink/go/varlink","interfaces":["org.varlink.service"]}}`+"\000",
			string(written))
	})
}

type VarlinkInterface struct{}

func (s *VarlinkInterface) VarlinkDispatch(ctx context.Context, call Call, methodname string) error {
	switch methodname {
	case "Ping":
		if !call.WantsMore() {
			return fmt.Errorf("More flag not passed")
		}
		if call.IsOneway() {
			return fmt.Errorf("OneShot flag set")
		}
		call.Continues = true
		if err := call.Reply(ctx, nil); err != nil {
			return err
		}
		if err := call.Reply(ctx, nil); err != nil {
			return err
		}
		call.Continues = false
		if err := call.Reply(ctx, nil); err != nil {
			return err
		}
		return nil

	case "PingError":
		return call.ReplyError(ctx, "org.example.test.PingError", nil)
	}

	call.Continues = true
	if err := call.Reply(ctx, nil); err == nil {
		return fmt.Errorf("call.Reply did not fail for Continues/More mismatch")
	}
	call.Continues = false

	if err := call.ReplyError(ctx, "WrongName", nil); err == nil {
		return fmt.Errorf("call.ReplyError accepted invalid error name")
	}

	if err := call.ReplyError(ctx, "org.varlink.service.MethodNotImplemented", nil); err == nil {
		return fmt.Errorf("call.ReplyError accepted org.varlink.service error")
	}

	return call.ReplyMethodNotImplemented(ctx, methodname)
}

func (s *VarlinkInterface) VarlinkGetName() string {
	return `org.example.test`
}

func (s *VarlinkInterface) VarlinkGetDescription() string {
	return "#"
}

func TestMoreService(t *testing.T) {
	newTestInterface := new(VarlinkInterface)

	service, _ := NewService(
		"Varlink",
		"Varlink Test",
		"1",
		"https://github.com/varlink/go/varlink",
	)

	if err := service.RegisterInterface(newTestInterface); err != nil {
		t.Fatalf("Couldn't register service: %v", err)
	}

	t.Run("MethodNotImplemented", func(t *testing.T) {
		var written []byte
		wf := readWriterContextFunc(func(ctx context.Context, in []byte) (int, error) {
			written = append(written, in...)
			return len(in), nil
		})
		msg := []byte(`{"method":"org.example.test.Pingf"}`)
		if err := service.HandleMessage(context.Background(), wf, msg); err != nil {
			t.Fatalf("HandleMessage returned error: %v", err)
		}
		expect(t, `{"parameters":{"method":"Pingf"},"error":"org.varlink.service.MethodNotImplemented"}`+"\000",
			string(written))
	})

	t.Run("PingError", func(t *testing.T) {
		var written []byte
		wf := readWriterContextFunc(func(ctx context.Context, in []byte) (int, error) {
			written = append(written, in...)
			return len(in), nil
		})
		msg := []byte(`{"method":"org.example.test.PingError", "more" : true}`)
		if err := service.HandleMessage(context.Background(), wf, msg); err != nil {
			t.Fatalf("HandleMessage returned error: %v", err)
		}
		expect(t, `{"error":"org.example.test.PingError"}`+"\000",
			string(written))
	})
	t.Run("MoreTest", func(t *testing.T) {
		var written []byte
		wf := readWriterContextFunc(func(ctx context.Context, in []byte) (int, error) {
			written = append(written, in...)
			return len(in), nil
		})
		msg := []byte(`{"method":"org.example.test.Ping", "more" : true}`)
		if err := service.HandleMessage(context.Background(), wf, msg); err != nil {
			t.Fatalf("HandleMessage returned error: %v", err)
		}
		expect(t, `{"continues":true}`+"\000"+`{"continues":true}`+"\000"+`{}`+"\000",
			string(written))
	})
}