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

Drop internal trusty REST code in favor of client from trusty-sdk #3523

Merged
merged 2 commits into from
Jun 13, 2024
Merged

Drop internal trusty REST code in favor of client from trusty-sdk #3523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f887754
Drop trusty REST client for SDK
puerco Jun 5, 2024
4d1a119
go.mod: Pull trusty SDK
puerco Jun 5, 2024
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
1 change: 1 addition & 0 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ require (
github.com/spf13/viper v1.19.0
github.com/sqlc-dev/pqtype v0.3.0
github.com/stacklok/frizbee v0.0.19
github.com/stacklok/trusty-sdk-go v0.1.0
github.com/stretchr/testify v1.9.0
github.com/styrainc/regal v0.22.0
github.com/thomaspoignant/go-feature-flag v1.30.0
Expand Down
2 changes: 2 additions & 0 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -866,6 +866,8 @@ github.com/sqlc-dev/pqtype v0.3.0 h1:b09TewZ3cSnO5+M1Kqq05y0+OjqIptxELaSayg7bmqk
github.com/sqlc-dev/pqtype v0.3.0/go.mod h1:oyUjp5981ctiL9UYvj1bVvCKi8OXkCa0u645hce7CAs=
github.com/stacklok/frizbee v0.0.19 h1:lD5O5e1lCYl6yGTtWW93m2w60TMeTJB5oLXMeaHnFHo=
github.com/stacklok/frizbee v0.0.19/go.mod h1:Hvi3/ryonTgeMBG4/EtBGjfK49W0rP0P3+0RAg3kqHI=
github.com/stacklok/trusty-sdk-go v0.1.0 h1:b0m9HrAjJpyorev7vMbGf56UUMI1XyUBgd3SwnHCPh0=
github.com/stacklok/trusty-sdk-go v0.1.0/go.mod h1:OWk/FxKjjFw+mQnCKaytoYL7vMWoj+8Ep2TYsp8QSaI=
github.com/stoewer/go-strcase v1.3.0 h1:g0eASXYtp+yvN9fK8sH94oCIk0fau9uV1/ZdJ0AVEzs=
github.com/stoewer/go-strcase v1.3.0/go.mod h1:fAH5hQ5pehh+j3nZfvwdk2RgEgQjAoM8wodgtPmh1xo=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
Expand Down
5 changes: 3 additions & 2 deletions internal/engine/eval/trusty/actions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import (

"github.com/google/go-github/v61/github"
"github.com/rs/zerolog"
trustytypes "github.com/stacklok/trusty-sdk-go/pkg/types"

"github.com/stacklok/minder/internal/constants"
"github.com/stacklok/minder/internal/engine/eval/pr_actions"
Expand Down Expand Up @@ -201,7 +202,7 @@ type dependencyAlternatives struct {
BlockPR bool

// trustyReply is the complete response from trusty for this package
trustyReply *Reply
trustyReply *trustytypes.Reply
}

// summaryPrHandler is a prStatusHandler that adds a summary text to the PR as a comment.
Expand Down Expand Up @@ -345,7 +346,7 @@ func (sph *summaryPrHandler) generateSummary() (string, error) {
}

// buildProvenanceStruct builds the provenance data structure for the PR template
func buildProvenanceStruct(r *Reply) *templateProvenance {
func buildProvenanceStruct(r *trustytypes.Reply) *templateProvenance {
if r == nil || r.Provenance == nil {
return nil
}
Expand Down
31 changes: 16 additions & 15 deletions internal/engine/eval/trusty/actions_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package trusty
import (
"testing"

trustytypes "github.com/stacklok/trusty-sdk-go/pkg/types"
"github.com/stretchr/testify/require"

v1 "github.com/stacklok/minder/pkg/api/protobuf/go/minder/v1"
Expand All @@ -36,23 +37,23 @@ func TestBuildProvenanceStruct(t *testing.T) {
t.Parallel()
for _, tc := range []struct {
name string
sut *Reply
sut *trustytypes.Reply
mustNil bool
expected *templateProvenance
}{
{
name: "full-response",
sut: &Reply{
Provenance: &Provenance{
sut: &trustytypes.Reply{
Provenance: &trustytypes.Provenance{
Score: 8.0,
Description: ProvenanceDescription{
Historical: HistoricalProvenance{
Description: trustytypes.ProvenanceDescription{
Historical: trustytypes.HistoricalProvenance{
Tags: 10,
Common: 8,
Overlap: 80,
Versions: 10,
},
Sigstore: SigstoreProvenance{
Sigstore: trustytypes.SigstoreProvenance{
Issuer: "CN=sigstore-intermediate,O=sigstore.dev",
Workflow: ".github/workflows/build_and_deploy.yml",
SourceRepository: "https://github.com/vercel/next.js",
Expand All @@ -78,11 +79,11 @@ func TestBuildProvenanceStruct(t *testing.T) {
},
{
name: "only-historical",
sut: &Reply{
Provenance: &Provenance{
sut: &trustytypes.Reply{
Provenance: &trustytypes.Provenance{
Score: 8.0,
Description: ProvenanceDescription{
Historical: HistoricalProvenance{
Description: trustytypes.ProvenanceDescription{
Historical: trustytypes.HistoricalProvenance{
Tags: 10,
Common: 8,
Overlap: 80,
Expand All @@ -102,11 +103,11 @@ func TestBuildProvenanceStruct(t *testing.T) {
},
{
name: "only-sigstore",
sut: &Reply{
Provenance: &Provenance{
sut: &trustytypes.Reply{
Provenance: &trustytypes.Provenance{
Score: 8.0,
Description: ProvenanceDescription{
Sigstore: SigstoreProvenance{
Description: trustytypes.ProvenanceDescription{
Sigstore: trustytypes.SigstoreProvenance{
Issuer: "CN=sigstore-intermediate,O=sigstore.dev",
Workflow: ".github/workflows/build_and_deploy.yml",
SourceRepository: "https://github.com/vercel/next.js",
Expand All @@ -132,7 +133,7 @@ func TestBuildProvenanceStruct(t *testing.T) {
},
{
name: "no-provenance",
sut: &Reply{},
sut: &trustytypes.Reply{},
mustNil: true,
},
} {
Expand Down
32 changes: 20 additions & 12 deletions internal/engine/eval/trusty/trusty.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ import (
"strings"

"github.com/rs/zerolog"
trusty "github.com/stacklok/trusty-sdk-go/pkg/client"
trustytypes "github.com/stacklok/trusty-sdk-go/pkg/types"

evalerrors "github.com/stacklok/minder/internal/engine/errors"
"github.com/stacklok/minder/internal/engine/eval/pr_actions"
Expand All @@ -41,7 +43,7 @@ const (
type Evaluator struct {
cli provifv1.GitHub
endpoint string
client *trustyClient
client *trusty.Trusty
}

// NewTrustyEvaluator creates a new trusty evaluator
Expand All @@ -55,21 +57,21 @@ func NewTrustyEvaluator(ctx context.Context, ghcli provifv1.GitHub) (*Evaluator,

// If the environment variable is not set, use the default endpoint
if trustyEndpoint == "" {
trustyEndpoint = trustyEndpointURL
trustyEndpoint = trusty.DefaultOptions.BaseURL
zerolog.Ctx(ctx).Info().Str("trusty-endpoint", trustyEndpoint).Msg("using default trusty endpoint")
} else {
zerolog.Ctx(ctx).Info().Str("trusty-endpoint", trustyEndpoint).Msg("using trusty endpoint from environment")
}

piCli := newPiClient(trustyEndpoint)
if piCli == nil {
return nil, fmt.Errorf("failed to create pi client")
}
trustyClient := trusty.NewWithOptions(trusty.Options{
HttpClient: trusty.DefaultOptions.HttpClient,
BaseURL: trustyEndpoint,
})

return &Evaluator{
cli: ghcli,
endpoint: trustyEndpoint,
client: piCli,
client: trustyClient,
}, nil
}

Expand Down Expand Up @@ -221,9 +223,15 @@ func buildEvalResult(prSummary *summaryPrHandler) error {
return nil
}

func getDependencyScore(ctx context.Context, trusty *trustyClient, dep *pb.PrDependencies_ContextualDependency) (*Reply, error) {
func getDependencyScore(
ctx context.Context, trustyClient *trusty.Trusty, dep *pb.PrDependencies_ContextualDependency,
) (*trustytypes.Reply, error) {
// Call the Trusty API
resp, err := trusty.SendRecvRequest(ctx, dep.Dep)
resp, err := trustyClient.Report(ctx, &trustytypes.Dependency{
Name: dep.Dep.Name,
Version: dep.Dep.Version,
Ecosystem: trustytypes.Ecosystem(dep.Dep.Ecosystem),
})
if err != nil {
return nil, fmt.Errorf("failed to send request: %w", err)
}
Expand All @@ -233,7 +241,7 @@ func getDependencyScore(ctx context.Context, trusty *trustyClient, dep *pb.PrDep
// classifyDependency checks the dependencies from the PR for maliciousness or
// low scores and adds them to the summary if needed
func classifyDependency(
_ context.Context, logger *zerolog.Logger, resp *Reply, ruleConfig *config,
_ context.Context, logger *zerolog.Logger, resp *trustytypes.Reply, ruleConfig *config,
prSummary *summaryPrHandler, dep *pb.PrDependencies_ContextualDependency,
) {
// Check all the policy violations
Expand Down Expand Up @@ -319,10 +327,10 @@ func classifyDependency(

// readPackageDescription reads the description from the package summary and
// normlizes the required values when missing from a partial Trusty response
func readPackageDescription(resp *Reply) map[string]any {
func readPackageDescription(resp *trustytypes.Reply) map[string]any {
descr := map[string]any{}
if resp == nil {
resp = &Reply{}
resp = &trustytypes.Reply{}
}
if resp.Summary.Description != nil {
descr = resp.Summary.Description
Expand Down
175 changes: 0 additions & 175 deletions internal/engine/eval/trusty/trusty_rest_handler.go
View file
Open in desktop

This file was deleted.

Loading