Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add lint and go generate steps to CI (#254)
* Add lint and go generate stages to CI
Add CI step to verify `go generate` was run on repo.
Add linter stage to CI along with linter config file,
`.golangci.yml`.
Will likely prefer revive over static-check.
Updated README Contributing section on linting requirements.
Added sequence ordering to make sure lint and go generate stages run
before tests and build.
This way, build and tests are not run on code that could potentially:
1. not build due to `gofmt` issues;
2. contain bugs;
3. have to be re-submitted after issues are fixed; or
4. contain outdated Win32 syscall or other auto-generated files.
Signed-off-by: Hamza El-Saawy <hamzaelsaawy@microsoft.com>
* Fixed linter issues
Code changes to satisfy linters:
- Ran `gofmt -s -w` on repo.
- Broke up long lines.
- When possible, changed names with incorrect initialism formatting
- Added exceptions for exported variables.
- Added exceptions for ALL_CAPS_WITH_UNDERSCORES code.
- Switched to using `windows` or `syscall` definitions if possible;
especially if some constants were unused.
- Added `_ =` to satisfy error linter, and acknowledge that errors are
being ignored.
- Switched to using `errors.Is` and `As` in places, elsewhere added
exceptions if error value was known to be `syscall.Errno`.
- Removed bare returns.
- Prevented variables from being overshadowed in certain places
(ignoring cases of overshadowing `err`).
- Renamed variables and functions (eg, `len`, `eventMetadata.bytes`) to
prevent shadowing pre-built functions and imported pacakges.
- Removed unused method receivers.
- Added exceptions to certain unused (unexported) constants and
functions.
- Deleted unused `once` from `pkg/etw.providerMap`.
- Renamed `noop.go` files to `main_other.go` or `doc.go`, to better fit
style recommendations.
- Added exceptions for non-secure use of SHA1 and weak crypto
libraries.
- Replaced `ioutil` with `io` and `os` (and `t.TempDir` in tests).
- Added fully exhaustive checks for `switch` statements in `pkg/etw`.
- Defined constant strings for `tools/mkwinsyscall`.
- Removed unnecessary conversions.
- Made sure `context.Cancel` was called.
Additionally, added `//go:build windows" constraints on files with
unexported code, since linter will complain about unused code on
non-Windows platforms.
Added a stub `main() {}` for `mkwinsyscall` for non-Windows builds, just in
case `//go:generate` directives are added to OS-agnostic files.
Signed-off-by: Hamza El-Saawy <hamzaelsaawy@microsoft.com>
* PR: spelling, constants, fuzzing
Moved HVSocket fuzzing tests to separate file with go 1.18 build
constraint.
Signed-off-by: Hamza El-Saawy <hamzaelsaawy@microsoft.com>
Signed-off-by: Hamza El-Saawy <hamzaelsaawy@microsoft.com>- Loading branch information
Showing
67 changed files
with
1,193 additions
and
675 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| * text=auto eol=lf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| run: | ||
| skip-dirs: | ||
| - pkg/etw/sample | ||
|
|
||
| linters: | ||
| enable: | ||
| # style | ||
| - containedctx # struct contains a context | ||
| - dupl # duplicate code | ||
| - errname # erorrs are named correctly | ||
| - goconst # strings that should be constants | ||
| - godot # comments end in a period | ||
| - misspell | ||
| - nolintlint # "//nolint" directives are properly explained | ||
| - revive # golint replacement | ||
| - stylecheck # golint replacement, less configurable than revive | ||
| - unconvert # unnecessary conversions | ||
| - wastedassign | ||
|
|
||
| # bugs, performance, unused, etc ... | ||
| - contextcheck # function uses a non-inherited context | ||
| - errorlint # errors not wrapped for 1.13 | ||
| - exhaustive # check exhaustiveness of enum switch statements | ||
| - gofmt # files are gofmt'ed | ||
| - gosec # security | ||
| - nestif # deeply nested ifs | ||
| - nilerr # returns nil even with non-nil error | ||
| - prealloc # slices that can be pre-allocated | ||
| - structcheck # unused struct fields | ||
| - unparam # unused function params | ||
|
|
||
| issues: | ||
| exclude-rules: | ||
| # err is very often shadowed in nested scopes | ||
| - linters: | ||
| - govet | ||
| text: '^shadow: declaration of "err" shadows declaration' | ||
|
|
||
| # ignore long lines for skip autogen directives | ||
| - linters: | ||
| - revive | ||
| text: "^line-length-limit: " | ||
| source: "^//(go:generate|sys) " | ||
|
|
||
| # allow unjustified ignores of error checks in defer statments | ||
| - linters: | ||
| - nolintlint | ||
| text: "^directive `//nolint:errcheck` should provide explanation" | ||
| source: '^\s*defer ' | ||
|
|
||
| # allow unjustified ignores of error lints for io.EOF | ||
| - linters: | ||
| - nolintlint | ||
| text: "^directive `//nolint:errorlint` should provide explanation" | ||
| source: '[=|!]= io.EOF' | ||
|
|
||
|
|
||
| linters-settings: | ||
| govet: | ||
| enable-all: true | ||
| disable: | ||
| # struct order is often for Win32 compat | ||
| # also, ignore pointer bytes/GC issues for now until performance becomes an issue | ||
| - fieldalignment | ||
| check-shadowing: true | ||
| nolintlint: | ||
| allow-leading-space: false | ||
| require-explanation: true | ||
| require-specific: true | ||
| revive: | ||
| # revive is more configurable than static check, so likely the preferred alternative to static-check | ||
| # (once the perf issue is solved: https://github.com/golangci/golangci-lint/issues/2997) | ||
| enable-all-rules: | ||
| true | ||
| # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md | ||
| rules: | ||
| # rules with required arguments | ||
| - name: argument-limit | ||
| disabled: true | ||
| - name: banned-characters | ||
| disabled: true | ||
| - name: cognitive-complexity | ||
| disabled: true | ||
| - name: cyclomatic | ||
| disabled: true | ||
| - name: file-header | ||
| disabled: true | ||
| - name: function-length | ||
| disabled: true | ||
| - name: function-result-limit | ||
| disabled: true | ||
| - name: max-public-structs | ||
| disabled: true | ||
| # geneally annoying rules | ||
| - name: add-constant # complains about any and all strings and integers | ||
| disabled: true | ||
| - name: confusing-naming # we frequently use "Foo()" and "foo()" together | ||
| disabled: true | ||
| - name: flag-parameter # excessive, and a common idiom we use | ||
| disabled: true | ||
| # general config | ||
| - name: line-length-limit | ||
| arguments: | ||
| - 140 | ||
| - name: var-naming | ||
| arguments: | ||
| - [] | ||
| - - CID | ||
| - CRI | ||
| - CTRD | ||
| - DACL | ||
| - DLL | ||
| - DOS | ||
| - ETW | ||
| - FSCTL | ||
| - GCS | ||
| - GMSA | ||
| - HCS | ||
| - HV | ||
| - IO | ||
| - LCOW | ||
| - LDAP | ||
| - LPAC | ||
| - LTSC | ||
| - MMIO | ||
| - NT | ||
| - OCI | ||
| - PMEM | ||
| - PWSH | ||
| - RX | ||
| - SACl | ||
| - SID | ||
| - SMB | ||
| - TX | ||
| - VHD | ||
| - VHDX | ||
| - VMID | ||
| - VPCI | ||
| - WCOW | ||
| - WIM | ||
| stylecheck: | ||
| checks: | ||
| - "all" | ||
| - "-ST1003" # use revive's var naming |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.