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

refactor: use defined types #5225

Merged
merged 9 commits into from
Sep 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 11 additions & 4 deletions .golangci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,21 @@ linters-settings:
min-occurrences: 3
misspell:
locale: US
goimports:
local-prefixes: github.com/aquasecurity
ignore-words:
- licence
gosec:
excludes:
- G101
- G114
- G204
- G402
gci:
sections:
- standard
- default
- prefix(github.com/aquasecurity/)
- blank
- dot

linters:
disable-all: true
Expand All @@ -39,14 +46,14 @@ linters:
- goconst
- gocyclo
- gofmt
- goimports
- misspell
- gci

run:
go: '1.20'
skip-files:
- ".*._mock.go$"
- ".*._test.go$"
- ".*_test.go$"
- "integration/*"
- "examples/*"

Expand Down
2 changes: 1 addition & 1 deletion aqua.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ registries:
- type: standard
ref: v3.157.0 # renovate: depName=aquaproj/aqua-registry
packages:
- name: tinygo-org/tinygo@v0.27.0
- name: tinygo-org/tinygo@v0.29.0
- name: WebAssembly/binaryen@version_112
- name: magefile/mage@v1.14.0
2 changes: 1 addition & 1 deletion contrib/html.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
<h1>{{- escapeXML ( index . 0 ).Target }} - Trivy Report - {{ now }}</h1>
<table>
{{- range . }}
<tr class="group-header"><th colspan="6">{{ escapeXML .Type }}</th></tr>
<tr class="group-header"><th colspan="6">{{ .Type | toString | escapeXML }}</th></tr>
{{- if (eq (len .Vulnerabilities) 0) }}
<tr><th colspan="6">No Vulnerabilities found</th></tr>
{{- else }}
Expand Down
3 changes: 1 addition & 2 deletions pkg/cache/remote_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ import (
"testing"
"time"

rpcScanner "github.com/aquasecurity/trivy/rpc/scanner"

google_protobuf "github.com/golang/protobuf/ptypes/empty"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
Expand All @@ -20,6 +18,7 @@ import (
fcache "github.com/aquasecurity/trivy/pkg/fanal/cache"
"github.com/aquasecurity/trivy/pkg/fanal/types"
rpcCache "github.com/aquasecurity/trivy/rpc/cache"
rpcScanner "github.com/aquasecurity/trivy/rpc/scanner"
)

type mockCacheServer struct {
Expand Down
8 changes: 4 additions & 4 deletions pkg/cloud/aws/commands/run_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ import (
"testing"
"time"

defsecTypes "github.com/aquasecurity/defsec/pkg/types"
"github.com/aquasecurity/trivy/pkg/compliance/spec"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

defsecTypes "github.com/aquasecurity/defsec/pkg/types"
dbTypes "github.com/aquasecurity/trivy-db/pkg/types"
"github.com/aquasecurity/trivy/pkg/compliance/spec"
"github.com/aquasecurity/trivy/pkg/flag"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

const expectedS3ScanResult = `{
Expand Down
9 changes: 3 additions & 6 deletions pkg/cloud/report/convert_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,13 @@ import (
"sort"
"testing"

fanaltypes "github.com/aquasecurity/trivy/pkg/fanal/types"

"github.com/aws/aws-sdk-go-v2/aws/arn"

defsecTypes "github.com/aquasecurity/defsec/pkg/types"
"github.com/aquasecurity/trivy/pkg/types"

"github.com/stretchr/testify/assert"

"github.com/aquasecurity/defsec/pkg/scan"
defsecTypes "github.com/aquasecurity/defsec/pkg/types"
fanaltypes "github.com/aquasecurity/trivy/pkg/fanal/types"
"github.com/aquasecurity/trivy/pkg/types"
)

func Test_ResultConversion(t *testing.T) {
Expand Down
3 changes: 1 addition & 2 deletions pkg/cloud/report/resource.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@ import (
"sort"
"strconv"

"github.com/aquasecurity/tml"

"golang.org/x/term"

"github.com/aquasecurity/table"
"github.com/aquasecurity/tml"
pkgReport "github.com/aquasecurity/trivy/pkg/report/table"
"github.com/aquasecurity/trivy/pkg/types"
)
Expand Down
4 changes: 1 addition & 3 deletions pkg/cloud/report/result.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@ import (
"io"

"github.com/aquasecurity/tml"

renderer "github.com/aquasecurity/trivy/pkg/report/table"

dbTypes "github.com/aquasecurity/trivy-db/pkg/types"
renderer "github.com/aquasecurity/trivy/pkg/report/table"
"github.com/aquasecurity/trivy/pkg/types"
)

Expand Down
3 changes: 1 addition & 2 deletions pkg/cloud/report/service.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@ import (
"strconv"
"time"

"github.com/aquasecurity/tml"

"github.com/aquasecurity/table"
"github.com/aquasecurity/tml"
pkgReport "github.com/aquasecurity/trivy/pkg/report/table"
"github.com/aquasecurity/trivy/pkg/types"
)
Expand Down
12 changes: 4 additions & 8 deletions pkg/cloud/report/service_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,14 @@ import (
"path/filepath"
"testing"

"github.com/aquasecurity/trivy-db/pkg/types"

"github.com/stretchr/testify/require"

"github.com/aquasecurity/trivy/pkg/flag"

"github.com/stretchr/testify/assert"

"github.com/aws/aws-sdk-go-v2/aws/arn"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/aquasecurity/defsec/pkg/scan"
defsecTypes "github.com/aquasecurity/defsec/pkg/types"
"github.com/aquasecurity/trivy-db/pkg/types"
"github.com/aquasecurity/trivy/pkg/flag"
)

func Test_ServiceReport(t *testing.T) {
Expand Down
1 change: 0 additions & 1 deletion pkg/commands/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import (
"golang.org/x/xerrors"

awsScanner "github.com/aquasecurity/defsec/pkg/scanners/cloud/aws"

awscommands "github.com/aquasecurity/trivy/pkg/cloud/aws/commands"
"github.com/aquasecurity/trivy/pkg/commands/artifact"
"github.com/aquasecurity/trivy/pkg/commands/convert"
Expand Down
3 changes: 1 addition & 2 deletions pkg/compliance/report/report.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ package report
import (
"io"

defsecTypes "github.com/aquasecurity/defsec/pkg/types"

"golang.org/x/xerrors"

defsecTypes "github.com/aquasecurity/defsec/pkg/types"
dbTypes "github.com/aquasecurity/trivy-db/pkg/types"
"github.com/aquasecurity/trivy/pkg/compliance/spec"
"github.com/aquasecurity/trivy/pkg/types"
Expand Down
3 changes: 1 addition & 2 deletions pkg/compliance/report/report_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ import (
"fmt"
"testing"

defsecTypes "github.com/aquasecurity/defsec/pkg/types"

"github.com/stretchr/testify/assert"

defsecTypes "github.com/aquasecurity/defsec/pkg/types"
dbTypes "github.com/aquasecurity/trivy-db/pkg/types"
"github.com/aquasecurity/trivy-db/pkg/vulnsrc/vulnerability"
"github.com/aquasecurity/trivy/pkg/compliance/report"
Expand Down
3 changes: 1 addition & 2 deletions pkg/compliance/spec/compliance_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ import (
"sort"
"testing"

defsecTypes "github.com/aquasecurity/defsec/pkg/types"

"github.com/stretchr/testify/assert"

defsecTypes "github.com/aquasecurity/defsec/pkg/types"
"github.com/aquasecurity/trivy/pkg/compliance/spec"
"github.com/aquasecurity/trivy/pkg/types"
)
Expand Down
3 changes: 1 addition & 2 deletions pkg/detector/library/compare/maven/compare.go
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
package maven

import (
"golang.org/x/xerrors"

version "github.com/masahiro331/go-mvn-version"
"golang.org/x/xerrors"

dbTypes "github.com/aquasecurity/trivy-db/pkg/types"
"github.com/aquasecurity/trivy/pkg/detector/library/compare"
Expand Down
2 changes: 1 addition & 1 deletion pkg/detector/library/detect.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
)

// Detect scans and returns vulnerabilities of library
func Detect(libType string, pkgs []ftypes.Package) ([]types.DetectedVulnerability, error) {
func Detect(libType ftypes.LangType, pkgs []ftypes.Package) ([]types.DetectedVulnerability, error) {
driver, ok := NewDriver(libType)
if !ok {
return nil, nil
Expand Down
2 changes: 1 addition & 1 deletion pkg/detector/library/driver.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (
)

// NewDriver returns a driver according to the library type
func NewDriver(libType string) (Driver, bool) {
func NewDriver(libType ftypes.LangType) (Driver, bool) {
var ecosystem dbTypes.Ecosystem
var comparer compare.Comparer

Expand Down
2 changes: 1 addition & 1 deletion pkg/detector/library/driver_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ func TestDriver_Detect(t *testing.T) {
tests := []struct {
name string
fixtures []string
libType string
libType ftypes.LangType
args args
want []types.DetectedVulnerability
wantErr string
Expand Down
2 changes: 1 addition & 1 deletion pkg/detector/ospkg/alma/alma.go
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ func (s *Scanner) Detect(osVer string, _ *ftypes.Repository, pkgs []ftypes.Packa
}

// IsSupportedVersion checks the OSFamily can be scanned using AlmaLinux scanner
func (s *Scanner) IsSupportedVersion(osFamily, osVer string) bool {
func (s *Scanner) IsSupportedVersion(osFamily ftypes.OSType, osVer string) bool {
if strings.Count(osVer, ".") > 0 {
osVer = osVer[:strings.Index(osVer, ".")]
}
Expand Down
23 changes: 16 additions & 7 deletions pkg/detector/ospkg/alma/alma_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,11 @@ func TestScanner_Detect(t *testing.T) {
},
},
{
name: "skip modular package",
fixtures: []string{"testdata/fixtures/modular.yaml", "testdata/fixtures/data-source.yaml"},
name: "skip modular package",
fixtures: []string{
"testdata/fixtures/modular.yaml",
"testdata/fixtures/data-source.yaml",
},
args: args{
osVer: "8.4",
pkgs: []ftypes.Package{
Expand All @@ -94,8 +97,11 @@ func TestScanner_Detect(t *testing.T) {
want: nil,
},
{
name: "modular package",
fixtures: []string{"testdata/fixtures/modular.yaml", "testdata/fixtures/data-source.yaml"},
name: "modular package",
fixtures: []string{
"testdata/fixtures/modular.yaml",
"testdata/fixtures/data-source.yaml",
},
args: args{
osVer: "8.6",
pkgs: []ftypes.Package{
Expand Down Expand Up @@ -131,8 +137,11 @@ func TestScanner_Detect(t *testing.T) {
},
},
{
name: "Get returns an error",
fixtures: []string{"testdata/fixtures/invalid.yaml", "testdata/fixtures/data-source.yaml"},
name: "Get returns an error",
fixtures: []string{
"testdata/fixtures/invalid.yaml",
"testdata/fixtures/data-source.yaml",
},
args: args{
osVer: "8.4",
pkgs: []ftypes.Package{
Expand Down Expand Up @@ -167,7 +176,7 @@ func TestScanner_Detect(t *testing.T) {

func TestScanner_IsSupportedVersion(t *testing.T) {
type args struct {
osFamily string
osFamily ftypes.OSType
osVer string
}
tests := []struct {
Expand Down
2 changes: 1 addition & 1 deletion pkg/detector/ospkg/alpine/alpine.go
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ func (s *Scanner) isVulnerable(installedVersion version.Version, adv dbTypes.Adv
}

// IsSupportedVersion checks the OSFamily can be scanned using Alpine scanner
func (s *Scanner) IsSupportedVersion(osFamily, osVer string) bool {
func (s *Scanner) IsSupportedVersion(osFamily ftypes.OSType, osVer string) bool {
if strings.Count(osVer, ".") > 1 {
osVer = osVer[:strings.LastIndex(osVer, ".")]
}
Expand Down