chore: garm login to interface

for possible future test cases, the login request towards garm is now also made in the corresponding interface. This will keep the code more straigt and also makes possible test-cases easier to implement. Signed-off-by: Mario Constanti <[email protected]>
mercedes-benz · Sep 18, 2023 · 1d80f35 · 1d80f35
1 parent a35bf35
commit 1d80f35
Show file tree

Hide file tree

Showing 12 changed files with 114 additions and 22 deletions.
diff --git a/internal/controller/enterprise_controller.go b/internal/controller/enterprise_controller.go
@@ -62,7 +62,8 @@ func (r *EnterpriseReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 		return ctrl.Result{}, nil
 	}
 
-	scope, err := garmClient.NewEnterpriseClient(garmClient.GarmScopeParams{
+	enterpriseClient := garmClient.NewEnterpriseClient()
+	err = enterpriseClient.Login(garmClient.GarmScopeParams{
 		BaseURL:  r.BaseURL,
 		Username: r.Username,
 		Password: r.Password,
@@ -74,10 +75,10 @@ func (r *EnterpriseReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 
 	// Handle deleted enterprises
 	if !enterprise.DeletionTimestamp.IsZero() {
-		return r.reconcileDelete(ctx, scope, enterprise)
+		return r.reconcileDelete(ctx, enterpriseClient, enterprise)
 	}
 
-	return r.reconcileNormal(ctx, scope, enterprise)
+	return r.reconcileNormal(ctx, enterpriseClient, enterprise)
 }
 
 func (r *EnterpriseReconciler) reconcileNormal(ctx context.Context, client garmClient.EnterpriseClient, enterprise *garmoperatorv1alpha1.Enterprise) (ctrl.Result, error) {

diff --git a/internal/controller/organization_controller.go b/internal/controller/organization_controller.go
@@ -61,7 +61,8 @@ func (r *OrganizationReconciler) Reconcile(ctx context.Context, req ctrl.Request
 		return ctrl.Result{}, nil
 	}
 
-	scope, err := garmClient.NewOrganizationClient(garmClient.GarmScopeParams{
+	organizationClient := garmClient.NewOrganizationClient()
+	err = organizationClient.Login(garmClient.GarmScopeParams{
 		BaseURL:  r.BaseURL,
 		Username: r.Username,
 		Password: r.Password,
@@ -73,10 +74,10 @@ func (r *OrganizationReconciler) Reconcile(ctx context.Context, req ctrl.Request
 
 	// Handle deleted organizations
 	if !organization.DeletionTimestamp.IsZero() {
-		return r.reconcileDelete(ctx, scope, organization)
+		return r.reconcileDelete(ctx, organizationClient, organization)
 	}
 
-	return r.reconcileNormal(ctx, scope, organization)
+	return r.reconcileNormal(ctx, organizationClient, organization)
 }
 
 func (r *OrganizationReconciler) reconcileNormal(ctx context.Context, client garmClient.OrganizationClient, organization *garmoperatorv1alpha1.Organization) (ctrl.Result, error) {

diff --git a/internal/controller/pool_controller.go b/internal/controller/pool_controller.go
@@ -70,7 +70,8 @@ func (r *PoolReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.
 		return ctrl.Result{}, nil
 	}
 
-	poolClient, err := garmClient.NewPoolClient(garmClient.GarmScopeParams{
+	poolClient := garmClient.NewPoolClient()
+	err := poolClient.Login(garmClient.GarmScopeParams{
 		BaseURL:  r.BaseURL,
 		Username: r.Username,
 		Password: r.Password,

diff --git a/internal/controller/repository_controller.go b/internal/controller/repository_controller.go
@@ -61,7 +61,8 @@ func (r *RepositoryReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 		return ctrl.Result{}, nil
 	}
 
-	scope, err := garmClient.NewRepositoryClient(garmClient.GarmScopeParams{
+	repositoryClient := garmClient.NewRepositoryClient()
+	err = repositoryClient.Login(garmClient.GarmScopeParams{
 		BaseURL:  r.BaseURL,
 		Username: r.Username,
 		Password: r.Password,
@@ -73,10 +74,10 @@ func (r *RepositoryReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 
 	// Handle deleted repositories
 	if !repository.DeletionTimestamp.IsZero() {
-		return r.reconcileDelete(ctx, scope, repository)
+		return r.reconcileDelete(ctx, repositoryClient, repository)
 	}
 
-	return r.reconcileNormal(ctx, scope, repository)
+	return r.reconcileNormal(ctx, repositoryClient, repository)
 }
 
 func (r *RepositoryReconciler) reconcileNormal(ctx context.Context, client garmClient.RepositoryClient, repository *garmoperatorv1alpha1.Repository) (ctrl.Result, error) {

diff --git a/pkg/client/enterprise.go b/pkg/client/enterprise.go
@@ -11,6 +11,7 @@ import (
 )
 
 type EnterpriseClient interface {
+	Login(garmParams GarmScopeParams) error
 	ListEnterprises(param *enterprises.ListEnterprisesParams) (*enterprises.ListEnterprisesOK, error)
 	CreateEnterprise(param *enterprises.CreateEnterpriseParams) (*enterprises.CreateEnterpriseOK, error)
 	GetEnterprise(param *enterprises.GetEnterpriseParams) (*enterprises.GetEnterpriseOK, error)
@@ -23,13 +24,19 @@ type enterpriseClient struct {
 	token  runtime.ClientAuthInfoWriter
 }
 
-func NewEnterpriseClient(garmParams GarmScopeParams) (EnterpriseClient, error) {
+func NewEnterpriseClient() EnterpriseClient {
+	return &enterpriseClient{}
+}
+
+func (s *enterpriseClient) Login(garmParams GarmScopeParams) error {
 	garmClient, token, err := newGarmClient(garmParams)
 	if err != nil {
-		return nil, err
+		return err
 	}
+	s.client = garmClient
+	s.token = token
 
-	return &enterpriseClient{garmClient, token}, nil
+	return nil
 }
 
 func (s *enterpriseClient) ListEnterprises(param *enterprises.ListEnterprisesParams) (*enterprises.ListEnterprisesOK, error) {

diff --git a/pkg/client/mock/enterprise.go b/pkg/client/mock/enterprise.go
diff --git a/pkg/client/mock/organization.go b/pkg/client/mock/organization.go
diff --git a/pkg/client/mock/pool.go b/pkg/client/mock/pool.go
diff --git a/pkg/client/mock/repository.go b/pkg/client/mock/repository.go
diff --git a/pkg/client/organization.go b/pkg/client/organization.go
@@ -11,6 +11,7 @@ import (
 )
 
 type OrganizationClient interface {
+	Login(garmParams GarmScopeParams) error
 	ListOrganizations(param *organizations.ListOrgsParams) (*organizations.ListOrgsOK, error)
 	CreateOrganization(param *organizations.CreateOrgParams) (*organizations.CreateOrgOK, error)
 	GetOrganization(param *organizations.GetOrgParams) (*organizations.GetOrgOK, error)
@@ -23,13 +24,19 @@ type organizationClient struct {
 	token  runtime.ClientAuthInfoWriter
 }
 
-func NewOrganizationClient(garmParams GarmScopeParams) (OrganizationClient, error) {
+func NewOrganizationClient() OrganizationClient {
+	return &organizationClient{}
+}
+
+func (s *organizationClient) Login(garmParams GarmScopeParams) error {
 	garmClient, token, err := newGarmClient(garmParams)
 	if err != nil {
-		return nil, err
+		return err
 	}
+	s.client = garmClient
+	s.token = token
 
-	return &organizationClient{garmClient, token}, nil
+	return nil
 }
 
 func (s *organizationClient) ListOrganizations(param *organizations.ListOrgsParams) (*organizations.ListOrgsOK, error) {

diff --git a/pkg/client/pool.go b/pkg/client/pool.go
@@ -14,6 +14,7 @@ import (
 )
 
 type PoolClient interface {
+	Login(garmParams GarmScopeParams) error
 	ListAllPools(param *pools.ListPoolsParams) (*pools.ListPoolsOK, error)
 	CreateRepoPool(param *repositories.CreateRepoPoolParams) (*repositories.CreateRepoPoolOK, error)
 	CreateOrgPool(param *organizations.CreateOrgPoolParams) (*organizations.CreateOrgPoolOK, error)
@@ -31,13 +32,19 @@ type poolClient struct {
 	token  runtime.ClientAuthInfoWriter
 }
 
-func NewPoolClient(garmParams GarmScopeParams) (PoolClient, error) {
+func NewPoolClient() PoolClient {
+	return &poolClient{}
+}
+
+func (p *poolClient) Login(garmParams GarmScopeParams) error {
 	garmClient, token, err := newGarmClient(garmParams)
 	if err != nil {
-		return nil, err
+		return err
 	}
+	p.client = garmClient
+	p.token = token
 
-	return &poolClient{garmClient, token}, nil
+	return nil
 }
 
 func (p *poolClient) ListAllPools(param *pools.ListPoolsParams) (*pools.ListPoolsOK, error) {

diff --git a/pkg/client/repository.go b/pkg/client/repository.go
@@ -11,6 +11,7 @@ import (
 )
 
 type RepositoryClient interface {
+	Login(garmParams GarmScopeParams) error
 	ListRepositories(param *repositories.ListReposParams) (*repositories.ListReposOK, error)
 	CreateRepository(param *repositories.CreateRepoParams) (*repositories.CreateRepoOK, error)
 	GetRepository(param *repositories.GetRepoParams) (*repositories.GetRepoOK, error)
@@ -23,13 +24,19 @@ type repositoryClient struct {
 	token  runtime.ClientAuthInfoWriter
 }
 
-func NewRepositoryClient(garmParams GarmScopeParams) (RepositoryClient, error) {
+func NewRepositoryClient() RepositoryClient {
+	return &repositoryClient{}
+}
+
+func (s *repositoryClient) Login(garmParams GarmScopeParams) error {
 	garmClient, token, err := newGarmClient(garmParams)
 	if err != nil {
-		return nil, err
+		return err
 	}
+	s.client = garmClient
+	s.token = token
 
-	return &repositoryClient{garmClient, token}, nil
+	return nil
 }
 
 func (s *repositoryClient) ListRepositories(param *repositories.ListReposParams) (*repositories.ListReposOK, error) {