Skip to content

filter out jira investigated findings #1117

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

Merged
ptzianos merged 2 commits into from
Oct 15, 2025
Merged

filter out jira investigated findings #1117

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
b7f5714
jira: add github.com/smithy-security/pkg/utils dependency
ptzianos Oct 15, 2025
ac59de2
jira: filter out any findings with investigation enrichment
ptzianos Oct 15, 2025
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
2 changes: 1 addition & 1 deletion components/reporters/jira/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ require (
github.com/go-errors/errors v1.5.1
github.com/smithy-security/pkg/env v0.0.3
github.com/smithy-security/pkg/retry v0.0.3
github.com/smithy-security/pkg/utils v0.0.2
github.com/smithy-security/smithy/sdk v0.0.19-alpha
github.com/stretchr/testify v1.10.0
go.uber.org/mock v0.5.0
Expand Down Expand Up @@ -51,7 +52,6 @@ require (
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/russross/blackfriday/v2 v2.1.0 // indirect
github.com/shopspring/decimal v1.4.0 // indirect
github.com/smithy-security/pkg/utils v0.0.2 // indirect
github.com/spf13/cast v1.7.1 // indirect
github.com/sqlc-dev/sqlc v1.28.0 // indirect
github.com/trivago/tgo v1.0.7 // indirect
Expand Down
24 changes: 24 additions & 0 deletions components/reporters/jira/internal/reporter/reporter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ func (r *reporter) Report(
) error {
logger := componentlogger.LoggerFromContext(ctx)

findings = r.removeInvestigatedFindings(findings)

logger.Debug("preparing to report issues...")
if len(findings) == 0 {
logger.Debug("no findings to report, skipping")
Expand Down Expand Up @@ -129,6 +131,28 @@ func (r *reporter) Report(
return nil
}

// removeInvestigatedFindings removes any vulnerability finding that has an
// investigation annotation because that could mess with the reporter to Jira
// skipping for now until we can improve the situation
func (r *reporter) removeInvestigatedFindings(vulnFindings []*vf.VulnerabilityFinding) []*vf.VulnerabilityFinding {
var filteredVulnFindings []*vf.VulnerabilityFinding
for _, vulnFinding := range vulnFindings {
investigationEnrichmentFound := false
for _, enrichment := range vulnFinding.Finding.Enrichments {
if enrichment.Name == ocsffindinginfo.Enrichment_ENRICHMENT_TYPE_INVESTIGATION.String() {
investigationEnrichmentFound = true
break
}
}

if !investigationEnrichmentFound {
filteredVulnFindings = append(filteredVulnFindings, vulnFinding)
}
}

return filteredVulnFindings
}

func (r *reporter) toIssues(tpl *template.Template, vf *vf.VulnerabilityFinding) ([]issuer.Issue, error) {
const (
unknownValue = "unknown"
Expand Down
194 changes: 125 additions & 69 deletions components/reporters/jira/internal/reporter/reporter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,19 @@ import (
"testing"
"time"

"github.com/smithy-security/pkg/utils"
vf "github.com/smithy-security/smithy/sdk/component/vulnerability-finding"
ocsffindinginfo "github.com/smithy-security/smithy/sdk/gen/ocsf_ext/finding_info/v1"
ocsf "github.com/smithy-security/smithy/sdk/gen/ocsf_schema/v1"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.uber.org/mock/gomock"
"google.golang.org/protobuf/encoding/protojson"

vf "github.com/smithy-security/smithy/sdk/component/vulnerability-finding"
ocsffindinginfo "github.com/smithy-security/smithy/sdk/gen/ocsf_ext/finding_info/v1"
ocsf "github.com/smithy-security/smithy/sdk/gen/ocsf_schema/v1"

"github.com/smithy-security/smithy/components/reporters/jira/internal/issuer"
"github.com/smithy-security/smithy/components/reporters/jira/internal/reporter"
)

func ptr[T any](v T) *T {
return &v
}

func TestReporter_Report(t *testing.T) {
const (
testBaseURL = "https://smithy.example.com"
Expand All @@ -40,61 +36,65 @@ func TestReporter_Report(t *testing.T) {
expectedDesc3, err := os.ReadFile(filepath.Join("testdata", "expected_issue3.txt"))
require.NoError(t, err)

dataSourceRepo := &ocsffindinginfo.DataSource{
TargetType: ocsffindinginfo.DataSource_TARGET_TYPE_REPOSITORY,
Uri: &ocsffindinginfo.DataSource_URI{
UriSchema: ocsffindinginfo.DataSource_URI_SCHEMA_FILE,
Path: "util/middleware/middleware.go",
},
LocationData: &ocsffindinginfo.DataSource_FileFindingLocationData_{
FileFindingLocationData: &ocsffindinginfo.DataSource_FileFindingLocationData{

@github-actions github-actions Bot Oct 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[go/errcheck] reported by reviewdog 🐶
baseURL, _ = url.Parse(testBaseURL)

StartLine: 70,
EndLine: 76,
StartColumn: 4,
EndColumn: 4,
},
},
SourceCodeMetadata: &ocsffindinginfo.DataSource_SourceCodeMetadata{
RepositoryUrl: "https://github.com/0c34/govwa",
Reference: "master",
},
}
dataSourceRepoJSON, err := protojson.Marshal(dataSourceRepo)
require.NoError(t, err)

baseURL, err := url.Parse(testBaseURL)
require.NoError(t, err)

var (
ctrl = gomock.NewController(t)
mockIssueCreator = NewMockIssueCreator(ctrl)
baseURL, _ = url.Parse(testBaseURL)
batchCreateErr = errors.New("batch create error")
dataSourceRepo = &ocsffindinginfo.DataSource{
TargetType: ocsffindinginfo.DataSource_TARGET_TYPE_REPOSITORY,
Uri: &ocsffindinginfo.DataSource_URI{
UriSchema: ocsffindinginfo.DataSource_URI_SCHEMA_FILE,
Path: "util/middleware/middleware.go",
},
LocationData: &ocsffindinginfo.DataSource_FileFindingLocationData_{
FileFindingLocationData: &ocsffindinginfo.DataSource_FileFindingLocationData{
StartLine: 70,
EndLine: 76,
StartColumn: 4,
EndColumn: 4,
},
},
SourceCodeMetadata: &ocsffindinginfo.DataSource_SourceCodeMetadata{
RepositoryUrl: "https://github.com/0c34/govwa",
Reference: "master",
},
}
dataSourceRepoJson, _ = protojson.Marshal(dataSourceRepo)
vulnerabilities = []*ocsf.Vulnerability{
vulnerabilities = []*ocsf.Vulnerability{
{
Title: ptr("Vulnerability 1"),
Desc: ptr("Description 1"),
Severity: ptr("SEVERITY_ID_MEDIUM"),
VendorName: ptr("gosec"),
Title: utils.Ptr("Vulnerability 1"),
Desc: utils.Ptr("Description 1"),
Severity: utils.Ptr("SEVERITY_ID_MEDIUM"),
VendorName: utils.Ptr("gosec"),
Cve: &ocsf.Cve{
Uid: "CVE-2022-1234",
Desc: ptr("CVE Description"),
Desc: utils.Ptr("CVE Description"),
},
Cwe: &ocsf.Cwe{
Caption: ptr("CWE-79"),
SrcUrl: ptr("https://cwe.mitre.org/data/definitions/79.html"),
Caption: utils.Ptr("CWE-79"),
SrcUrl: utils.Ptr("https://cwe.mitre.org/data/definitions/79.html"),
},
},
{
Title: ptr("Vulnerability 2"),
Desc: ptr("Description 2"),
Severity: ptr("SEVERITY_ID_HIGH"),
VendorName: ptr("semgrep"),
Title: utils.Ptr("Vulnerability 2"),
Desc: utils.Ptr("Description 2"),
Severity: utils.Ptr("SEVERITY_ID_HIGH"),
VendorName: utils.Ptr("semgrep"),
Cwe: &ocsf.Cwe{
Caption: ptr("CWE-89"),
SrcUrl: ptr("https://cwe.mitre.org/data/definitions/89.html"),
Caption: utils.Ptr("CWE-89"),
SrcUrl: utils.Ptr("https://cwe.mitre.org/data/definitions/89.html"),
},
},
{
Title: ptr("Vulnerability 3"),
Desc: ptr("Description 3"),
Severity: ptr("SEVERITY_ID_CRITICAL"),
VendorName: ptr("snyk"),
Title: utils.Ptr("Vulnerability 3"),
Desc: utils.Ptr("Description 3"),
Severity: utils.Ptr("SEVERITY_ID_CRITICAL"),
VendorName: utils.Ptr("snyk"),
Cve: &ocsf.Cve{
Uid: "CVE-2023-5678",
},
Expand All @@ -106,11 +106,11 @@ func TestReporter_Report(t *testing.T) {
Finding: &ocsf.VulnerabilityFinding{
FindingInfo: &ocsf.FindingInfo{
DataSources: []string{
string(dataSourceRepoJson),
string(dataSourceRepoJSON),
},
},
ConfidenceId: ptr(ocsf.VulnerabilityFinding_CONFIDENCE_ID_HIGH),
Confidence: ptr("High"),
ConfidenceId: utils.Ptr(ocsf.VulnerabilityFinding_CONFIDENCE_ID_HIGH),
Confidence: utils.Ptr("High"),
Vulnerabilities: vulnerabilities,
},
},
Expand Down Expand Up @@ -146,11 +146,11 @@ func TestReporter_Report(t *testing.T) {
Finding: &ocsf.VulnerabilityFinding{
FindingInfo: &ocsf.FindingInfo{
DataSources: []string{
string(dataSourceRepoJson),
string(dataSourceRepoJSON),
},
},
ConfidenceId: ptr(ocsf.VulnerabilityFinding_CONFIDENCE_ID_HIGH),
Confidence: ptr("High"),
ConfidenceId: utils.Ptr(ocsf.VulnerabilityFinding_CONFIDENCE_ID_HIGH),
Confidence: utils.Ptr("High"),
Vulnerabilities: []*ocsf.Vulnerability{vulnerabilities[0]},
},
},
Expand All @@ -161,11 +161,11 @@ func TestReporter_Report(t *testing.T) {
Finding: &ocsf.VulnerabilityFinding{
FindingInfo: &ocsf.FindingInfo{
DataSources: []string{
string(dataSourceRepoJson),
string(dataSourceRepoJSON),
},
},
ConfidenceId: ptr(ocsf.VulnerabilityFinding_CONFIDENCE_ID_HIGH),
Confidence: ptr("High"),
ConfidenceId: utils.Ptr(ocsf.VulnerabilityFinding_CONFIDENCE_ID_HIGH),
Confidence: utils.Ptr("High"),
Vulnerabilities: []*ocsf.Vulnerability{vulnerabilities[1]},
},
},
Expand All @@ -176,11 +176,11 @@ func TestReporter_Report(t *testing.T) {
Finding: &ocsf.VulnerabilityFinding{
FindingInfo: &ocsf.FindingInfo{
DataSources: []string{
string(dataSourceRepoJson),
string(dataSourceRepoJSON),
},
},
ConfidenceId: ptr(ocsf.VulnerabilityFinding_CONFIDENCE_ID_HIGH),
Confidence: ptr("High"),
ConfidenceId: utils.Ptr(ocsf.VulnerabilityFinding_CONFIDENCE_ID_HIGH),
Confidence: utils.Ptr("High"),
Vulnerabilities: []*ocsf.Vulnerability{vulnerabilities[2]},
},
},
Expand All @@ -197,8 +197,8 @@ func TestReporter_Report(t *testing.T) {
require.NoError(t, err)

t.Run("successful report", func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
t.Cleanup(cancel)

mockIssueCreator.EXPECT().
BatchCreate(ctx, expectedIssues).
Expand All @@ -209,16 +209,16 @@ func TestReporter_Report(t *testing.T) {
})

t.Run("empty findings list", func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
t.Cleanup(cancel)

err = testReporter.Report(ctx, []*vf.VulnerabilityFinding{})
require.NoError(t, err)
})

t.Run("failed to create issues with false bool", func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
t.Cleanup(cancel)

mockIssueCreator.EXPECT().
BatchCreate(ctx, []issuer.Issue{expectedIssue1}).
Expand All @@ -230,8 +230,8 @@ func TestReporter_Report(t *testing.T) {
})

t.Run("partial success with true bool", func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
t.Cleanup(cancel)

mockIssueCreator.EXPECT().
BatchCreate(ctx, []issuer.Issue{expectedIssue2}).
Expand All @@ -242,8 +242,8 @@ func TestReporter_Report(t *testing.T) {
})

t.Run("no issues created", func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
t.Cleanup(cancel)

mockIssueCreator.EXPECT().
BatchCreate(ctx, []issuer.Issue{expectedIssue3}).
Expand All @@ -252,4 +252,60 @@ func TestReporter_Report(t *testing.T) {
err = testReporter.Report(ctx, simpleFindings3)
require.NoError(t, err)
})

t.Run("investigated findings are skipped", func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
t.Cleanup(cancel)

dataSourceRepo = &ocsffindinginfo.DataSource{
TargetType: ocsffindinginfo.DataSource_TARGET_TYPE_WEBSITE,
Uri: &ocsffindinginfo.DataSource_URI{
UriSchema: ocsffindinginfo.DataSource_URI_SCHEMA_WEBSITE,
Path: "https://example.com",
},
}
dataSourceRepoJSON, err = protojson.Marshal(dataSourceRepo)
require.NoError(t, err)

err = testReporter.Report(
ctx,
[]*vf.VulnerabilityFinding{
{
ID: 1,
Finding: &ocsf.VulnerabilityFinding{
FindingInfo: &ocsf.FindingInfo{
DataSources: []string{
string(dataSourceRepoJSON),
},
},
ConfidenceId: utils.Ptr(ocsf.VulnerabilityFinding_CONFIDENCE_ID_HIGH),
Confidence: utils.Ptr("High"),
Enrichments: []*ocsf.Enrichment{
{
Name: ocsffindinginfo.Enrichment_ENRICHMENT_TYPE_INVESTIGATION.String(),
Type: utils.Ptr(ocsffindinginfo.Enrichment_ENRICHMENT_TYPE_INVESTIGATION.String()),
},
},
Vulnerabilities: []*ocsf.Vulnerability{
{
Title: utils.Ptr("Vulnerability 1"),
Desc: utils.Ptr("Description 1"),
Severity: utils.Ptr("SEVERITY_ID_MEDIUM"),
VendorName: utils.Ptr("gosec"),
Cve: &ocsf.Cve{
Uid: "CVE-2022-1234",
Desc: utils.Ptr("CVE Description"),
},
Cwe: &ocsf.Cwe{
Caption: utils.Ptr("CWE-79"),
SrcUrl: utils.Ptr("https://cwe.mitre.org/data/definitions/79.html"),
},
},
},
},
},
},
)
require.NoError(t, err)
})
}
Loading