Merge pull request #186 from mnaboka/mnaboka/add-missing-response-fields

Add missing dashboard fields

Author: ojongerius

dashboards.go

@@ -162,10 +162,27 @@ type Dashboard struct {
 // DashboardLite represents a user created dashboard. This is the mini
 // struct when we load the summaries.
 type DashboardLite struct {
-	Id          *int    `json:"id,string,omitempty"` // TODO: Remove ',string'.
-	Resource    *string `json:"resource,omitempty"`
-	Description *string `json:"description,omitempty"`
-	Title       *string `json:"title,omitempty"`
+	Id          *int       `json:"id,string,omitempty"` // TODO: Remove ',string'.
+	Resource    *string    `json:"resource,omitempty"`
+	Description *string    `json:"description,omitempty"`
+	Title       *string    `json:"title,omitempty"`
+	ReadOnly    *bool      `json:"read_only,omitempty"`
+	Created     *string    `json:"created,omitempty"`
+	Modified    *string    `json:"modified,omitempty"`
+	CreatedBy   *CreatedBy `json:"created_by,omitempty"`
+}
+
+// CreatedBy represents a field from DashboardLite.
+type CreatedBy struct {
+	Disabled   *bool   `json:"disabled,omitempty"`
+	Handle     *string `json:"handle,omitempty"`
+	Name       *string `json:"name,omitempty"`
+	IsAdmin    *bool   `json:"is_admin,omitempty"`
+	Role       *string `json:"role,omitempty"`
+	AccessRole *string `json:"access_role,omitempty"`
+	Verified   *bool   `json:"verified,omitempty"`
+	Email      *string `json:"email,omitempty"`
+	Icon       *string `json:"icon,omitempty"`
 }
 
 // reqGetDashboards from /api/v1/dash

dashboards_test.go

@@ -2,6 +2,9 @@ package datadog
 
 import (
 	"encoding/json"
+	"io/ioutil"
+	"net/http"
+	"net/http/httptest"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -75,3 +78,154 @@ func (suite *YAxisTestSuite) TestYAxisJSONUnmarshalAutoMinMax() {
 func TestYAxisTestSuite(t *testing.T) {
 	suite.Run(t, new(YAxisTestSuite))
 }
+
+func TestDashboardGetters(t *testing.T) {
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		response, err := ioutil.ReadFile("./tests/fixtures/dashboards_response.json")
+		if err != nil {
+			t.Fatal(err)
+		}
+		w.Write(response)
+	}))
+	defer ts.Close()
+
+	datadogClient := Client{
+		baseUrl:    ts.URL,
+		HttpClient: http.DefaultClient,
+	}
+
+	dashboards, err := datadogClient.GetDashboards()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	if len(dashboards) != 2 {
+		t.Fatalf("expect response with 2 dashboards. Got %d", len(dashboards))
+	}
+
+	d1 := dashboards[0]
+
+	expectedID := 123
+	if id := d1.GetId(); id != expectedID {
+		t.Fatalf("expect ID %d. Got %d", expectedID, id)
+	}
+
+	expectedTitle := "Dashboard 1"
+	if title := d1.GetTitle(); title != expectedTitle {
+		t.Fatalf("expect title %s. Got %s", expectedTitle, title)
+	}
+
+	expectedDescription := "created by user1"
+	if description := d1.GetDescription(); description != expectedDescription {
+		t.Fatalf("expect description %s. Got %s", expectedDescription, description)
+	}
+
+	expectedCreateTime := "2018-10-05T12:32:01.000000+00:00"
+	createTime, ok := d1.GetCreatedOk()
+	if !ok {
+		t.Fatalf("expect to have a created field")
+	}
+
+	if createTime != expectedCreateTime {
+		t.Fatalf("expect create time %s. Got %s", expectedCreateTime, createTime)
+	}
+
+	expectedReadOnly := false
+	readOnly, ok := d1.GetReadOnlyOk()
+	if !ok {
+		t.Fatalf("expect to have a read_only field")
+	}
+
+	if readOnly != expectedReadOnly {
+		t.Fatalf("expect read_only %v. Got %v", expectedReadOnly, readOnly)
+	}
+
+	expectedModified := "2018-09-11T06:38:09.000000+00:00"
+	modified, ok := d1.GetModifiedOk()
+	if !ok {
+		t.Fatalf("expect to have a modified field")
+	}
+
+	if modified != expectedModified {
+		t.Fatalf("expect modified %s. Got %s", expectedModified, modified)
+	}
+
+	createdBy, ok := d1.GetCreatedByOk()
+	if !ok {
+		t.Fatal("expect created_by field to exist")
+	}
+
+	validateCreatedBy(t, &createdBy)
+}
+
+func validateCreatedBy(t *testing.T, cb *CreatedBy) {
+	expectedAccessRole := "adm"
+	accessRole, ok := cb.GetAccessRoleOk()
+	if !ok {
+		t.Fatal("expect to have access_role field")
+	}
+
+	if accessRole != expectedAccessRole {
+		t.Fatalf("expect access_role %s. Got %s", expectedAccessRole, accessRole)
+	}
+
+	expectedDisabled := true
+	disabled, ok := cb.GetDisabledOk()
+	if !ok {
+		t.Fatal("expect to have disabled field")
+	}
+
+	if disabled != expectedDisabled {
+		t.Fatalf("expect disabled %v. Got %v", expectedDisabled, disabled)
+	}
+
+	expectedEmail := "[email protected]"
+	email, ok := cb.GetEmailOk()
+	if !ok {
+		t.Fatal("expect to have email field")
+	}
+
+	if email != expectedEmail {
+		t.Fatalf("expect email %s. Got %s", expectedEmail, email)
+	}
+
+	expectedHandle := "[email protected]"
+	handle, ok := cb.GetHandleOk()
+	if !ok {
+		t.Fatal("expect to have handle field")
+	}
+
+	if handle != expectedHandle {
+		t.Fatalf("expect handle %s. Got %s", expectedHandle, handle)
+	}
+
+	expectedIcon := "https://pics.site.com/123.jpg"
+	icon, ok := cb.GetIconOk()
+	if !ok {
+		t.Fatal("expect to have icon field")
+	}
+
+	if icon != expectedIcon {
+		t.Fatalf("expect icon %s. Got %s", expectedIcon, icon)
+	}
+
+	expectedName := "John Doe"
+	name, ok := cb.GetNameOk()
+	if !ok {
+		t.Fatal("expect to have name field")
+	}
+
+	if name != expectedName {
+		t.Fatalf("expect name %s. Got %s", expectedName, name)
+	}
+
+	expectedVerified := true
+	verified, ok := cb.GetVerifiedOk()
+	if !ok {
+		t.Fatal("expect to have verified field")
+	}
+
+	if verified != expectedVerified {
+		t.Fatalf("expect verify %v. Got %v", expectedVerified, verified)
+	}
+}