chore(controlplane): move OnboardingSpec message to public package (#1135)

jiparis · web-flow · commit e57234cfcdac · 2024-07-25T16:06:20.000+02:00
Signed-off-by: Jose I. Paris &lt;jiparis@chainloop.dev&gt;
diff --git a/Makefile b/Makefile
@@ -14,6 +14,7 @@ api:
 # generate config proto
 config:
 	cd ./pkg/credentials/api && buf generate
+	cd ./app/controlplane/pkg/conf && buf generate
 	make -C ./app/controlplane config
 	make -C ./app/artifact-cas config
 
diff --git a/app/controlplane/internal/conf/controlplane/config/v1/conf.pb.go b/app/controlplane/internal/conf/controlplane/config/v1/conf.pb.go
diff --git a/app/controlplane/internal/conf/controlplane/config/v1/conf.proto b/app/controlplane/internal/conf/controlplane/config/v1/conf.proto
@@ -18,8 +18,8 @@ syntax = "proto3";
 package controlplane.config.v1;
 
 import "buf/validate/validate.proto";
-import "controlplane/v1/response_messages.proto";
 import "credentials/v1/config.proto";
+import "controlplane/config/v1/config.proto";
 import "google/protobuf/duration.proto";
 
 option go_package = "github.com/chainloop-dev/chainloop/app/controlplane/internal/conf/controlplane/config/v1;conf";
@@ -168,19 +168,6 @@ message CA {
   }
 }
 
