Broker authentication username
| @@ -86,9 +87,18 @@ Broker service configuration values: | TLS_CERT_CHAIN | api.certCaBundle | string |File path to a pem encoded certificate chain
| | TLS_PRIVATE_KEY | api.tlsKey | string |File path to a pem encoded private key
| + +## Debugging +Values for debugging: + +| Environment Variable | Config File Value | Type | Description | +|----------------------------------------|---------------------------|------|-------------------------------------------------------------------------------------------------| +| CSB_DEBUG_LEAVE_WORKSPACE_DIR | debug.leave_workspace_dir | bool | Disables the cleanup of workspace directories, so you can inspect the files and run tf commands | + ## Feature flags Configuration Feature flags can be toggled through the following configuration values. See also [source code occurences of "toggles.Features.Toggle"](https://github.com/cloudfoundry/cloud-service-broker/search?q=toggles.Features.Toggle&type=code) + | Environment Variable | Config File Value | Type | Description | Default | |----------------------|------|-------------|------------------|----------| | GSB_COMPATIBILITY_ENABLE_BUILTIN_BROKERPAKS * | compatibility.enable_builtin_brokerpaks | Boolean |Load brokerpaks that are built-in to the software.
| "true" | diff --git a/internal/storage/service_instance_details.go b/internal/storage/service_instance_details.go index 78af047e9..f2c1c0e9d 100644 --- a/internal/storage/service_instance_details.go +++ b/internal/storage/service_instance_details.go @@ -10,15 +10,11 @@ import ( type ServiceInstanceDetails struct { GUID string Name string - Location string - URL string Outputs JSONObject ServiceGUID string PlanGUID string SpaceGUID string OrganizationGUID string - OperationType string - OperationGUID string } func (s *Storage) StoreServiceInstanceDetails(d ServiceInstanceDetails) error { @@ -33,15 +29,11 @@ func (s *Storage) StoreServiceInstanceDetails(d ServiceInstanceDetails) error { } m.Name = d.Name - m.Location = d.Location - m.URL = d.URL m.OtherDetails = encoded m.ServiceID = d.ServiceGUID m.PlanID = d.PlanGUID m.SpaceGUID = d.SpaceGUID m.OrganizationGUID = d.OrganizationGUID - m.OperationType = d.OperationType - m.OperationID = d.OperationGUID switch m.ID { case "": @@ -88,15 +80,11 @@ func (s *Storage) GetServiceInstanceDetails(guid string) (ServiceInstanceDetails return ServiceInstanceDetails{ GUID: guid, Name: receiver.Name, - Location: receiver.Location, - URL: receiver.URL, Outputs: decoded, ServiceGUID: receiver.ServiceID, PlanGUID: receiver.PlanID, SpaceGUID: receiver.SpaceGUID, OrganizationGUID: receiver.OrganizationGUID, - OperationType: receiver.OperationType, - OperationGUID: receiver.OperationID, }, nil } diff --git a/internal/storage/service_instance_details_test.go b/internal/storage/service_instance_details_test.go index 4bc717b8b..83a15bd07 100644 --- a/internal/storage/service_instance_details_test.go +++ b/internal/storage/service_instance_details_test.go @@ -15,15 +15,11 @@ var _ = Describe("ServiceInstanceDetails", func() { err := store.StoreServiceInstanceDetails(storage.ServiceInstanceDetails{ GUID: "fake-guid", Name: "fake-name", - Location: "fake-location", - URL: "fake-url", Outputs: map[string]any{"foo": "bar"}, ServiceGUID: "fake-service-guid", PlanGUID: "fake-plan-guid", SpaceGUID: "fake-space-guid", OrganizationGUID: "fake-org-guid", - OperationType: "fake-operation-type", - OperationGUID: "fake-operation-guid", }) Expect(err).NotTo(HaveOccurred()) @@ -31,15 +27,11 @@ var _ = Describe("ServiceInstanceDetails", func() { Expect(db.Find(&receiver).Error).NotTo(HaveOccurred()) Expect(receiver.ID).To(Equal("fake-guid")) Expect(receiver.Name).To(Equal("fake-name")) - Expect(receiver.Location).To(Equal("fake-location")) - Expect(receiver.URL).To(Equal("fake-url")) Expect(receiver.OtherDetails).To(Equal([]byte(`{"encrypted":{"foo":"bar"}}`))) Expect(receiver.ServiceID).To(Equal("fake-service-guid")) Expect(receiver.PlanID).To(Equal("fake-plan-guid")) Expect(receiver.SpaceGUID).To(Equal("fake-space-guid")) Expect(receiver.OrganizationGUID).To(Equal("fake-org-guid")) - Expect(receiver.OperationType).To(Equal("fake-operation-type")) - Expect(receiver.OperationID).To(Equal("fake-operation-guid")) }) When("encoding fails", func() { @@ -60,15 +52,11 @@ var _ = Describe("ServiceInstanceDetails", func() { err := store.StoreServiceInstanceDetails(storage.ServiceInstanceDetails{ GUID: "fake-id-1", Name: "fake-name", - Location: "fake-location", - URL: "fake-url", Outputs: map[string]any{"foo": "bar"}, ServiceGUID: "fake-service-guid", PlanGUID: "fake-plan-guid", SpaceGUID: "fake-space-guid", OrganizationGUID: "fake-org-guid", - OperationType: "fake-operation-type", - OperationGUID: "fake-operation-guid", }) Expect(err).NotTo(HaveOccurred()) @@ -76,15 +64,11 @@ var _ = Describe("ServiceInstanceDetails", func() { Expect(db.Where(`id = "fake-id-1"`).Find(&receiver).Error).NotTo(HaveOccurred()) Expect(receiver.ID).To(Equal("fake-id-1")) Expect(receiver.Name).To(Equal("fake-name")) - Expect(receiver.Location).To(Equal("fake-location")) - Expect(receiver.URL).To(Equal("fake-url")) Expect(receiver.OtherDetails).To(Equal([]byte(`{"encrypted":{"foo":"bar"}}`))) Expect(receiver.ServiceID).To(Equal("fake-service-guid")) Expect(receiver.PlanID).To(Equal("fake-plan-guid")) Expect(receiver.SpaceGUID).To(Equal("fake-space-guid")) Expect(receiver.OrganizationGUID).To(Equal("fake-org-guid")) - Expect(receiver.OperationType).To(Equal("fake-operation-type")) - Expect(receiver.OperationID).To(Equal("fake-operation-guid")) }) }) }) @@ -99,15 +83,11 @@ var _ = Describe("ServiceInstanceDetails", func() { Expect(err).NotTo(HaveOccurred()) Expect(r.GUID).To(Equal("fake-id-2")) - Expect(r.Location).To(Equal("fake-location-2")) - Expect(r.URL).To(Equal("fake-url-2")) Expect(r.Outputs).To(Equal(storage.JSONObject{"decrypted": map[string]any{"foo": "bar-2"}})) Expect(r.ServiceGUID).To(Equal("fake-service-id-2")) Expect(r.PlanGUID).To(Equal("fake-plan-id-2")) Expect(r.SpaceGUID).To(Equal("fake-space-guid-2")) Expect(r.OrganizationGUID).To(Equal("fake-org-guid-2")) - Expect(r.OperationType).To(Equal("fake-operation-type-2")) - Expect(r.OperationGUID).To(Equal("fake-operation-id-2")) }) When("decoding fails", func() { @@ -204,40 +184,28 @@ func addFakeServiceInstanceDetails() { Expect(db.Create(&models.ServiceInstanceDetails{ ID: "fake-id-1", Name: "fake-name-1", - Location: "fake-location-1", - URL: "fake-url-1", OtherDetails: []byte(`{"foo":"bar-1"}`), ServiceID: "fake-service-id-1", PlanID: "fake-plan-id-1", SpaceGUID: "fake-space-guid-1", OrganizationGUID: "fake-org-guid-1", - OperationType: "fake-operation-type-1", - OperationID: "fake-operation-id-1", }).Error).NotTo(HaveOccurred()) Expect(db.Create(&models.ServiceInstanceDetails{ ID: "fake-id-2", Name: "fake-name-2", - Location: "fake-location-2", - URL: "fake-url-2", OtherDetails: []byte(`{"foo":"bar-2"}`), ServiceID: "fake-service-id-2", PlanID: "fake-plan-id-2", SpaceGUID: "fake-space-guid-2", OrganizationGUID: "fake-org-guid-2", - OperationType: "fake-operation-type-2", - OperationID: "fake-operation-id-2", }).Error).NotTo(HaveOccurred()) Expect(db.Create(&models.ServiceInstanceDetails{ ID: "fake-id-3", Name: "fake-name-3", - Location: "fake-location-3", - URL: "fake-url-3", OtherDetails: []byte(`{"foo":"bar-3"}`), ServiceID: "fake-service-id-3", PlanID: "fake-plan-id-3", SpaceGUID: "fake-space-guid-3", OrganizationGUID: "fake-org-guid-3", - OperationType: "fake-operation-type-3", - OperationID: "fake-operation-id-3", }).Error).NotTo(HaveOccurred()) } diff --git a/pkg/broker/brokerfakes/fake_service_provider.go b/pkg/broker/brokerfakes/fake_service_provider.go index a965087eb..53f9f9f56 100644 --- a/pkg/broker/brokerfakes/fake_service_provider.go +++ b/pkg/broker/brokerfakes/fake_service_provider.go @@ -5,7 +5,6 @@ import ( "context" "sync" - "github.com/cloudfoundry/cloud-service-broker/v2/dbservice/models" "github.com/cloudfoundry/cloud-service-broker/v2/internal/storage" "github.com/cloudfoundry/cloud-service-broker/v2/pkg/broker" "github.com/cloudfoundry/cloud-service-broker/v2/pkg/varcontext" @@ -49,6 +48,18 @@ type FakeServiceProvider struct { checkUpgradeAvailableReturnsOnCall map[int]struct { result1 error } + ClearOperationTypeStub func(context.Context, string) error + clearOperationTypeMutex sync.RWMutex + clearOperationTypeArgsForCall []struct { + arg1 context.Context + arg2 string + } + clearOperationTypeReturns struct { + result1 error + } + clearOperationTypeReturnsOnCall map[int]struct { + result1 error + } DeleteBindingDataStub func(context.Context, string, string) error deleteBindingDataMutex sync.RWMutex deleteBindingDataArgsForCall []struct { @@ -119,7 +130,7 @@ type FakeServiceProvider struct { result1 storage.JSONObject result2 error } - PollInstanceStub func(context.Context, string) (bool, string, error) + PollInstanceStub func(context.Context, string) (bool, string, string, error) pollInstanceMutex sync.RWMutex pollInstanceArgsForCall []struct { arg1 context.Context @@ -128,26 +139,26 @@ type FakeServiceProvider struct { pollInstanceReturns struct { result1 bool result2 string - result3 error + result3 string + result4 error } pollInstanceReturnsOnCall map[int]struct { result1 bool result2 string - result3 error + result3 string + result4 error } - ProvisionStub func(context.Context, *varcontext.VarContext) (storage.ServiceInstanceDetails, error) + ProvisionStub func(context.Context, *varcontext.VarContext) error provisionMutex sync.RWMutex provisionArgsForCall []struct { arg1 context.Context arg2 *varcontext.VarContext } provisionReturns struct { - result1 storage.ServiceInstanceDetails - result2 error + result1 error } provisionReturnsOnCall map[int]struct { - result1 storage.ServiceInstanceDetails - result2 error + result1 error } UnbindStub func(context.Context, string, string, *varcontext.VarContext) error unbindMutex sync.RWMutex @@ -163,19 +174,17 @@ type FakeServiceProvider struct { unbindReturnsOnCall map[int]struct { result1 error } - UpdateStub func(context.Context, *varcontext.VarContext) (models.ServiceInstanceDetails, error) + UpdateStub func(context.Context, *varcontext.VarContext) error updateMutex sync.RWMutex updateArgsForCall []struct { arg1 context.Context arg2 *varcontext.VarContext } updateReturns struct { - result1 models.ServiceInstanceDetails - result2 error + result1 error } updateReturnsOnCall map[int]struct { - result1 models.ServiceInstanceDetails - result2 error + result1 error } UpgradeBindingsStub func(context.Context, *varcontext.VarContext, []*varcontext.VarContext) error upgradeBindingsMutex sync.RWMutex @@ -396,6 +405,68 @@ func (fake *FakeServiceProvider) CheckUpgradeAvailableReturnsOnCall(i int, resul }{result1} } +func (fake *FakeServiceProvider) ClearOperationType(arg1 context.Context, arg2 string) error { + fake.clearOperationTypeMutex.Lock() + ret, specificReturn := fake.clearOperationTypeReturnsOnCall[len(fake.clearOperationTypeArgsForCall)] + fake.clearOperationTypeArgsForCall = append(fake.clearOperationTypeArgsForCall, struct { + arg1 context.Context + arg2 string + }{arg1, arg2}) + stub := fake.ClearOperationTypeStub + fakeReturns := fake.clearOperationTypeReturns + fake.recordInvocation("ClearOperationType", []interface{}{arg1, arg2}) + fake.clearOperationTypeMutex.Unlock() + if stub != nil { + return stub(arg1, arg2) + } + if specificReturn { + return ret.result1 + } + return fakeReturns.result1 +} + +func (fake *FakeServiceProvider) ClearOperationTypeCallCount() int { + fake.clearOperationTypeMutex.RLock() + defer fake.clearOperationTypeMutex.RUnlock() + return len(fake.clearOperationTypeArgsForCall) +} + +func (fake *FakeServiceProvider) ClearOperationTypeCalls(stub func(context.Context, string) error) { + fake.clearOperationTypeMutex.Lock() + defer fake.clearOperationTypeMutex.Unlock() + fake.ClearOperationTypeStub = stub +} + +func (fake *FakeServiceProvider) ClearOperationTypeArgsForCall(i int) (context.Context, string) { + fake.clearOperationTypeMutex.RLock() + defer fake.clearOperationTypeMutex.RUnlock() + argsForCall := fake.clearOperationTypeArgsForCall[i] + return argsForCall.arg1, argsForCall.arg2 +} + +func (fake *FakeServiceProvider) ClearOperationTypeReturns(result1 error) { + fake.clearOperationTypeMutex.Lock() + defer fake.clearOperationTypeMutex.Unlock() + fake.ClearOperationTypeStub = nil + fake.clearOperationTypeReturns = struct { + result1 error + }{result1} +} + +func (fake *FakeServiceProvider) ClearOperationTypeReturnsOnCall(i int, result1 error) { + fake.clearOperationTypeMutex.Lock() + defer fake.clearOperationTypeMutex.Unlock() + fake.ClearOperationTypeStub = nil + if fake.clearOperationTypeReturnsOnCall == nil { + fake.clearOperationTypeReturnsOnCall = make(map[int]struct { + result1 error + }) + } + fake.clearOperationTypeReturnsOnCall[i] = struct { + result1 error + }{result1} +} + func (fake *FakeServiceProvider) DeleteBindingData(arg1 context.Context, arg2 string, arg3 string) error { fake.deleteBindingDataMutex.Lock() ret, specificReturn := fake.deleteBindingDataReturnsOnCall[len(fake.deleteBindingDataArgsForCall)] @@ -724,7 +795,7 @@ func (fake *FakeServiceProvider) GetTerraformOutputsReturnsOnCall(i int, result1 }{result1, result2} } -func (fake *FakeServiceProvider) PollInstance(arg1 context.Context, arg2 string) (bool, string, error) { +func (fake *FakeServiceProvider) PollInstance(arg1 context.Context, arg2 string) (bool, string, string, error) { fake.pollInstanceMutex.Lock() ret, specificReturn := fake.pollInstanceReturnsOnCall[len(fake.pollInstanceArgsForCall)] fake.pollInstanceArgsForCall = append(fake.pollInstanceArgsForCall, struct { @@ -739,9 +810,9 @@ func (fake *FakeServiceProvider) PollInstance(arg1 context.Context, arg2 string) return stub(arg1, arg2) } if specificReturn { - return ret.result1, ret.result2, ret.result3 + return ret.result1, ret.result2, ret.result3, ret.result4 } - return fakeReturns.result1, fakeReturns.result2, fakeReturns.result3 + return fakeReturns.result1, fakeReturns.result2, fakeReturns.result3, fakeReturns.result4 } func (fake *FakeServiceProvider) PollInstanceCallCount() int { @@ -750,7 +821,7 @@ func (fake *FakeServiceProvider) PollInstanceCallCount() int { return len(fake.pollInstanceArgsForCall) } -func (fake *FakeServiceProvider) PollInstanceCalls(stub func(context.Context, string) (bool, string, error)) { +func (fake *FakeServiceProvider) PollInstanceCalls(stub func(context.Context, string) (bool, string, string, error)) { fake.pollInstanceMutex.Lock() defer fake.pollInstanceMutex.Unlock() fake.PollInstanceStub = stub @@ -763,18 +834,19 @@ func (fake *FakeServiceProvider) PollInstanceArgsForCall(i int) (context.Context return argsForCall.arg1, argsForCall.arg2 } -func (fake *FakeServiceProvider) PollInstanceReturns(result1 bool, result2 string, result3 error) { +func (fake *FakeServiceProvider) PollInstanceReturns(result1 bool, result2 string, result3 string, result4 error) { fake.pollInstanceMutex.Lock() defer fake.pollInstanceMutex.Unlock() fake.PollInstanceStub = nil fake.pollInstanceReturns = struct { result1 bool result2 string - result3 error - }{result1, result2, result3} + result3 string + result4 error + }{result1, result2, result3, result4} } -func (fake *FakeServiceProvider) PollInstanceReturnsOnCall(i int, result1 bool, result2 string, result3 error) { +func (fake *FakeServiceProvider) PollInstanceReturnsOnCall(i int, result1 bool, result2 string, result3 string, result4 error) { fake.pollInstanceMutex.Lock() defer fake.pollInstanceMutex.Unlock() fake.PollInstanceStub = nil @@ -782,17 +854,19 @@ func (fake *FakeServiceProvider) PollInstanceReturnsOnCall(i int, result1 bool, fake.pollInstanceReturnsOnCall = make(map[int]struct { result1 bool result2 string - result3 error + result3 string + result4 error }) } fake.pollInstanceReturnsOnCall[i] = struct { result1 bool result2 string - result3 error - }{result1, result2, result3} + result3 string + result4 error + }{result1, result2, result3, result4} } -func (fake *FakeServiceProvider) Provision(arg1 context.Context, arg2 *varcontext.VarContext) (storage.ServiceInstanceDetails, error) { +func (fake *FakeServiceProvider) Provision(arg1 context.Context, arg2 *varcontext.VarContext) error { fake.provisionMutex.Lock() ret, specificReturn := fake.provisionReturnsOnCall[len(fake.provisionArgsForCall)] fake.provisionArgsForCall = append(fake.provisionArgsForCall, struct { @@ -807,9 +881,9 @@ func (fake *FakeServiceProvider) Provision(arg1 context.Context, arg2 *varcontex return stub(arg1, arg2) } if specificReturn { - return ret.result1, ret.result2 + return ret.result1 } - return fakeReturns.result1, fakeReturns.result2 + return fakeReturns.result1 } func (fake *FakeServiceProvider) ProvisionCallCount() int { @@ -818,7 +892,7 @@ func (fake *FakeServiceProvider) ProvisionCallCount() int { return len(fake.provisionArgsForCall) } -func (fake *FakeServiceProvider) ProvisionCalls(stub func(context.Context, *varcontext.VarContext) (storage.ServiceInstanceDetails, error)) { +func (fake *FakeServiceProvider) ProvisionCalls(stub func(context.Context, *varcontext.VarContext) error) { fake.provisionMutex.Lock() defer fake.provisionMutex.Unlock() fake.ProvisionStub = stub @@ -831,30 +905,27 @@ func (fake *FakeServiceProvider) ProvisionArgsForCall(i int) (context.Context, * return argsForCall.arg1, argsForCall.arg2 } -func (fake *FakeServiceProvider) ProvisionReturns(result1 storage.ServiceInstanceDetails, result2 error) { +func (fake *FakeServiceProvider) ProvisionReturns(result1 error) { fake.provisionMutex.Lock() defer fake.provisionMutex.Unlock() fake.ProvisionStub = nil fake.provisionReturns = struct { - result1 storage.ServiceInstanceDetails - result2 error - }{result1, result2} + result1 error + }{result1} } -func (fake *FakeServiceProvider) ProvisionReturnsOnCall(i int, result1 storage.ServiceInstanceDetails, result2 error) { +func (fake *FakeServiceProvider) ProvisionReturnsOnCall(i int, result1 error) { fake.provisionMutex.Lock() defer fake.provisionMutex.Unlock() fake.ProvisionStub = nil if fake.provisionReturnsOnCall == nil { fake.provisionReturnsOnCall = make(map[int]struct { - result1 storage.ServiceInstanceDetails - result2 error + result1 error }) } fake.provisionReturnsOnCall[i] = struct { - result1 storage.ServiceInstanceDetails - result2 error - }{result1, result2} + result1 error + }{result1} } func (fake *FakeServiceProvider) Unbind(arg1 context.Context, arg2 string, arg3 string, arg4 *varcontext.VarContext) error { @@ -921,7 +992,7 @@ func (fake *FakeServiceProvider) UnbindReturnsOnCall(i int, result1 error) { }{result1} } -func (fake *FakeServiceProvider) Update(arg1 context.Context, arg2 *varcontext.VarContext) (models.ServiceInstanceDetails, error) { +func (fake *FakeServiceProvider) Update(arg1 context.Context, arg2 *varcontext.VarContext) error { fake.updateMutex.Lock() ret, specificReturn := fake.updateReturnsOnCall[len(fake.updateArgsForCall)] fake.updateArgsForCall = append(fake.updateArgsForCall, struct { @@ -936,9 +1007,9 @@ func (fake *FakeServiceProvider) Update(arg1 context.Context, arg2 *varcontext.V return stub(arg1, arg2) } if specificReturn { - return ret.result1, ret.result2 + return ret.result1 } - return fakeReturns.result1, fakeReturns.result2 + return fakeReturns.result1 } func (fake *FakeServiceProvider) UpdateCallCount() int { @@ -947,7 +1018,7 @@ func (fake *FakeServiceProvider) UpdateCallCount() int { return len(fake.updateArgsForCall) } -func (fake *FakeServiceProvider) UpdateCalls(stub func(context.Context, *varcontext.VarContext) (models.ServiceInstanceDetails, error)) { +func (fake *FakeServiceProvider) UpdateCalls(stub func(context.Context, *varcontext.VarContext) error) { fake.updateMutex.Lock() defer fake.updateMutex.Unlock() fake.UpdateStub = stub @@ -960,30 +1031,27 @@ func (fake *FakeServiceProvider) UpdateArgsForCall(i int) (context.Context, *var return argsForCall.arg1, argsForCall.arg2 } -func (fake *FakeServiceProvider) UpdateReturns(result1 models.ServiceInstanceDetails, result2 error) { +func (fake *FakeServiceProvider) UpdateReturns(result1 error) { fake.updateMutex.Lock() defer fake.updateMutex.Unlock() fake.UpdateStub = nil fake.updateReturns = struct { - result1 models.ServiceInstanceDetails - result2 error - }{result1, result2} + result1 error + }{result1} } -func (fake *FakeServiceProvider) UpdateReturnsOnCall(i int, result1 models.ServiceInstanceDetails, result2 error) { +func (fake *FakeServiceProvider) UpdateReturnsOnCall(i int, result1 error) { fake.updateMutex.Lock() defer fake.updateMutex.Unlock() fake.UpdateStub = nil if fake.updateReturnsOnCall == nil { fake.updateReturnsOnCall = make(map[int]struct { - result1 models.ServiceInstanceDetails - result2 error + result1 error }) } fake.updateReturnsOnCall[i] = struct { - result1 models.ServiceInstanceDetails - result2 error - }{result1, result2} + result1 error + }{result1} } func (fake *FakeServiceProvider) UpgradeBindings(arg1 context.Context, arg2 *varcontext.VarContext, arg3 []*varcontext.VarContext) error { @@ -1128,6 +1196,8 @@ func (fake *FakeServiceProvider) Invocations() map[string][][]interface{} { defer fake.checkOperationConstraintsMutex.RUnlock() fake.checkUpgradeAvailableMutex.RLock() defer fake.checkUpgradeAvailableMutex.RUnlock() + fake.clearOperationTypeMutex.RLock() + defer fake.clearOperationTypeMutex.RUnlock() fake.deleteBindingDataMutex.RLock() defer fake.deleteBindingDataMutex.RUnlock() fake.deleteInstanceDataMutex.RLock() diff --git a/pkg/broker/service_provider.go b/pkg/broker/service_provider.go index f28cc0758..60532ceb4 100644 --- a/pkg/broker/service_provider.go +++ b/pkg/broker/service_provider.go @@ -18,7 +18,6 @@ import ( "context" "sync" - "github.com/cloudfoundry/cloud-service-broker/v2/dbservice/models" "github.com/cloudfoundry/cloud-service-broker/v2/internal/storage" "github.com/cloudfoundry/cloud-service-broker/v2/pkg/varcontext" ) @@ -33,10 +32,10 @@ import ( type ServiceProvider interface { // Provision creates the necessary resources that an instance of this service // needs to operate. - Provision(ctx context.Context, provisionContext *varcontext.VarContext) (storage.ServiceInstanceDetails, error) + Provision(ctx context.Context, provisionContext *varcontext.VarContext) error // Update makes necessary updates to resources so they match new desired configuration - Update(ctx context.Context, updateContext *varcontext.VarContext) (models.ServiceInstanceDetails, error) + Update(ctx context.Context, updateContext *varcontext.VarContext) error UpgradeInstance(ctx context.Context, instanceContext *varcontext.VarContext) (*sync.WaitGroup, error) UpgradeBindings(ctx context.Context, instanceContext *varcontext.VarContext, bindingContexts []*varcontext.VarContext) error @@ -57,7 +56,7 @@ type ServiceProvider interface { // If no error and no operationId are returned, then the deprovision is expected to have been completed successfully. Deprovision(ctx context.Context, instanceGUID string, vc *varcontext.VarContext) (*string, error) - PollInstance(ctx context.Context, instanceGUID string) (bool, string, error) + PollInstance(ctx context.Context, instanceGUID string) (bool, string, string, error) GetTerraformOutputs(ctx context.Context, instanceGUID string) (storage.JSONObject, error) @@ -65,6 +64,8 @@ type ServiceProvider interface { DeleteBindingData(ctx context.Context, instanceGUID, bindingID string) error + ClearOperationType(ctx context.Context, instanceGUID string) error + CheckUpgradeAvailable(deploymentID string) error CheckOperationConstraints(deploymentID string, operationType string) error diff --git a/pkg/providers/tf/bind.go b/pkg/providers/tf/bind.go index 286c1053d..076473c20 100644 --- a/pkg/providers/tf/bind.go +++ b/pkg/providers/tf/bind.go @@ -18,11 +18,13 @@ func (provider *TerraformProvider) Bind(ctx context.Context, bindContext *varcon "context": bindContext.ToMap(), }) - tfID, err := provider.create(ctx, bindContext, provider.serviceDefinition.BindSettings, models.BindOperationType) + err := provider.create(ctx, bindContext, provider.serviceDefinition.BindSettings, models.BindOperationType) if err != nil { return nil, fmt.Errorf("error from provider bind: %w", err) } + tfID := bindContext.GetString("tf_id") + if err := provider.Wait(ctx, tfID); err != nil { return nil, fmt.Errorf("error waiting for result: %w", err) } diff --git a/pkg/providers/tf/bind_test.go b/pkg/providers/tf/bind_test.go index 2217542e2..536ceccd2 100644 --- a/pkg/providers/tf/bind_test.go +++ b/pkg/providers/tf/bind_test.go @@ -5,6 +5,7 @@ import ( "errors" "fmt" + "github.com/cloudfoundry/cloud-service-broker/v2/dbservice/models" "github.com/cloudfoundry/cloud-service-broker/v2/pkg/providers/tf/workspace/workspacefakes" "github.com/cloudfoundry/cloud-service-broker/v2/pkg/providers/tf/workspace" @@ -69,7 +70,7 @@ var _ = Describe("Bind", func() { It("returns the binding output", func() { fakeDeploymentManager.CreateAndSaveDeploymentReturns(deployment, nil) fakeDeploymentManager.GetTerraformDeploymentReturns(deployment, nil) - fakeDeploymentManager.OperationStatusReturns(true, "operation succeeded", nil) + fakeDeploymentManager.OperationStatusReturns(true, "operation succeeded", models.BindOperationType, nil) fakeInvokerBuilder.VersionedTerraformInvokerReturns(fakeDefaultInvoker) fakeDefaultInvoker.ApplyReturns(nil) fakeTerraformWorkspace.OutputsReturns(map[string]any{"username": "some-user"}, nil) @@ -153,7 +154,7 @@ var _ = Describe("Bind", func() { It("returns the error in last operation, if tofu apply fails", func() { fakeDeploymentManager.CreateAndSaveDeploymentReturns(deployment, nil) - fakeDeploymentManager.OperationStatusReturns(true, "operation failed", fmt.Errorf("tofu apply failed")) + fakeDeploymentManager.OperationStatusReturns(true, "operation failed", models.BindOperationType, fmt.Errorf("tofu apply failed")) fakeDeploymentManager.MarkOperationFinishedReturns(errors.New("couldnt do this now")) fakeInvokerBuilder.VersionedTerraformInvokerReturns(fakeDefaultInvoker) fakeDefaultInvoker.ApplyReturns(errors.New("some TF issue happened")) diff --git a/pkg/providers/tf/clear_operation_type.go b/pkg/providers/tf/clear_operation_type.go new file mode 100644 index 000000000..e5edfc923 --- /dev/null +++ b/pkg/providers/tf/clear_operation_type.go @@ -0,0 +1,18 @@ +package tf + +import ( + "context" + + "code.cloudfoundry.org/lager/v3" + "github.com/cloudfoundry/cloud-service-broker/v2/utils/correlation" +) + +func (provider *TerraformProvider) ClearOperationType(ctx context.Context, instanceGUID string) error { + provider.logger.Debug("ClearOperationType", correlation.ID(ctx), lager.Data{ + "instance": instanceGUID, + }) + + tfID := generateTfID(instanceGUID, "") + + return provider.ResetOperationType(tfID) +} diff --git a/pkg/providers/tf/deployment_manager.go b/pkg/providers/tf/deployment_manager.go index 3a3f6c19b..55ae07e47 100644 --- a/pkg/providers/tf/deployment_manager.go +++ b/pkg/providers/tf/deployment_manager.go @@ -6,6 +6,7 @@ import ( "code.cloudfoundry.org/lager/v3" + "github.com/cloudfoundry/cloud-service-broker/v2/dbservice/models" "github.com/cloudfoundry/cloud-service-broker/v2/internal/storage" "github.com/cloudfoundry/cloud-service-broker/v2/pkg/broker" "github.com/cloudfoundry/cloud-service-broker/v2/pkg/featureflags" @@ -86,19 +87,19 @@ func (d *DeploymentManager) MarkOperationFinished(deployment *storage.TerraformD return d.store.RemoveLockFile(deployment.ID) } -func (d *DeploymentManager) OperationStatus(deploymentID string) (bool, string, error) { +func (d *DeploymentManager) OperationStatus(deploymentID string) (bool, string, string, error) { deployment, err := d.store.GetTerraformDeployment(deploymentID) if err != nil { - return true, "", err + return true, "", "", err } switch deployment.LastOperationState { case Succeeded: - return true, deployment.LastOperationMessage, nil + return true, deployment.LastOperationMessage, deployment.LastOperationType, nil case Failed: - return true, deployment.LastOperationMessage, errors.New(deployment.LastOperationMessage) + return true, deployment.LastOperationMessage, deployment.LastOperationType, errors.New(deployment.LastOperationMessage) default: - return false, deployment.LastOperationMessage, nil + return false, deployment.LastOperationMessage, deployment.LastOperationType, nil } } @@ -157,3 +158,13 @@ func (d *DeploymentManager) GetBindingDeployments(deploymentID string) ([]storag } return bindingDeployments, nil } + +func (d *DeploymentManager) ResetOperationType(deploymentID string) error { + deployment, err := d.store.GetTerraformDeployment(deploymentID) + if err != nil { + return err + } + + deployment.LastOperationType = models.ClearOperationType + return d.store.StoreTerraformDeployment(deployment) +} diff --git a/pkg/providers/tf/deployment_manager_test.go b/pkg/providers/tf/deployment_manager_test.go index 30c8d5eb5..7f929c41e 100644 --- a/pkg/providers/tf/deployment_manager_test.go +++ b/pkg/providers/tf/deployment_manager_test.go @@ -5,6 +5,7 @@ import ( "code.cloudfoundry.org/lager/v3/lagertest" + "github.com/cloudfoundry/cloud-service-broker/v2/dbservice/models" "github.com/cloudfoundry/cloud-service-broker/v2/internal/storage" "github.com/cloudfoundry/cloud-service-broker/v2/pkg/broker" "github.com/cloudfoundry/cloud-service-broker/v2/pkg/broker/brokerfakes" @@ -257,10 +258,11 @@ var _ = Describe("DeploymentManager", func() { } fakeStore.GetTerraformDeploymentReturns(existingDeployment, nil) - completed, lastOpMessage, err := deploymentManager.OperationStatus(existingDeploymentID) + completed, lastOpMessage, operationType, err := deploymentManager.OperationStatus(existingDeploymentID) Expect(err).NotTo(HaveOccurred()) Expect(completed).To(BeTrue()) + Expect(operationType).To(Equal("update")) Expect(lastOpMessage).To(Equal("great update")) }) }) @@ -275,10 +277,11 @@ var _ = Describe("DeploymentManager", func() { } fakeStore.GetTerraformDeploymentReturns(existingDeployment, nil) - completed, lastOpMessage, err := deploymentManager.OperationStatus(existingDeploymentID) + completed, lastOpMessage, operationType, err := deploymentManager.OperationStatus(existingDeploymentID) Expect(err).To(MatchError("not so great update")) Expect(completed).To(BeTrue()) + Expect(operationType).To(Equal("update")) Expect(lastOpMessage).To(Equal("not so great update")) }) }) @@ -292,10 +295,11 @@ var _ = Describe("DeploymentManager", func() { } fakeStore.GetTerraformDeploymentReturns(existingDeployment, nil) - completed, lastOpMessage, err := deploymentManager.OperationStatus(existingDeploymentID) + completed, lastOpMessage, operationType, err := deploymentManager.OperationStatus(existingDeploymentID) Expect(err).NotTo(HaveOccurred()) Expect(completed).To(BeFalse()) + Expect(operationType).To(Equal("update")) Expect(lastOpMessage).To(Equal("still doing stuff")) }) }) @@ -303,7 +307,7 @@ var _ = Describe("DeploymentManager", func() { It("fails, when it errors getting the deployment", func() { fakeStore.GetTerraformDeploymentReturns(storage.TerraformDeployment{}, errors.New("cant get it now")) - _, _, err := deploymentManager.OperationStatus(existingDeploymentID) + _, _, _, err := deploymentManager.OperationStatus(existingDeploymentID) Expect(err).To(MatchError("cant get it now")) }) @@ -604,6 +608,36 @@ var _ = Describe("DeploymentManager", func() { }) }) + Describe("ResetOperationType", func() { + var ( + fakeStore brokerfakes.FakeServiceProviderStorage + deploymentManager *tf.DeploymentManager + existingDeployment storage.TerraformDeployment + ) + + const existingDeploymentID = "tf:instance:binding" + + BeforeEach(func() { + fakeStore = brokerfakes.FakeServiceProviderStorage{} + deploymentManager = tf.NewDeploymentManager(&fakeStore, lagertest.NewTestLogger("test")) + existingDeployment = storage.TerraformDeployment{ + ID: existingDeploymentID, + LastOperationType: "validation", + } + }) + + It("it clears the operation type", func() { + fakeStore.GetTerraformDeploymentReturns(existingDeployment, nil) + + err := deploymentManager.ResetOperationType(existingDeploymentID) + + Expect(err).NotTo(HaveOccurred()) + Expect(fakeStore.StoreTerraformDeploymentCallCount()).To(Equal(1)) + actualDeployment := fakeStore.StoreTerraformDeploymentArgsForCall(0) + Expect(actualDeployment.LastOperationType).To(Equal(models.ClearOperationType)) + }) + }) + Describe("GetBindingDeployments", func() { var ( fakeStore brokerfakes.FakeServiceProviderStorage diff --git a/pkg/providers/tf/poll_instance.go b/pkg/providers/tf/poll_instance.go index fb01548d0..8d0a39d5e 100644 --- a/pkg/providers/tf/poll_instance.go +++ b/pkg/providers/tf/poll_instance.go @@ -5,6 +5,6 @@ import ( ) // PollInstance returns the instance status of the backing job. -func (provider *TerraformProvider) PollInstance(_ context.Context, instanceGUID string) (bool, string, error) { +func (provider *TerraformProvider) PollInstance(_ context.Context, instanceGUID string) (bool, string, string, error) { return provider.OperationStatus(generateTfID(instanceGUID, "")) } diff --git a/pkg/providers/tf/poll_instance_test.go b/pkg/providers/tf/poll_instance_test.go index 7e593fd2a..104fdf9dc 100644 --- a/pkg/providers/tf/poll_instance_test.go +++ b/pkg/providers/tf/poll_instance_test.go @@ -17,13 +17,14 @@ var _ = Describe("PollInstance", func() { fakeInvokerBuilder := &tffakes.FakeTerraformInvokerBuilder{} fakeLogger := utils.NewLogger("test") - fakeDeploymentManager.OperationStatusReturns(true, "LO message", nil) + fakeDeploymentManager.OperationStatusReturns(true, "LO message", "update", nil) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, tf.TfServiceDefinitionV1{}, fakeDeploymentManager) - finished, message, err := provider.PollInstance(context.TODO(), "instance-guid") + finished, message, operationType, err := provider.PollInstance(context.TODO(), "instance-guid") Expect(err).NotTo(HaveOccurred()) Expect(finished).To(BeTrue()) + Expect(operationType).To(Equal("update")) Expect(message).To(Equal("LO message")) Expect(fakeDeploymentManager.OperationStatusCallCount()).To(Equal(1)) diff --git a/pkg/providers/tf/provider.go b/pkg/providers/tf/provider.go index 6e2eaeae7..9a828a083 100644 --- a/pkg/providers/tf/provider.go +++ b/pkg/providers/tf/provider.go @@ -68,25 +68,25 @@ func (provider *TerraformProvider) VersionedInvoker(version *version.Version) in return provider.VersionedTerraformInvoker(version) } -func (provider *TerraformProvider) create(ctx context.Context, vars *varcontext.VarContext, action TfServiceDefinitionV1Action, operationType string) (string, error) { +func (provider *TerraformProvider) create(ctx context.Context, vars *varcontext.VarContext, action TfServiceDefinitionV1Action, operationType string) error { tfID := vars.GetString("tf_id") if err := vars.Error(); err != nil { - return "", err + return err } newWorkspace, err := workspace.NewWorkspace(vars.ToMap(), action.Template, action.Templates, []workspace.ParameterMapping{}, []string{}, []workspace.ParameterMapping{}) if err != nil { - return tfID, fmt.Errorf("error creating workspace: %w", err) + return fmt.Errorf("error creating workspace: %w", err) } deployment, err := provider.CreateAndSaveDeployment(tfID, newWorkspace) if err != nil { provider.logger.Error("deployment create failed", err) - return tfID, fmt.Errorf("deployment create failed: %w", err) + return fmt.Errorf("deployment create failed: %w", err) } if err := provider.MarkOperationStarted(&deployment, operationType); err != nil { - return tfID, fmt.Errorf("error marking job started: %w", err) + return fmt.Errorf("error marking job started: %w", err) } go func() { @@ -102,7 +102,7 @@ func (provider *TerraformProvider) create(ctx context.Context, vars *varcontext. } }() - return tfID, nil + return nil } func (provider *TerraformProvider) destroy(ctx context.Context, deploymentID string, templateVars map[string]any, operationType string) error { @@ -129,6 +129,7 @@ func (provider *TerraformProvider) destroy(ctx context.Context, deploymentID str tfWorkspace.Instances[0].Configuration = limitedConfig + fmt.Println("provider.MarkOperationStarted") if err := provider.MarkOperationStarted(&deployment, operationType); err != nil { return err } @@ -148,7 +149,7 @@ func (provider *TerraformProvider) Wait(ctx context.Context, id string) error { return nil case <-time.After(1 * time.Second): - isDone, _, err := provider.OperationStatus(id) + isDone, _, _, err := provider.OperationStatus(id) if isDone { return err } @@ -163,8 +164,9 @@ type DeploymentManagerInterface interface { CreateAndSaveDeployment(deploymentID string, workspace *workspace.TerraformWorkspace) (storage.TerraformDeployment, error) MarkOperationStarted(deployment *storage.TerraformDeployment, operationType string) error MarkOperationFinished(deployment *storage.TerraformDeployment, err error) error - OperationStatus(deploymentID string) (bool, string, error) + OperationStatus(deploymentID string) (bool, string, string, error) UpdateWorkspaceHCL(deploymentID string, serviceDefinitionAction TfServiceDefinitionV1Action, templateVars map[string]any) error GetBindingDeployments(deploymentID string) ([]storage.TerraformDeployment, error) DeleteTerraformDeployment(deploymentID string) error + ResetOperationType(deploymentID string) error } diff --git a/pkg/providers/tf/provision.go b/pkg/providers/tf/provision.go index d4c499462..1bdb7a545 100644 --- a/pkg/providers/tf/provision.go +++ b/pkg/providers/tf/provision.go @@ -8,7 +8,6 @@ import ( "code.cloudfoundry.org/lager/v3" "github.com/cloudfoundry/cloud-service-broker/v2/dbservice/models" "github.com/cloudfoundry/cloud-service-broker/v2/internal/steps" - "github.com/cloudfoundry/cloud-service-broker/v2/internal/storage" "github.com/cloudfoundry/cloud-service-broker/v2/pkg/broker" "github.com/cloudfoundry/cloud-service-broker/v2/pkg/providers/tf/invoker" "github.com/cloudfoundry/cloud-service-broker/v2/pkg/providers/tf/workspace" @@ -25,42 +24,36 @@ type ImportResource struct { // Provision creates the necessary resources that an instance of this service // needs to operate. -func (provider *TerraformProvider) Provision(ctx context.Context, provisionContext *varcontext.VarContext) (storage.ServiceInstanceDetails, error) { +func (provider *TerraformProvider) Provision(ctx context.Context, provisionContext *varcontext.VarContext) error { provider.logger.Debug("terraform-provision", correlation.ID(ctx), lager.Data{ "context": provisionContext.ToMap(), }) - var ( - tfID string - err error - ) + var err error switch provider.serviceDefinition.ProvisionSettings.IsTfImport(provisionContext) { case true: - tfID, err = provider.importCreate(ctx, provisionContext, provider.serviceDefinition.ProvisionSettings) + err = provider.importCreate(ctx, provisionContext, provider.serviceDefinition.ProvisionSettings) default: - tfID, err = provider.create(ctx, provisionContext, provider.serviceDefinition.ProvisionSettings, models.ProvisionOperationType) + err = provider.create(ctx, provisionContext, provider.serviceDefinition.ProvisionSettings, models.ProvisionOperationType) } if err != nil { - return storage.ServiceInstanceDetails{}, err + return err } - return storage.ServiceInstanceDetails{ - OperationGUID: tfID, - OperationType: models.ProvisionOperationType, - }, nil + return nil } -func (provider *TerraformProvider) importCreate(ctx context.Context, vars *varcontext.VarContext, action TfServiceDefinitionV1Action) (string, error) { +func (provider *TerraformProvider) importCreate(ctx context.Context, vars *varcontext.VarContext, action TfServiceDefinitionV1Action) error { varsMap := vars.ToMap() importParams, err := validateImportParams(action.ImportVariables, varsMap) if err != nil { - return "", err + return err } tfID := vars.GetString("tf_id") if err := vars.Error(); err != nil { - return "", err + return err } newWorkspace, err := workspace.NewWorkspace( @@ -71,17 +64,17 @@ func (provider *TerraformProvider) importCreate(ctx context.Context, vars *varco action.ImportParametersToDelete, evaluateParametersToAdd(action.ImportParametersToAdd)) if err != nil { - return tfID, fmt.Errorf("error creating workspace: %w", err) + return fmt.Errorf("error creating workspace: %w", err) } deployment, err := provider.CreateAndSaveDeployment(tfID, newWorkspace) if err != nil { provider.logger.Error("deployment create failed", err) - return tfID, fmt.Errorf("deployment create failed: %w", err) + return fmt.Errorf("deployment create failed: %w", err) } if err := provider.MarkOperationStarted(&deployment, models.ProvisionOperationType); err != nil { - return tfID, fmt.Errorf("error marking job started: %w", err) + return fmt.Errorf("error marking job started: %w", err) } go func() { @@ -122,7 +115,7 @@ func (provider *TerraformProvider) importCreate(ctx context.Context, vars *varco } }() - return tfID, nil + return nil } func validateImportParams(importVariables []broker.ImportVariable, varsMap map[string]any) ([]ImportResource, error) { diff --git a/pkg/providers/tf/provision_test.go b/pkg/providers/tf/provision_test.go index 8aaef029d..75abe6ed8 100644 --- a/pkg/providers/tf/provision_test.go +++ b/pkg/providers/tf/provision_test.go @@ -67,11 +67,9 @@ var _ = Describe("Provision", func() { fakeInvokerBuilder.VersionedTerraformInvokerReturns(fakeDefaultInvoker) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - actualInstanceDetails, err := provider.Provision(context.TODO(), provisionContext) + err := provider.Provision(context.TODO(), provisionContext) Expect(err).NotTo(HaveOccurred()) - Expect(actualInstanceDetails.OperationGUID).To(Equal(expectedTfID)) - Expect(actualInstanceDetails.OperationType).To(Equal("provision")) By("checking the new saved deployment") Expect(fakeDeploymentManager.CreateAndSaveDeploymentCallCount()).To(Equal(1)) @@ -104,7 +102,7 @@ var _ = Describe("Provision", func() { provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err = provider.Provision(context.TODO(), provisionContext) + err = provider.Provision(context.TODO(), provisionContext) Expect(err.Error()).To(ContainSubstring(`missing value for key "tf_id"`)) }) @@ -119,7 +117,7 @@ var _ = Describe("Provision", func() { provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Provision(context.TODO(), provisionContext) + err := provider.Provision(context.TODO(), provisionContext) Expect(err).To(MatchError(`error creating workspace: :1,17-17: Invalid block definition; Either a quoted string block label or an opening brace ("{") is expected here.`)) }) @@ -128,7 +126,7 @@ var _ = Describe("Provision", func() { fakeDeploymentManager.CreateAndSaveDeploymentReturns(storage.TerraformDeployment{}, errors.New("cant save now")) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Provision(context.TODO(), provisionContext) + err := provider.Provision(context.TODO(), provisionContext) Expect(err).To(MatchError("deployment create failed: cant save now")) }) @@ -138,7 +136,7 @@ var _ = Describe("Provision", func() { fakeDeploymentManager.MarkOperationStartedReturns(errors.New("couldnt do this now")) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Provision(context.TODO(), provisionContext) + err := provider.Provision(context.TODO(), provisionContext) Expect(err).To(MatchError("error marking job started: couldnt do this now")) }) @@ -149,7 +147,7 @@ var _ = Describe("Provision", func() { fakeDefaultInvoker.ApplyReturns(errors.New("some TF issue happened")) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Provision(context.TODO(), provisionContext) + err := provider.Provision(context.TODO(), provisionContext) Expect(err).NotTo(HaveOccurred()) By("checking TF apply has been called") @@ -206,11 +204,9 @@ var _ = Describe("Provision", func() { fakeInvokerBuilder.VersionedTerraformInvokerReturns(fakeDefaultInvoker) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - actualInstanceDetails, err := provider.Provision(context.TODO(), provisionContext) + err := provider.Provision(context.TODO(), provisionContext) Expect(err).NotTo(HaveOccurred()) - Expect(actualInstanceDetails.OperationGUID).To(Equal(expectedTfID)) - Expect(actualInstanceDetails.OperationType).To(Equal("provision")) By("checking the new saved deployment") Expect(fakeDeploymentManager.CreateAndSaveDeploymentCallCount()).To(Equal(1)) @@ -249,7 +245,7 @@ var _ = Describe("Provision", func() { provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err = provider.Provision(context.TODO(), pc) + err = provider.Provision(context.TODO(), pc) Expect(err).To(MatchError("must provide values for all import parameters: import_input")) }) @@ -260,7 +256,7 @@ var _ = Describe("Provision", func() { provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err = provider.Provision(context.TODO(), pc) + err = provider.Provision(context.TODO(), pc) Expect(err.Error()).To(ContainSubstring(`missing value for key "tf_id"`)) }) @@ -298,7 +294,7 @@ var _ = Describe("Provision", func() { provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, sd, fakeDeploymentManager) - _, err := provider.Provision(context.TODO(), provisionContext) + err := provider.Provision(context.TODO(), provisionContext) Expect(err.Error()).To(ContainSubstring(`error creating workspace: :1,17-17: Invalid block definition; Either a quoted string block label or an opening brace ("{") is expected here.`)) }) @@ -307,7 +303,7 @@ var _ = Describe("Provision", func() { fakeDeploymentManager.CreateAndSaveDeploymentReturns(storage.TerraformDeployment{}, errors.New("cant save now")) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Provision(context.TODO(), provisionContext) + err := provider.Provision(context.TODO(), provisionContext) Expect(err).To(MatchError("deployment create failed: cant save now")) }) @@ -317,7 +313,7 @@ var _ = Describe("Provision", func() { fakeDeploymentManager.MarkOperationStartedReturns(errors.New("couldnt do this now")) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Provision(context.TODO(), provisionContext) + err := provider.Provision(context.TODO(), provisionContext) Expect(err).To(MatchError("error marking job started: couldnt do this now")) }) @@ -329,7 +325,7 @@ var _ = Describe("Provision", func() { fakeDefaultInvoker.ImportReturns(errors.New("some TF import issue happened")) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Provision(context.TODO(), provisionContext) + err := provider.Provision(context.TODO(), provisionContext) Expect(err).NotTo(HaveOccurred()) By("checking TF import has been called") @@ -347,7 +343,7 @@ var _ = Describe("Provision", func() { fakeDefaultInvoker.ShowReturns("", errors.New("some TF show issue happened")) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Provision(context.TODO(), provisionContext) + err := provider.Provision(context.TODO(), provisionContext) Expect(err).NotTo(HaveOccurred()) By("checking TF show has been called") @@ -364,7 +360,7 @@ var _ = Describe("Provision", func() { fakeDefaultInvoker.PlanReturns(executor.ExecutionOutput{}, errors.New("some TF plan issue happened")) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Provision(context.TODO(), provisionContext) + err := provider.Provision(context.TODO(), provisionContext) Expect(err).NotTo(HaveOccurred()) By("checking TF plan has been called") @@ -380,7 +376,7 @@ var _ = Describe("Provision", func() { fakeDefaultInvoker.ApplyReturns(errors.New("some TF apply issue happened")) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Provision(context.TODO(), provisionContext) + err := provider.Provision(context.TODO(), provisionContext) Expect(err).NotTo(HaveOccurred()) By("checking TF apply has been called") diff --git a/pkg/providers/tf/tffakes/fake_deployment_manager_interface.go b/pkg/providers/tf/tffakes/fake_deployment_manager_interface.go index 60a2a8c6a..9a2ea75a0 100644 --- a/pkg/providers/tf/tffakes/fake_deployment_manager_interface.go +++ b/pkg/providers/tf/tffakes/fake_deployment_manager_interface.go @@ -85,7 +85,7 @@ type FakeDeploymentManagerInterface struct { markOperationStartedReturnsOnCall map[int]struct { result1 error } - OperationStatusStub func(string) (bool, string, error) + OperationStatusStub func(string) (bool, string, string, error) operationStatusMutex sync.RWMutex operationStatusArgsForCall []struct { arg1 string @@ -93,12 +93,25 @@ type FakeDeploymentManagerInterface struct { operationStatusReturns struct { result1 bool result2 string - result3 error + result3 string + result4 error } operationStatusReturnsOnCall map[int]struct { result1 bool result2 string - result3 error + result3 string + result4 error + } + ResetOperationTypeStub func(string) error + resetOperationTypeMutex sync.RWMutex + resetOperationTypeArgsForCall []struct { + arg1 string + } + resetOperationTypeReturns struct { + result1 error + } + resetOperationTypeReturnsOnCall map[int]struct { + result1 error } UpdateWorkspaceHCLStub func(string, tf.TfServiceDefinitionV1Action, map[string]any) error updateWorkspaceHCLMutex sync.RWMutex @@ -495,7 +508,7 @@ func (fake *FakeDeploymentManagerInterface) MarkOperationStartedReturnsOnCall(i }{result1} } -func (fake *FakeDeploymentManagerInterface) OperationStatus(arg1 string) (bool, string, error) { +func (fake *FakeDeploymentManagerInterface) OperationStatus(arg1 string) (bool, string, string, error) { fake.operationStatusMutex.Lock() ret, specificReturn := fake.operationStatusReturnsOnCall[len(fake.operationStatusArgsForCall)] fake.operationStatusArgsForCall = append(fake.operationStatusArgsForCall, struct { @@ -509,9 +522,9 @@ func (fake *FakeDeploymentManagerInterface) OperationStatus(arg1 string) (bool, return stub(arg1) } if specificReturn { - return ret.result1, ret.result2, ret.result3 + return ret.result1, ret.result2, ret.result3, ret.result4 } - return fakeReturns.result1, fakeReturns.result2, fakeReturns.result3 + return fakeReturns.result1, fakeReturns.result2, fakeReturns.result3, fakeReturns.result4 } func (fake *FakeDeploymentManagerInterface) OperationStatusCallCount() int { @@ -520,7 +533,7 @@ func (fake *FakeDeploymentManagerInterface) OperationStatusCallCount() int { return len(fake.operationStatusArgsForCall) } -func (fake *FakeDeploymentManagerInterface) OperationStatusCalls(stub func(string) (bool, string, error)) { +func (fake *FakeDeploymentManagerInterface) OperationStatusCalls(stub func(string) (bool, string, string, error)) { fake.operationStatusMutex.Lock() defer fake.operationStatusMutex.Unlock() fake.OperationStatusStub = stub @@ -533,18 +546,19 @@ func (fake *FakeDeploymentManagerInterface) OperationStatusArgsForCall(i int) st return argsForCall.arg1 } -func (fake *FakeDeploymentManagerInterface) OperationStatusReturns(result1 bool, result2 string, result3 error) { +func (fake *FakeDeploymentManagerInterface) OperationStatusReturns(result1 bool, result2 string, result3 string, result4 error) { fake.operationStatusMutex.Lock() defer fake.operationStatusMutex.Unlock() fake.OperationStatusStub = nil fake.operationStatusReturns = struct { result1 bool result2 string - result3 error - }{result1, result2, result3} + result3 string + result4 error + }{result1, result2, result3, result4} } -func (fake *FakeDeploymentManagerInterface) OperationStatusReturnsOnCall(i int, result1 bool, result2 string, result3 error) { +func (fake *FakeDeploymentManagerInterface) OperationStatusReturnsOnCall(i int, result1 bool, result2 string, result3 string, result4 error) { fake.operationStatusMutex.Lock() defer fake.operationStatusMutex.Unlock() fake.OperationStatusStub = nil @@ -552,14 +566,77 @@ func (fake *FakeDeploymentManagerInterface) OperationStatusReturnsOnCall(i int, fake.operationStatusReturnsOnCall = make(map[int]struct { result1 bool result2 string - result3 error + result3 string + result4 error }) } fake.operationStatusReturnsOnCall[i] = struct { result1 bool result2 string - result3 error - }{result1, result2, result3} + result3 string + result4 error + }{result1, result2, result3, result4} +} + +func (fake *FakeDeploymentManagerInterface) ResetOperationType(arg1 string) error { + fake.resetOperationTypeMutex.Lock() + ret, specificReturn := fake.resetOperationTypeReturnsOnCall[len(fake.resetOperationTypeArgsForCall)] + fake.resetOperationTypeArgsForCall = append(fake.resetOperationTypeArgsForCall, struct { + arg1 string + }{arg1}) + stub := fake.ResetOperationTypeStub + fakeReturns := fake.resetOperationTypeReturns + fake.recordInvocation("ResetOperationType", []interface{}{arg1}) + fake.resetOperationTypeMutex.Unlock() + if stub != nil { + return stub(arg1) + } + if specificReturn { + return ret.result1 + } + return fakeReturns.result1 +} + +func (fake *FakeDeploymentManagerInterface) ResetOperationTypeCallCount() int { + fake.resetOperationTypeMutex.RLock() + defer fake.resetOperationTypeMutex.RUnlock() + return len(fake.resetOperationTypeArgsForCall) +} + +func (fake *FakeDeploymentManagerInterface) ResetOperationTypeCalls(stub func(string) error) { + fake.resetOperationTypeMutex.Lock() + defer fake.resetOperationTypeMutex.Unlock() + fake.ResetOperationTypeStub = stub +} + +func (fake *FakeDeploymentManagerInterface) ResetOperationTypeArgsForCall(i int) string { + fake.resetOperationTypeMutex.RLock() + defer fake.resetOperationTypeMutex.RUnlock() + argsForCall := fake.resetOperationTypeArgsForCall[i] + return argsForCall.arg1 +} + +func (fake *FakeDeploymentManagerInterface) ResetOperationTypeReturns(result1 error) { + fake.resetOperationTypeMutex.Lock() + defer fake.resetOperationTypeMutex.Unlock() + fake.ResetOperationTypeStub = nil + fake.resetOperationTypeReturns = struct { + result1 error + }{result1} +} + +func (fake *FakeDeploymentManagerInterface) ResetOperationTypeReturnsOnCall(i int, result1 error) { + fake.resetOperationTypeMutex.Lock() + defer fake.resetOperationTypeMutex.Unlock() + fake.ResetOperationTypeStub = nil + if fake.resetOperationTypeReturnsOnCall == nil { + fake.resetOperationTypeReturnsOnCall = make(map[int]struct { + result1 error + }) + } + fake.resetOperationTypeReturnsOnCall[i] = struct { + result1 error + }{result1} } func (fake *FakeDeploymentManagerInterface) UpdateWorkspaceHCL(arg1 string, arg2 tf.TfServiceDefinitionV1Action, arg3 map[string]any) error { @@ -642,6 +719,8 @@ func (fake *FakeDeploymentManagerInterface) Invocations() map[string][][]interfa defer fake.markOperationStartedMutex.RUnlock() fake.operationStatusMutex.RLock() defer fake.operationStatusMutex.RUnlock() + fake.resetOperationTypeMutex.RLock() + defer fake.resetOperationTypeMutex.RUnlock() fake.updateWorkspaceHCLMutex.RLock() defer fake.updateWorkspaceHCLMutex.RUnlock() copiedInvocations := map[string][][]interface{}{} diff --git a/pkg/providers/tf/unbind_test.go b/pkg/providers/tf/unbind_test.go index ed24c5bec..9919f197d 100644 --- a/pkg/providers/tf/unbind_test.go +++ b/pkg/providers/tf/unbind_test.go @@ -79,7 +79,7 @@ var _ = Describe("Unbind", func() { It("destroys the binding", func() { fakeInvokerBuilder.VersionedTerraformInvokerReturns(fakeDefaultInvoker) fakeDeploymentManager.GetTerraformDeploymentReturns(deployment, nil) - fakeDeploymentManager.OperationStatusReturns(true, "operation succeeded", nil) + fakeDeploymentManager.OperationStatusReturns(true, "operation succeeded", "bind", nil) provider := tf.NewTerraformProvider(executor.TFBinariesContext{DefaultTfVersion: version.Must(version.NewVersion("1"))}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) @@ -141,7 +141,7 @@ var _ = Describe("Unbind", func() { fakeDeploymentManager.MarkOperationStartedReturns(nil) fakeInvokerBuilder.VersionedTerraformInvokerReturns(fakeDefaultInvoker) fakeDefaultInvoker.DestroyReturns(errors.New(expectedError)) - fakeDeploymentManager.OperationStatusReturns(true, "", errors.New(expectedError)) + fakeDeploymentManager.OperationStatusReturns(true, "", "destroy", errors.New(expectedError)) provider := tf.NewTerraformProvider(executor.TFBinariesContext{DefaultTfVersion: version.Must(version.NewVersion("1"))}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) diff --git a/pkg/providers/tf/update.go b/pkg/providers/tf/update.go index d3295c3fc..87166ab6a 100644 --- a/pkg/providers/tf/update.go +++ b/pkg/providers/tf/update.go @@ -12,33 +12,33 @@ import ( ) // Update makes necessary updates to resources, so they match new desired configuration -func (provider *TerraformProvider) Update(ctx context.Context, updateContext *varcontext.VarContext) (models.ServiceInstanceDetails, error) { +func (provider *TerraformProvider) Update(ctx context.Context, updateContext *varcontext.VarContext) error { provider.logger.Debug("update", correlation.ID(ctx), lager.Data{ "context": updateContext.ToMap(), }) if provider.serviceDefinition.ProvisionSettings.IsTfImport(updateContext) { - return models.ServiceInstanceDetails{}, fmt.Errorf("cannot update to subsume plan\n\nFor OpsMan Tile users see documentation here: https://via.vmw.com/ENs4\n\nFor Open Source users deployed via 'cf push' see documentation here: https://via.vmw.com/ENw4") + return fmt.Errorf("cannot update to subsume plan\n\nFor OpsMan Tile users see documentation here: https://via.vmw.com/ENs4\n\nFor Open Source users deployed via 'cf push' see documentation here: https://via.vmw.com/ENw4") } tfID := updateContext.GetString("tf_id") if err := updateContext.Error(); err != nil { - return models.ServiceInstanceDetails{}, err + return err } if err := provider.UpdateWorkspaceHCL(tfID, provider.serviceDefinition.ProvisionSettings, updateContext.ToMap()); err != nil { - return models.ServiceInstanceDetails{}, err + return err } deployment, err := provider.GetTerraformDeployment(tfID) if err != nil { - return models.ServiceInstanceDetails{}, err + return err } workspace := deployment.Workspace if err := provider.MarkOperationStarted(&deployment, models.UpdateOperationType); err != nil { - return models.ServiceInstanceDetails{}, err + return err } go func() { @@ -52,8 +52,5 @@ func (provider *TerraformProvider) Update(ctx context.Context, updateContext *va _ = provider.MarkOperationFinished(&deployment, err) }() - return models.ServiceInstanceDetails{ - OperationID: tfID, - OperationType: models.UpdateOperationType, - }, nil + return nil } diff --git a/pkg/providers/tf/update_test.go b/pkg/providers/tf/update_test.go index b3d0377a6..74bd9e78f 100644 --- a/pkg/providers/tf/update_test.go +++ b/pkg/providers/tf/update_test.go @@ -63,7 +63,7 @@ var _ = Describe("Update", func() { provider := tf.NewTerraformProvider(executor.TFBinariesContext{DefaultTfVersion: newVersion(tfVersion)}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Update(context.TODO(), varContext) + err := provider.Update(context.TODO(), varContext) Expect(err).NotTo(HaveOccurred()) Eventually(operationWasFinishedForDeployment(fakeDeploymentManager)).Should(Equal(deployment)) Expect(operationWasFinishedWithError(fakeDeploymentManager)()).To(BeNil()) @@ -81,7 +81,7 @@ var _ = Describe("Update", func() { fakeWorkspace.OutputsReturns(map[string]any{"status": "status from terraform"}, nil) provider := tf.NewTerraformProvider(executor.TFBinariesContext{DefaultTfVersion: newVersion(tfVersion)}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Update(context.TODO(), varContext) + err := provider.Update(context.TODO(), varContext) Expect(err).To(Succeed()) Eventually(operationWasFinishedForDeployment(fakeDeploymentManager)).Should(Equal(deployment)) Expect(operationWasFinishedWithError(fakeDeploymentManager)()).To(BeNil()) @@ -96,7 +96,7 @@ var _ = Describe("Update", func() { fakeDefaultInvoker.ApplyReturns(genericError) provider := tf.NewTerraformProvider(executor.TFBinariesContext{DefaultTfVersion: newVersion(tfVersion)}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Update(context.TODO(), varContext) + err := provider.Update(context.TODO(), varContext) Expect(err).To(Succeed()) Eventually(operationWasFinishedForDeployment(fakeDeploymentManager)).Should(Equal(deployment)) @@ -115,7 +115,7 @@ var _ = Describe("Update", func() { provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err = provider.Update(context.TODO(), varContext) + err = provider.Update(context.TODO(), varContext) Expect(err).To(MatchError("cannot update to subsume plan\n\nFor OpsMan Tile users see documentation here: https://via.vmw.com/ENs4\n\nFor Open Source users deployed via 'cf push' see documentation here: https://via.vmw.com/ENw4")) }) }) @@ -127,7 +127,7 @@ var _ = Describe("Update", func() { provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err = provider.Update(context.TODO(), varContext) + err = provider.Update(context.TODO(), varContext) Expect(err).To(MatchError(`1 error(s) occurred: missing value for key "tf_id"`)) }) }) @@ -138,7 +138,7 @@ var _ = Describe("Update", func() { provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Update(context.TODO(), varContext) + err := provider.Update(context.TODO(), varContext) Expect(err).To(MatchError(genericError)) }) }) @@ -148,7 +148,7 @@ var _ = Describe("Update", func() { fakeDeploymentManager.GetTerraformDeploymentReturns(storage.TerraformDeployment{}, genericError) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Update(context.TODO(), varContext) + err := provider.Update(context.TODO(), varContext) Expect(err).To(MatchError(genericError)) }) }) @@ -159,7 +159,7 @@ var _ = Describe("Update", func() { fakeDeploymentManager.MarkOperationStartedReturns(genericError) provider := tf.NewTerraformProvider(executor.TFBinariesContext{}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Update(context.TODO(), varContext) + err := provider.Update(context.TODO(), varContext) Expect(err).To(MatchError(genericError)) }) @@ -175,7 +175,7 @@ var _ = Describe("Update", func() { provider := tf.NewTerraformProvider(executor.TFBinariesContext{DefaultTfVersion: newVersion(tfVersion)}, fakeInvokerBuilder, fakeLogger, fakeServiceDefinition, fakeDeploymentManager) - _, err := provider.Update(context.TODO(), varContext) + err := provider.Update(context.TODO(), varContext) Expect(err).NotTo(HaveOccurred()) Eventually(operationWasFinishedForDeployment(fakeDeploymentManager)).Should(Equal(deployment)) diff --git a/pkg/providers/tf/workspace/workspace.go b/pkg/providers/tf/workspace/workspace.go index 2da28988f..a54073c87 100644 --- a/pkg/providers/tf/workspace/workspace.go +++ b/pkg/providers/tf/workspace/workspace.go @@ -25,18 +25,27 @@ import ( "strings" "sync" + "github.com/spf13/viper" + "github.com/cloudfoundry/cloud-service-broker/v2/pkg/providers/tf/command" "github.com/cloudfoundry/cloud-service-broker/v2/pkg/providers/tf/executor" "github.com/hashicorp/go-version" ) -// DefaultInstanceName is the default name of an instance of a particular module. const ( - DefaultInstanceName = "instance" - binaryName = "tofu" + // DefaultInstanceName is the default name of an instance of a particular module. + DefaultInstanceName = "instance" + binaryName = "tofu" + leaveWorkspaceDirectoryConfigKey = "debug.leave_workspace_dir" + leaveWorkspaceDirectoryEnvVar = "CSB_DEBUG_LEAVE_WORKSPACE_DIR" ) +func init() { + viper.BindEnv(leaveWorkspaceDirectoryConfigKey, leaveWorkspaceDirectoryEnvVar) + viper.SetDefault(leaveWorkspaceDirectoryConfigKey, false) +} + // NewWorkspace creates a new TerraformWorkspace from a given template and variables to populate an instance of it. // The created instance will have the name specified by the DefaultInstanceName constant. func NewWorkspace(templateVars map[string]any, @@ -287,8 +296,10 @@ func (workspace *TerraformWorkspace) teardownFs() error { workspace.State = bytes - if err := os.RemoveAll(workspace.dir); err != nil { - return err + if !viper.GetBool(leaveWorkspaceDirectoryConfigKey) { + if err := os.RemoveAll(workspace.dir); err != nil { + return err + } } workspace.dir = ""