mirror of
https://github.com/rwinkhart/go-winio.git
synced 2026-08-28 04:46:50 -04:00
* 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>
89 lines
2.5 KiB
Go
89 lines
2.5 KiB
Go
//go:build windows && go1.18
|
|
|
|
package winio
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"testing"
|
|
"time"
|
|
)
|
|
|
|
func FuzzHvSockRxTx(f *testing.F) {
|
|
for _, b := range [][]byte{
|
|
[]byte("hello?"),
|
|
[]byte("This is a really long string that should be a good example of the really long " +
|
|
"payloads that may be sent over hvsockets when really long inputs are being used, tautologically. " +
|
|
"That means that we will have to test with really long input sequences, which means that " +
|
|
"we need to include really long byte sequences or strings in our testing so that we know that " +
|
|
"the sockets can deal with really long inputs. Look at this key mashing: " +
|
|
"sdflhsdfgkjdhskljjsad;kljfasd;lfkjsadl ;fasdjfopiwej09q34iur092\"i4o[piwajfliasdkf-012ior]-" +
|
|
"01oi3;'lSD<Fplkasdjgoisaefjoiasdlj\"hgfoaisdkf';laksdjdf[poaiseefk-0923i4roi3qwjrf9" +
|
|
"08sEJKEFOLIsaejf[09saEJFLKSADjf;lkasdjf;kljaslddhgaskghk"),
|
|
{0x5c, 0xbd, 0xb5, 0xe7, 0x6b, 0xcb, 0xe7, 0x23, 0xff, 0x7a, 0x19, 0x77, 0x2c, 0xca, 0xab, 0x3b},
|
|
} {
|
|
f.Add(b)
|
|
}
|
|
|
|
f.Fuzz(func(t *testing.T, a []byte) {
|
|
if string(a) == "" {
|
|
t.Skip("skipping empty string")
|
|
}
|
|
t.Logf("testing %q (%d)", a, len(a))
|
|
u := newUtil(t)
|
|
cl, sv, _ := clientServer(u)
|
|
|
|
svCh := u.Go(func() error {
|
|
n, err := cl.Write(a)
|
|
if err != nil {
|
|
return fmt.Errorf("client write: %w", err)
|
|
}
|
|
if n != len(a) {
|
|
return errors.New("client did not send full message")
|
|
}
|
|
|
|
b := make([]byte, len(a)+5) // a little extra to make sure nothing else is sent
|
|
n, err = cl.Read(b)
|
|
if err != nil {
|
|
return fmt.Errorf("client read: %w", err)
|
|
}
|
|
if n != len(a) {
|
|
return errors.New("client did not read full message")
|
|
}
|
|
bn := b[:n]
|
|
if string(a) != string(bn) {
|
|
return fmt.Errorf("client payload mismatch %q != %q", a, bn)
|
|
}
|
|
t.Log("client received")
|
|
return nil
|
|
})
|
|
|
|
clCh := u.Go(func() error {
|
|
b := make([]byte, len(a)+5) // a little extra to make sure nothing else is sent
|
|
n, err := sv.Read(b)
|
|
if err != nil {
|
|
return fmt.Errorf("server read: %w", err)
|
|
}
|
|
if n != len(a) {
|
|
return errors.New("server did not read full message")
|
|
}
|
|
bn := b[:n]
|
|
if string(a) != string(bn) {
|
|
return fmt.Errorf("server payload mismatch %q != %q", a, bn)
|
|
}
|
|
|
|
n, err = sv.Write(bn)
|
|
if err != nil {
|
|
return fmt.Errorf("server write: %w", err)
|
|
}
|
|
if n != len(a) {
|
|
return errors.New("server did not send full message")
|
|
}
|
|
t.Log("server sent")
|
|
return nil
|
|
})
|
|
u.WaitErr(svCh, 250*time.Millisecond)
|
|
u.WaitErr(clCh, 250*time.Millisecond)
|
|
})
|
|
}
|