-// OnboardingSpec is a configuration to automatically onboard users in organizations with specific roles
-message OnboardingSpec {
-  // Name of the organization
-  string name = 1 [(buf.validate.field).string.min_len = 1];
-  // Role to assign to the user
-  controlplane.v1.MembershipRole role = 2 [
-    (buf.validate.field).enum = {
-      not_in: [0]
-    },
-    (buf.validate.field).enum.defined_only = true
-  ];
-}
-
 // PrometheusIntegrationSpec is a configuration to enable Prometheus integration for the
 // specified organizations
 message PrometheusIntegrationSpec {
diff --git a/app/controlplane/pkg/biz/organization.go b/app/controlplane/pkg/biz/organization.go
@@ -22,8 +22,8 @@ import (
 	"io"
 	"time"
 
-	conf "github.com/chainloop-dev/chainloop/app/controlplane/internal/conf/controlplane/config/v1"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/authz"
+	config "github.com/chainloop-dev/chainloop/app/controlplane/pkg/conf/controlplane/config/v1"
 	"github.com/chainloop-dev/chainloop/pkg/servicelogger"
 	"github.com/go-kratos/kratos/v2/log"
 	"github.com/google/uuid"
@@ -48,10 +48,10 @@ type OrganizationUseCase struct {
 	casBackendUseCase *CASBackendUseCase
 	integrationUC     *IntegrationUseCase
 	membershipRepo    MembershipRepo
-	onboardingConfig  []*conf.OnboardingSpec
+	onboardingConfig  []*config.OnboardingSpec
 }
 
-func NewOrganizationUseCase(repo OrganizationRepo, repoUC *CASBackendUseCase, iUC *IntegrationUseCase, mRepo MembershipRepo, onboardingConfig []*conf.OnboardingSpec, l log.Logger) *OrganizationUseCase {
+func NewOrganizationUseCase(repo OrganizationRepo, repoUC *CASBackendUseCase, iUC *IntegrationUseCase, mRepo MembershipRepo, onboardingConfig []*config.OnboardingSpec, l log.Logger) *OrganizationUseCase {
 	if l == nil {
 		l = log.NewStdLogger(io.Discard)
 	}
diff --git a/app/controlplane/pkg/biz/organization_integration_test.go b/app/controlplane/pkg/biz/organization_integration_test.go
@@ -20,10 +20,10 @@ import (
 	"testing"
 
 	v1 "github.com/chainloop-dev/chainloop/app/controlplane/api/controlplane/v1"
-	conf "github.com/chainloop-dev/chainloop/app/controlplane/internal/conf/controlplane/config/v1"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/authz"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/biz"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/biz/testhelpers"
+	config "github.com/chainloop-dev/chainloop/app/controlplane/pkg/conf/controlplane/config/v1"
 	"github.com/chainloop-dev/chainloop/app/controlplane/plugins/sdk/v1"
 	integrationMocks "github.com/chainloop-dev/chainloop/app/controlplane/plugins/sdk/v1/mocks"
 	"github.com/google/uuid"
@@ -246,7 +246,7 @@ func (s *AuthOnboardingTestSuite) SetupTest() {
 	t := s.T()
 	ctx := context.Background()
 
-	s.TestingUseCases = testhelpers.NewTestingUseCases(t, testhelpers.WithOnboardingConfiguration([]*conf.OnboardingSpec{
+	s.TestingUseCases = testhelpers.NewTestingUseCases(t, testhelpers.WithOnboardingConfiguration([]*config.OnboardingSpec{
 		{
 			Name: "non-existing-org",
 			Role: v1.MembershipRole_MEMBERSHIP_ROLE_ORG_VIEWER,
diff --git a/app/controlplane/pkg/biz/testhelpers/database.go b/app/controlplane/pkg/biz/testhelpers/database.go
@@ -23,6 +23,7 @@ import (
 	"testing"
 	"time"
 
+	config "github.com/chainloop-dev/chainloop/app/controlplane/pkg/conf/controlplane/config/v1"
 	// Required for the database waitFor strategy
 	_ "github.com/lib/pq"
 
@@ -87,7 +88,7 @@ type newTestingOpts struct {
 	credsReaderWriter       credentials.ReaderWriter
 	integrations            sdk.AvailablePlugins
 	providers               backends.Providers
-	onboardingConfiguration []*conf.OnboardingSpec
+	onboardingConfiguration []*config.OnboardingSpec
 }
 
 type NewTestingUCOpt func(*newTestingOpts)
@@ -108,7 +109,7 @@ func WithRegisteredIntegration(i sdk.FanOut) NewTestingUCOpt {
 	}
 }
 
-func WithOnboardingConfiguration(conf []*conf.OnboardingSpec) NewTestingUCOpt {
+func WithOnboardingConfiguration(conf []*config.OnboardingSpec) NewTestingUCOpt {
 	return func(tu *newTestingOpts) {
 		tu.onboardingConfiguration = conf
 	}
diff --git a/app/controlplane/pkg/biz/testhelpers/wire.go b/app/controlplane/pkg/biz/testhelpers/wire.go
@@ -26,6 +26,7 @@ import (
 	conf "github.com/chainloop-dev/chainloop/app/controlplane/internal/conf/controlplane/config/v1"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/authz"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/biz"
+	config "github.com/chainloop-dev/chainloop/app/controlplane/pkg/conf/controlplane/config/v1"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/data"
 	"github.com/chainloop-dev/chainloop/app/controlplane/plugins/sdk/v1"
 	robotaccount "github.com/chainloop-dev/chainloop/internal/robotaccount/cas"
@@ -36,7 +37,7 @@ import (
 )
 
 // wireTestData init testing data
-func WireTestData(*TestDatabase, *testing.T, log.Logger, credentials.ReaderWriter, *robotaccount.Builder, *conf.Auth, *conf.Bootstrap, []*conf.OnboardingSpec, sdk.AvailablePlugins, backends.Providers) (*TestingUseCases, func(), error) {
+func WireTestData(*TestDatabase, *testing.T, log.Logger, credentials.ReaderWriter, *robotaccount.Builder, *conf.Auth, *conf.Bootstrap, []*config.OnboardingSpec, sdk.AvailablePlugins, backends.Providers) (*TestingUseCases, func(), error) {
 	panic(
 		wire.Build(
 			data.ProviderSet,
diff --git a/app/controlplane/pkg/biz/testhelpers/wire_gen.go b/app/controlplane/pkg/biz/testhelpers/wire_gen.go
diff --git a/app/controlplane/pkg/biz/user.go b/app/controlplane/pkg/biz/user.go
@@ -21,8 +21,8 @@ import (
 	"time"
 
 	pb "github.com/chainloop-dev/chainloop/app/controlplane/api/controlplane/v1"
-	conf "github.com/chainloop-dev/chainloop/app/controlplane/internal/conf/controlplane/config/v1"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/authz"
+	config "github.com/chainloop-dev/chainloop/app/controlplane/pkg/conf/controlplane/config/v1"
 	"github.com/go-kratos/kratos/v2/log"
 	"github.com/google/uuid"
 )
@@ -50,14 +50,14 @@ type UserUseCase struct {
 	logger              *log.Helper
 	membershipUseCase   *MembershipUseCase
 	organizationUseCase *OrganizationUseCase
-	onboardingConfig    []*conf.OnboardingSpec
+	onboardingConfig    []*config.OnboardingSpec
 }
 
 type NewUserUseCaseParams struct {
 	UserRepo            UserRepo
 	MembershipUseCase   *MembershipUseCase
 	OrganizationUseCase *OrganizationUseCase
-	OnboardingConfig    []*conf.OnboardingSpec
+	OnboardingConfig    []*config.OnboardingSpec
 	Logger              log.Logger
 }
 
diff --git a/app/controlplane/pkg/biz/user_integration_test.go b/app/controlplane/pkg/biz/user_integration_test.go
@@ -20,11 +20,10 @@ import (
 	"testing"
 
 	v1 "github.com/chainloop-dev/chainloop/app/controlplane/api/controlplane/v1"
-	conf "github.com/chainloop-dev/chainloop/app/controlplane/internal/conf/controlplane/config/v1"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/authz"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/biz"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/biz/testhelpers"
-
+	config "github.com/chainloop-dev/chainloop/app/controlplane/pkg/conf/controlplane/config/v1"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
@@ -139,7 +138,7 @@ func (s *userOnboardingTestSuite) TestAutoOnboardOrganizationsNoConfiguration()
 func (s *userOnboardingTestSuite) TestAutoOnboardOrganizationsWithConfiguration() {
 	ctx := context.Background()
 	const orgName = "existing-org"
-	s.TestingUseCases = testhelpers.NewTestingUseCases(s.T(), testhelpers.WithOnboardingConfiguration([]*conf.OnboardingSpec{
+	s.TestingUseCases = testhelpers.NewTestingUseCases(s.T(), testhelpers.WithOnboardingConfiguration([]*config.OnboardingSpec{
 		{
 			Name: orgName,
 			Role: v1.MembershipRole_MEMBERSHIP_ROLE_ORG_VIEWER,
diff --git a/app/controlplane/pkg/conf/buf.gen.yaml b/app/controlplane/pkg/conf/buf.gen.yaml
@@ -0,0 +1,5 @@
+version: v1
+plugins:
+  - name: go
+    out: .
+    opt: paths=source_relative
diff --git a/app/controlplane/pkg/conf/buf.lock b/app/controlplane/pkg/conf/buf.lock
@@ -0,0 +1,15 @@
+# Generated by buf. DO NOT EDIT.
+version: v1
+deps:
+  - remote: buf.build
+    owner: bufbuild
+    repository: protovalidate
+    commit: 46a4cf4ba1094a34bcd89a6c67163b4b
+  - remote: buf.build
+    owner: googleapis
+    repository: googleapis
+    commit: f0e53af8f2fc4556b94f482688b57223
+  - remote: buf.build
+    owner: kratos-go
+    repository: kratos
+    commit: e1d52e944e3845c6862a566db322432d
diff --git a/app/controlplane/pkg/conf/buf.yaml b/app/controlplane/pkg/conf/buf.yaml
@@ -0,0 +1,10 @@
+version: v1
+breaking:
+  use:
+    - FILE
+deps:
+  - buf.build/googleapis/googleapis
+  - buf.build/bufbuild/protovalidate
+lint:
+  use:
+    - DEFAULT
diff --git a/app/controlplane/pkg/conf/controlplane/config/v1/config.pb.go b/app/controlplane/pkg/conf/controlplane/config/v1/config.pb.go
diff --git a/app/controlplane/pkg/conf/controlplane/config/v1/config.proto b/app/controlplane/pkg/conf/controlplane/config/v1/config.proto
diff --git a/buf.work.yaml b/buf.work.yaml

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ import (`
`23`	`23`	`"testing"`
`24`	`24`	`"time"`
`25`	`25`
	`26`	`+ config "github.com/chainloop-dev/chainloop/app/controlplane/pkg/conf/controlplane/config/v1"`
`26`	`27`	`// Required for the database waitFor strategy`
`27`	`28`	`_ "github.com/lib/pq"`
`28`	`29`
`@@ -87,7 +88,7 @@ type newTestingOpts struct {`
`87`	`88`	`credsReaderWriter credentials.ReaderWriter`
`88`	`89`	`integrations sdk.AvailablePlugins`
`89`	`90`	`providers backends.Providers`
`90`		`- onboardingConfiguration []*conf.OnboardingSpec`
	`91`	`+ onboardingConfiguration []*config.OnboardingSpec`
`91`	`92`	`}`
`92`	`93`
`93`	`94`	`type NewTestingUCOpt func(*newTestingOpts)`
`@@ -108,7 +109,7 @@ func WithRegisteredIntegration(i sdk.FanOut) NewTestingUCOpt {`
`108`	`109`	`}`
`109`	`110`	`}`
`110`	`111`
`111`		`-func WithOnboardingConfiguration(conf []*conf.OnboardingSpec) NewTestingUCOpt {`
	`112`	`+func WithOnboardingConfiguration(conf []*config.OnboardingSpec) NewTestingUCOpt {`
`112`	`113`	`return func(tu *newTestingOpts) {`
`113`	`114`	`tu.onboardingConfiguration = conf`
`114`	`115`	`}`