chore: improve coverage of cryptorand package (#377)

Check error cases in cryptorand functions, such as failures to
read random data and input parameter validation.
This commit is contained in:
Jonathan Yu 2022-02-28 09:50:55 -08:00 committed by GitHub
parent 0c005cebca
commit 2d6804c746
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 100 additions and 0 deletions

86
cryptorand/errors_test.go Normal file
View File

@ -0,0 +1,86 @@
package cryptorand_test
import (
"crypto/rand"
"io"
"testing"
"testing/iotest"
"github.com/stretchr/testify/require"
"github.com/coder/coder/cryptorand"
)
// TestRandError checks that the code handles errors when reading from
// the rand.Reader.
//
// This test replaces the global rand.Reader, so cannot be parallelized
//nolint:paralleltest
func TestRandError(t *testing.T) {
var origReader = rand.Reader
t.Cleanup(func() {
rand.Reader = origReader
})
rand.Reader = iotest.ErrReader(io.ErrShortBuffer)
t.Run("Int63", func(t *testing.T) {
_, err := cryptorand.Int63()
require.ErrorIs(t, err, io.ErrShortBuffer, "expected Int63 error")
})
t.Run("Uint64", func(t *testing.T) {
_, err := cryptorand.Uint64()
require.ErrorIs(t, err, io.ErrShortBuffer, "expected Uint64 error")
})
t.Run("Int31", func(t *testing.T) {
_, err := cryptorand.Int31()
require.ErrorIs(t, err, io.ErrShortBuffer, "expected Int31 error")
})
t.Run("Int31n", func(t *testing.T) {
_, err := cryptorand.Int31n(100)
require.ErrorIs(t, err, io.ErrShortBuffer, "expected Int31n error")
})
t.Run("Uint32", func(t *testing.T) {
_, err := cryptorand.Uint32()
require.ErrorIs(t, err, io.ErrShortBuffer, "expected Uint32 error")
})
t.Run("Int", func(t *testing.T) {
_, err := cryptorand.Int()
require.ErrorIs(t, err, io.ErrShortBuffer, "expected Int error")
})
t.Run("Intn_32bit", func(t *testing.T) {
_, err := cryptorand.Intn(100)
require.ErrorIs(t, err, io.ErrShortBuffer, "expected Intn error")
})
t.Run("Intn_64bit", func(t *testing.T) {
_, err := cryptorand.Intn(int(1 << 35))
require.ErrorIs(t, err, io.ErrShortBuffer, "expected Intn error")
})
t.Run("Float64", func(t *testing.T) {
_, err := cryptorand.Float64()
require.ErrorIs(t, err, io.ErrShortBuffer, "expected Float64 error")
})
t.Run("Float32", func(t *testing.T) {
_, err := cryptorand.Float32()
require.ErrorIs(t, err, io.ErrShortBuffer, "expected Float32 error")
})
t.Run("Bool", func(t *testing.T) {
_, err := cryptorand.Bool()
require.ErrorIs(t, err, io.ErrShortBuffer, "expected Bool error")
})
t.Run("StringCharset", func(t *testing.T) {
_, err := cryptorand.HexString(10)
require.ErrorIs(t, err, io.ErrShortBuffer, "expected HexString error")
})
}

View File

@ -92,6 +92,11 @@ func TestInt63n(t *testing.T) {
require.True(t, v >= 0, "values must be positive")
require.True(t, v < 1<<35, "values must be less than 1<<35")
}
// Expect a panic if max is negative
require.PanicsWithValue(t, "invalid argument to Int63n", func() {
cryptorand.Int63n(0)
})
}
func TestInt31n(t *testing.T) {
@ -116,6 +121,15 @@ func TestIntn(t *testing.T) {
require.True(t, v >= 0, "values must be positive")
require.True(t, v < 100, "values must be less than 100")
}
// Ensure Intn works for int larger than 32 bits
_, err := cryptorand.Intn(1 << 35)
require.NoError(t, err, "expected Intn to work for 64-bit int")
// Expect a panic if max is negative
require.PanicsWithValue(t, "n must be a positive nonzero number", func() {
cryptorand.Intn(0)
})
}
func TestFloat64(t *testing.T) {