Wire new Release + SDLC Core Entities (#3839)

* Add release + core SDLC subjects to entities This commit adds 'release' plus some of the core subjects of the cd events spec as entities to the minder protos: ENTITY_RELEASE ENTITY_PIPELINE_RUN ENTITY_TASK_RUN ENTITY_BUILD Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]> * Proto: Add SDLC stubs This commit adds stub messages for the SDLC entities: Release PipelineRun TaskRun Build Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]> * Add SQL migrations for SDLC entities This commit adds up and down (although down is empty) migrations to add release and the core cd events subjects to the sql entities type. Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]> * SDLXC entities: Make gen (Run make gen) Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]> * Add SLDC entities to Profile This adds release and the core SLDX entity types to the profile functions Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]> * Add release+SLDC entities to controlplane This commit adds the release and SLDC entities to the control plane functions Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]> * Wire SDLC entities to engine This commit wires the SDLC entities to the engine functions and creates the With* functional options for the new types. Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]> * Handle SDLC ents telemetry with noops This commit adds NOOP cases to functions where the SDLC entities need to be implemented in the database or, where hardcoded entity types in functions prevent us from wiring up the values. Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]> * Handle SDLC entities in mindev * Add SDLC noops to history and exec aggregator Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]> --------- Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]> Co-authored-by: Radoslav Dimitrov <[email protected]>
mindersec · Jul 12, 2024 · 33ae09f · 33ae09f
1 parent 40cbccd
commit 33ae09f
Show file tree

Hide file tree

Showing 20 changed files with 3,336 additions and 2,775 deletions.
diff --git a/cmd/dev/app/rule_type/rttst.go b/cmd/dev/app/rule_type/rttst.go
@@ -287,8 +287,10 @@ func readEntityFromFile(fpath string, entType minderv1.Entity) (protoreflect.Pro
 		out = &minderv1.Artifact{}
 	case minderv1.Entity_ENTITY_PULL_REQUESTS:
 		out = &minderv1.PullRequest{}
-	case minderv1.Entity_ENTITY_BUILD_ENVIRONMENTS:
-		return nil, fmt.Errorf("build environments not yet supported")
+	case minderv1.Entity_ENTITY_BUILD_ENVIRONMENTS, minderv1.Entity_ENTITY_RELEASE,
+		minderv1.Entity_ENTITY_PIPELINE_RUN,
+		minderv1.Entity_ENTITY_TASK_RUN, minderv1.Entity_ENTITY_BUILD:
+		return nil, fmt.Errorf("entity type not yet supported")
 	case minderv1.Entity_ENTITY_UNSPECIFIED:
 		return nil, fmt.Errorf("entity type unspecified")
 	default:

diff --git a/database/migrations/000074_sdlc_entities.down.sql b/database/migrations/000074_sdlc_entities.down.sql
@@ -0,0 +1,13 @@
+-- Copyright 2024 Stacklok, Inc
+--
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- you may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--      http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
diff --git a/database/migrations/000074_sdlc_entities.up.sql b/database/migrations/000074_sdlc_entities.up.sql
@@ -0,0 +1,22 @@
+-- Copyright 2024 Stacklok, Inc
+--
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- you may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--      http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+
+BEGIN TRANSACTION;
+
+ALTER TYPE entities ADD VALUE 'release';
+ALTER TYPE entities ADD VALUE 'pipeline_run';
+ALTER TYPE entities ADD VALUE 'task_run';
+ALTER TYPE entities ADD VALUE 'build';
+
+COMMIT;
diff --git a/docs/docs/ref/proto.md b/docs/docs/ref/proto.md
diff --git a/internal/controlplane/handlers_evalstatus.go b/internal/controlplane/handlers_evalstatus.go
@@ -595,6 +595,14 @@ func dbEntityToEntity(dbEnt db.Entities) minderv1.Entity {
 		return minderv1.Entity_ENTITY_REPOSITORIES
 	case db.EntitiesBuildEnvironment:
 		return minderv1.Entity_ENTITY_BUILD_ENVIRONMENTS
+	case db.EntitiesRelease:
+		return minderv1.Entity_ENTITY_RELEASE
+	case db.EntitiesPipelineRun:
+		return minderv1.Entity_ENTITY_PIPELINE_RUN
+	case db.EntitiesTaskRun:
+		return minderv1.Entity_ENTITY_TASK_RUN
+	case db.EntitiesBuild:
+		return minderv1.Entity_ENTITY_BUILD
 	default:
 		return minderv1.Entity_ENTITY_UNSPECIFIED
 	}
@@ -636,7 +644,8 @@ func getEntityName(
 			row.RepoOwner.String,
 			row.RepoName.String,
 		), nil
-	case db.EntitiesBuildEnvironment:
+	case db.EntitiesBuildEnvironment, db.EntitiesRelease,
+		db.EntitiesPipelineRun, db.EntitiesTaskRun, db.EntitiesBuild:
 		return "", errors.New("invalid entity type")
 	default:
 		return "", errors.New("invalid entity type")

diff --git a/internal/db/models.go b/internal/db/models.go
diff --git a/internal/eea/eea.go b/internal/eea/eea.go
@@ -302,10 +302,11 @@ func (e *EEA) buildEntityWrapper(
 		return e.buildArtifactInfoWrapper(ctx, repoID, projID, artID)
 	case db.EntitiesPullRequest:
 		return e.buildPullRequestInfoWrapper(ctx, repoID, projID, prID)
-	case db.EntitiesBuildEnvironment:
-		return nil, fmt.Errorf("build environment entity not supported")
+	case db.EntitiesBuildEnvironment, db.EntitiesRelease,
+		db.EntitiesPipelineRun, db.EntitiesTaskRun, db.EntitiesBuild:
+		return nil, fmt.Errorf("entity type %q not yet supported", entity)
 	default:
-		return nil, fmt.Errorf("unknown entity type: %s", entity)
+		return nil, fmt.Errorf("unknown entity type: %q", entity)
 	}
 }
 

