Tests | Data Races eliminated

[derwesx]

This PR addresses issue #89 by fixing a data race conditions and removing duplicate checks in the test suite.

Changes

1. Fixed data race in internal/keyring/threadkeyring.go - Added error channel to prevent passage of non-initialized errors between goroutines (Now works with --race flag).

go func() {
	ak, err = keyring.CreateKeyring()
	if err != nil {
		errCh <- err
		return
	}
	errCh <- nil
	...
}

if err <- errCh; ... // Waiting for initialization

return &tk, err 

2. Fixed data race in cmd/ssh-tpm-agent/main_test.go - launching shell after Stdout is assigned and waiting for the exit.

var b bytes.Buffer
session.Stdout = &b
session.Shell()
session.Wait()

3. PascalCase + Duplicate checks in internal/keyring/threadkeyring_test.go

Notes

I noticed that keyring.ReadKey appears to return syscall.ENOENT when given unknown key, not syscall.ENOKEY as the test expects.

Also unix.RequestKey(X, description, "", destKeyring) will return ENOENT with X="user" and "logon", whilst ENOKEY with "Asdasdasd", etc.. Seems like an issue with keyring initialization on my system?

_, err = keyring.ReadKey("this.key.does.not.exist") // Returns syscall.ENOENT when tested

assert.Truef(t, errors.Is(err, syscall.ENOKEY), "Got: '%v'\nExpected: '%v'", err, syscall.ENOKEY) 

[Foxboron]

I noticed that keyring.ReadKey appears to return syscall.ENOENT when given unknown key, not syscall.ENOKEY as the test expects. Is this behaviour platform-dependent, or should the tests be updated to expect the correct error type?

Uh, the tests have been passing on my machine so I'm not quite sure.

Per the documentation it says that ENOENT should be returned if the keyring doesn't exist, and ENOKEY if the key doesn't exist.

https://docs.kernel.org/security/keys/core.html

[Foxboron]

Please split into two commits.

One for the race condition.

One for the assert changes.

[derwesx]

Seems like --race is happy now.

[Foxboron]

Cool, thanks!

There are a couple of things that needs to be done to clean up the commit history.

• Squash 4a3d707 and f54310d together.
• Drop the captial casing on each word in the commit, peferably prefix the message with that module you are touching

[derwesx]

Cleaned!

[Foxboron]

Thanks!