Merge pull request #22 from elimity-com/feature/21-timestamp-support

Add optional timestamp to DomainGraph struct
elimity-com · Jun 18, 2020 · be553a7 · be553a7
2 parents b7d804c + 66f099d
commit be553a7
Show file tree

Hide file tree

Showing 2 changed files with 116 additions and 83 deletions.
diff --git a/domaingraph.go b/domaingraph.go
@@ -1,6 +1,9 @@
 package insights
 
-import "net/http"
+import (
+	"net/http"
+	"time"
+)
 
 // AttributeAssignment represents the assignment of an attribute of a given type with a compatible value, which may be
 // managed at an Elimity Insights server.
@@ -27,9 +30,11 @@ func (c Client) ReloadDomainGraph(domainGraph DomainGraph) error {
 }
 
 // DomainGraph represents a graph of domain data that may be managed at an Elimity Insights server.
+// The Timestamp field is optional.
 type DomainGraph struct {
 	Entities      []Entity
 	Relationships []Relationship
+	Timestamp     *time.Time
 }
 
 func (g DomainGraph) model() domainGraphModel {
@@ -48,6 +53,7 @@ func (g DomainGraph) model() domainGraphModel {
 	return domainGraphModel{
 		Entities:      entityModels,
 		Relationships: relationshipModels,
+		Timestamp:     g.Timestamp,
 	}
 }
 
@@ -109,6 +115,7 @@ type attributeAssignmentModel struct {
 type domainGraphModel struct {
 	Entities      []entityModel       `json:"entities"`
 	Relationships []relationshipModel `json:"relationships"`
+	Timestamp     *time.Time          `json:"historyTimestamp,omitempty"`
 }
 
 type entityModel struct {

diff --git a/domaingraph_test.go b/domaingraph_test.go
@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"io/ioutil"
 	"net/http"
+	"net/http/httptest"
 	"testing"
 	"time"
 
@@ -12,92 +13,66 @@ import (
 )
 
 func TestClientReloadDomainGraph(t *testing.T) {
-	var fun http.HandlerFunc = func(writer http.ResponseWriter, request *http.Request) {
-		if request.URL.Path != "/domain-graph/reload" {
-			t.Fatalf(`got path %q, want "/domain-graph/reload"`, request.URL.Path)
-		}
-
-		actualBodyBytes, err := ioutil.ReadAll(request.Body)
-		if err != nil {
-			t.Fatalf("failed reading request body: %v", err)
-		}
-
-		var actualBody interface{}
-		if err := json.Unmarshal(actualBodyBytes, &actualBody); err != nil {
-			t.Fatalf("failed unmarshalling body: %v", err)
-		}
-
-		expectedBodyString := `{
-			"entities": [
-				{
-					"active": true,
-					"attributeAssignments": [
-						{
-							"attributeTypeName": "foo",
-							"value": {
-								"type": "boolean",
-								"value": "true"
-							}
-						},
-						{
-							"attributeTypeName": "bar",
-							"value": {
-								"type": "date",
-								"value": "2006-01-02"
-							}
+	expectedBodyString := `{
+		"entities": [
+			{
+				"active": true,
+				"attributeAssignments": [
+					{
+						"attributeTypeName": "foo",
+						"value": {
+							"type": "boolean",
+							"value": "true"
 						}
-					],
-					"id": "foo",
-					"name": "bar",
-					"type": "baz"
-				},
-				{
-					"active": false,
-					"attributeAssignments": [
-						{
-							"attributeTypeName": "baz",
-							"value": {
-								"type": "time",
-								"value": "15:04:05Z"
-							}
+					},
+					{
+						"attributeTypeName": "bar",
+						"value": {
+							"type": "date",
+							"value": "2006-01-02"
 						}
-					],
-					"id": "bar",
-					"name": "baz",
-					"type": "foo"
-				}
-			],
-			"relationships": [
-				{
-					"attributeAssignments": [
-						{
-							"attributeTypeName": "asd",
-							"value": {
-								"type": "string",
-								"value": "asd"
-							}
+					}
+				],
+				"id": "foo",
+				"name": "bar",
+				"type": "baz"
+			},
+			{
+				"active": false,
+				"attributeAssignments": [
+					{
+						"attributeTypeName": "baz",
+						"value": {
+							"type": "time",
+							"value": "15:04:05Z"
 						}
-					],
-					"fromId": "foo",
-					"fromType": "baz",
-					"toId": "bar",
-					"toType": "foo"
-				}
-			]
-		}`
-		expectedBodyBytes := []byte(expectedBodyString)
-
-		var expectedBody interface{}
-		if err := json.Unmarshal(expectedBodyBytes, &expectedBody); err != nil {
-			panic(err)
-		}
-
-		if diff := cmp.Diff(expectedBody, actualBody); diff != "" {
-			t.Fatalf("body mismatch (-got, +want):\n%s", diff)
-		}
-	}
+					}
+				],
+				"id": "bar",
+				"name": "baz",
+				"type": "foo"
+			}
+		],
+		"relationships": [
+			{
+				"attributeAssignments": [
+					{
+						"attributeTypeName": "asd",
+						"value": {
+							"type": "string",
+							"value": "asd"
+						}
+					}
+				],
+				"fromId": "foo",
+				"fromType": "baz",
+				"toId": "bar",
+				"toType": "foo"
+			}
+		]
+	}`
 
-	client, server := setup(t, fun)
+	client, server := domainGraphTestClientServer(t, expectedBodyString)
 	defer server.Close()
 
 	fooValue := insights.NewBooleanValue(true)
@@ -158,3 +133,54 @@ func TestClientReloadDomainGraph(t *testing.T) {
 		t.Fatalf("failed reloading domain graph: %v", err)
 	}
 }
+
+func TestClientReloadDomainGraphTimestamp(t *testing.T) {
+	expectedBodyString := `{
+		"entities": [],
+		"relationships": [],
+		"historyTimestamp": "2020-06-15T16:26:10Z"
+	}`
+
+	client, server := domainGraphTestClientServer(t, expectedBodyString)
+	defer server.Close()
+
+	timestamp := time.Date(2020, time.June, 15, 16, 26, 10, 0, time.UTC)
+	domainGraph := insights.DomainGraph{
+		Timestamp: &timestamp,
+	}
+
+	if err := client.ReloadDomainGraph(domainGraph); err != nil {
+		t.Fatalf("failed reloading domain graph: %v", err)
+	}
+}
+
+func domainGraphTestClientServer(t *testing.T, expectedBodyString string) (insights.Client, *httptest.Server) {
+	var handlerFunc http.HandlerFunc = func(writer http.ResponseWriter, request *http.Request) {
+		if request.URL.Path != "/domain-graph/reload" {
+			t.Fatalf(`got path %q, want "/domain-graph/reload"`, request.URL.Path)
+		}
+
+		actualBodyBytes, err := ioutil.ReadAll(request.Body)
+		if err != nil {
+			t.Fatalf("failed reading request body: %v", err)
+		}
+
+		var actualBody interface{}
+		if err := json.Unmarshal(actualBodyBytes, &actualBody); err != nil {
+			t.Fatalf("failed unmarshalling body: %v", err)
+		}
+
+		expectedBodyBytes := []byte(expectedBodyString)
+
+		var expectedBody interface{}
+		if err := json.Unmarshal(expectedBodyBytes, &expectedBody); err != nil {
+			panic(err)
+		}
+
+		if diff := cmp.Diff(expectedBody, actualBody); diff != "" {
+			t.Fatalf("body mismatch (-got, +want):\n%s", diff)
+		}
+	}
+
+	return setup(t, handlerFunc)
+}