Skip to content

quality-report.md

Latest commit

 

History

History
170 lines (113 loc) · 4.21 KB

quality-report.md

File metadata and controls

170 lines (113 loc) · 4.21 KB
Raw

xtcp2 code-quality report

Generated: 2026-05-20T20:35:42Z

Tool versions: go=go1.25.10; golangci-lint=2.12.2; gosec=2.26.1; nixfmt=1.2.0;

This report is generated by tools/quality-report and refreshed via nix run .#update-quality-report. Every section is regenerated end-to-end on each refresh; section anchors are stable so git diff docs/quality-report.md between commits reveals exactly what changed.

1. Executive summary

Metric Value
Total findings 0
Findings (Tier 0) 0
Findings (Tier 1) 0
Findings (Tier 2) 0
Findings (non-tiered) 0
Files with at least one finding 0
Test failures (new) 0
Test failures (pre-existing) 0
Config exclusions reviewed 4

2. Tool status

Tool Status Findings Runtime
golangci-lint (comprehensive) clean 0 5s
golangci-lint (standard) clean 0 5s
golangci-lint (quick) clean 0 14s
gosec clean 0 1s
go vet clean 0 2s
gofmt clean 0 1s
nixfmt clean 0 0s
netlink-audit clean 0 0s
iouring-audit clean 0 0s
metrics-audit clean 0 0s
proto-field-audit clean 0 1s
go test clean 0 9s
go test -cover clean 0 0s

3. Tier rollup

Tier Linters Findings Quick-fixable¹
0 (lint-quick) govet, errcheck, ineffassign, unused, staticcheck 0 0
1 (lint / CI) Tier 0 + gosec, gocritic, revive, noctx, contextcheck, durationcheck 0 0
2 (lint-comprehensive) Tier 1 + exhaustive, prealloc, gocyclo, funlen, goconst, dupl, unconvert, nakedret, misspell 0 0

¹ Quick-fixable = produced by a linter that supports golangci-lint run --fix (gofmt, goimports, misspell, unconvert, …).

4. Hotspot files (top 10)

No file-attributed findings.

5. Findings by linter

No linter findings.

6. Custom audits

No audit findings.

7. Security (gosec)

No security findings.

8. Test results

Status Count
Pass 1290
Fail (new) 0
Fail (pre-existing) 0
Skip 9

9. CLI -help smoke

Not run.

10. Format checks

gofmt: clean.

nixfmt: clean.

11. Configuration audit

Every linter exclusion in the repo, with the recovered justification from the adjacent YAML comment. Rows with no justification need review.

Source Rule Scope Justification
nix/checks/go-sec.nix G103 gosec unsafe pointers: required by pkg/io_uring (giouring wraps liburing SQE/CQE with unsafe.Pointer)
nix/checks/go-sec.nix G115 gosec integer overflow conversions: netlink length fields + io_uring batch indices, all bounds-checked
nix/checks/go-sec.nix G204 gosec subprocess with variable: cmd/ns + cmd/nsTest invoke ip netns exec ... by design
nix/checks/go-sec.nix G304 gosec file path from variable: register_schema reads .proto paths from CLI

12. Recommendations

  • No specific recommendations — the codebase is clean across every tier the report measures.

13. Test coverage

Overall: 92.4% of statements (target: 90% per package).

Package Coverage Status
cmd/clickhouse_http_insert_protobuflist 93.7% 🟢 OK
cmd/clickhouse_protobuflist 93.2% 🟢 OK
cmd/clickhouse_protobuflist_db 93.3% 🟢 OK
cmd/kafka_to_clickhouse 91.4% 🟢 OK
cmd/ns 93.9% 🟢 OK
cmd/nsTest 94.1% 🟢 OK
cmd/register_schema 91.4% 🟢 OK
cmd/xtcp2 95.9% 🟢 OK
cmd/xtcp2_kafka_client 93.0% 🟢 OK
cmd/xtcp2client 91.6% 🟢 OK
pkg/io_uring 92.6% 🟢 OK
pkg/misc 93.8% 🟢 OK
pkg/xtcp 90.8% 🟢 OK
pkg/xtcpnl 91.8% 🟢 OK
tools/iouring-audit 95.2% 🟢 OK
tools/kafka_topic_reader 94.7% 🟢 OK
tools/metrics-audit 97.2% 🟢 OK
tools/netlink-audit 95.8% 🟢 OK
tools/proto-field-audit 96.7% 🟢 OK
tools/quality-report 92.8% 🟢 OK
tools/tcp_client 93.1% 🟢 OK
tools/tcp_server 94.6% 🟢 OK
tools/udp_receiver_server 97.9% 🟢 OK