diff --git a/internal/engine/entities/entities.go b/internal/engine/entities/entities.go
@@ -56,6 +56,14 @@ func EntityTypeFromDB(entity db.Entities) minderv1.Entity {
 		return minderv1.Entity_ENTITY_ARTIFACTS
 	case db.EntitiesPullRequest:
 		return minderv1.Entity_ENTITY_PULL_REQUESTS
+	case db.EntitiesRelease:
+		return minderv1.Entity_ENTITY_RELEASE
+	case db.EntitiesPipelineRun:
+		return minderv1.Entity_ENTITY_PIPELINE_RUN
+	case db.EntitiesTaskRun:
+		return minderv1.Entity_ENTITY_TASK_RUN
+	case db.EntitiesBuild:
+		return minderv1.Entity_ENTITY_BUILD
 	default:
 		return minderv1.Entity_ENTITY_UNSPECIFIED
 	}
@@ -74,6 +82,14 @@ func EntityTypeToDB(entity minderv1.Entity) db.Entities {
 		dbEnt = db.EntitiesArtifact
 	case minderv1.Entity_ENTITY_PULL_REQUESTS:
 		dbEnt = db.EntitiesPullRequest
+	case minderv1.Entity_ENTITY_RELEASE:
+		dbEnt = db.EntitiesRelease
+	case minderv1.Entity_ENTITY_PIPELINE_RUN:
+		dbEnt = db.EntitiesPipelineRun
+	case minderv1.Entity_ENTITY_TASK_RUN:
+		dbEnt = db.EntitiesTaskRun
+	case minderv1.Entity_ENTITY_BUILD:
+		dbEnt = db.EntitiesBuild
 	case minderv1.Entity_ENTITY_UNSPECIFIED:
 		// This shouldn't happen
 	}

diff --git a/internal/engine/entities/entity_event.go b/internal/engine/entities/entity_event.go
@@ -78,6 +78,14 @@ const (
 	ArtifactIDEventKey = "artifact_id"
 	// PullRequestIDEventKey is the key for the pull request ID
 	PullRequestIDEventKey = "pull_request_id"
+	// ReleaseIDEventKey is the key for the pull request ID
+	ReleaseIDEventKey = "release_id"
+	// PipelineRunIDEventKey is the key for a pipeline run
+	PipelineRunIDEventKey = "pipeline_run_id"
+	// TaskRunIDEventKey is the key for a task run
+	TaskRunIDEventKey = "task_run_id"
+	// BuildIDEventKey is the key for a build
+	BuildIDEventKey = "build_run_id"
 	// ExecutionIDKey is the key for the execution ID. This is set when acquiring a lock.
 	ExecutionIDKey = "execution_id"
 	// ActionEventKey is the key for the action event
@@ -129,6 +137,38 @@ func (eiw *EntityInfoWrapper) WithPullRequest(p *minderv1.PullRequest) *EntityIn
 	return eiw
 }
 
