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.

Sign up for GitHub

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

Jump to bottom

Add two more generic methods for EntityInfoWrapper #4518

Merged
merged 1 commit into from
Sep 17, 2024
Merged

Add two more generic methods for EntityInfoWrapper #4518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions internal/engine/entities/entity_event.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,15 @@ func (eiw *EntityInfoWrapper) WithProviderID(providerID uuid.UUID) *EntityInfoWr
return eiw
}

// WithProtoMessage sets the entity to a protobuf message
// and sets the entity type
func (eiw *EntityInfoWrapper) WithProtoMessage(entType minderv1.Entity, msg protoreflect.ProtoMessage) *EntityInfoWrapper {
eiw.Type = entType
eiw.Entity = msg

return eiw
}

// WithArtifact sets the entity to a versioned artifact sets the entity to a versioned artifact
func (eiw *EntityInfoWrapper) WithArtifact(va *minderv1.Artifact) *EntityInfoWrapper {
eiw.Type = minderv1.Entity_ENTITY_ARTIFACTS
Expand Down Expand Up @@ -547,3 +556,14 @@ func ParseEntityEvent(msg *message.Message) (*EntityInfoWrapper, error) {

return out, nil
}

// WithID sets the ID for an entity type
func (eiw *EntityInfoWrapper) WithID(entType minderv1.Entity, id uuid.UUID) *EntityInfoWrapper {
key, err := getEntityMetadataKey(entType)
if err != nil {
return nil
}

eiw.withID(key, id.String())
return eiw
}
176 changes: 134 additions & 42 deletions internal/engine/entities/entity_event_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,58 +185,150 @@ func Test_parseEntityEvent(t *testing.T) {
}
}

