main ae76d4b

business_logic_golden_test.go RawHistoryFolder

1package analyzer
2
3import (
4	"path/filepath"
5	"strings"
6	"testing"
7
8	"github.com/bnema/hexcheck/config"
9
10	"golang.org/x/tools/go/analysis/analysistest"
11)
12
13const businessLogicRule = "suspicious-business-logic-in-adapter"
14
15func TestBusinessLogicGoldenCases(t *testing.T) {
16	result := analysistest.Run(t, analysistest.TestData(), New(Options{Config: testConfig(), ModulePath: "example.com/project"}), "example.com/project/internal/infrastructure/http")
17
18	// rulesByFile maps each file to the diagnostic categories reported in it.
19	rulesByFile := map[string][]string{}
20	for _, diagnostic := range result[0].Diagnostics {
21		file := filepath.ToSlash(result[0].Pass.Fset.Position(diagnostic.Pos).Filename)
22		rulesByFile[file] = append(rulesByFile[file], diagnostic.Category)
23	}
24
25	tests := []struct {
26		file string
27		want bool
28	}{
29		{file: "typed_policy.go", want: true},
30		{file: "mixed_detection.go", want: true},
31		{file: "probing.go", want: false},
32	}
33	for _, tt := range tests {
34		t.Run(tt.file, func(t *testing.T) {
35			if got := hasRuleInFile(rulesByFile, tt.file, businessLogicRule); got != tt.want {
36				t.Fatalf("business-logic diagnostic in %s = %v, want %v", tt.file, got, tt.want)
37			}
38		})
39	}
40}
41
42func TestBusinessLogicCapGolden(t *testing.T) {
43	cfg := testConfig()
44	cfg.Components["capped"] = config.Component{Role: config.RoleAdapter, Paths: []string{"internal/infrastructure/capped/**"}}
45	cfg.Heuristics.BusinessLogicMaxDiagnosticsPerPackage = testIntPtr(1)
46	analysistest.Run(t, analysistest.TestData(), New(Options{Config: cfg, ModulePath: "example.com/project"}), "example.com/project/internal/infrastructure/capped")
47}
48
49func TestUsedIgnoreInTestPackageVariants(t *testing.T) {
50	cfg := testConfig()
51	cfg.Components["variants"] = config.Component{Role: config.RoleAdapter, Paths: []string{"internal/infrastructure/variants/**"}}
52	results := analysistest.Run(t, analysistest.TestData(), New(Options{Config: cfg, ModulePath: "example.com/project"}), "example.com/project/internal/infrastructure/variants")
53	plain, withTests := false, false
54	for _, result := range results {
55		if len(result.Diagnostics) != 0 {
56			t.Fatalf("%s: unexpected diagnostics: %v", result.Pass.Pkg.Path(), result.Diagnostics)
57		}
58		hasTestFile := false
59		for _, file := range result.Pass.Files {
60			if strings.HasSuffix(result.Pass.Fset.Position(file.Pos()).Filename, "_test.go") {
61				hasTestFile = true
62			}
63		}
64		if hasTestFile {
65			withTests = true
66		} else {
67			plain = true
68		}
69	}
70	if !plain || !withTests {
71		t.Fatalf("expected both ordinary and test package variants; plain=%v withTests=%v", plain, withTests)
72	}
73}
74
75func hasRuleInFile(rulesByFile map[string][]string, fileSuffix, rule string) bool {
76	for file, rules := range rulesByFile {
77		if !strings.HasSuffix(file, fileSuffix) {
78			continue
79		}
80		for _, got := range rules {
81			if got == rule {
82				return true
83			}
84		}
85	}
86	return false
87}

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 5

↑↓ moveenter openesc close