+// WithRelease sets a Release as the entity of the wrapper
+func (eiw *EntityInfoWrapper) WithRelease(r *minderv1.Release) *EntityInfoWrapper {
+	eiw.Type = minderv1.Entity_ENTITY_RELEASE
+	eiw.Entity = r
+
+	return eiw
+}
+
+// WithPipelineRun sets a PipelineRun as the entity of the wrapper
+func (eiw *EntityInfoWrapper) WithPipelineRun(plr *minderv1.PipelineRun) *EntityInfoWrapper {
+	eiw.Type = minderv1.Entity_ENTITY_PIPELINE_RUN
+	eiw.Entity = plr
+
+	return eiw
+}
+
+// WithTaskRun sets a TaskRun as the entity of the wrapper
+func (eiw *EntityInfoWrapper) WithTaskRun(tr *minderv1.TaskRun) *EntityInfoWrapper {
+	eiw.Type = minderv1.Entity_ENTITY_TASK_RUN
+	eiw.Entity = tr
+
+	return eiw
+}
+
+// WithBuild sets a Build as the entity of the wrapper
+func (eiw *EntityInfoWrapper) WithBuild(tr *minderv1.Build) *EntityInfoWrapper {
+	eiw.Type = minderv1.Entity_ENTITY_TASK_RUN
+	eiw.Entity = tr
+
+	return eiw
+}
+
 // WithProjectID sets the project ID
 func (eiw *EntityInfoWrapper) WithProjectID(id uuid.UUID) *EntityInfoWrapper {
 	eiw.ProjectID = id
@@ -157,6 +197,34 @@ func (eiw *EntityInfoWrapper) WithPullRequestID(id uuid.UUID) *EntityInfoWrapper
 	return eiw
 }
 
+// WithReleaseID sets the release ID
+func (eiw *EntityInfoWrapper) WithReleaseID(id uuid.UUID) *EntityInfoWrapper {
+	eiw.withID(ReleaseIDEventKey, id.String())
+
+	return eiw
+}
+
+// WithPipelineRunID sets the pipeline run ID
+func (eiw *EntityInfoWrapper) WithPipelineRunID(id uuid.UUID) *EntityInfoWrapper {
+	eiw.withID(PipelineRunIDEventKey, id.String())
+
+	return eiw
+}
+
+// WithTaskRunID sets the pipeline run ID
+func (eiw *EntityInfoWrapper) WithTaskRunID(id uuid.UUID) *EntityInfoWrapper {
+	eiw.withID(TaskRunIDEventKey, id.String())
+
+	return eiw
+}
+
+// WithBuildID sets the pipeline run ID
+func (eiw *EntityInfoWrapper) WithBuildID(id uuid.UUID) *EntityInfoWrapper {
+	eiw.withID(BuildIDEventKey, id.String())
+
+	return eiw
+}
+
 // WithExecutionID sets the execution ID
 func (eiw *EntityInfoWrapper) WithExecutionID(id uuid.UUID) *EntityInfoWrapper {
 	eiw.ExecutionID = &id
@@ -368,6 +436,14 @@ func pbEntityTypeToString(t minderv1.Entity) (string, error) {
 		return VersionedArtifactEventEntityType, nil
 	case minderv1.Entity_ENTITY_PULL_REQUESTS:
 		return PullRequestEventEntityType, nil
+	case minderv1.Entity_ENTITY_RELEASE:
+		return "", fmt.Errorf("releases not yet supported")
+	case minderv1.Entity_ENTITY_PIPELINE_RUN:
+		return "", fmt.Errorf("pipeline runs not yet supported")
+	case minderv1.Entity_ENTITY_TASK_RUN:
+		return "", fmt.Errorf("task runs not yet supported")
+	case minderv1.Entity_ENTITY_BUILD:
+		return "", fmt.Errorf("builds not yet supported")
 	case minderv1.Entity_ENTITY_BUILD_ENVIRONMENTS:
 		return "", fmt.Errorf("build environments not yet supported")
 	case minderv1.Entity_ENTITY_UNSPECIFIED:

diff --git a/internal/engine/eval_status.go b/internal/engine/eval_status.go
@@ -69,8 +69,9 @@ func (e *executor) createEvalStatusParams(
 		entityID = params.RepoID
 	case db.EntitiesPullRequest:
 		entityID = params.PullRequestID
-	case db.EntitiesBuildEnvironment:
-		return nil, fmt.Errorf("build environment entity type not supported")
+	case db.EntitiesBuildEnvironment, db.EntitiesRelease, db.EntitiesPipelineRun,
+		db.EntitiesTaskRun, db.EntitiesBuild:
+		return nil, fmt.Errorf("entity type not yet supported")
 	}
 
 	ruleTypeName := sql.NullString{

diff --git a/internal/engine/interfaces/interface.go b/internal/engine/interfaces/interface.go
@@ -137,6 +137,10 @@ type EvalStatusParams struct {
 	ArtifactID       uuid.NullUUID
 	PullRequestID    uuid.NullUUID
 	ProjectID        uuid.UUID
+	ReleaseID        uuid.UUID
+	PipelineRunID    uuid.UUID
+	TaskRunID        uuid.UUID
+	BuildID          uuid.UUID
 	EntityType       db.Entities
 	RuleTypeID       uuid.UUID
 	EvalStatusFromDb *db.ListRuleEvaluationsByProfileIdRow

diff --git a/internal/history/service.go b/internal/history/service.go
@@ -191,9 +191,10 @@ func paramsFromEntity(
 		params.PullRequestID = nullableEntityID
 	case db.EntitiesArtifact:
 		params.ArtifactID = nullableEntityID
-	case db.EntitiesBuildEnvironment:
+	case db.EntitiesBuildEnvironment, db.EntitiesRelease,
+		db.EntitiesPipelineRun, db.EntitiesTaskRun, db.EntitiesBuild:
 	default:
-		return nil, fmt.Errorf("unknown entity %s", entityType)
+		return nil, fmt.Errorf("unknown entity %q", entityType)
 	}
 	return &params, nil
 }

diff --git a/internal/logger/telemetry_store_watermill.go b/internal/logger/telemetry_store_watermill.go
@@ -94,7 +94,10 @@ func newTelemetryStoreFromEntity(inf *entities.EntityInfoWrapper) (*TelemetrySto
 		ts.Artifact = ent
 	case minderv1.Entity_ENTITY_PULL_REQUESTS:
 		ts.PullRequest = ent
-	case minderv1.Entity_ENTITY_BUILD_ENVIRONMENTS:
+	case minderv1.Entity_ENTITY_BUILD_ENVIRONMENTS,
+		minderv1.Entity_ENTITY_RELEASE, minderv1.Entity_ENTITY_PIPELINE_RUN,
+		minderv1.Entity_ENTITY_TASK_RUN, minderv1.Entity_ENTITY_BUILD:
+		// Noop, see https://github.com/stacklok/minder/issues/3838
 	case minderv1.Entity_ENTITY_UNSPECIFIED:
 		// Do nothing
 	}
@@ -121,6 +124,9 @@ func getEntityID(inf *entities.EntityInfoWrapper) (uuid.UUID, error) {
 		ent = artID.UUID
 	case minderv1.Entity_ENTITY_PULL_REQUESTS:
 		ent = prID.UUID
+	case minderv1.Entity_ENTITY_RELEASE, minderv1.Entity_ENTITY_PIPELINE_RUN,
+		minderv1.Entity_ENTITY_TASK_RUN, minderv1.Entity_ENTITY_BUILD:
+		// Noop, see https://github.com/stacklok/minder/issues/3838
 	}
 
 	return ent, nil

diff --git a/internal/profiles/service.go b/internal/profiles/service.go
@@ -158,6 +158,10 @@ func (p *profileService) CreateProfile(
 		minderv1.Entity_ENTITY_ARTIFACTS:          profile.GetArtifact(),
 		minderv1.Entity_ENTITY_BUILD_ENVIRONMENTS: profile.GetBuildEnvironment(),
 		minderv1.Entity_ENTITY_PULL_REQUESTS:      profile.GetPullRequest(),
+		minderv1.Entity_ENTITY_RELEASE:            profile.GetRelease(),
+		minderv1.Entity_ENTITY_PIPELINE_RUN:       profile.GetPipelineRun(),
+		minderv1.Entity_ENTITY_TASK_RUN:           profile.GetTaskRun(),
+		minderv1.Entity_ENTITY_BUILD:              profile.GetBuild(),
 	} {
 		if err := createProfileRulesForEntity(ctx, ent, &newProfile, qtx, entRules, rulesInProf); err != nil {
 			return nil, err
@@ -259,6 +263,10 @@ func (p *profileService) UpdateProfile(
 		minderv1.Entity_ENTITY_ARTIFACTS:          profile.GetArtifact(),
 		minderv1.Entity_ENTITY_BUILD_ENVIRONMENTS: profile.GetBuildEnvironment(),
 		minderv1.Entity_ENTITY_PULL_REQUESTS:      profile.GetPullRequest(),
+		minderv1.Entity_ENTITY_RELEASE:            profile.GetRelease(),
+		minderv1.Entity_ENTITY_PIPELINE_RUN:       profile.GetPipelineRun(),
+		minderv1.Entity_ENTITY_TASK_RUN:           profile.GetTaskRun(),
+		minderv1.Entity_ENTITY_BUILD:              profile.GetBuild(),
 	} {
 		if err = updateProfileRulesForEntity(ctx, ent, &updatedProfile, qtx, entRules, rules); err != nil {
 			return nil, err