feat: banchmark goccy/yaml to detect performance regressions (#288)

coreruleset · Apr 8, 2024 · 62b9de7 · 62b9de7
1 parent f45c831
commit 62b9de7
Show file tree

Hide file tree

Showing 4 changed files with 1,342 additions and 2 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,9 +3,9 @@ repos:
   rev: v1.0.0-rc.1
   hooks:
     - id: go-fmt
-    - id: go-vet
+    - id: go-vet-mod
     - id: go-imports
-    - id: golangci-lint
+    - id: golangci-lint-mod
     - id: go-critic
     - id: go-test-mod
     - id: go-build-mod

diff --git a/runner/run_input_override_test.go b/runner/run_input_override_test.go
@@ -322,6 +322,7 @@ func (s *inputOverrideTestSuite) TestApplyInputOverrideNoAutocompleteHeaders() {
 		AutocompleteHeaders: func() *bool { b := false; return &b }(),
 	}
 	s.Nil(s.cfg.TestOverride.Overrides.AutocompleteHeaders)
+	//nolint:staticcheck
 	s.Nil(s.cfg.TestOverride.Overrides.StopMagic)
 	test.ApplyInputOverrides(&s.cfg.TestOverride.Overrides, &testInput)
 
@@ -333,6 +334,7 @@ func (s *inputOverrideTestSuite) TestApplyInputOverrideNoStopMagic() {
 		StopMagic: func() *bool { b := true; return &b }(),
 	}
 	s.Nil(s.cfg.TestOverride.Overrides.AutocompleteHeaders)
+	//nolint:staticcheck
 	s.Nil(s.cfg.TestOverride.Overrides.StopMagic)
 	test.ApplyInputOverrides(&s.cfg.TestOverride.Overrides, &testInput)
 

diff --git a/test/files_test.go b/test/files_test.go
@@ -85,3 +85,22 @@ func (s *filesTestSuite) TestGetFromBadYAML() {
 
 	s.Error(err, "reading yaml should fail")
 }
+
+// This test guards against performance regressions in goccy/yaml. It uses
+// an artificially large test file to force the YAML parser to run long
+// enough so that the performance difference becomse large enough to test.
+// The impacted versions of goccy (v1.9.2 - v1.11.3) will score well above
+// 0.01 nano seconds per operation.
+func (s *filesTestSuite) TestBenchmarkGetTestsFromFiles() {
+	result := testing.Benchmark(func(b *testing.B) {
+		_, err := GetTestsFromFiles("testdata/TestCheckBenchmarkCheckFiles.yaml")
+		if err != nil {
+			b.FailNow()
+		}
+	})
+	nsPerOp := float64(result.T.Nanoseconds()) / float64(result.N)
+	s.T().Logf("Nano seconds per operation: %f", nsPerOp)
+	if nsPerOp > 0.01 {
+		s.FailNow("Nano seconds per operation exceeded limit for benchmark: ", nsPerOp)
+	}
+}