Skip to content

Commit d361e7b

Browse files
trapgatetrapgate
authored
update for go-libvirt's changed API (digitalocean#166)
* update for go-libvirt's changed API Recent breaking changes to go-libvirt's API introduced contexts to the QEMU events endpoints used by go-qemu. This change also converts go-qemu to a module.
1 parent d5bc2f9 commit d361e7b

12 files changed

+79
-21
lines changed

‎.travis.yml

+1
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ install:
4949
before_install:
5050
- go get golang.org/x/lint/golint
5151
- go get golang.org/x/tools/cmd/stringer
52+
- go mod tidy
5253

5354
before_script:
5455
- go get -d ./...

‎go.mod

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module github.com/digitalocean/go-qemu
2+
3+
go 1.15
4+
5+
require (
6+
github.com/digitalocean/go-libvirt v0.0.0-20201209184759-e2a69bcd5bd1
7+
github.com/fatih/camelcase v1.0.0
8+
)

‎go.sum

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
2+
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
3+
github.com/digitalocean/go-libvirt v0.0.0-20201209184759-e2a69bcd5bd1 h1:j6vGflaQ2T7yOWqVgPdiRF73j/U2Zmpbbzab8nyDCRQ=
4+
github.com/digitalocean/go-libvirt v0.0.0-20201209184759-e2a69bcd5bd1/go.mod h1:QS1XzqZLcDniNYrN7EZefq3wIyb/M2WmJbql4ZKoc1Q=
5+
github.com/fatih/camelcase v1.0.0 h1:hxNvNX/xYBp0ovncs8WyWZrOrpBNub/JfaMvbURyft8=
6+
github.com/fatih/camelcase v1.0.0/go.mod h1:yN2Sb0lFhZJUdVvtELVWefmrXpuZESvPmqwoZc+/fpc=
7+
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
8+
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
9+
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
10+
github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
11+
github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
12+
github.com/yuin/goldmark v1.1.32/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
13+
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
14+
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
15+
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
16+
golang.org/x/mod v0.3.0 h1:RM4zey1++hCTbCVQfnWeKs9/IEsaBLA8vTkd0WVtmH4=
17+
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
18+
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
19+
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
20+
golang.org/x/net v0.0.0-20200625001655-4c5254603344/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA=
21+
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
22+
golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
23+
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
24+
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
25+
golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
26+
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
27+
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
28+
golang.org/x/tools v0.0.0-20200711155855-7342f9734a7d h1:F3OmlXCzYtG9YE6tXDnUOlJBzVzHF8EcmZ1yTJlcgIk=
29+
golang.org/x/tools v0.0.0-20200711155855-7342f9734a7d/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA=
30+
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
31+
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
32+
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
33+
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
34+
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
35+
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
36+
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
37+
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

‎hypervisor/hypervisor_test.go

+5-4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
package hypervisor
1616

