Skip to content

🌱 add support for trivy SAST tool #4685

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

Closed
wants to merge 2 commits into from
Closed

🌱 add support for trivy SAST tool #4685

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
d64381c
🌱 add support for trivy SAST tool
AdamKorcz Jun 28, 2025
e9e391f
remove tool from app list
AdamKorcz Jul 9, 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: 2 additions & 0 deletions checker/raw_result.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,8 @@ const (
PysaWorkflow SASTWorkflowType = "Pysa"
// QodanaWorkflow represents a workflow that runs Qodana.
QodanaWorkflow SASTWorkflowType = "Qodana"
// TrivyWorkflow represents a workflow that runs Trivy.
TrivyWorkflow SASTWorkflowType = "Trivy"
)

// SASTWorkflow represents a SAST workflow.
Expand Down
19 changes: 19 additions & 0 deletions checks/evaluation/sast_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,25 @@ func TestSAST(t *testing.T) {
NumberOfInfo: 2,
},
},
{
name: "Trivy is installed, no other SAST tools are installed",
findings: []finding.Finding{
tool(checker.TrivyWorkflow),
{
Probe: sastToolRunsOnAllCommits.Probe,
Outcome: finding.OutcomeTrue,
Values: map[string]string{
sastToolRunsOnAllCommits.AnalyzedPRsKey: "1",
sastToolRunsOnAllCommits.TotalPRsKey: "3",
},
},
},
result: scut.TestReturn{
Score: 10,
NumberOfWarn: 0,
NumberOfInfo: 2,
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand Down
6 changes: 6 additions & 0 deletions checks/raw/sast.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,12 @@ func SAST(c *checker.CheckRequest) (checker.SASTData, error) {
}
data.Workflows = append(data.Workflows, qodanaWorkflows...)

trivyWorkflows, err := getSastUsesWorkflows(c, "^aquasecurity/trivy-action$", checker.TrivyWorkflow)
if err != nil {
return data, err
}
data.Workflows = append(data.Workflows, trivyWorkflows...)

return data, nil
}

Expand Down
23 changes: 23 additions & 0 deletions checks/raw/sast_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,29 @@ func TestSAST(t *testing.T) {
},
},
},
{
name: "Has Trivy",
files: []string{".github/workflows/github-trivy-workflow.yaml"},
commits: []clients.Commit{
{
AssociatedMergeRequest: clients.PullRequest{
Number: 1,
},
},
},
expected: checker.SASTData{
Workflows: []checker.SASTWorkflow{
{
Type: checker.TrivyWorkflow,
File: checker.File{
Path: ".github/workflows/github-trivy-workflow.yaml",
Offset: checker.OffsetDefault,
Type: finding.FileTypeSource,
},
},
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand Down
24 changes: 24 additions & 0 deletions checks/raw/testdata/.github/workflows/github-trivy-workflow.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: build
on:
push:
branches:
- main
pull_request:
jobs:
build:
name: Build
runs-on: ubuntu-24.04
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Build an image from Dockerfile
run: docker build -t docker.io/my-organization/my-app:${{ github.sha }} .
- name: Run Trivy vulnerability scanner
uses: aquasecurity/[email protected]
with:
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
format: 'table'
exit-code: '1'
ignore-unfixed: true
vuln-type: 'os,library'
severity: 'CRITICAL,HIGH'
83 changes: 77 additions & 6 deletions checks/sast_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,10 @@ func Test_SAST(t *testing.T) {
},
},
searchresult: clients.SearchResponse{},
searchRequest: clients.SearchRequest{
Query: "github/codeql-action/analyze",
Path: "/.github/workflows",
},
Comment on lines +79 to +82
Copy link
Member

Choose a reason for hiding this comment

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

let's revert the search request changes in this file like in 7846164

checkRuns: []clients.CheckRun{
{
Status: "completed",
Expand All @@ -101,6 +105,10 @@ func Test_SAST(t *testing.T) {
},
},
searchresult: clients.SearchResponse{},
searchRequest: clients.SearchRequest{
Query: "github/codeql-action/analyze",
Path: "/.github/workflows",
},
checkRuns: []clients.CheckRun{
{
Status: "completed",
Expand All @@ -126,6 +134,10 @@ func Test_SAST(t *testing.T) {
},
},
searchresult: clients.SearchResponse{},
searchRequest: clients.SearchRequest{
Query: "github/codeql-action/analyze",
Path: "/.github/workflows",
},
checkRuns: []clients.CheckRun{
{
Status: "completed",
Expand All @@ -152,6 +164,10 @@ func Test_SAST(t *testing.T) {
},
},
searchresult: clients.SearchResponse{},
searchRequest: clients.SearchRequest{
Query: "github/codeql-action/analyze",
Path: "/.github/workflows",
},
checkRuns: []clients.CheckRun{
{
Status: "completed",
Expand All @@ -178,7 +194,11 @@ func Test_SAST(t *testing.T) {
},
},
searchresult: clients.SearchResponse{},
path: ".github/workflows/airflow-codeql-workflow.yaml",
searchRequest: clients.SearchRequest{
Query: "github/codeql-action/analyze",
Path: "/.github/workflows",
},
path: ".github/workflows/airflow-codeql-workflow.yaml",
expected: scut.TestReturn{
Score: 7,
NumberOfWarn: 1,
Expand All @@ -196,6 +216,10 @@ func Test_SAST(t *testing.T) {
},
},
searchresult: clients.SearchResponse{},
searchRequest: clients.SearchRequest{
Query: "github/codeql-action/analyze",
Path: "/.github/workflows",
},
checkRuns: []clients.CheckRun{
{
Status: "completed",
Expand Down Expand Up @@ -231,6 +255,10 @@ func Test_SAST(t *testing.T) {
},
},
searchresult: clients.SearchResponse{},
searchRequest: clients.SearchRequest{
Query: "github/codeql-action/analyze",
Path: "/.github/workflows",
},
checkRuns: []clients.CheckRun{
{
Status: "completed",
Expand Down Expand Up @@ -271,6 +299,10 @@ func Test_SAST(t *testing.T) {
},
},
searchresult: clients.SearchResponse{},
searchRequest: clients.SearchRequest{
Query: "github/codeql-action/analyze",
Path: "/.github/workflows",
},
checkRuns: []clients.CheckRun{
{
Status: "notCompletedForTestingOnly",
Expand All @@ -294,12 +326,51 @@ func Test_SAST(t *testing.T) {
NumberOfInfo: 1,
},
},
{
name: `Trivy workflow with commits`,
err: nil,
commits: []clients.Commit{
{
AssociatedMergeRequest: clients.PullRequest{
MergedAt: time.Now().Add(time.Hour - 1),
},
},
{
AssociatedMergeRequest: clients.PullRequest{
MergedAt: time.Now().Add(time.Hour - 2),
},
},
},
searchresult: clients.SearchResponse{},
searchRequest: clients.SearchRequest{
Query: "github/aquasecurity/trivy-action",
Path: "/.github/workflows",
},
checkRuns: []clients.CheckRun{
{
Status: "completed",
Conclusion: "success",
App: clients.CheckRunApp{
Slug: "aqua-security-trivy",
},
},
{
Status: "completed",
Conclusion: "success",
App: clients.CheckRunApp{
Slug: "aqua-security-trivy",
},
},
Comment on lines +349 to +363
Copy link
Member

Choose a reason for hiding this comment

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

same comment about checkRuns reverts
7846164#diff-d8b8a85f712c853eb9ef66ae055c6b18ad46f699b2b55606953c2af654af5ffbL354-L373

},
path: ".github/workflows/github-trivy-workflow.yaml",
expected: scut.TestReturn{
Score: checker.MaxResultScore,
NumberOfDebug: 2,
NumberOfInfo: 2,
},
},
}
for _, tt := range tests {
searchRequest := clients.SearchRequest{
Query: "github/codeql-action/analyze",
Path: "/.github/workflows",
}
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
ctrl := gomock.NewController(t)
Expand All @@ -311,7 +382,7 @@ func Test_SAST(t *testing.T) {
return tt.commits, tt.err
})
mockRepoClient.EXPECT().ListCheckRunsForRef("").Return(tt.checkRuns, nil).AnyTimes()
mockRepoClient.EXPECT().Search(searchRequest).Return(tt.searchresult, nil).AnyTimes()
mockRepoClient.EXPECT().Search(tt.searchRequest).Return(tt.searchresult, nil).AnyTimes()
mockRepoClient.EXPECT().ListFiles(gomock.Any()).DoAndReturn(
func(predicate func(string) (bool, error)) ([]string, error) {
if strings.Contains(tt.path, "pom") {
Expand Down
24 changes: 24 additions & 0 deletions checks/testdata/.github/workflows/github-trivy-workflow.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: build
on:
push:
branches:
- main
pull_request:
jobs:
build:
name: Build
runs-on: ubuntu-24.04
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Build an image from Dockerfile
run: docker build -t docker.io/my-organization/my-app:${{ github.sha }} .
- name: Run Trivy vulnerability scanner
uses: aquasecurity/[email protected]
with:
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
format: 'table'
exit-code: '1'
ignore-unfixed: true
vuln-type: 'os,library'
severity: 'CRITICAL,HIGH'
17 changes: 17 additions & 0 deletions probes/sastToolConfigured/impl_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,17 @@ func Test_Run(t *testing.T) {
{
Type: checker.PysaWorkflow,
},
{
Type: checker.TrivyWorkflow,
},
},
},
},
outcomes: []finding.Outcome{
finding.OutcomeTrue,
finding.OutcomeTrue,
finding.OutcomeTrue,
finding.OutcomeTrue,
},
},
}
Expand Down Expand Up @@ -148,6 +152,19 @@ func Test_Run_tools(t *testing.T) {
},
tools: []string{"Sonar", "Pysa"},
},
{
name: "Trivy",
raw: &checker.RawResults{
SASTResults: checker.SASTData{
Workflows: []checker.SASTWorkflow{
{
Type: checker.TrivyWorkflow,
},
},
},
},
tools: []string{"Trivy"},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand Down
Loading