Merge pull request #46 from ripienaar/19.1

(#19) expose identity in the cloud event headers as subject

Author: ripienaar

alive.go

@@ -44,12 +44,12 @@ func newAliveEventFromJSON(j []byte) (*AliveEvent, error) {
 		return nil, err
 	}
 
-	switch event.Protocol {
+	switch event.EventProtocol {
 	case "io.choria.lifecycle.v1.alive":
 	case "choria:lifecycle:alive:1":
-		event.Protocol = "io.choria.lifecycle.v1.alive"
+		event.EventProtocol = "io.choria.lifecycle.v1.alive"
 	default:
-		return nil, fmt.Errorf("invalid protocol '%s'", event.Protocol)
+		return nil, fmt.Errorf("invalid protocol '%s'", event.EventProtocol)
 	}
 
 	return event, nil

basic.go

@@ -6,17 +6,22 @@ import (
 )
 
 type basicEvent struct {
-	Protocol    string `json:"protocol"`
-	EventID     string `json:"id"`
-	Ident       string `json:"identity"`
-	Comp        string `json:"component"`
-	Timestamp   int64  `json:"timestamp"`
-	EventFormat Format `json:"-"`
+	EventProtocol string `json:"protocol"`
+	EventID       string `json:"id"`
+	Ident         string `json:"identity"`
+	Comp          string `json:"component"`
+	Timestamp     int64  `json:"timestamp"`
+	EventFormat   Format `json:"-"`
 
 	etype string
 	dtype Type
 }
 
+// Protocol retrieves the event protocol
+func (e *basicEvent) Protocol() string {
+	return e.EventProtocol
+}
+
 // Format retrieves the encoding format for the event
 func (e *basicEvent) Format() Format {
 	return e.EventFormat
@@ -83,11 +88,11 @@ func (e *basicEvent) TimeStamp() time.Time {
 
 func newBasicEvent(t string) basicEvent {
 	return basicEvent{
-		Protocol:    fmt.Sprintf("io.choria.lifecycle.v1.%s", t),
-		EventID:     eventID(),
-		Timestamp:   timeStamp(),
-		EventFormat: ChoriaFormat,
-		etype:       t,
-		dtype:       eventTypes[t],
+		EventProtocol: fmt.Sprintf("io.choria.lifecycle.v1.%s", t),
+		EventID:       eventID(),
+		Timestamp:     timeStamp(),
+		EventFormat:   ChoriaFormat,
+		etype:         t,
+		dtype:         eventTypes[t],
 	}
 }

event.go

@@ -6,6 +6,7 @@ import (
 
 // Event is event that can be published to the network
 type Event interface {
+	Protocol() string
 	Target() (string, error)
 	String() string
 	Type() Type

lifecycle.go

@@ -189,9 +189,9 @@ func protoStringToTypeString(proto string) (eventType string, err error) {
 func ToCloudEventV1(e Event) cloudevents.Event {
 	event := cloudevents.NewEvent("1.0")
 
-	event.SetType(e.TypeString())
+	event.SetType(e.Protocol())
 	event.SetSource("io.choria.lifecycle")
-	event.SetSubject(e.Component())
+	event.SetSubject(e.Identity())
 	event.SetID(e.ID())
 	event.SetTime(e.TimeStamp())
 	event.SetData(e)

lifecycle_test.go

@@ -92,7 +92,7 @@ var _ = Describe("Events", func() {
 				event, err := NewFromJSON(j)
 				Expect(err).ToNot(HaveOccurred())
 				Expect(event.Type()).To(Equal(Shutdown))
-				Expect(event.Component()).To(Equal("server"))
+				Expect(event.Component()).To(Equal("ginkgo"))
 				Expect(event.Format()).To(Equal(CloudEventV1Format))
 			})
 		})
@@ -117,7 +117,7 @@ var _ = Describe("Events", func() {
 			event, err := New(Startup, Component("ginkgo"), Version("1.2.3"), Identity("ginkgo.example.net"))
 			Expect(err).ToNot(HaveOccurred())
 			event.SetFormat(CloudEventV1Format)
-			conn.EXPECT().PublishRaw("choria.lifecycle.event.startup.ginkgo", []byte(`{"data":{"protocol":"io.choria.lifecycle.v1.startup","id":"01e72410-d734-4611-9485-8c6a2dd2579b","identity":"ginkgo.example.net","component":"ginkgo","timestamp":1535106973,"version":"1.2.3"},"id":"01e72410-d734-4611-9485-8c6a2dd2579b","source":"io.choria.lifecycle","specversion":"1.0","subject":"ginkgo","time":"2018-08-24T10:36:13Z","type":"startup"}`))
+			conn.EXPECT().PublishRaw("choria.lifecycle.event.startup.ginkgo", []byte(`{"data":{"protocol":"io.choria.lifecycle.v1.startup","id":"01e72410-d734-4611-9485-8c6a2dd2579b","identity":"ginkgo.example.net","component":"ginkgo","timestamp":1535106973,"version":"1.2.3"},"id":"01e72410-d734-4611-9485-8c6a2dd2579b","source":"io.choria.lifecycle","specversion":"1.0","subject":"ginkgo.example.net","time":"2018-08-24T10:36:13Z","type":"io.choria.lifecycle.v1.startup"}`))
 			err = PublishEvent(event, conn)
 			Expect(err).ToNot(HaveOccurred())
 		})

provisioned.go

@@ -40,12 +40,12 @@ func newProvisionedEventFromJSON(j []byte) (*ProvisionedEvent, error) {
 		return nil, err
 	}
 
-	switch event.Protocol {
+	switch event.EventProtocol {
 	case "io.choria.lifecycle.v1.provisioned":
 	case "choria:lifecycle:provisioned:1":
-		event.Protocol = "io.choria.lifecycle.v1.provisioned"
+		event.EventProtocol = "io.choria.lifecycle.v1.provisioned"
 	default:
-		return nil, fmt.Errorf("invalid protocol '%s'", event.Protocol)
+		return nil, fmt.Errorf("invalid protocol '%s'", event.EventProtocol)
 	}
 
 	return event, nil

shutdown.go

@@ -39,12 +39,12 @@ func newShutdownEventFromJSON(j []byte) (*ShutdownEvent, error) {
 		return nil, err
 	}
 
-	switch event.Protocol {
+	switch event.EventProtocol {
 	case "io.choria.lifecycle.v1.shutdown":
 	case "choria:lifecycle:shutdown:1":
-		event.Protocol = "io.choria.lifecycle.v1.shutdown"
+		event.EventProtocol = "io.choria.lifecycle.v1.shutdown"
 	default:
-		return nil, fmt.Errorf("invalid protocol '%s'", event.Protocol)
+		return nil, fmt.Errorf("invalid protocol '%s'", event.EventProtocol)
 	}
 
 	return event, nil

startup.go

@@ -44,12 +44,12 @@ func newStartupEventFromJSON(j []byte) (*StartupEvent, error) {
 		return nil, err
 	}
 
-	switch event.Protocol {
+	switch event.EventProtocol {
 	case "io.choria.lifecycle.v1.startup":
 	case "choria:lifecycle:startup:1":
-		event.Protocol = "io.choria.lifecycle.v1.startup"
+		event.EventProtocol = "io.choria.lifecycle.v1.startup"
 	default:
-		return nil, fmt.Errorf("invalid protocol '%s'", event.Protocol)
+		return nil, fmt.Errorf("invalid protocol '%s'", event.EventProtocol)
 	}
 
 	return event, nil

testdata/cloudEventFormatShutdown.json

@@ -1,14 +1,16 @@
 {
+    "id": "01e72410-d734-4611-9485-8c6a2dd2579b",
+    "source": "io.choria.lifecycle",
     "specversion": "1.0",
+    "subject": "ginkgo.example.net",
+    "time": "2018-08-24T10:36:13Z",
     "type": "io.choria.lifecycle.v1.shutdown",
-    "source": "io.choria.lifecycle",
-    "id": "A234-1234-1234",
-    "time": "2019-12-04T18:58:58Z",
     "data": {
         "protocol": "io.choria.lifecycle.v1.shutdown",
-        "id": "cb6f1dbc-d65b-49b9-907e-e4a51bee75f8",
-        "identity": "dev1.devco.net",
-        "component": "server",
-        "timestamp": 1575482338
+        "id": "01e72410-d734-4611-9485-8c6a2dd2579b",
+        "identity": "ginkgo.example.net",
+        "component": "ginkgo",
+        "timestamp": 1535106973,
+        "version": "1.2.3"
     }
 }