Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pipeline created from API gets overwritten by config file with duplicate ID #1229

Merged
merged 18 commits into from
Oct 13, 2023
Merged

Pipeline created from API gets overwritten by config file with duplicate ID #1229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
0ae5ce6
add check for existing pipelines from API in provisioning/service
AdamHaffar Sep 27, 2023
3d405a1
remove println
AdamHaffar Sep 27, 2023
baf0ecc
fix service.go to store config value
AdamHaffar Oct 3, 2023
c193cea
add test in service_test.go for duplicate ID for API pipeline
AdamHaffar Oct 3, 2023
52a4b34
add test for duplicate pipeline from API and fix tests in service_tes…
AdamHaffar Oct 4, 2023
2213d32
remove test in pipeline/service_test.go that was added by mistake
AdamHaffar Oct 4, 2023
6619235
fix err handling in service.go and add test to check error handling s…
AdamHaffar Oct 4, 2023
8514b3e
Merge branch 'main' into adam/overwrite-api-pipeline-fix
AdamHaffar Oct 4, 2023
37957cd
error handle fix to check for instance not found err
AdamHaffar Oct 4, 2023
e5871e6
Merge remote-tracking branch 'origin/adam/overwrite-api-pipeline-fix'…
AdamHaffar Oct 4, 2023
596f790
error handle fix
AdamHaffar Oct 4, 2023
c9c372d
modify error descriptions for pipeline provisioned through api.
AdamHaffar Oct 10, 2023
8a8c50f
Merge branch 'main' into adam/overwrite-api-pipeline-fix
AdamHaffar Oct 10, 2023
3e309e6
error name fix
AdamHaffar Oct 10, 2023
59adec9
service_test.go comment fix
AdamHaffar Oct 10, 2023
8211878
fix test in service_test.go by dereferencing OldInstancePipeline
AdamHaffar Oct 10, 2023
abf0a02
Merge branch 'main' into adam/overwrite-api-pipeline-fix
maha-hajja Oct 11, 2023
001021b
Merge branch 'main' into adam/overwrite-api-pipeline-fix
hariso Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions pkg/provisioning/service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,23 @@ func (s *Service) Init(ctx context.Context) error {
allPls = append(allPls, duplicateID)
}

// remove pipelines with duplicate IDs from API pipelines
var apiProvisioned []int
for i, pl := range configs {
pipelineInstance, err := s.pipelineService.Get(ctx, pl.ID)
if err != nil {
if !cerrors.Is(err, pipeline.ErrInstanceNotFound) {
multierr = multierror.Append(multierr, cerrors.Errorf("error getting pipeline instance with ID %q: %w", pl.ID, err))
}
continue
}
if pipelineInstance.ProvisionedBy != pipeline.ProvisionTypeConfig {
multierr = multierror.Append(multierr, cerrors.Errorf("pipelines with ID %q will be skipped: %w", pl.ID, ErrNotProvisionedByConfig))
apiProvisioned = append(apiProvisioned, i)
}
}
configs = s.deleteIndexes(configs, apiProvisioned)

