Refactor: Move Properties to pkg as Public API (#5402)

* Refactor: Move Properties to pkg as Public API Properties are leveraged by many pieces of Minder, including providers, and should be considered a public API instead of being in our internal package. The idea is to move properties to `pkg`. However, the underlying service package will remain internal, as it is a minder-server implementation detail. This commit fixes the affected functions to refer to the public API to access properties Signed-off-by: Kugamoorthy Gajananan <[email protected]> * Refactor: Move Properties to pkg as Public API Properties are leveraged by many pieces of Minder, including providers, and should be considered a public API instead of being in our internal package. The idea is to move properties to `pkg`. However, the underlying service package will remain internal, as it is a minder-server implementation detail. This commit includes uncommitted changes found in the previous commit. The was done aftering run 'make gen'. Signed-off-by: Kugamoorthy Gajananan <[email protected]> * Refactor: Move Properties to pkg as Public API Properties are leveraged by many pieces of Minder, including providers, and should be considered a public API instead of being in our internal package. The idea is to move properties to `pkg`. However, the underlying service package will remain internal, as it is a minder-server implementation detail. This commit includes changes after running 1. `make bootstrap` again to resolve conflicts in the following files - internal/proto/internal.pb.go - pkg/api/protobuf/go/minder/v1/minder.pb.go 2. `make gen` Signed-off-by: Kugamoorthy Gajananan <[email protected]> --------- Signed-off-by: Kugamoorthy Gajananan <[email protected]>
mindersec · Feb 4, 2025 · 15f65ba · 15f65ba
1 parent f770400
commit 15f65ba
Show file tree

Hide file tree

Showing 62 changed files with 59 additions and 59 deletions.
diff --git a/cmd/dev/app/rule_type/rttst.go b/cmd/dev/app/rule_type/rttst.go
@@ -26,7 +26,6 @@ import (
 	engif "github.com/mindersec/minder/internal/engine/interfaces"
 	"github.com/mindersec/minder/internal/engine/options"
 	entModels "github.com/mindersec/minder/internal/entities/models"
-	entProps "github.com/mindersec/minder/internal/entities/properties"
 	"github.com/mindersec/minder/internal/providers/credentials"
 	"github.com/mindersec/minder/internal/providers/dockerhub"
 	"github.com/mindersec/minder/internal/providers/github/clients"
@@ -41,6 +40,7 @@ import (
 	v1datasources "github.com/mindersec/minder/pkg/datasources/v1"
 	"github.com/mindersec/minder/pkg/engine/selectors"
 	"github.com/mindersec/minder/pkg/engine/v1/rtengine"
+	entProps "github.com/mindersec/minder/pkg/entities/properties"
 	"github.com/mindersec/minder/pkg/profiles"
 	"github.com/mindersec/minder/pkg/profiles/models"
 	provifv1 "github.com/mindersec/minder/pkg/providers/v1"

diff --git a/internal/controlplane/handlers_entities.go b/internal/controlplane/handlers_entities.go
@@ -15,12 +15,12 @@ import (
 
 	"github.com/mindersec/minder/internal/db"
 	"github.com/mindersec/minder/internal/engine/engcontext"
-	"github.com/mindersec/minder/internal/entities/properties"
 	"github.com/mindersec/minder/internal/logger"
 	"github.com/mindersec/minder/internal/providers"
 	"github.com/mindersec/minder/internal/reconcilers/messages"
 	"github.com/mindersec/minder/internal/util"
 	pb "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	"github.com/mindersec/minder/pkg/eventer/constants"
 )
 

diff --git a/internal/controlplane/handlers_evalstatus.go b/internal/controlplane/handlers_evalstatus.go
@@ -20,12 +20,12 @@ import (
 	"github.com/mindersec/minder/internal/db"
 	"github.com/mindersec/minder/internal/engine/engcontext"
 	entmodels "github.com/mindersec/minder/internal/entities/models"
-	"github.com/mindersec/minder/internal/entities/properties"
 	propSvc "github.com/mindersec/minder/internal/entities/properties/service"
 	"github.com/mindersec/minder/internal/history"
 	ghprop "github.com/mindersec/minder/internal/providers/github/properties"
 	"github.com/mindersec/minder/internal/util"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	"github.com/mindersec/minder/pkg/ruletypes"
 )
 

diff --git a/internal/controlplane/handlers_profile.go b/internal/controlplane/handlers_profile.go
@@ -21,12 +21,12 @@ import (
 	"github.com/mindersec/minder/internal/engine/engcontext"
 	"github.com/mindersec/minder/internal/engine/entities"
 	entmodels "github.com/mindersec/minder/internal/entities/models"
-	"github.com/mindersec/minder/internal/entities/properties"
 	propSvc "github.com/mindersec/minder/internal/entities/properties/service"
 	"github.com/mindersec/minder/internal/logger"
 	ghprop "github.com/mindersec/minder/internal/providers/github/properties"
 	"github.com/mindersec/minder/internal/util"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	prof "github.com/mindersec/minder/pkg/profiles"
 	"github.com/mindersec/minder/pkg/ruletypes"
 )

diff --git a/internal/controlplane/handlers_repositories.go b/internal/controlplane/handlers_repositories.go
@@ -19,7 +19,6 @@ import (
 
 	"github.com/mindersec/minder/internal/db"
 	"github.com/mindersec/minder/internal/engine/engcontext"
-	"github.com/mindersec/minder/internal/entities/properties"
 	"github.com/mindersec/minder/internal/logger"
 	"github.com/mindersec/minder/internal/projects/features"
 	"github.com/mindersec/minder/internal/providers"
@@ -29,6 +28,7 @@ import (
 	cursorutil "github.com/mindersec/minder/internal/util/cursor"
 	"github.com/mindersec/minder/internal/util/ptr"
 	pb "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	v1 "github.com/mindersec/minder/pkg/providers/v1"
 )
 

diff --git a/internal/controlplane/handlers_repositories_test.go b/internal/controlplane/handlers_repositories_test.go
@@ -21,7 +21,6 @@ import (
 	"github.com/mindersec/minder/internal/db"
 	"github.com/mindersec/minder/internal/engine/engcontext"
 	"github.com/mindersec/minder/internal/entities/models"
-	"github.com/mindersec/minder/internal/entities/properties"
 	"github.com/mindersec/minder/internal/providers"
 	ghprovider "github.com/mindersec/minder/internal/providers/github/clients"
 	mockgh "github.com/mindersec/minder/internal/providers/github/mock"
@@ -34,6 +33,7 @@ import (
 	"github.com/mindersec/minder/internal/util/ptr"
 	pb "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
 	"github.com/mindersec/minder/pkg/config/server"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	provinfv1 "github.com/mindersec/minder/pkg/providers/v1"
 )
 

diff --git a/internal/eea/eea_test.go b/internal/eea/eea_test.go
@@ -24,13 +24,13 @@ import (
 	"github.com/mindersec/minder/internal/eea"
 	"github.com/mindersec/minder/internal/engine/entities"
 	"github.com/mindersec/minder/internal/entities/models"
-	"github.com/mindersec/minder/internal/entities/properties"
 	psvc "github.com/mindersec/minder/internal/entities/properties/service"
 	propsvcmock "github.com/mindersec/minder/internal/entities/properties/service/mock"
 	pbinternal "github.com/mindersec/minder/internal/proto"
 	mockmanager "github.com/mindersec/minder/internal/providers/manager/mock"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
 	serverconfig "github.com/mindersec/minder/pkg/config/server"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	"github.com/mindersec/minder/pkg/eventer"
 	"github.com/mindersec/minder/pkg/eventer/constants"
 )

diff --git a/internal/entities/handlers/handler.go b/internal/entities/handlers/handler.go
@@ -17,11 +17,11 @@ import (
 	entStrategies "github.com/mindersec/minder/internal/entities/handlers/strategies/entity"
 	msgStrategies "github.com/mindersec/minder/internal/entities/handlers/strategies/message"
 	"github.com/mindersec/minder/internal/entities/models"
-	"github.com/mindersec/minder/internal/entities/properties"
 	propertyService "github.com/mindersec/minder/internal/entities/properties/service"
 	"github.com/mindersec/minder/internal/projects/features"
 	"github.com/mindersec/minder/internal/providers/manager"
 	v1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	"github.com/mindersec/minder/pkg/eventer/constants"
 	"github.com/mindersec/minder/pkg/eventer/interfaces"
 )

diff --git a/internal/entities/handlers/handler_test.go b/internal/entities/handlers/handler_test.go
@@ -21,7 +21,6 @@ import (
 	"github.com/mindersec/minder/internal/engine/entities"
 	"github.com/mindersec/minder/internal/entities/handlers/message"
 	"github.com/mindersec/minder/internal/entities/models"
-	"github.com/mindersec/minder/internal/entities/properties"
 	"github.com/mindersec/minder/internal/entities/properties/service"
 	"github.com/mindersec/minder/internal/entities/properties/service/mock/fixtures"
 	stubeventer "github.com/mindersec/minder/internal/events/stubs"
@@ -33,6 +32,7 @@ import (
 	provManFixtures "github.com/mindersec/minder/internal/providers/manager/mock/fixtures"
 	"github.com/mindersec/minder/internal/reconcilers/messages"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	"github.com/mindersec/minder/pkg/eventer/constants"
 	"github.com/mindersec/minder/pkg/eventer/interfaces"
 	provifv1 "github.com/mindersec/minder/pkg/providers/v1"

diff --git a/internal/entities/handlers/message/message.go b/internal/entities/handlers/message/message.go
@@ -11,8 +11,8 @@ import (
 	"github.com/ThreeDotsLabs/watermill/message"
 	"github.com/google/uuid"
 
-	"github.com/mindersec/minder/internal/entities/properties"
 	v1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 )
 
 // TypedProps is a struct that contains the type of entity and its properties.

diff --git a/internal/entities/handlers/message/message_test.go b/internal/entities/handlers/message/message_test.go
@@ -12,8 +12,8 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/mindersec/minder/internal/db"
-	"github.com/mindersec/minder/internal/entities/properties"
 	v1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 )
 
 func TestEntityRefreshAndDoMessageRoundTrip(t *testing.T) {

diff --git a/internal/entities/handlers/strategies/entity/add_originating_entity.go b/internal/entities/handlers/strategies/entity/add_originating_entity.go
@@ -15,10 +15,10 @@ import (
 	"github.com/mindersec/minder/internal/entities/handlers/message"
 	"github.com/mindersec/minder/internal/entities/handlers/strategies"
 	"github.com/mindersec/minder/internal/entities/models"
-	"github.com/mindersec/minder/internal/entities/properties"
 	propertyService "github.com/mindersec/minder/internal/entities/properties/service"
 	"github.com/mindersec/minder/internal/providers/manager"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 )
 
 type addOriginatingEntityStrategy struct {

diff --git a/internal/entities/handlers/strategies/entity/common.go b/internal/entities/handlers/strategies/entity/common.go
@@ -10,9 +10,9 @@ import (
 
 	"github.com/mindersec/minder/internal/entities/handlers/message"
 	"github.com/mindersec/minder/internal/entities/models"
-	"github.com/mindersec/minder/internal/entities/properties"
 	propertyService "github.com/mindersec/minder/internal/entities/properties/service"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 )
 
 func getEntityInner(

diff --git a/internal/entities/models/models.go b/internal/entities/models/models.go
@@ -11,8 +11,8 @@ import (
 
 	"github.com/mindersec/minder/internal/db"
 	"github.com/mindersec/minder/internal/engine/entities"
-	"github.com/mindersec/minder/internal/entities/properties"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 )
 
 // EntityInstance represents an entity instance

diff --git a/internal/entities/properties/service/helpers.go b/internal/entities/properties/service/helpers.go
@@ -17,8 +17,8 @@ import (
 	"github.com/mindersec/minder/internal/db"
 	"github.com/mindersec/minder/internal/engine/entities"
 	"github.com/mindersec/minder/internal/entities/models"
-	"github.com/mindersec/minder/internal/entities/properties"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	provifv1 "github.com/mindersec/minder/pkg/providers/v1"
 )
 

diff --git a/internal/entities/properties/service/mock/fixtures/fixtures.go b/internal/entities/properties/service/mock/fixtures/fixtures.go
@@ -10,8 +10,8 @@ package fixtures
 
 import (
 	"github.com/google/uuid"
-	"github.com/mindersec/minder/internal/entities/properties"
 	minder "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	"go.uber.org/mock/gomock"
 	"google.golang.org/protobuf/reflect/protoreflect"
 

diff --git a/internal/entities/properties/service/mock/service.go b/internal/entities/properties/service/mock/service.go
diff --git a/internal/entities/properties/service/service.go b/internal/entities/properties/service/service.go
@@ -17,9 +17,9 @@ import (
 
 	"github.com/mindersec/minder/internal/db"
 	"github.com/mindersec/minder/internal/entities/models"
-	"github.com/mindersec/minder/internal/entities/properties"
 	"github.com/mindersec/minder/internal/providers/manager"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	provifv1 "github.com/mindersec/minder/pkg/providers/v1"
 )
 

diff --git a/internal/entities/properties/service/service_test.go b/internal/entities/properties/service/service_test.go
@@ -20,11 +20,11 @@ import (
 	"github.com/mindersec/minder/internal/db/embedded"
 	"github.com/mindersec/minder/internal/engine/entities"
 	"github.com/mindersec/minder/internal/entities/models"
-	"github.com/mindersec/minder/internal/entities/properties"
 	mock_github "github.com/mindersec/minder/internal/providers/github/mock"
 	ghprop "github.com/mindersec/minder/internal/providers/github/properties"
 	"github.com/mindersec/minder/internal/util/rand"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 )
 
 type githubMockBuilder func(*gomock.Controller) *mock_github.MockGitHub

diff --git a/internal/providers/dockerhub/dockerhub.go b/internal/providers/dockerhub/dockerhub.go
@@ -17,9 +17,9 @@ import (
 	"google.golang.org/protobuf/reflect/protoreflect"
 
 	"github.com/mindersec/minder/internal/db"
-	"github.com/mindersec/minder/internal/entities/properties"
 	"github.com/mindersec/minder/internal/providers/oci"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	provifv1 "github.com/mindersec/minder/pkg/providers/v1"
 )
 

diff --git a/internal/providers/github/entities.go b/internal/providers/github/entities.go
@@ -15,10 +15,10 @@ import (
 	"github.com/rs/zerolog"
 	"google.golang.org/protobuf/reflect/protoreflect"
 
-	"github.com/mindersec/minder/internal/entities/properties"
 	ghprop "github.com/mindersec/minder/internal/providers/github/properties"
 	"github.com/mindersec/minder/internal/util/ptr"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 )
 
 var (

diff --git a/internal/providers/github/ghcr/ghcr.go b/internal/providers/github/ghcr/ghcr.go
@@ -16,9 +16,9 @@ import (
 	"google.golang.org/protobuf/proto"
 	"google.golang.org/protobuf/reflect/protoreflect"
 
-	"github.com/mindersec/minder/internal/entities/properties"
 	"github.com/mindersec/minder/internal/verifier/verifyif"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	provifv1 "github.com/mindersec/minder/pkg/providers/v1"
 )
 

diff --git a/internal/providers/github/mock/github.go b/internal/providers/github/mock/github.go
diff --git a/internal/providers/github/properties.go b/internal/providers/github/properties.go
@@ -11,9 +11,9 @@ import (
 
 	"github.com/rs/zerolog"
 
-	"github.com/mindersec/minder/internal/entities/properties"
 	properties2 "github.com/mindersec/minder/internal/providers/github/properties"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 )
 
 // FetchProperty fetches a single property for the given entity

diff --git a/internal/providers/github/properties/artifact.go b/internal/providers/github/properties/artifact.go
@@ -16,9 +16,9 @@ import (
 	"github.com/rs/zerolog"
 	"google.golang.org/protobuf/types/known/timestamppb"
 
-	"github.com/mindersec/minder/internal/entities/properties"
 	"github.com/mindersec/minder/internal/verifier/verifyif"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	v1 "github.com/mindersec/minder/pkg/providers/v1"
 )
 

diff --git a/internal/providers/github/properties/artifact_test.go b/internal/providers/github/properties/artifact_test.go
@@ -10,7 +10,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	"github.com/mindersec/minder/internal/entities/properties"
+	"github.com/mindersec/minder/pkg/entities/properties"
 )
 
 func TestNewArtifactFetcher(t *testing.T) {

diff --git a/internal/providers/github/properties/fetcher.go b/internal/providers/github/properties/fetcher.go
@@ -9,8 +9,8 @@ import (
 
 	go_github "github.com/google/go-github/v63/github"
 
-	"github.com/mindersec/minder/internal/entities/properties"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 )
 
 // GhPropertyWrapper is a function that fetches a property from the GitHub API

diff --git a/internal/providers/github/properties/pull_request.go b/internal/providers/github/properties/pull_request.go
@@ -14,8 +14,8 @@ import (
 
 	go_github "github.com/google/go-github/v63/github"
 
-	"github.com/mindersec/minder/internal/entities/properties"
 	pbinternal "github.com/mindersec/minder/internal/proto"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	v1 "github.com/mindersec/minder/pkg/providers/v1"
 )
 

diff --git a/internal/providers/github/properties/release.go b/internal/providers/github/properties/release.go
@@ -10,8 +10,8 @@ import (
 
 	go_github "github.com/google/go-github/v63/github"
 
-	"github.com/mindersec/minder/internal/entities/properties"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	v1 "github.com/mindersec/minder/pkg/providers/v1"
 )
 

diff --git a/internal/providers/github/properties/repository.go b/internal/providers/github/properties/repository.go
@@ -13,8 +13,8 @@ import (
 	go_github "github.com/google/go-github/v63/github"
 	"github.com/rs/zerolog"
 
-	"github.com/mindersec/minder/internal/entities/properties"
 	minderv1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	v1 "github.com/mindersec/minder/pkg/providers/v1"
 )
 

diff --git a/internal/providers/github/webhook/app.go b/internal/providers/github/webhook/app.go
@@ -19,12 +19,12 @@ import (
 
 	"github.com/mindersec/minder/internal/controlplane/metrics"
 	"github.com/mindersec/minder/internal/db"
-	"github.com/mindersec/minder/internal/entities/properties"
 	"github.com/mindersec/minder/internal/providers/github/clients"
 	"github.com/mindersec/minder/internal/providers/github/installations"
 	"github.com/mindersec/minder/internal/providers/github/service"
 	"github.com/mindersec/minder/internal/reconcilers/messages"
 	pb "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	"github.com/mindersec/minder/pkg/eventer/constants"
 	"github.com/mindersec/minder/pkg/eventer/interfaces"
 )

diff --git a/internal/providers/github/webhook/handlers_githubwebhooks_test.go b/internal/providers/github/webhook/handlers_githubwebhooks_test.go
@@ -39,7 +39,6 @@ import (
 	"github.com/mindersec/minder/internal/crypto"
 	"github.com/mindersec/minder/internal/db"
 	entMsg "github.com/mindersec/minder/internal/entities/handlers/message"
-	"github.com/mindersec/minder/internal/entities/properties"
 	mock_service "github.com/mindersec/minder/internal/entities/properties/service/mock"
 	"github.com/mindersec/minder/internal/providers/github/installations"
 	gf "github.com/mindersec/minder/internal/providers/github/mock/fixtures"
@@ -49,6 +48,7 @@ import (
 	"github.com/mindersec/minder/internal/util/testqueue"
 	v1 "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
 	serverconfig "github.com/mindersec/minder/pkg/config/server"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	"github.com/mindersec/minder/pkg/eventer"
 	"github.com/mindersec/minder/pkg/eventer/constants"
 )

diff --git a/internal/providers/github/webhook/handlers_packages.go b/internal/providers/github/webhook/handlers_packages.go
@@ -14,9 +14,9 @@ import (
 
 	"github.com/mindersec/minder/internal/db"
 	entityMessage "github.com/mindersec/minder/internal/entities/handlers/message"
-	"github.com/mindersec/minder/internal/entities/properties"
 	ghprop "github.com/mindersec/minder/internal/providers/github/properties"
 	pb "github.com/mindersec/minder/pkg/api/protobuf/go/minder/v1"
+	"github.com/mindersec/minder/pkg/entities/properties"
 	"github.com/mindersec/minder/pkg/eventer/constants"
 )