
This change further plumbs the components required for implementing event filters. Specifically, we now have the ability to filter on the `topic` and `namespace`. In the course of implementing this functionality, it was found that there were mismatches in the events API that created extra serialization round trips. A modification to `typeurl.MarshalAny` and a clear separation between publishing and forwarding allow us to avoid these serialization issues. Unfortunately, this has required a few tweaks to the GRPC API, so this is a breaking change. `Publish` and `Forward` have been clearly separated in the GRPC API. `Publish` honors the contextual namespace and performs timestamping while `Forward` simply validates and forwards. The behavior of `Subscribe` is to propagate events for all namespaces unless specifically filtered (and hence the relation to this particular change. The following is an example of using filters to monitor the task events generated while running the [bucketbench tool](https://github.com/estesp/bucketbench): ``` $ ctr events 'topic~=/tasks/.+,namespace==bb' ... 2017-07-28 22:19:51.78944874 +0000 UTC bb /tasks/start {"container_id":"bb-ctr-6-8","pid":25889} 2017-07-28 22:19:51.791893688 +0000 UTC bb /tasks/start {"container_id":"bb-ctr-4-8","pid":25882} 2017-07-28 22:19:51.792608389 +0000 UTC bb /tasks/start {"container_id":"bb-ctr-2-9","pid":25860} 2017-07-28 22:19:51.793035217 +0000 UTC bb /tasks/start {"container_id":"bb-ctr-5-6","pid":25869} 2017-07-28 22:19:51.802659622 +0000 UTC bb /tasks/start {"container_id":"bb-ctr-0-7","pid":25877} 2017-07-28 22:19:51.805192898 +0000 UTC bb /tasks/start {"container_id":"bb-ctr-3-6","pid":25856} 2017-07-28 22:19:51.832374931 +0000 UTC bb /tasks/exit {"container_id":"bb-ctr-8-6","id":"bb-ctr-8-6","pid":25864,"exited_at":"2017-07-28T22:19:51.832013043Z"} 2017-07-28 22:19:51.84001249 +0000 UTC bb /tasks/exit {"container_id":"bb-ctr-2-9","id":"bb-ctr-2-9","pid":25860,"exited_at":"2017-07-28T22:19:51.839717714Z"} 2017-07-28 22:19:51.840272635 +0000 UTC bb /tasks/exit {"container_id":"bb-ctr-7-6","id":"bb-ctr-7-6","pid":25855,"exited_at":"2017-07-28T22:19:51.839796335Z"} ... ``` In addition to the events changes, we now display the namespace origin of the event in the cli tool. This will be followed by a PR to add individual field filtering for the events API for each event type. Signed-off-by: Stephen J Day <stephen.day@docker.com>
171 lines
3.1 KiB
Go
171 lines
3.1 KiB
Go
package typeurl
|
|
|
|
import (
|
|
"fmt"
|
|
"path/filepath"
|
|
"reflect"
|
|
"testing"
|
|
|
|
eventsapi "github.com/containerd/containerd/api/services/events/v1"
|
|
)
|
|
|
|
type test struct {
|
|
Name string
|
|
Age int
|
|
}
|
|
|
|
func clear() {
|
|
registry = make(map[reflect.Type]string)
|
|
}
|
|
|
|
func TestRegisterPointerGetPointer(t *testing.T) {
|
|
clear()
|
|
expected := filepath.Join(Prefix, "test")
|
|
Register(&test{}, "test")
|
|
|
|
url, err := TypeURL(&test{})
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if url != expected {
|
|
t.Fatalf("expected %q but received %q", expected, url)
|
|
}
|
|
}
|
|
|
|
func TestMarshal(t *testing.T) {
|
|
clear()
|
|
expected := filepath.Join(Prefix, "test")
|
|
Register(&test{}, "test")
|
|
|
|
v := &test{
|
|
Name: "koye",
|
|
Age: 6,
|
|
}
|
|
any, err := MarshalAny(v)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if any.TypeUrl != expected {
|
|
t.Fatalf("expected %q but received %q", expected, any.TypeUrl)
|
|
}
|
|
|
|
// marshal it again and make sure we get the same thing back.
|
|
newany, err := MarshalAny(any)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
if newany != any { // you that right: we want the same *pointer*!
|
|
t.Fatalf("expected to get back same object: %v != %v", newany, any)
|
|
}
|
|
|
|
}
|
|
|
|
func TestMarshalUnmarshal(t *testing.T) {
|
|
clear()
|
|
Register(&test{}, "test")
|
|
|
|
v := &test{
|
|
Name: "koye",
|
|
Age: 6,
|
|
}
|
|
any, err := MarshalAny(v)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
nv, err := UnmarshalAny(any)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
td, ok := nv.(*test)
|
|
if !ok {
|
|
t.Fatal("expected value to cast to *test")
|
|
}
|
|
if td.Name != "koye" {
|
|
t.Fatal("invalid name")
|
|
}
|
|
if td.Age != 6 {
|
|
t.Fatal("invalid age")
|
|
}
|
|
}
|
|
|
|
func TestIs(t *testing.T) {
|
|
clear()
|
|
Register(&test{}, "test")
|
|
|
|
v := &test{
|
|
Name: "koye",
|
|
Age: 6,
|
|
}
|
|
any, err := MarshalAny(v)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if !Is(any, &test{}) {
|
|
t.Fatal("Is(any, test{}) should be true")
|
|
}
|
|
}
|
|
|
|
func TestMarshalEvent(t *testing.T) {
|
|
for _, testcase := range []struct {
|
|
event interface{}
|
|
url string
|
|
}{
|
|
{
|
|
event: &eventsapi.TaskStart{},
|
|
url: "types.containerd.io/containerd.services.events.v1.TaskStart",
|
|
},
|
|
|
|
{
|
|
event: &eventsapi.NamespaceUpdate{},
|
|
url: "types.containerd.io/containerd.services.events.v1.NamespaceUpdate",
|
|
},
|
|
} {
|
|
t.Run(fmt.Sprintf("%T", testcase.event), func(t *testing.T) {
|
|
a, err := MarshalAny(testcase.event)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if a.TypeUrl != testcase.url {
|
|
t.Fatalf("unexpected url: %v != %v", a.TypeUrl, testcase.url)
|
|
}
|
|
|
|
v, err := UnmarshalAny(a)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if !reflect.DeepEqual(v, testcase.event) {
|
|
t.Fatalf("round trip failed %v != %v", v, testcase.event)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestRegisterDiffUrls(t *testing.T) {
|
|
clear()
|
|
defer func() {
|
|
if err := recover(); err == nil {
|
|
t.Error("registering the same type with different urls should panic")
|
|
}
|
|
}()
|
|
Register(&test{}, "test")
|
|
Register(&test{}, "test", "two")
|
|
}
|
|
|
|
func BenchmarkMarshalEvent(b *testing.B) {
|
|
ev := &eventsapi.TaskStart{}
|
|
expected, err := MarshalAny(ev)
|
|
if err != nil {
|
|
b.Fatal(err)
|
|
}
|
|
for i := 0; i < b.N; i++ {
|
|
a, err := MarshalAny(ev)
|
|
if err != nil {
|
|
b.Fatal(err)
|
|
}
|
|
if a.TypeUrl != expected.TypeUrl {
|
|
b.Fatalf("incorrect type url: %v != %v", a, expected)
|
|
}
|
|
}
|
|
}
|