Made maintenance_info a pointer in Update and Provision Request struc…

…tures Removed check for NilOrEmpty since we are working with pointers and dont expect the maintenanceInfo to be empty [#167086819] Co-authored-by: Derik Evangelista <[email protected]>
pivotal-cf · Jul 4, 2019 · 68c365c · 68c365c
1 parent e7d54e4
commit 68c365c
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 95 deletions.
diff --git a/api_test.go b/api_test.go
@@ -414,7 +414,7 @@ var _ = Describe("Service Broker API", func() {
  PlanID: "plan-id",
  OrganizationGUID: "organization-guid",
  SpaceGUID: "space-guid",
- MaintenanceInfo: brokerapi.MaintenanceInfo{
+ MaintenanceInfo: &brokerapi.MaintenanceInfo{
  Public: map[string]string{
  "k8s-version": "0.0.1-alpha2",
  },
@@ -692,7 +692,7 @@ var _ = Describe("Service Broker API", func() {
  PlanID: "plan-id",
  OrganizationGUID: "organization-guid",
  SpaceGUID: "space-guid",
- MaintenanceInfo: brokerapi.MaintenanceInfo{
+ MaintenanceInfo: &brokerapi.MaintenanceInfo{
  Public: map[string]string{
  "k8s-version": "0.0.1-alpha2",
  },
@@ -964,7 +964,7 @@ var _ = Describe("Service Broker API", func() {
  },
  ))
  Expect(fakeServiceBroker.UpdateDetails.RawParameters).To(Equal(json.RawMessage(`{"new-param":"new-param-value"}`)))
- Expect(fakeServiceBroker.UpdateDetails.MaintenanceInfo).To(Equal(brokerapi.MaintenanceInfo{
+ Expect(*fakeServiceBroker.UpdateDetails.MaintenanceInfo).To(Equal(brokerapi.MaintenanceInfo{
  Public: map[string]string{"k8s-version": "0.0.1-alpha2"},
  Private: "just a sha thing"},
  ))

diff --git a/domain/maintenance_info.go b/domain/maintenance_info.go
@@ -11,7 +11,3 @@ type MaintenanceInfo struct {
 func (m *MaintenanceInfo) Equals(input MaintenanceInfo) bool {
  return reflect.DeepEqual(*m, input)
 }
-
-func (m *MaintenanceInfo) NilOrEmpty() bool {
- return m == nil || m.Equals(MaintenanceInfo{})
-}
diff --git a/domain/maintenance_info_test.go b/domain/maintenance_info_test.go
@@ -97,35 +97,4 @@ var _ = Describe("MaintenanceInfo", func() {
  nil),
  )
  })
-
- Describe("NilOrEmpty", func() {
- It("return true when maintenance_info is nil", func() {
- var m *domain.MaintenanceInfo = nil
-
- Expect(m.NilOrEmpty()).To(BeTrue())
- })
-
- It("return true when maintenance_info is empty", func() {
- var m = &domain.MaintenanceInfo{
- Public: nil,
- Private: "",
- Version: "",
- }
-
- Expect(m.NilOrEmpty()).To(BeTrue())
- })
-
- It("return false when maintenance_info has properties", func() {
- m := &domain.MaintenanceInfo{
- Public: map[string]string{
- "test": "foo",
- },
- Private: "test-again",
- Version: "1.2.3",
- }
-
- Expect(m.NilOrEmpty()).To(BeFalse())
- })
- })
-
 })
diff --git a/domain/service_broker.go b/domain/service_broker.go
@@ -55,7 +55,7 @@ type ServiceBroker interface {
 
 type LastOperation struct {
  State LastOperationState `json:"state"`
- Description string `json:"description"`
+ Description string  `json:"description"`
 }
 
 type LastOperationState string
@@ -80,13 +80,13 @@ type SharedDevice struct {
 }
 
 type ProvisionDetails struct {
- ServiceID string `json:"service_id"`
- PlanID string `json:"plan_id"`
- OrganizationGUID string `json:"organization_guid"`
- SpaceGUID string `json:"space_guid"`
- RawContext json.RawMessage `json:"context,omitempty"`
- RawParameters json.RawMessage `json:"parameters,omitempty"`
- MaintenanceInfo MaintenanceInfo `json:"maintenance_info,omitempty"`
+ ServiceID string  `json:"service_id"`
+ PlanID string  `json:"plan_id"`
+ OrganizationGUID string  `json:"organization_guid"`
+ SpaceGUID string  `json:"space_guid"`
+ RawContext json.RawMessage  `json:"context,omitempty"`
+ RawParameters json.RawMessage  `json:"parameters,omitempty"`
+ MaintenanceInfo *MaintenanceInfo `json:"maintenance_info,omitempty"`
 }
 
 type ProvisionedServiceSpec struct {
@@ -114,12 +114,12 @@ type GetInstanceDetailsSpec struct {
 }
 
 type UpdateDetails struct {
- ServiceID string `json:"service_id"`
- PlanID string `json:"plan_id"`
- RawParameters json.RawMessage `json:"parameters,omitempty"`
- PreviousValues PreviousValues `json:"previous_values"`
- RawContext json.RawMessage `json:"context,omitempty"`
- MaintenanceInfo MaintenanceInfo `json:"maintenance_info,omitempty"`
+ ServiceID string  `json:"service_id"`
+ PlanID string  `json:"plan_id"`
+ RawParameters json.RawMessage  `json:"parameters,omitempty"`
+ PreviousValues PreviousValues  `json:"previous_values"`
+ RawContext json.RawMessage  `json:"context,omitempty"`
+ MaintenanceInfo *MaintenanceInfo `json:"maintenance_info,omitempty"`
 }
 
 type PreviousValues struct {

diff --git a/maintenance_info_test.go b/maintenance_info_test.go
@@ -8,7 +8,7 @@ import (
 )
 
 var _ = Describe("MaintenanceInfo", func() {
- Describe ("Equals", func() {
+ Describe("Equals", func() {
  DescribeTable(
  "returns false",
  func(m1, m2 brokerapi.MaintenanceInfo) {
@@ -17,54 +17,54 @@ var _ = Describe("MaintenanceInfo", func() {
  Entry(
  "one property is missing",
  brokerapi.MaintenanceInfo{
- Public: map[string]string{"foo": "bar"},
+ Public:  map[string]string{"foo": "bar"},
  Private: "test",
  Version: "1.2.3",
  },
  brokerapi.MaintenanceInfo{
- Public: map[string]string{"foo": "bar"},
+ Public:  map[string]string{"foo": "bar"},
  Private: "test",
  }),
  Entry(
  "one extra property is added",
  brokerapi.MaintenanceInfo{
- Public: map[string]string{"foo": "bar"},
+ Public:  map[string]string{"foo": "bar"},
  Private: "test",
  },
  brokerapi.MaintenanceInfo{
- Public: map[string]string{"foo": "bar"},
+ Public:  map[string]string{"foo": "bar"},
  Private: "test",
  Version: "1.2.3",
  }),
  Entry(
  "one property is different",
  brokerapi.MaintenanceInfo{
- Public: map[string]string{"foo": "bar"},
+ Public:  map[string]string{"foo": "bar"},
  Private: "test",
  Version: "1.2.3",
  },
  brokerapi.MaintenanceInfo{
- Public: map[string]string{"foo": "bar"},
+ Public:  map[string]string{"foo": "bar"},
  Private: "test-not-the-same",
  Version: "1.2.3",
  }),
  Entry(
  "all properties are missing in one of the objects",
  brokerapi.MaintenanceInfo{
- Public: map[string]string{"foo": "bar"},
+ Public:  map[string]string{"foo": "bar"},
  Private: "test",
  Version: "1.2.3",
  },
  brokerapi.MaintenanceInfo{}),
  Entry(
  "all properties are defined but different",
  brokerapi.MaintenanceInfo{
- Public: map[string]string{"foo": "bar"},
+ Public:  map[string]string{"foo": "bar"},
  Private: "test",
  Version: "1.2.3",
  },
  brokerapi.MaintenanceInfo{
- Public: map[string]string{"bar": "foo"},
+ Public:  map[string]string{"bar": "foo"},
  Private: "test-not-the-same",
  Version: "8.9.6-rc3",
  }),
@@ -78,12 +78,12 @@ var _ = Describe("MaintenanceInfo", func() {
  Entry(
  "all properties are the same",
  brokerapi.MaintenanceInfo{
- Public: map[string]string{"foo": "bar"},
+ Public:  map[string]string{"foo": "bar"},
  Private: "test",
  Version: "1.2.3",
  },
  brokerapi.MaintenanceInfo{
- Public: map[string]string{"foo": "bar"},
+ Public:  map[string]string{"foo": "bar"},
  Private: "test",
  Version: "1.2.3",
  }),
@@ -97,35 +97,4 @@ var _ = Describe("MaintenanceInfo", func() {
  nil),
  )
  })
-
- Describe("NilOrEmpty", func() {
- It("return true when maintenance_info is nil", func() {
- var m *brokerapi.MaintenanceInfo = nil
-
- Expect(m.NilOrEmpty()).To(BeTrue())
- })
-
- It("return true when maintenance_info is empty", func() {
- var m = &brokerapi.MaintenanceInfo{
- Public: nil,
- Private: "",
- Version: "",
- }
-
- Expect(m.NilOrEmpty()).To(BeTrue())
- })
-
- It("return false when maintenance_info has properties", func() {
- m := &brokerapi.MaintenanceInfo{
- Public: map[string]string{
- "test": "foo",
- },
- Private: "test-again",
- Version: "1.2.3",
- }
-
- Expect(m.NilOrEmpty()).To(BeFalse())
- })
- })
-
 })