Commits on Aug 22, 2022

1. 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>

   

   helsaawy committed Aug 22, 2022
   Copy the full SHA

   e140bdb View commit details

   Browse the repository at this point in the history

2. 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>

   

   helsaawy committed Aug 22, 2022
   Copy the full SHA

   9b6856b View commit details

   Browse the repository at this point in the history

3. 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>

   

   helsaawy committed Aug 22, 2022
   Copy the full SHA

   3109bf7 View commit details

   Browse the repository at this point in the history