// contains pipelineIDs of successfully provisioned pipelines.
var successPls []string
for _, cfg := range configs {
Expand Down
81 changes: 79 additions & 2 deletions pkg/provisioning/service_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,12 @@ func TestService_Init_Create(t *testing.T) {
service, pipelineService, connService, procService, plugService := newTestService(ctrl, logger)
service.pipelinesPath = "./test/pipelines1"

// return a pipeline not provisioned by API
pipelineService.EXPECT().Get(anyCtx, p1.P1.ID).Return(nil, pipeline.ErrInstanceNotFound)

pipelineService.EXPECT().List(anyCtx)
// pipeline doesn't exist
pipelineService.EXPECT().Get(anyCtx, p1.P1.ID).Return(nil, pipeline.ErrInstanceNotFound)

// create pipeline
pipelineService.EXPECT().CreateWithInstance(anyCtx, p1.P1)
pipelineService.EXPECT().UpdateDLQ(anyCtx, p1.P1.ID, p1.P1.DLQ)
Expand Down Expand Up @@ -144,6 +146,9 @@ func TestService_Init_Update(t *testing.T) {
service.pipelinesPath = "./test/pipelines1"

pipelineService.EXPECT().List(anyCtx)
// return a pipeline not provisioned by API
pipelineService.EXPECT().Get(anyCtx, p1.P1.ID).Return(nil, pipeline.ErrInstanceNotFound)

// pipeline exists
pipelineService.EXPECT().Get(anyCtx, p1.P1.ID).Return(oldPipelineInstance, nil)

Expand Down Expand Up @@ -204,6 +209,9 @@ func TestService_Init_NoRollbackOnFailedStart(t *testing.T) {
service, pipelineService, connService, procService, plugService := newTestService(ctrl, logger)
service.pipelinesPath = "./test/pipelines1"

// return a pipeline not provisioned by API
pipelineService.EXPECT().Get(anyCtx, p1.P1.ID).Return(nil, pipeline.ErrInstanceNotFound)

pipelineService.EXPECT().List(anyCtx)
pipelineService.EXPECT().Get(anyCtx, p1.P1.ID).Return(nil, pipeline.ErrInstanceNotFound)

Expand Down Expand Up @@ -237,6 +245,9 @@ func TestService_Init_RollbackCreate(t *testing.T) {
service, pipelineService, connService, procService, plugService := newTestService(ctrl, logger)
service.pipelinesPath = "./test/pipelines1"

// return a pipeline not provisioned by API
pipelineService.EXPECT().Get(anyCtx, p1.P1.ID).Return(nil, pipeline.ErrInstanceNotFound)

pipelineService.EXPECT().List(anyCtx)
pipelineService.EXPECT().Get(anyCtx, p1.P1.ID).Return(nil, pipeline.ErrInstanceNotFound)

Expand Down Expand Up @@ -273,6 +284,9 @@ func TestService_Init_RollbackUpdate(t *testing.T) {
service, pipelineService, connService, procService, _ := newTestService(ctrl, logger)
service.pipelinesPath = "./test/pipelines1"

// return a pipeline not provisioned by API
pipelineService.EXPECT().Get(anyCtx, p1.P1.ID).Return(nil, pipeline.ErrInstanceNotFound)

pipelineService.EXPECT().List(anyCtx)
// pipeline exists
pipelineService.EXPECT().Get(anyCtx, p1.P1.ID).Return(oldPipelineInstance, nil)
Expand Down Expand Up @@ -310,6 +324,9 @@ func TestService_Init_MultiplePipelinesDuplicatedPipelineID(t *testing.T) {
service, pipelineService, connService, procService, plugService := newTestService(ctrl, logger)
service.pipelinesPath = "./test/pipelines2"

// return a pipeline not provisioned by API
pipelineService.EXPECT().Get(anyCtx, p2.P2.ID).Return(nil, pipeline.ErrInstanceNotFound)

pipelineService.EXPECT().List(anyCtx)
pipelineService.EXPECT().Get(anyCtx, p2.P2.ID).Return(nil, pipeline.ErrInstanceNotFound)

Expand All @@ -336,6 +353,10 @@ func TestService_Init_MultiplePipelines(t *testing.T) {
service, pipelineService, connService, procService, plugService := newTestService(ctrl, logger)
service.pipelinesPath = "./test/pipelines3"

// return a pipeline not provisioned by API
pipelineService.EXPECT().Get(anyCtx, p3.P1.ID).Return(nil, pipeline.ErrInstanceNotFound)
pipelineService.EXPECT().Get(anyCtx, p3.P2.ID).Return(nil, pipeline.ErrInstanceNotFound)

pipelineService.EXPECT().List(anyCtx)
pipelineService.EXPECT().Get(anyCtx, p3.P1.ID).Return(nil, pipeline.ErrInstanceNotFound)
pipelineService.EXPECT().Get(anyCtx, p3.P2.ID).Return(nil, pipeline.ErrInstanceNotFound)
Expand Down Expand Up @@ -366,6 +387,63 @@ func TestService_Init_MultiplePipelines(t *testing.T) {
is.NoErr(err)
}

func TestService_Init_PipelineProvisionedFromAPI(t *testing.T) {
is := is.New(t)
logger := log.Nop()
ctrl := gomock.NewController(t)

tmp := *oldPipelineInstance
APIPipelineInstance := &tmp
APIPipelineInstance.ProvisionedBy = pipeline.ProvisionTypeAPI // change the test pipeline to be API provisioned

service, pipelineService, _, _, _ := newTestService(ctrl, logger)
service.pipelinesPath = "./test/pipelines1"

// pipeline provisioned by API
pipelineService.EXPECT().Get(anyCtx, p1.P1.ID).Return(APIPipelineInstance, nil)

pipelineService.EXPECT().List(anyCtx)

err := service.Init(context.Background())
is.True(cerrors.Is(err, ErrNotProvisionedByConfig))
}

func TestService_Init_PipelineProvisionedFromAPI_Error(t *testing.T) {
is := is.New(t)
logger := log.Nop()
ctrl := gomock.NewController(t)
otherErr := cerrors.New("GetError")

service, pipelineService, connService, procService, plugService := newTestService(ctrl, logger)
service.pipelinesPath = "./test/pipelines1"

// error from calling Get
pipelineService.EXPECT().Get(anyCtx, p1.P1.ID).Return(nil, otherErr)

pipelineService.EXPECT().List(anyCtx)
// pipeline doesn't exist
pipelineService.EXPECT().Get(anyCtx, p1.P1.ID).Return(nil, pipeline.ErrInstanceNotFound)
// create pipeline
pipelineService.EXPECT().CreateWithInstance(anyCtx, p1.P1)
pipelineService.EXPECT().UpdateDLQ(anyCtx, p1.P1.ID, p1.P1.DLQ)
pipelineService.EXPECT().AddConnector(anyCtx, p1.P1.ID, p1.P1.ConnectorIDs[0])
pipelineService.EXPECT().AddConnector(anyCtx, p1.P1.ID, p1.P1.ConnectorIDs[1])
pipelineService.EXPECT().AddProcessor(anyCtx, p1.P1.ID, p1.P1.ProcessorIDs[0])

connService.EXPECT().CreateWithInstance(anyCtx, p1.P1C1)
connService.EXPECT().CreateWithInstance(anyCtx, p1.P1C2)
connService.EXPECT().AddProcessor(anyCtx, p1.P1C2.ID, p1.P1C2.ProcessorIDs[0])

procService.EXPECT().CreateWithInstance(anyCtx, p1.P1C2P1)
procService.EXPECT().CreateWithInstance(anyCtx, p1.P1P1)

// start pipeline
pipelineService.EXPECT().Start(anyCtx, connService, procService, plugService, p1.P1.ID)

err := service.Init(context.Background())
is.True(cerrors.Is(err, otherErr))
}

func TestService_Delete(t *testing.T) {
is := is.New(t)
logger := log.Nop()
Expand All @@ -379,7 +457,6 @@ func TestService_Delete(t *testing.T) {
connService.EXPECT().Get(anyCtx, oldConnector2Instance.ID).Return(oldConnector2Instance, nil)
procService.EXPECT().Get(anyCtx, oldConnectorProcessorInstance.ID).Return(oldConnectorProcessorInstance, nil)
procService.EXPECT().Get(anyCtx, oldPipelineProcessorInstance.ID).Return(oldPipelineProcessorInstance, nil)

// delete pipeline
pipelineService.EXPECT().Delete(anyCtx, oldPipelineInstance.ID).Return(nil)
connService.EXPECT().Delete(anyCtx, oldConnector1Instance.ID, plugService).Return(nil)
Expand Down
Loading