Fixes 2896: refactor pulp client in dao (#438)

* Fixes 2896: refactor pulp client in dao

* add mock helper methods

* make copy of receiver

* fix tests

Author: rverdile

cmd/external-repos/main.go

@@ -201,7 +201,7 @@ func enqueueSnapshotRepos(urls *[]string) error {
 	}
 	c := client.NewTaskClient(&q)
 
-	repoConfigDao := dao.GetRepositoryConfigDao(db.DB)
+	repoConfigDao := dao.GetRepositoryConfigDao(db.DB, pulp_client.GetPulpClientWithDomain(context.Background(), ""))
 	var filter *dao.ListRepoFilter
 	if urls != nil {
 		filter = &dao.ListRepoFilter{

hammer.py

@@ -24,16 +24,22 @@ type DaoRegistry struct {
 func GetDaoRegistry(db *gorm.DB) *DaoRegistry {
 	reg := DaoRegistry{
 		RepositoryConfig: &repositoryConfigDaoImpl{
-			db:      db,
-			yumRepo: &yum.Repository{},
+			db:         db,
+			yumRepo:    &yum.Repository{},
+			pulpClient: pulp_client.GetPulpClientWithDomain(context.Background(), ""),
+			ctx:        context.Background(),
 		},
 		Rpm:        rpmDaoImpl{db: db},
 		Repository: repositoryDaoImpl{db: db},
 		Metrics:    metricsDaoImpl{db: db},
-		Snapshot:   &snapshotDaoImpl{db: db},
-		TaskInfo:   taskInfoDaoImpl{db: db},
-		AdminTask:  adminTaskInfoDaoImpl{db: db, pulpClient: pulp_client.GetGlobalPulpClient(context.Background())},
-		Domain:     domainDaoImpl{db: db},
+		Snapshot: &snapshotDaoImpl{
+			db:         db,
+			pulpClient: pulp_client.GetPulpClientWithDomain(context.Background(), ""),
+			ctx:        context.Background(),
+		},
+		TaskInfo:  taskInfoDaoImpl{db: db},
+		AdminTask: adminTaskInfoDaoImpl{db: db, pulpClient: pulp_client.GetGlobalPulpClient(context.Background())},
+		Domain:    domainDaoImpl{db: db},
 	}
 	return &reg
 }
@@ -55,7 +61,7 @@ type RepositoryConfigDao interface {
 	InternalOnly_FetchRepoConfigsForRepoUUID(uuid string) []api.RepositoryResponse
 	UpdateLastSnapshotTask(taskUUID string, orgID string, repoUUID string) error
 	InternalOnly_RefreshRedHatRepo(request api.RepositoryRequest) (*api.RepositoryResponse, error)
-	InitializePulpClient(ctx context.Context, orgID string) error
+	WithContext(ctx context.Context) RepositoryConfigDao
 }
 
 //go:generate mockery --name RpmDao --filename rpms_mock.go --inpackage
@@ -84,7 +90,7 @@ type SnapshotDao interface {
 	Delete(snapUUID string) error
 	FetchLatestSnapshot(repoConfigUUID string) (api.SnapshotResponse, error)
 	GetRepositoryConfigurationFile(orgID, snapshotUUID, repoConfigUUID string) (string, error)
-	InitializePulpClient(ctx context.Context, orgID string) error
+	WithContext(ctx context.Context) SnapshotDao
 }
 
 //go:generate mockery --name MetricsDao --filename metrics_mock.go --inpackage

pkg/dao/interfaces.go

@@ -0,0 +1,13 @@
+package dao
+
+import "github.com/stretchr/testify/mock"
+
+func (m *MockRepositoryConfigDao) WithContextMock() *MockRepositoryConfigDao {
+	m.On("WithContext", mock.AnythingOfType("*context.valueCtx")).Return(m)
+	return m
+}
+
+func (m *MockSnapshotDao) WithContextMock() *MockSnapshotDao {
+	m.On("WithContext", mock.AnythingOfType("*context.valueCtx")).Return(m)
+	return m
+}

pkg/dao/mock_helpers.go

@@ -28,16 +28,10 @@ type repositoryConfigDaoImpl struct {
 	db         *gorm.DB
 	yumRepo    yum.YumRepository
 	pulpClient pulp_client.PulpClient
+	ctx        context.Context
 }
 
-func GetRepositoryConfigDao(db *gorm.DB) RepositoryConfigDao {
-	return &repositoryConfigDaoImpl{
-		db:      db,
-		yumRepo: &yum.Repository{},
-	}
-}
-
-func GetRepositoryConfigDaoWithPulpClient(db *gorm.DB, pulpClient pulp_client.PulpClient) RepositoryConfigDao {
+func GetRepositoryConfigDao(db *gorm.DB, pulpClient pulp_client.PulpClient) RepositoryConfigDao {
 	return &repositoryConfigDaoImpl{
 		db:         db,
 		yumRepo:    &yum.Repository{},
@@ -79,20 +73,10 @@ func DBErrorToApi(e error) *ce.DaoError {
 	}
 }
 
-func (r *repositoryConfigDaoImpl) InitializePulpClient(ctx context.Context, orgID string) error {
-	if !config.Get().Features.Snapshots.Enabled {
-		return nil
-	}
-
-	dDao := GetDomainDao(r.db)
-	domainName, err := dDao.Fetch(orgID)
-	if err != nil {
-		return err
-	}
-
-	pulpClient := pulp_client.GetPulpClientWithDomain(context.TODO(), domainName)
-	r.pulpClient = pulpClient
-	return nil
+func (r *repositoryConfigDaoImpl) WithContext(ctx context.Context) RepositoryConfigDao {
+	cpy := *r
+	cpy.ctx = ctx
+	return &cpy
 }
 
 func (r repositoryConfigDaoImpl) Create(newRepoReq api.RepositoryRequest) (api.RepositoryResponse, error) {
@@ -265,7 +249,6 @@ func (r repositoryConfigDaoImpl) List(
 ) (api.RepositoryCollectionResponse, int64, error) {
 	var totalRepos int64
 	repoConfigs := make([]models.RepositoryConfiguration, 0)
-	var err error
 	var contentPath string
 
 	filteredDB := r.filteredDbForList(OrgID, r.db, filterData)
@@ -304,8 +287,14 @@ func (r repositoryConfigDaoImpl) List(
 		return api.RepositoryCollectionResponse{}, totalRepos, filteredDB.Error
 	}
 
-	if r.pulpClient != nil && config.Get().Features.Snapshots.Enabled {
-		contentPath, err = r.pulpClient.GetContentPath()
+	if config.Get().Features.Snapshots.Enabled {
+		dDao := domainDaoImpl{db: r.db}
+		domain, err := dDao.Fetch(OrgID)
+		if err != nil {
+			return api.RepositoryCollectionResponse{}, totalRepos, err
+		}
+
+		contentPath, err = r.pulpClient.WithContext(r.ctx).WithDomain(domain).GetContentPath()
 		if err != nil {
 			return api.RepositoryCollectionResponse{}, totalRepos, err
 		}
@@ -404,10 +393,12 @@ func (r repositoryConfigDaoImpl) Fetch(orgID string, uuid string) (api.Repositor
 	ModelToApiFields(repoConfig, &repo)
 
 	if repoConfig.LastSnapshot != nil && config.Get().Features.Snapshots.Enabled {
-		if r.pulpClient == nil {
-			return api.RepositoryResponse{}, fmt.Errorf("pulpClient cannot be nil")
+		dDao := domainDaoImpl{db: r.db}
+		domainName, err := dDao.Fetch(orgID)
+		if err != nil {
+			return api.RepositoryResponse{}, err
 		}
-		contentPath, err := r.pulpClient.GetContentPath()
+		contentPath, err := r.pulpClient.WithContext(r.ctx).WithDomain(domainName).GetContentPath()
 		if err != nil {
 			return api.RepositoryResponse{}, err
 		}