1717
import (
18+
"context"
1819
"reflect"
1920
"testing"
2021

@@ -122,10 +123,10 @@ var _ qmp.Monitor = &noopMonitor{}
122123

123124
type noopMonitor struct{}
124125

125-
func (noopMonitor) Connect() error { return nil }
126-
func (noopMonitor) Disconnect() error { return nil }
127-
func (noopMonitor) Run(_ []byte) ([]byte, error) { return nil, nil }
128-
func (noopMonitor) Events() (<-chan qmp.Event, error) { return nil, nil }
126+
func (noopMonitor) Connect() error { return nil }
127+
func (noopMonitor) Disconnect() error { return nil }
128+
func (noopMonitor) Run(_ []byte) ([]byte, error) { return nil, nil }
129+
func (noopMonitor) Events(context.Context) (<-chan qmp.Event, error) { return nil, nil }
129130

130131
type testConnectMonitor struct {
131132
connected bool

‎qemu/domain.go

+5-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ package qemu
1919
//go:generate ../scripts/prependlicense.sh string.gen.go
2020

2121
import (
22+
"context"
2223
"encoding/json"
2324
"errors"
2425
"fmt"
@@ -393,8 +394,10 @@ func (d *Domain) Events() (chan qmp.Event, chan struct{}, error) {
393394

394395
// listenAndServe handles a domain's event broadcast service.
395396
func (d *Domain) listenAndServe() error {
396-
stream, err := d.m.Events()
397+
ctx, cancel := context.WithCancel(context.Background())
398+
stream, err := d.m.Events(ctx)
397399
if err != nil {
400+
cancel()
398401
// let Event() inform the user events are not supported
399402
if err == qmp.ErrEventsNotSupported {
400403
d.eventsUnsupported = true
@@ -405,6 +408,7 @@ func (d *Domain) listenAndServe() error {
405408
}
406409

407410
go func() {
411+
defer cancel()
408412
for {
409413
select {
410414
case <-d.done:

‎qemu/domain_test.go

+6-5
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ package qemu
1616

1717
import (
1818
"bytes"
19+
"context"
1920
"encoding/json"
2021
"io/ioutil"
2122
"os"
@@ -647,7 +648,7 @@ func (t *testMonitor) Run(raw []byte) ([]byte, error) {
647648
return json.Marshal(result)
648649
}
649650

650-
func (t *testMonitor) Events() (<-chan qmp.Event, error) {
651+
func (t *testMonitor) Events(ctx context.Context) (<-chan qmp.Event, error) {
651652
c := make(chan qmp.Event)
652653
go func() {
653654
events := []string{blockJobReady, blockJobCompleted}
@@ -679,7 +680,7 @@ var _ qmp.Monitor = &noopMonitor{}
679680

680681
type noopMonitor struct{}
681682

682-
func (noopMonitor) Connect() error { return nil }
683-
func (noopMonitor) Disconnect() error { return nil }
684-
func (noopMonitor) Run(_ []byte) ([]byte, error) { return nil, nil }
685-
func (noopMonitor) Events() (<-chan qmp.Event, error) { return nil, nil }
683+
func (noopMonitor) Connect() error { return nil }
684+
func (noopMonitor) Disconnect() error { return nil }
685+
func (noopMonitor) Run(_ []byte) ([]byte, error) { return nil, nil }
686+
func (noopMonitor) Events(context.Context) (<-chan qmp.Event, error) { return nil, nil }

‎qmp/qmp.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
package qmp
1818

1919
import (
20+
"context"
2021
"errors"
2122
"fmt"
2223
)
@@ -31,7 +32,7 @@ type Monitor interface {
3132
Connect() error
3233
Disconnect() error
3334
Run(command []byte) (out []byte, err error)
34-
Events() (events <-chan Event, err error)
35+
Events(context.Context) (events <-chan Event, err error)
3536
}
3637

3738
// Command represents a QMP command.

‎qmp/qmptest/qmptest.go

+5-4
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
package qmptest
1818

1919
import (
20+
"context"
2021
"encoding/json"
2122

2223
"github.com/digitalocean/go-qemu/qmp"
@@ -59,7 +60,7 @@ var _ qmp.Monitor = &noopMonitor{}
5960

6061
type noopMonitor struct{}
6162

62-
func (noopMonitor) Connect() error { return nil }
63-
func (noopMonitor) Disconnect() error { return nil }
64-
func (noopMonitor) Run(_ []byte) ([]byte, error) { return nil, nil }
65-
func (noopMonitor) Events() (<-chan qmp.Event, error) { return nil, nil }
63+
func (noopMonitor) Connect() error { return nil }
64+
func (noopMonitor) Disconnect() error { return nil }
65+
func (noopMonitor) Run(_ []byte) ([]byte, error) { return nil, nil }
66+
func (noopMonitor) Events(context.Context) (<-chan qmp.Event, error) { return nil, nil }

‎qmp/rpc.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ func (rpc *LibvirtRPCMonitor) Disconnect() error {
5555
return rpc.l.Disconnect()
5656
}
5757

58-
// Events streams QEMU QMP Events.
58+
// Events streams QEMU QMP Events until the provided context is cancelled.
5959
// If a problem is encountered setting up the event monitor connection
6060
// an error will be returned. Errors encountered during streaming will
6161
// cause the returned event channel to be closed.
62-
func (rpc *LibvirtRPCMonitor) Events() (<-chan Event, error) {
63-
events, err := rpc.l.SubscribeQEMUEvents(context.Background(), rpc.Domain)
62+
func (rpc *LibvirtRPCMonitor) Events(ctx context.Context) (<-chan Event, error) {
63+
events, err := rpc.l.SubscribeQEMUEvents(ctx, rpc.Domain)
6464
if err != nil {
6565
return nil, err
6666
}

‎qmp/rpc_test.go

+3-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
package qmp
1616

1717
import (
18+
"context"
1819
"encoding/json"
1920
"testing"
2021
"time"
@@ -170,11 +171,12 @@ func TestLibvirtRPCMonitorRun(t *testing.T) {
170171
}
171172

172173
func TestLibvirtRPCMonitorEvents(t *testing.T) {
174+
ctx := context.Background()
173175
conn := libvirttest.New()
174176
mon := NewLibvirtRPCMonitor("test", conn)
175177
done := make(chan struct{})
176178

177-
stream, err := mon.Events()
179+
stream, err := mon.Events(ctx)
178180
if err != nil {
179181
t.Error(err)
180182
}

‎qmp/socket.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ package qmp
1616

1717
import (
1818
"bufio"
19+
"context"
1920
"encoding/json"
2021
"io"
2122
"net"
@@ -149,7 +150,7 @@ func (mon *SocketMonitor) Connect() error {
149150
// Events streams QEMU QMP Events.
150151
// Events should only be called once per Socket. If used with a qemu.Domain,
151152
// qemu.Domain.Events should be called to retrieve events instead.
152-
func (mon *SocketMonitor) Events() (<-chan Event, error) {
153+
func (mon *SocketMonitor) Events(context.Context) (<-chan Event, error) {
153154
atomic.AddInt32(mon.listeners, 1)
154155
return mon.events, nil
155156
}

‎qmp/socket_test.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
package qmp
1616

1717
import (
18+
"context"
1819
"encoding/json"
1920
"errors"
2021
"fmt"
@@ -83,7 +84,7 @@ func TestSocketMonitorEvents(t *testing.T) {
8384
mon, w, done := testSocket(t)
8485
defer done()
8586

86-
events, err := mon.Events()
87+
events, err := mon.Events(context.Background())
8788
if err != nil {
8889
t.Fatalf("unexpected error: %v", err)
8990
}

0 commit comments

Comments
 (0)