Skip to content
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .deepsource.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,9 @@ name = "go"
[analyzers.meta]
import_root = "globstar.dev"

[[analyzers]]
name = "test-coverage"
enabled = true

[[transformers]]
name = "gofmt"
10 changes: 10 additions & 0 deletions .github/workflows/build-and-test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@ on:
jobs:
build-and-test:
runs-on: ubuntu-latest
permissions:
id-token: write
steps:
- name: Checkout
uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha}}

- name: Set up Go
uses: actions/setup-go@v4
Expand All @@ -19,3 +23,9 @@ jobs:

- name: test
run: make testall

- name: Report result to DeepSource
run: |
curl https://deepsource.io/cli | sh
./bin/deepsource report --analyzer test-coverage --key go --value-file ./coverage.out --use-oidc

3 changes: 1 addition & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,8 @@ release:

.PHONY: test
test:
@CGO_CFLAGS="-w" go test -coverprofile=coverage.out -covermode=atomic ./cmd/... ./pkg/...
@CGO_CFLAGS="-w" go test -coverprofile=coverage.out -covermode=atomic $$(go list -e ./... | grep -v -E "(checkers/go|checkers/discover/custom_analyzer_stub)")
@go tool cover -func=coverage.out | grep total: | awk '{print "Total coverage: " $$3}'
@rm coverage.out

.PHONY: fmt
fmt:
Expand Down
16 changes: 8 additions & 8 deletions checkers/discover/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,26 +73,27 @@ const (
package checkers

import (
"globstar.dev/checkers/javascript"
"globstar.dev/checkers/python"
goAnalysis "globstar.dev/analysis"
"globstar.dev/checkers/javascript"
"globstar.dev/checkers/python"
goAnalysis "globstar.dev/analysis"
)

var AnalyzerRegistry = []Analyzer{`

entryTemplate = `
{
TestDir: "%[1]s/testdata", // relative to the repository root
Analyzers: []*goAnalysis.Analyzer{%[2]s
},
},
TestDir: "%[1]s/testdata", // relative to the repository root
Analyzers: []*goAnalysis.Analyzer{%[2]s
},
},
`

footerTemplate = "}\n"
)

func generateBuiltinCheckerRegistry(builtinCheckerMap map[string][]string) string {
var builder strings.Builder

// write the header
builder.WriteString(headerTemplate)

Expand All @@ -110,7 +111,6 @@ func generateBuiltinCheckerRegistry(builtinCheckerMap map[string][]string) strin
}

builder.WriteString(footerTemplate)

return builder.String()
}

Expand Down
51 changes: 18 additions & 33 deletions checkers/discover/generate_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ package discover

import (
"testing"

"github.com/google/go-cmp/cmp"
)

func TestGenerateAnalyzerRegistry(t *testing.T) {
Expand All @@ -17,6 +19,7 @@ func TestGenerateAnalyzerRegistry(t *testing.T) {

import (
"globstar.dev/analysis"
"globstar.dev/customanalyzer/checkers"
)

var customCheckers []*analysis.Analyzer = []*analysis.Analyzer{}`,
Expand All @@ -28,6 +31,7 @@ var customCheckers []*analysis.Analyzer = []*analysis.Analyzer{}`,

import (
"globstar.dev/analysis"
"globstar.dev/customanalyzer/checkers"
)

var customCheckers []*analysis.Analyzer = []*analysis.Analyzer{
Expand All @@ -53,7 +57,7 @@ func TestGenerateBuiltinCheckerRegistry(t *testing.T) {
}{
{
name: "empty checkers",
goCheckers: map[string][]string{},
goCheckers: map[string][]string{"javascript": []string{}, "python": []string{}},
want: `// AUTOMATICALLY GENERATED: DO NOT EDIT

package checkers
Expand All @@ -64,18 +68,7 @@ import (
goAnalysis "globstar.dev/analysis"
)

var AnalyzerRegistry = []Analyzer{
{
TestDir: "checkers/javascript/testdata", // relative to the repository root
Analyzers: []*goAnalysis.Analyzer{
},
},
{
TestDir: "checkers/python/testdata",
Analyzers: []*goAnalysis.Analyzer{
},
},
}
var AnalyzerRegistry = []Analyzer{}
`,
},
{
Expand All @@ -98,18 +91,13 @@ import (

var AnalyzerRegistry = []Analyzer{
{
TestDir: "checkers/javascript/testdata", // relative to the repository root
Analyzers: []*goAnalysis.Analyzer{
TestDir: "javascript/testdata", // relative to the repository root
Analyzers: []*goAnalysis.Analyzer{
javascript.NoDoubleEq,
javascript.SQLInjection,

},
},
{
TestDir: "checkers/python/testdata",
Analyzers: []*goAnalysis.Analyzer{
},
},
}
`,
},
Expand All @@ -133,13 +121,8 @@ import (

var AnalyzerRegistry = []Analyzer{
{
TestDir: "checkers/javascript/testdata", // relative to the repository root
Analyzers: []*goAnalysis.Analyzer{
},
},
{
TestDir: "checkers/python/testdata",
Analyzers: []*goAnalysis.Analyzer{
TestDir: "python/testdata", // relative to the repository root
Analyzers: []*goAnalysis.Analyzer{
python.DjangoSQLInjection,
python.DjangoCSVWriterInjection,

Expand Down Expand Up @@ -173,16 +156,17 @@ import (

var AnalyzerRegistry = []Analyzer{
{
TestDir: "checkers/javascript/testdata", // relative to the repository root
Analyzers: []*goAnalysis.Analyzer{
TestDir: "javascript/testdata", // relative to the repository root
Analyzers: []*goAnalysis.Analyzer{
javascript.SQLInjection,
javascript.NoDoubleEq,

},
},

{
TestDir: "checkers/python/testdata", // relative to the repository root
Analyzers: []*goAnalysis.Analyzer{
TestDir: "python/testdata", // relative to the repository root
Analyzers: []*goAnalysis.Analyzer{
python.DjangoSQLInjection,
python.DjangoCSVWriterInjection,
python.InsecureUrllibFtp,
Expand All @@ -196,8 +180,9 @@ var AnalyzerRegistry = []Analyzer{

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := generateBuiltinCheckerRegistry(tt.goCheckers); got != tt.want {
t.Errorf("generateBuiltinAnalyzerRegistry() = \n%v, want \n%v", got, tt.want)
got := generateBuiltinCheckerRegistry(tt.goCheckers)
if diff := cmp.Diff(tt.want, got); diff != "" {
t.Errorf("mismatch (-want +got):\n%s", diff)
}
})
}
Expand Down
1 change: 1 addition & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ require (
github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect
github.com/go-git/go-billy/v5 v5.6.2 // indirect
github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect
github.com/google/go-cmp v0.7.0 // indirect
github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
github.com/kevinburke/ssh_config v1.2.0 // indirect
github.com/mattn/go-colorable v0.1.13 // indirect
Expand Down