CloudMigrations: Refactor API for async work (#89084)

* rename some stuff

* more renaming

* clean up api

* rename more functions

* rename cms -> gms

* update comment

* update swagger gen

* update endpoints

* overzealous

* final touches

* dont modify existing migrations

* break structs into domain and dtos

* add some conversion funcs

* fix build

* update frontend

* try to make swagger happy

pkg/services/cloudmigration/cloudmigrationimpl/cloudmigration.go

@@ -16,7 +16,7 @@ import (
 	"github.com/grafana/grafana/pkg/infra/tracing"
 	"github.com/grafana/grafana/pkg/services/cloudmigration"
 	"github.com/grafana/grafana/pkg/services/cloudmigration/api"
-	"github.com/grafana/grafana/pkg/services/cloudmigration/cmsclient"
+	"github.com/grafana/grafana/pkg/services/cloudmigration/gmsclient"
 	"github.com/grafana/grafana/pkg/services/contexthandler"
 	"github.com/grafana/grafana/pkg/services/dashboards"
 	"github.com/grafana/grafana/pkg/services/datasources"
@@ -38,7 +38,7 @@ type Service struct {
 	cfg *setting.Cfg
 
 	features  featuremgmt.FeatureToggles
-	cmsClient cmsclient.Client
+	gmsClient gmsclient.Client
 
 	dsService        datasources.DataSourceService
 	gcomService      gcom.Service
@@ -95,16 +95,16 @@ func ProvideService(
 	s.api = api.RegisterApi(routeRegister, s, tracer)
 
 	if !cfg.CloudMigration.IsDeveloperMode {
-		// get CMS path from the config
+		// get GMS path from the config
 		domain, err := s.parseCloudMigrationConfig()
 		if err != nil {
 			return nil, fmt.Errorf("config parse error: %w", err)
 		}
-		s.cmsClient = cmsclient.NewCMSClient(domain)
+		s.gmsClient = gmsclient.NewGMSClient(domain)
 
 		s.gcomService = gcom.New(gcom.Config{ApiURL: cfg.GrafanaComAPIURL, Token: cfg.CloudMigration.GcomAPIToken})
 	} else {
-		s.cmsClient = cmsclient.NewInMemoryClient()
+		s.gmsClient = gmsclient.NewInMemoryClient()
 		s.gcomService = &gcomStub{policies: map[string]gcom.AccessPolicy{}, token: nil}
 		s.cfg.StackID = "12345"
 	}
@@ -242,7 +242,7 @@ func (s *Service) CreateToken(ctx context.Context) (cloudmigration.CreateAccessT
 		Instance: cloudmigration.Base64HGInstance{
 			StackID:     instance.ID,
 			RegionSlug:  instance.RegionSlug,
-			ClusterSlug: instance.ClusterSlug, // This should be used for routing to CMS
+			ClusterSlug: instance.ClusterSlug, // This should be used for routing to GMS
 			Slug:        instance.Slug,
 		},
 	})
@@ -275,11 +275,11 @@ func (s *Service) findAccessPolicyByName(ctx context.Context, regionSlug, access
 	return nil, nil
 }
 
-func (s *Service) ValidateToken(ctx context.Context, cm cloudmigration.CloudMigration) error {
+func (s *Service) ValidateToken(ctx context.Context, cm cloudmigration.CloudMigrationSession) error {
 	ctx, span := s.tracer.Start(ctx, "CloudMigrationService.ValidateToken")
 	defer span.End()
 
-	if err := s.cmsClient.ValidateKey(ctx, cm); err != nil {
+	if err := s.gmsClient.ValidateKey(ctx, cm); err != nil {
 		return fmt.Errorf("validating key: %w", err)
 	}
 
@@ -315,10 +315,10 @@ func (s *Service) DeleteToken(ctx context.Context, tokenID string) error {
 	return nil
 }
 
-func (s *Service) GetMigration(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error) {
+func (s *Service) GetSession(ctx context.Context, uid string) (*cloudmigration.CloudMigrationSession, error) {
 	ctx, span := s.tracer.Start(ctx, "CloudMigrationService.GetMigration")
 	defer span.End()
-	migration, err := s.store.GetMigrationByUID(ctx, uid)
+	migration, err := s.store.GetMigrationSessionByUID(ctx, uid)
 	if err != nil {
 		return nil, err
 	}
@@ -326,25 +326,25 @@ func (s *Service) GetMigration(ctx context.Context, uid string) (*cloudmigration
 	return migration, nil
 }
 
-func (s *Service) GetMigrationList(ctx context.Context) (*cloudmigration.CloudMigrationListResponse, error) {
-	values, err := s.store.GetAllCloudMigrations(ctx)
+func (s *Service) GetSessionList(ctx context.Context) (*cloudmigration.CloudMigrationSessionListResponse, error) {
+	values, err := s.store.GetAllCloudMigrationSessions(ctx)
 	if err != nil {
 		return nil, err
 	}
 
-	migrations := make([]cloudmigration.CloudMigrationResponse, 0)
+	migrations := make([]cloudmigration.CloudMigrationSessionResponse, 0)
 	for _, v := range values {
-		migrations = append(migrations, cloudmigration.CloudMigrationResponse{
+		migrations = append(migrations, cloudmigration.CloudMigrationSessionResponse{
 			UID:     v.UID,
-			Stack:   v.Stack,
+			Slug:    v.Slug,
 			Created: v.Created,
 			Updated: v.Updated,
 		})
 	}
-	return &cloudmigration.CloudMigrationListResponse{Migrations: migrations}, nil
+	return &cloudmigration.CloudMigrationSessionListResponse{Sessions: migrations}, nil
 }
 
-func (s *Service) CreateMigration(ctx context.Context, cmd cloudmigration.CloudMigrationRequest) (*cloudmigration.CloudMigrationResponse, error) {
+func (s *Service) CreateSession(ctx context.Context, cmd cloudmigration.CloudMigrationSessionRequest) (*cloudmigration.CloudMigrationSessionResponse, error) {
 	ctx, span := s.tracer.Start(ctx, "CloudMigrationService.createMigration")
 	defer span.End()
 
@@ -359,32 +359,27 @@ func (s *Service) CreateMigration(ctx context.Context, cmd cloudmigration.CloudM
 	}
 
 	migration := token.ToMigration()
-	// validate token against cms before saving
+	// validate token against GMS before saving
 	if err := s.ValidateToken(ctx, migration); err != nil {
 		return nil, fmt.Errorf("token validation: %w", err)
 	}
 
-	cm, err := s.store.CreateMigration(ctx, migration)
+	cm, err := s.store.CreateMigrationSession(ctx, migration)
 	if err != nil {
 		return nil, fmt.Errorf("error creating migration: %w", err)
 	}
 
-	return &cloudmigration.CloudMigrationResponse{
+	return &cloudmigration.CloudMigrationSessionResponse{
 		UID:     cm.UID,
-		Stack:   token.Instance.Slug,
+		Slug:    token.Instance.Slug,
 		Created: cm.Created,
 		Updated: cm.Updated,
 	}, nil
 }
 
-func (s *Service) UpdateMigration(ctx context.Context, uid string, request cloudmigration.CloudMigrationRequest) (*cloudmigration.CloudMigrationResponse, error) {
-	// TODO: Implement method
-	return nil, nil
-}
-
-func (s *Service) RunMigration(ctx context.Context, uid string) (*cloudmigration.MigrateDataResponseDTO, error) {
+func (s *Service) RunMigration(ctx context.Context, uid string) (*cloudmigration.MigrateDataResponse, error) {
 	// Get migration to read the auth token
-	migration, err := s.GetMigration(ctx, uid)
+	migration, err := s.GetSession(ctx, uid)
 	if err != nil {
 		return nil, fmt.Errorf("migration get error: %w", err)
 	}
@@ -396,8 +391,8 @@ func (s *Service) RunMigration(ctx context.Context, uid string) (*cloudmigration
 		return nil, fmt.Errorf("migration data get error: %w", err)
 	}
 
-	// Call the cms service
-	resp, err := s.cmsClient.MigrateData(ctx, *migration, *request)
+	// Call the gms service
+	resp, err := s.gmsClient.MigrateData(ctx, *migration, *request)
 	if err != nil {
 		s.log.Error("error migrating data: %w", err)
 		return nil, fmt.Errorf("migrate data error: %w", err)
@@ -411,9 +406,9 @@ func (s *Service) RunMigration(ctx context.Context, uid string) (*cloudmigration
 	}
 
 	// save the result of the migration
-	runUID, err := s.createMigrationRun(ctx, cloudmigration.CloudMigrationRun{
-		CloudMigrationUID: migration.UID,
-		Result:            respData,
+	runUID, err := s.createMigrationRun(ctx, cloudmigration.CloudMigrationSnapshot{
+		SessionUID: migration.UID,
+		Result:     respData,
 	})
 	if err != nil {
 		response.Error(http.StatusInternalServerError, "migration run save error", err)
@@ -424,8 +419,8 @@ func (s *Service) RunMigration(ctx context.Context, uid string) (*cloudmigration
 	return resp, nil
 }
 
-func (s *Service) getMigrationDataJSON(ctx context.Context) (*cloudmigration.MigrateDataRequestDTO, error) {
-	var migrationDataSlice []cloudmigration.MigrateDataRequestItemDTO
+func (s *Service) getMigrationDataJSON(ctx context.Context) (*cloudmigration.MigrateDataRequest, error) {
+	var migrationDataSlice []cloudmigration.MigrateDataRequestItem
 	// Data sources
 	dataSources, err := s.getDataSources(ctx)
 	if err != nil {
@@ -433,7 +428,7 @@ func (s *Service) getMigrationDataJSON(ctx context.Context) (*cloudmigration.Mig
 		return nil, err
 	}
 	for _, ds := range dataSources {
-		migrationDataSlice = append(migrationDataSlice, cloudmigration.MigrateDataRequestItemDTO{
+		migrationDataSlice = append(migrationDataSlice, cloudmigration.MigrateDataRequestItem{
 			Type:  cloudmigration.DatasourceDataType,
 			RefID: ds.UID,
 			Name:  ds.Name,
@@ -450,7 +445,7 @@ func (s *Service) getMigrationDataJSON(ctx context.Context) (*cloudmigration.Mig
 
 	for _, dashboard := range dashboards {
 		dashboard.Data.Del("id")
-		migrationDataSlice = append(migrationDataSlice, cloudmigration.MigrateDataRequestItemDTO{
+		migrationDataSlice = append(migrationDataSlice, cloudmigration.MigrateDataRequestItem{
 			Type:  cloudmigration.DashboardDataType,
 			RefID: dashboard.UID,
 			Name:  dashboard.Title,
@@ -466,14 +461,14 @@ func (s *Service) getMigrationDataJSON(ctx context.Context) (*cloudmigration.Mig
 	}
 
 	for _, f := range folders {
-		migrationDataSlice = append(migrationDataSlice, cloudmigration.MigrateDataRequestItemDTO{
+		migrationDataSlice = append(migrationDataSlice, cloudmigration.MigrateDataRequestItem{
 			Type:  cloudmigration.FolderDataType,
 			RefID: f.UID,
 			Name:  f.Title,
 			Data:  f,
 		})
 	}
-	migrationData := &cloudmigration.MigrateDataRequestDTO{
+	migrationData := &cloudmigration.MigrateDataRequest{
 		Items: migrationDataSlice,
 	}
 
@@ -547,7 +542,7 @@ func (s *Service) getDashboards(ctx context.Context) ([]dashboards.Dashboard, er
 	return result, nil
 }
 
-func (s *Service) createMigrationRun(ctx context.Context, cmr cloudmigration.CloudMigrationRun) (string, error) {
+func (s *Service) createMigrationRun(ctx context.Context, cmr cloudmigration.CloudMigrationSnapshot) (string, error) {
 	uid, err := s.store.CreateMigrationRun(ctx, cmr)
 	if err != nil {
 		s.log.Error("Failed to save migration run", "err", err)
@@ -556,7 +551,7 @@ func (s *Service) createMigrationRun(ctx context.Context, cmr cloudmigration.Clo
 	return uid, nil
 }
 
-func (s *Service) GetMigrationStatus(ctx context.Context, runUID string) (*cloudmigration.CloudMigrationRun, error) {
+func (s *Service) GetMigrationStatus(ctx context.Context, runUID string) (*cloudmigration.CloudMigrationSnapshot, error) {
 	cmr, err := s.store.GetMigrationStatus(ctx, runUID)
 	if err != nil {
 		return nil, fmt.Errorf("retrieving migration status from db: %w", err)
@@ -564,15 +559,15 @@ func (s *Service) GetMigrationStatus(ctx context.Context, runUID string) (*cloud
 	return cmr, nil
 }
 
-func (s *Service) GetMigrationRunList(ctx context.Context, migUID string) (*cloudmigration.CloudMigrationRunList, error) {
+func (s *Service) GetMigrationRunList(ctx context.Context, migUID string) (*cloudmigration.SnapshotList, error) {
 	runs, err := s.store.GetMigrationStatusList(ctx, migUID)
 	if err != nil {
 		return nil, fmt.Errorf("retrieving migration statuses from db: %w", err)
 	}
 
-	runList := &cloudmigration.CloudMigrationRunList{Runs: []cloudmigration.MigrateDataResponseListDTO{}}
+	runList := &cloudmigration.SnapshotList{Runs: []cloudmigration.MigrateDataResponseList{}}
 	for _, s := range runs {
-		runList.Runs = append(runList.Runs, cloudmigration.MigrateDataResponseListDTO{
+		runList.Runs = append(runList.Runs, cloudmigration.MigrateDataResponseList{
 			RunUID: s.UID,
 		})
 	}
@@ -580,8 +575,8 @@ func (s *Service) GetMigrationRunList(ctx context.Context, migUID string) (*clou
 	return runList, nil
 }
 
-func (s *Service) DeleteMigration(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error) {
-	c, err := s.store.DeleteMigration(ctx, uid)
+func (s *Service) DeleteSession(ctx context.Context, uid string) (*cloudmigration.CloudMigrationSession, error) {
+	c, err := s.store.DeleteMigrationSessionByUID(ctx, uid)
 	if err != nil {
 		return c, fmt.Errorf("deleting migration from db: %w", err)
 	}

pkg/services/cloudmigration/cloudmigrationimpl/cloudmigration_noop.go

@@ -24,42 +24,38 @@ func (s *NoopServiceImpl) DeleteToken(ctx context.Context, uid string) error {
 	return cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) ValidateToken(ctx context.Context, cm cloudmigration.CloudMigration) error {
+func (s *NoopServiceImpl) ValidateToken(ctx context.Context, cm cloudmigration.CloudMigrationSession) error {
 	return cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) GetMigration(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error) {
+func (s *NoopServiceImpl) GetSession(ctx context.Context, uid string) (*cloudmigration.CloudMigrationSession, error) {
 	return nil, cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) GetMigrationList(ctx context.Context) (*cloudmigration.CloudMigrationListResponse, error) {
+func (s *NoopServiceImpl) GetSessionList(ctx context.Context) (*cloudmigration.CloudMigrationSessionListResponse, error) {
 	return nil, cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) CreateMigration(ctx context.Context, cm cloudmigration.CloudMigrationRequest) (*cloudmigration.CloudMigrationResponse, error) {
+func (s *NoopServiceImpl) CreateSession(ctx context.Context, cm cloudmigration.CloudMigrationSessionRequest) (*cloudmigration.CloudMigrationSessionResponse, error) {
 	return nil, cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) UpdateMigration(ctx context.Context, uid string, cm cloudmigration.CloudMigrationRequest) (*cloudmigration.CloudMigrationResponse, error) {
+func (s *NoopServiceImpl) GetMigrationStatus(ctx context.Context, runUID string) (*cloudmigration.CloudMigrationSnapshot, error) {
 	return nil, cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) GetMigrationStatus(ctx context.Context, runUID string) (*cloudmigration.CloudMigrationRun, error) {
+func (s *NoopServiceImpl) GetMigrationRunList(ctx context.Context, uid string) (*cloudmigration.SnapshotList, error) {
 	return nil, cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) GetMigrationRunList(ctx context.Context, uid string) (*cloudmigration.CloudMigrationRunList, error) {
+func (s *NoopServiceImpl) DeleteSession(ctx context.Context, uid string) (*cloudmigration.CloudMigrationSession, error) {
 	return nil, cloudmigration.ErrFeatureDisabledError
 }
 
-func (s *NoopServiceImpl) DeleteMigration(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error) {
-	return nil, cloudmigration.ErrFeatureDisabledError
-}
-
-func (s *NoopServiceImpl) CreateMigrationRun(context.Context, cloudmigration.CloudMigrationRun) (string, error) {
+func (s *NoopServiceImpl) CreateMigrationRun(context.Context, cloudmigration.CloudMigrationSnapshot) (string, error) {
 	return "", cloudmigration.ErrInternalNotImplementedError
 }
 
-func (s *NoopServiceImpl) RunMigration(context.Context, string) (*cloudmigration.MigrateDataResponseDTO, error) {
+func (s *NoopServiceImpl) RunMigration(context.Context, string) (*cloudmigration.MigrateDataResponse, error) {
 	return nil, cloudmigration.ErrFeatureDisabledError
 }

pkg/services/cloudmigration/cloudmigrationimpl/cloudmigration_test.go

@@ -50,7 +50,7 @@ func Test_CreateGetAndDeleteToken(t *testing.T) {
 	_, err = s.GetToken(context.Background())
 	assert.ErrorIs(t, cloudmigration.ErrTokenNotFound, err)
 
-	cm := cloudmigration.CloudMigration{}
+	cm := cloudmigration.CloudMigrationSession{}
 	err = s.ValidateToken(context.Background(), cm)
 	assert.NoError(t, err)
 }
@@ -62,27 +62,27 @@ func Test_CreateGetRunMigrationsAndRuns(t *testing.T) {
 	assert.NoError(t, err)
 	assert.NotEmpty(t, createTokenResp.Token)
 
-	cmd := cloudmigration.CloudMigrationRequest{
+	cmd := cloudmigration.CloudMigrationSessionRequest{
 		AuthToken: createTokenResp.Token,
 	}
 
-	createResp, err := s.CreateMigration(context.Background(), cmd)
+	createResp, err := s.CreateSession(context.Background(), cmd)
 	require.NoError(t, err)
 	require.NotEmpty(t, createResp.UID)
-	require.NotEmpty(t, createResp.Stack)
+	require.NotEmpty(t, createResp.Slug)
 
-	getMigResp, err := s.GetMigration(context.Background(), createResp.UID)
+	getMigResp, err := s.GetSession(context.Background(), createResp.UID)
 	require.NoError(t, err)
 	require.NotNil(t, getMigResp)
 	require.Equal(t, createResp.UID, getMigResp.UID)
-	require.Equal(t, createResp.Stack, getMigResp.Stack)
+	require.Equal(t, createResp.Slug, getMigResp.Slug)
 
-	listResp, err := s.GetMigrationList(context.Background())
+	listResp, err := s.GetSessionList(context.Background())
 	require.NoError(t, err)
 	require.NotNil(t, listResp)
-	require.Equal(t, 1, len(listResp.Migrations))
-	require.Equal(t, createResp.UID, listResp.Migrations[0].UID)
-	require.Equal(t, createResp.Stack, listResp.Migrations[0].Stack)
+	require.Equal(t, 1, len(listResp.Sessions))
+	require.Equal(t, createResp.UID, listResp.Sessions[0].UID)
+	require.Equal(t, createResp.Slug, listResp.Sessions[0].Slug)
 
 	runResp, err := s.RunMigration(ctxWithSignedInUser(), createResp.UID)
 	require.NoError(t, err)
@@ -104,7 +104,7 @@ func Test_CreateGetRunMigrationsAndRuns(t *testing.T) {
 	require.Equal(t, 1, len(listRunResp.Runs))
 	require.Equal(t, runResp.RunUID, listRunResp.Runs[0].RunUID)
 
-	delMigResp, err := s.DeleteMigration(context.Background(), createResp.UID)
+	delMigResp, err := s.DeleteSession(context.Background(), createResp.UID)
 	require.NoError(t, err)
 	require.NotNil(t, createResp.UID, delMigResp.UID)
 }

pkg/services/cloudmigration/cloudmigrationimpl/fake/cloudmigration_fake.go

@@ -33,7 +33,7 @@ func (m FakeServiceImpl) CreateToken(_ context.Context) (cloudmigration.CreateAc
 	return cloudmigration.CreateAccessTokenResponse{Token: "mock_token"}, nil
 }
 
-func (m FakeServiceImpl) ValidateToken(ctx context.Context, migration cloudmigration.CloudMigration) error {
+func (m FakeServiceImpl) ValidateToken(ctx context.Context, migration cloudmigration.CloudMigrationSession) error {
 	panic("implement me")
 }
 
@@ -44,49 +44,45 @@ func (m FakeServiceImpl) DeleteToken(_ context.Context, _ string) error {
 	return nil
 }
 
-func (m FakeServiceImpl) CreateMigration(_ context.Context, _ cloudmigration.CloudMigrationRequest) (*cloudmigration.CloudMigrationResponse, error) {
+func (m FakeServiceImpl) CreateSession(_ context.Context, _ cloudmigration.CloudMigrationSessionRequest) (*cloudmigration.CloudMigrationSessionResponse, error) {
 	if m.ReturnError {
 		return nil, fmt.Errorf("mock error")
 	}
-	return &cloudmigration.CloudMigrationResponse{
+	return &cloudmigration.CloudMigrationSessionResponse{
 		UID:     "fake_uid",
-		Stack:   "fake_stack",
+		Slug:    "fake_stack",
 		Created: fixedDate,
 		Updated: fixedDate,
 	}, nil
 }
 
-func (m FakeServiceImpl) GetMigration(_ context.Context, _ string) (*cloudmigration.CloudMigration, error) {
+func (m FakeServiceImpl) GetSession(_ context.Context, _ string) (*cloudmigration.CloudMigrationSession, error) {
 	if m.ReturnError {
 		return nil, fmt.Errorf("mock error")
 	}
-	return &cloudmigration.CloudMigration{UID: "fake"}, nil
+	return &cloudmigration.CloudMigrationSession{UID: "fake"}, nil
 }
 
-func (m FakeServiceImpl) DeleteMigration(_ context.Context, _ string) (*cloudmigration.CloudMigration, error) {
+func (m FakeServiceImpl) DeleteSession(_ context.Context, _ string) (*cloudmigration.CloudMigrationSession, error) {
 	if m.ReturnError {
 		return nil, fmt.Errorf("mock error")
 	}
-	return &cloudmigration.CloudMigration{UID: "fake"}, nil
+	return &cloudmigration.CloudMigrationSession{UID: "fake"}, nil
 }
 
-func (m FakeServiceImpl) UpdateMigration(ctx context.Context, uid string, request cloudmigration.CloudMigrationRequest) (*cloudmigration.CloudMigrationResponse, error) {
-	panic("implement me")
-}
-
-func (m FakeServiceImpl) GetMigrationList(_ context.Context) (*cloudmigration.CloudMigrationListResponse, error) {
+func (m FakeServiceImpl) GetSessionList(_ context.Context) (*cloudmigration.CloudMigrationSessionListResponse, error) {
 	if m.ReturnError {
 		return nil, fmt.Errorf("mock error")
 	}
-	return &cloudmigration.CloudMigrationListResponse{
-		Migrations: []cloudmigration.CloudMigrationResponse{
-			{UID: "mock_uid_1", Stack: "mock_stack_1", Created: fixedDate, Updated: fixedDate},
-			{UID: "mock_uid_2", Stack: "mock_stack_2", Created: fixedDate, Updated: fixedDate},
+	return &cloudmigration.CloudMigrationSessionListResponse{
+		Sessions: []cloudmigration.CloudMigrationSessionResponse{
+			{UID: "mock_uid_1", Slug: "mock_stack_1", Created: fixedDate, Updated: fixedDate},
+			{UID: "mock_uid_2", Slug: "mock_stack_2", Created: fixedDate, Updated: fixedDate},
 		},
 	}, nil
 }
 
-func (m FakeServiceImpl) RunMigration(_ context.Context, _ string) (*cloudmigration.MigrateDataResponseDTO, error) {
+func (m FakeServiceImpl) RunMigration(_ context.Context, _ string) (*cloudmigration.MigrateDataResponse, error) {
 	if m.ReturnError {
 		return nil, fmt.Errorf("mock error")
 	}
@@ -94,20 +90,20 @@ func (m FakeServiceImpl) RunMigration(_ context.Context, _ string) (*cloudmigrat
 	return &r, nil
 }
 
-func fakeMigrateDataResponseDTO() cloudmigration.MigrateDataResponseDTO {
-	return cloudmigration.MigrateDataResponseDTO{
+func fakeMigrateDataResponseDTO() cloudmigration.MigrateDataResponse {
+	return cloudmigration.MigrateDataResponse{
 		RunUID: "fake_uid",
-		Items: []cloudmigration.MigrateDataResponseItemDTO{
+		Items: []cloudmigration.MigrateDataResponseItem{
 			{Type: "type", RefID: "make_refid", Status: "ok", Error: "none"},
 		},
 	}
 }
 
-func (m FakeServiceImpl) CreateMigrationRun(ctx context.Context, run cloudmigration.CloudMigrationRun) (string, error) {
+func (m FakeServiceImpl) CreateMigrationRun(ctx context.Context, run cloudmigration.CloudMigrationSnapshot) (string, error) {
 	panic("implement me")
 }
 
-func (m FakeServiceImpl) GetMigrationStatus(_ context.Context, _ string) (*cloudmigration.CloudMigrationRun, error) {
+func (m FakeServiceImpl) GetMigrationStatus(_ context.Context, _ string) (*cloudmigration.CloudMigrationSnapshot, error) {
 	if m.ReturnError {
 		return nil, fmt.Errorf("mock error")
 	}
@@ -115,23 +111,23 @@ func (m FakeServiceImpl) GetMigrationStatus(_ context.Context, _ string) (*cloud
 	if err != nil {
 		return nil, err
 	}
-	return &cloudmigration.CloudMigrationRun{
-		ID:                0,
-		UID:               "fake_uid",
-		CloudMigrationUID: "fake_mig_uid",
-		Result:            result,
-		Created:           fixedDate,
-		Updated:           fixedDate,
-		Finished:          fixedDate,
+	return &cloudmigration.CloudMigrationSnapshot{
+		ID:         0,
+		UID:        "fake_uid",
+		SessionUID: "fake_mig_uid",
+		Result:     result,
+		Created:    fixedDate,
+		Updated:    fixedDate,
+		Finished:   fixedDate,
 	}, nil
 }
 
-func (m FakeServiceImpl) GetMigrationRunList(_ context.Context, _ string) (*cloudmigration.CloudMigrationRunList, error) {
+func (m FakeServiceImpl) GetMigrationRunList(_ context.Context, _ string) (*cloudmigration.SnapshotList, error) {
 	if m.ReturnError {
 		return nil, fmt.Errorf("mock error")
 	}
-	return &cloudmigration.CloudMigrationRunList{
-		Runs: []cloudmigration.MigrateDataResponseListDTO{
+	return &cloudmigration.SnapshotList{
+		Runs: []cloudmigration.MigrateDataResponseList{
 			{RunUID: "fake_run_uid_1"},
 			{RunUID: "fake_run_uid_2"},
 		},

pkg/services/cloudmigration/cloudmigrationimpl/store.go

@@ -7,12 +7,12 @@ import (
 )
 
 type store interface {
-	CreateMigration(ctx context.Context, token cloudmigration.CloudMigration) (*cloudmigration.CloudMigration, error)
-	GetMigrationByUID(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error)
-	GetAllCloudMigrations(ctx context.Context) ([]*cloudmigration.CloudMigration, error)
-	DeleteMigration(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error)
+	CreateMigrationSession(ctx context.Context, session cloudmigration.CloudMigrationSession) (*cloudmigration.CloudMigrationSession, error)
+	GetMigrationSessionByUID(ctx context.Context, uid string) (*cloudmigration.CloudMigrationSession, error)
+	GetAllCloudMigrationSessions(ctx context.Context) ([]*cloudmigration.CloudMigrationSession, error)
+	DeleteMigrationSessionByUID(ctx context.Context, uid string) (*cloudmigration.CloudMigrationSession, error)
 
-	CreateMigrationRun(ctx context.Context, cmr cloudmigration.CloudMigrationRun) (string, error)
-	GetMigrationStatus(ctx context.Context, cmrUID string) (*cloudmigration.CloudMigrationRun, error)
-	GetMigrationStatusList(ctx context.Context, migrationUID string) ([]*cloudmigration.CloudMigrationRun, error)
+	CreateMigrationRun(ctx context.Context, cmr cloudmigration.CloudMigrationSnapshot) (string, error)
+	GetMigrationStatus(ctx context.Context, cmrUID string) (*cloudmigration.CloudMigrationSnapshot, error)
+	GetMigrationStatusList(ctx context.Context, migrationUID string) ([]*cloudmigration.CloudMigrationSnapshot, error)
 }

pkg/services/cloudmigration/cloudmigrationimpl/xorm_store.go

@@ -20,8 +20,8 @@ type sqlStore struct {
 	secretsService secrets.Service
 }
 
-func (ss *sqlStore) GetMigrationByUID(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error) {
-	var cm cloudmigration.CloudMigration
+func (ss *sqlStore) GetMigrationSessionByUID(ctx context.Context, uid string) (*cloudmigration.CloudMigrationSession, error) {
+	var cm cloudmigration.CloudMigrationSession
 	err := ss.db.WithDbSession(ctx, func(sess *db.Session) error {
 		exist, err := sess.Where("uid=?", uid).Get(&cm)
 		if err != nil {
@@ -40,7 +40,7 @@ func (ss *sqlStore) GetMigrationByUID(ctx context.Context, uid string) (*cloudmi
 	return &cm, err
 }
 
-func (ss *sqlStore) CreateMigrationRun(ctx context.Context, cmr cloudmigration.CloudMigrationRun) (string, error) {
+func (ss *sqlStore) CreateMigrationRun(ctx context.Context, cmr cloudmigration.CloudMigrationSnapshot) (string, error) {
 	err := ss.db.WithDbSession(ctx, func(sess *db.Session) error {
 		cmr.Created = time.Now()
 		cmr.Updated = time.Now()
@@ -56,7 +56,7 @@ func (ss *sqlStore) CreateMigrationRun(ctx context.Context, cmr cloudmigration.C
 	return cmr.UID, nil
 }
 
-func (ss *sqlStore) CreateMigration(ctx context.Context, migration cloudmigration.CloudMigration) (*cloudmigration.CloudMigration, error) {
+func (ss *sqlStore) CreateMigrationSession(ctx context.Context, migration cloudmigration.CloudMigrationSession) (*cloudmigration.CloudMigrationSession, error) {
 	if err := ss.encryptToken(ctx, &migration); err != nil {
 		return nil, err
 	}
@@ -78,8 +78,8 @@ func (ss *sqlStore) CreateMigration(ctx context.Context, migration cloudmigratio
 	return &migration, nil
 }
 
-func (ss *sqlStore) GetAllCloudMigrations(ctx context.Context) ([]*cloudmigration.CloudMigration, error) {
-	var migrations = make([]*cloudmigration.CloudMigration, 0)
+func (ss *sqlStore) GetAllCloudMigrationSessions(ctx context.Context) ([]*cloudmigration.CloudMigrationSession, error) {
+	var migrations = make([]*cloudmigration.CloudMigrationSession, 0)
 	err := ss.db.WithDbSession(ctx, func(sess *db.Session) error { return sess.Find(&migrations) })
 	if err != nil {
 		return nil, err
@@ -95,8 +95,8 @@ func (ss *sqlStore) GetAllCloudMigrations(ctx context.Context) ([]*cloudmigratio
 	return migrations, nil
 }
 
-func (ss *sqlStore) DeleteMigration(ctx context.Context, uid string) (*cloudmigration.CloudMigration, error) {
-	var c cloudmigration.CloudMigration
+func (ss *sqlStore) DeleteMigrationSessionByUID(ctx context.Context, uid string) (*cloudmigration.CloudMigrationSession, error) {
+	var c cloudmigration.CloudMigrationSession
 	err := ss.db.WithDbSession(ctx, func(sess *db.Session) error {
 		exist, err := sess.Where("uid=?", uid).Get(&c)
 		if err != nil {
@@ -106,7 +106,7 @@ func (ss *sqlStore) DeleteMigration(ctx context.Context, uid string) (*cloudmigr
 			return cloudmigration.ErrMigrationNotFound
 		}
 		id := c.ID
-		affected, err := sess.Delete(&cloudmigration.CloudMigration{
+		affected, err := sess.Delete(&cloudmigration.CloudMigrationSession{
 			ID: id,
 		})
 		if affected == 0 {
@@ -118,8 +118,8 @@ func (ss *sqlStore) DeleteMigration(ctx context.Context, uid string) (*cloudmigr
 	return &c, err
 }
 
-func (ss *sqlStore) GetMigrationStatus(ctx context.Context, cmrUID string) (*cloudmigration.CloudMigrationRun, error) {
-	var c cloudmigration.CloudMigrationRun
+func (ss *sqlStore) GetMigrationStatus(ctx context.Context, cmrUID string) (*cloudmigration.CloudMigrationSnapshot, error) {
+	var c cloudmigration.CloudMigrationSnapshot
 	err := ss.db.WithDbSession(ctx, func(sess *db.Session) error {
 		exist, err := sess.Where("uid=?", cmrUID).Get(&c)
 		if err != nil {
@@ -133,11 +133,11 @@ func (ss *sqlStore) GetMigrationStatus(ctx context.Context, cmrUID string) (*clo
 	return &c, err
 }
 
-func (ss *sqlStore) GetMigrationStatusList(ctx context.Context, migrationUID string) ([]*cloudmigration.CloudMigrationRun, error) {
-	var runs = make([]*cloudmigration.CloudMigrationRun, 0)
+func (ss *sqlStore) GetMigrationStatusList(ctx context.Context, migrationUID string) ([]*cloudmigration.CloudMigrationSnapshot, error) {
+	var runs = make([]*cloudmigration.CloudMigrationSnapshot, 0)
 	err := ss.db.WithDbSession(ctx, func(sess *db.Session) error {
-		return sess.Find(&runs, &cloudmigration.CloudMigrationRun{
-			CloudMigrationUID: migrationUID,
+		return sess.Find(&runs, &cloudmigration.CloudMigrationSnapshot{
+			SessionUID: migrationUID,
 		})
 	})
 	if err != nil {
@@ -146,7 +146,7 @@ func (ss *sqlStore) GetMigrationStatusList(ctx context.Context, migrationUID str
 	return runs, nil
 }
 
-func (ss *sqlStore) encryptToken(ctx context.Context, cm *cloudmigration.CloudMigration) error {
+func (ss *sqlStore) encryptToken(ctx context.Context, cm *cloudmigration.CloudMigrationSession) error {
 	s, err := ss.secretsService.Encrypt(ctx, []byte(cm.AuthToken), secrets.WithoutScope())
 	if err != nil {
 		return fmt.Errorf("encrypting auth token: %w", err)
@@ -157,7 +157,7 @@ func (ss *sqlStore) encryptToken(ctx context.Context, cm *cloudmigration.CloudMi
 	return nil
 }
 
-func (ss *sqlStore) decryptToken(ctx context.Context, cm *cloudmigration.CloudMigration) error {
+func (ss *sqlStore) decryptToken(ctx context.Context, cm *cloudmigration.CloudMigrationSession) error {
 	decoded, err := base64.StdEncoding.DecodeString(cm.AuthToken)
 	if err != nil {
 		return fmt.Errorf("token could not be decoded")

pkg/services/cloudmigration/cloudmigrationimpl/xorm_store_test.go

@@ -22,20 +22,20 @@ func Test_GetAllCloudMigrations(t *testing.T) {
 	_, s := setUpTest(t)
 	ctx := context.Background()
 
-	t.Run("get all cloud_migrations", func(t *testing.T) {
-		value, err := s.GetAllCloudMigrations(ctx)
+	t.Run("get all cloud_migration_session entries", func(t *testing.T) {
+		value, err := s.GetAllCloudMigrationSessions(ctx)
 		require.NoError(t, err)
 		require.Equal(t, 3, len(value))
 		for _, m := range value {
 			switch m.ID {
 			case 1:
-				require.Equal(t, "11111", m.Stack)
+				require.Equal(t, "11111", m.Slug)
 				require.Equal(t, "12345", m.AuthToken)
 			case 2:
-				require.Equal(t, "22222", m.Stack)
+				require.Equal(t, "22222", m.Slug)
 				require.Equal(t, "6789", m.AuthToken)
 			case 3:
-				require.Equal(t, "33333", m.Stack)
+				require.Equal(t, "33333", m.Slug)
 				require.Equal(t, "777", m.AuthToken)
 			default:
 				require.Fail(t, "ID value not expected: "+strconv.FormatInt(m.ID, 10))
@@ -49,24 +49,24 @@ func Test_CreateMigration(t *testing.T) {
 	ctx := context.Background()
 
 	t.Run("creates migrations and reads it from the db", func(t *testing.T) {
-		cm := cloudmigration.CloudMigration{
+		cm := cloudmigration.CloudMigrationSession{
 			AuthToken:   encodeToken("token"),
-			Stack:       "fake_stack",
+			Slug:        "fake_stack",
 			StackID:     1234,
 			RegionSlug:  "fake_slug",
 			ClusterSlug: "fake_cluster_slug",
 		}
-		mig, err := s.CreateMigration(ctx, cm)
+		mig, err := s.CreateMigrationSession(ctx, cm)
 		require.NoError(t, err)
 		require.NotEmpty(t, mig.ID)
 		require.NotEmpty(t, mig.UID)
 
-		getRes, err := s.GetMigrationByUID(ctx, mig.UID)
+		getRes, err := s.GetMigrationSessionByUID(ctx, mig.UID)
 		require.NoError(t, err)
 		require.Equal(t, mig.ID, getRes.ID)
 		require.Equal(t, mig.UID, getRes.UID)
 		require.Equal(t, cm.AuthToken, getRes.AuthToken)
-		require.Equal(t, cm.Stack, getRes.Stack)
+		require.Equal(t, cm.Slug, getRes.Slug)
 		require.Equal(t, cm.StackID, getRes.StackID)
 		require.Equal(t, cm.RegionSlug, getRes.RegionSlug)
 		require.Equal(t, cm.ClusterSlug, getRes.ClusterSlug)
@@ -76,15 +76,15 @@ func Test_CreateMigration(t *testing.T) {
 func Test_GetMigrationByUID(t *testing.T) {
 	_, s := setUpTest(t)
 	ctx := context.Background()
-	t.Run("find migration by uid", func(t *testing.T) {
+	t.Run("find session by uid", func(t *testing.T) {
 		uid := "qwerty"
-		mig, err := s.GetMigrationByUID(ctx, uid)
+		mig, err := s.GetMigrationSessionByUID(ctx, uid)
 		require.NoError(t, err)
 		require.Equal(t, uid, mig.UID)
 	})
 
-	t.Run("returns error if migration is not found by uid", func(t *testing.T) {
-		_, err := s.GetMigrationByUID(ctx, "fake_uid_1234")
+	t.Run("returns error if session is not found by uid", func(t *testing.T) {
+		_, err := s.GetMigrationSessionByUID(ctx, "fake_uid_1234")
 		require.ErrorIs(t, cloudmigration.ErrMigrationNotFound, err)
 	})
 }
@@ -93,14 +93,14 @@ func Test_DeleteMigration(t *testing.T) {
 	_, s := setUpTest(t)
 	ctx := context.Background()
 
-	t.Run("deletes a migration from the db", func(t *testing.T) {
+	t.Run("deletes a session from the db", func(t *testing.T) {
 		uid := "qwerty"
-		delResp, err := s.DeleteMigration(ctx, uid)
+		delResp, err := s.DeleteMigrationSessionByUID(ctx, uid)
 		require.NoError(t, err)
 		require.Equal(t, uid, delResp.UID)
 
 		// now we try to find it, should return an error
-		_, err = s.GetMigrationByUID(ctx, uid)
+		_, err = s.GetMigrationSessionByUID(ctx, uid)
 		require.ErrorIs(t, cloudmigration.ErrMigrationNotFound, err)
 	})
 }
@@ -109,11 +109,11 @@ func Test_CreateMigrationRun(t *testing.T) {
 	_, s := setUpTest(t)
 	ctx := context.Background()
 
-	t.Run("creates a migration run and retrieves it from db", func(t *testing.T) {
+	t.Run("creates a session run and retrieves it from db", func(t *testing.T) {
 		result := []byte("OK")
-		cmr := cloudmigration.CloudMigrationRun{
-			CloudMigrationUID: "asdfg",
-			Result:            result,
+		cmr := cloudmigration.CloudMigrationSnapshot{
+			SessionUID: "asdfg",
+			Result:     result,
 		}
 
 		createResp, err := s.CreateMigrationRun(ctx, cmr)
@@ -173,7 +173,7 @@ func setUpTest(t *testing.T) (*sqlstore.SQLStore, *sqlStore) {
 	// insert cloud migration test data
 	_, err := testDB.GetSqlxSession().Exec(ctx, `
  			INSERT INTO
- 			    cloud_migration (id, uid, auth_token, stack, stack_id, region_slug, cluster_slug, created, updated)
+ 			    cloud_migration_session (id, uid, auth_token, slug, stack_id, region_slug, cluster_slug, created, updated)
  			VALUES
  			    (1,'qwerty', ?, '11111', 11111, 'test', 'test', '2024-03-25 15:30:36.000', '2024-03-27 15:30:43.000'),
   				(2,'asdfgh', ?, '22222', 22222, 'test', 'test', '2024-03-25 15:30:36.000', '2024-03-27 15:30:43.000'),
@@ -188,7 +188,7 @@ func setUpTest(t *testing.T) (*sqlstore.SQLStore, *sqlStore) {
 	// insert cloud migration run test data
 	_, err = testDB.GetSqlxSession().Exec(ctx, `
  			INSERT INTO
- 			    cloud_migration_run (cloud_migration_uid, uid, result, created, updated, finished)
+ 			    cloud_migration_snapshot (session_uid, uid, result, created, updated, finished)
  			VALUES
  			    ('qwerty', 'poiuy', ?, '2024-03-25 15:30:36.000', '2024-03-27 15:30:43.000', '2024-03-27 15:30:43.000'),
   				('qwerty', 'lkjhg', ?, '2024-03-25 15:30:36.000', '2024-03-27 15:30:43.000', '2024-03-27 15:30:43.000'),