func TestEntityInfoWrapper_RepositoryToMessage(t *testing.T) {
func TestEntityInfoWrapper_ToMessage(t *testing.T) {
t.Parallel()

projectID := uuid.New()
repoID := uuid.New()
providerID := uuid.New()
eiw := NewEntityInfoWrapper().
WithProviderID(providerID).
WithProjectID(projectID).
WithRepository(&pb.Repository{
Owner: "test",
RepoId: 123,
}).WithRepositoryID(repoID)

msg, err := eiw.BuildMessage()
require.NoError(t, err, "unexpected error")

assert.Equal(t, providerID.String(), msg.Metadata.Get(ProviderIDEventKey), "provider ID mismatch")
assert.Equal(t, RepositoryEventEntityType, msg.Metadata.Get(EntityTypeEventKey), "entity type mismatch")
assert.Equal(t, projectID.String(), msg.Metadata.Get(ProjectIDEventKey), "project id mismatch")
assert.Equal(t, repoID.String(), msg.Metadata.Get(RepositoryIDEventKey), "repository id mismatch")
}

func TestEntityInfoWrapper_VersionedArtifact(t *testing.T) {
t.Parallel()

projectID := uuid.New()
artifactID := uuid.New()
repoID := uuid.New()
providerID := uuid.New()
pullRequestID := uuid.New()

eiw := NewEntityInfoWrapper().
WithProviderID(providerID).
WithProjectID(projectID).
WithArtifact(&pb.Artifact{
ArtifactPk: artifactID.String(),
Versions: []*pb.ArtifactVersion{
{
VersionId: 101112,
},
tests := []struct {
name string
eiw *EntityInfoWrapper
expected map[string]string
}{
{
name: "repository event",
eiw: NewEntityInfoWrapper().
WithProviderID(providerID).
WithProjectID(projectID).
WithRepository(&pb.Repository{
Owner: "test",
RepoId: 123,
}).WithRepositoryID(repoID),
expected: map[string]string{
ProviderIDEventKey: providerID.String(),
EntityTypeEventKey: RepositoryEventEntityType,
ProjectIDEventKey: projectID.String(),
RepositoryIDEventKey: repoID.String(),
},
},
{
name: "repository using generic protobuf message and id",
eiw: NewEntityInfoWrapper().
WithProviderID(providerID).
WithProjectID(projectID).
WithProtoMessage(pb.Entity_ENTITY_REPOSITORIES, &pb.Repository{
Owner: "test",
RepoId: 123,
}).
WithID(pb.Entity_ENTITY_REPOSITORIES, repoID),
expected: map[string]string{
ProviderIDEventKey: providerID.String(),
EntityTypeEventKey: RepositoryEventEntityType,
ProjectIDEventKey: projectID.String(),
RepositoryIDEventKey: repoID.String(),
},
},
{
name: "artifact event",
eiw: NewEntityInfoWrapper().
WithProviderID(providerID).
WithProjectID(projectID).
WithArtifact(&pb.Artifact{
ArtifactPk: artifactID.String(),
Versions: []*pb.ArtifactVersion{
{
VersionId: 101112,
},
},
}).WithRepositoryID(repoID).
WithArtifactID(artifactID),
expected: map[string]string{
ProviderIDEventKey: providerID.String(),
EntityTypeEventKey: VersionedArtifactEventEntityType,
ProjectIDEventKey: projectID.String(),
RepositoryIDEventKey: repoID.String(),
ArtifactIDEventKey: artifactID.String(),
},
},
{
name: "artifact using WithID and WithProtoMessage",
eiw: NewEntityInfoWrapper().
WithProviderID(providerID).
WithProjectID(projectID).
WithProtoMessage(pb.Entity_ENTITY_ARTIFACTS, &pb.Artifact{
ArtifactPk: artifactID.String(),
Versions: []*pb.ArtifactVersion{
{
VersionId: 101112,
},
},
}).
WithID(pb.Entity_ENTITY_ARTIFACTS, artifactID),
expected: map[string]string{
ProviderIDEventKey: providerID.String(),
EntityTypeEventKey: VersionedArtifactEventEntityType,
ProjectIDEventKey: projectID.String(),
ArtifactIDEventKey: artifactID.String(),
},
}).WithRepositoryID(repoID).
WithArtifactID(artifactID)
},
{
name: "pull request using WithID and WithProtoMessage",
eiw: NewEntityInfoWrapper().
WithProviderID(providerID).
WithProjectID(projectID).
WithProtoMessage(pb.Entity_ENTITY_PULL_REQUESTS, &pb.PullRequest{
Url: "https://api.github.com/repos/jakubtestorg/bad-npm/pulls/3",
CommitSha: "bd9958a63c9b95ccc2bc0cf1eef65a87529aed16",
Number: 3,
RepoOwner: "jakubtestorg",
RepoName: "bad-npm",
}).
WithID(pb.Entity_ENTITY_PULL_REQUESTS, pullRequestID),
expected: map[string]string{
ProviderIDEventKey: providerID.String(),
EntityTypeEventKey: PullRequestEventEntityType,
ProjectIDEventKey: projectID.String(),
PullRequestIDEventKey: pullRequestID.String(),
},
},
{
name: "pull request using WithPullRequest",
eiw: NewEntityInfoWrapper().
WithProviderID(providerID).
WithProjectID(projectID).
WithPullRequest(&pb.PullRequest{
Url: "https://api.github.com/repos/jakubtestorg/bad-npm/pulls/3",
CommitSha: "bd9958a63c9b95ccc2bc0cf1eef65a87529aed16",
Number: 3,
RepoOwner: "jakubtestorg",
RepoName: "bad-npm",
}).
WithPullRequestID(pullRequestID),
expected: map[string]string{
ProviderIDEventKey: providerID.String(),
EntityTypeEventKey: PullRequestEventEntityType,
ProjectIDEventKey: projectID.String(),
PullRequestIDEventKey: pullRequestID.String(),
},
},
}

msg, err := eiw.BuildMessage()
require.NoError(t, err, "unexpected error")
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()

msg, err := tt.eiw.BuildMessage()
require.NoError(t, err, "unexpected error")

assert.Equal(t, VersionedArtifactEventEntityType, msg.Metadata.Get(EntityTypeEventKey), "entity type mismatch")
assert.Equal(t, projectID.String(), msg.Metadata.Get(ProjectIDEventKey), "project id mismatch")
assert.Equal(t, providerID.String(), msg.Metadata.Get(ProviderIDEventKey), "provider id mismatch")
assert.Equal(t, repoID.String(), msg.Metadata.Get(RepositoryIDEventKey), "repository id mismatch")
assert.Equal(t, artifactID.String(), msg.Metadata.Get(ArtifactIDEventKey), "artifact id mismatch")
for key, expectedValue := range tt.expected {
assert.Equal(t, expectedValue, msg.Metadata.Get(key), key+" mismatch")
}
})
}
}

func TestEntityInfoWrapper_FailsWithoutProjectID(t *testing.T) {
Expand Down