Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add proto validation for entity type in ProvidersService #4903

Merged
merged 1 commit into from
Nov 7, 2024

Conversation

rdimitrov
Copy link
Member

Summary

Ref https://github.com/stacklok/minder-stories/issues/94

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

@rdimitrov rdimitrov requested a review from a team as a code owner November 7, 2024 12:36
@coveralls
Copy link

coveralls commented Nov 7, 2024

Coverage Status

coverage: 54.763%. remained the same
when pulling c3c2595 on validate-providers
into 3c86de3 on main.

string entity = 2;
string entity = 2 [
(buf.validate.field).string = {
pattern: "^[a-z]+(_[a-z]+)*$",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like these string enum values are capitalized?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@evankanderson - Where is that, because I based it on these mappings here -

// Entity types as string-like enums. Used in CLI and other user-facing code
const (
	// RepositoryEntity is a repository entity
	RepositoryEntity EntityType = "repository"
	// BuildEnvironmentEntity is a build environment entity
	BuildEnvironmentEntity EntityType = "build_environment"
	// ArtifactEntity is an artifact entity
	ArtifactEntity EntityType = "artifact"
	// PullRequestEntity is a pull request entity
	PullRequestEntity EntityType = "pull_request"
	// ReleaseEntity is an entity abstracting a release
	ReleaseEntity EntityType = "release"
	// PipelineRunEntity is an entity abstracting a pipeline run (eg a workflow)
	PipelineRunEntity EntityType = "pipeline_run"
	// TaskRunEntity is an entity abstracting a task run (eg a step)
	TaskRunEntity EntityType = "task_run"
	// BuildEntity is an entity that represents a software build
	BuildEntity EntityType = "build"
	// UnknownEntity is an explicitly unknown entity
	UnknownEntity EntityType = "unknown"
)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, I mis-read this line and the generated entity constants:

https://github.com/mindersec/minder/blob/http-send/internal/controlplane/handlers_entities.go#L45

It does look like we force these to lower-case on the server side before comparison, but I think this probably fine to start with.

@rdimitrov rdimitrov self-assigned this Nov 7, 2024
evankanderson
evankanderson previously approved these changes Nov 7, 2024
string entity = 2;
string entity = 2 [
(buf.validate.field).string = {
pattern: "^[a-z]+(_[a-z]+)*$",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, I mis-read this line and the generated entity constants:

https://github.com/mindersec/minder/blob/http-send/internal/controlplane/handlers_entities.go#L45

It does look like we force these to lower-case on the server side before comparison, but I think this probably fine to start with.

Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
@rdimitrov rdimitrov merged commit 3dc58b6 into main Nov 7, 2024
24 checks passed
@rdimitrov rdimitrov deleted the validate-providers branch November 7, 2024 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants