From 4abc7d4c89cd7355e482b62726f2f04820edbe8a Mon Sep 17 00:00:00 2001 From: nitram509 Date: Tue, 1 Oct 2024 21:27:10 +0200 Subject: [PATCH] incorporate suggestions and feedback --- common_test.go | 3 +-- decoder.go | 4 ++-- decoder_test.go | 29 ++++++++++++++--------------- encoder.go | 4 ++-- keystore.go | 4 ++-- keystore_test.go | 18 ++++++------------ 6 files changed, 27 insertions(+), 35 deletions(-) diff --git a/common_test.go b/common_test.go index 1e90718..d036a7e 100644 --- a/common_test.go +++ b/common_test.go @@ -2,7 +2,6 @@ package keystore import ( "crypto/rand" - "reflect" "testing" "github.com/stretchr/testify/assert" @@ -58,6 +57,6 @@ func TestPasswordBytes(t *testing.T) { for _, tt := range table { output := passwordBytes(tt.input) - assert.Truef(t, reflect.DeepEqual(output, tt.output), "convert password bytes '%v', '%v'", output, tt.output) + assert.Equal(t, tt.output, output, "convert password bytes") } } diff --git a/decoder.go b/decoder.go index 374d740..250141d 100644 --- a/decoder.go +++ b/decoder.go @@ -128,7 +128,7 @@ func (d decoder) readPrivateKeyEntry(version uint32) (PrivateKeyEntry, error) { chain = append(chain, cert) } - creationDateTime := time.UnixMilli(int64(creationTimeStamp)) //nolint:all + creationDateTime := time.UnixMilli(int64(creationTimeStamp)) //nolint:gosec privateKeyEntry := PrivateKeyEntry{ PrivateKey: encryptedPrivateKey, CreationTime: creationDateTime, @@ -149,7 +149,7 @@ func (d decoder) readTrustedCertificateEntry(version uint32) (TrustedCertificate return TrustedCertificateEntry{}, fmt.Errorf("read certificate: %w", err) } - creationDateTime := time.UnixMilli(int64(creationTimeStamp)) //nolint:all + creationDateTime := time.UnixMilli(int64(creationTimeStamp)) //nolint:gosec trustedCertificateEntry := TrustedCertificateEntry{ CreationTime: creationDateTime, Certificate: certificate, diff --git a/decoder_test.go b/decoder_test.go index b5f210a..4a9bbf8 100644 --- a/decoder_test.go +++ b/decoder_test.go @@ -8,7 +8,6 @@ import ( "errors" "fmt" "io" - "reflect" "testing" "github.com/stretchr/testify/assert" @@ -72,14 +71,14 @@ func TestReadUint16(t *testing.T) { } number, err := d.readUint16() - assert.Truef(t, reflect.DeepEqual(err, tt.err), "invalid error '%v' '%v'", err, tt.err) + assert.Equal(t, tt.err, err) if err == nil { assert.Equal(t, tt.number, number) } hash := d.h.Sum(nil) - assert.Truef(t, reflect.DeepEqual(hash, tt.hash[:]), "invalid hash '%v' '%v'", hash, tt.hash) + assert.Equal(t, tt.hash[:], hash) } } @@ -140,14 +139,14 @@ func TestReadUint32(t *testing.T) { } number, err := d.readUint32() - assert.Truef(t, reflect.DeepEqual(err, tt.err), "invalid error '%v' '%v'", err, tt.err) + assert.Equal(t, tt.err, err) if err == nil { assert.Equal(t, tt.number, number) } hash := d.h.Sum(nil) - assert.Truef(t, reflect.DeepEqual(hash, tt.hash[:]), "invalid hash '%v' '%v'", hash, tt.hash) + assert.Equal(t, tt.hash[:], hash) } } @@ -212,14 +211,14 @@ func TestReadUint64(t *testing.T) { } number, err := d.readUint64() - assert.Truef(t, reflect.DeepEqual(err, tt.err), "invalid error '%v' '%v'", err, tt.err) + assert.Equal(t, tt.err, err) if err == nil { assert.Equal(t, tt.number, number) } hash := d.h.Sum(nil) - assert.Truef(t, reflect.DeepEqual(hash, tt.hash[:]), "invalid hash '%v' '%v'", hash, tt.hash) + assert.Equal(t, tt.hash[:], hash) } } @@ -278,10 +277,10 @@ func TestReadBytes(t *testing.T) { bts, err := d.readBytes(tt.readLen) require.NoError(t, err) - assert.Truef(t, reflect.DeepEqual(bts, tt.bytes), "invalid bytes '%v' '%v'", bts, tt.bytes) + assert.Equal(t, tt.bytes, bts) hash := d.h.Sum(nil) - assert.Truef(t, reflect.DeepEqual(hash, tt.hash[:]), "invalid hash '%v' '%v'", hash, tt.hash) + assert.Equal(t, tt.hash[:], hash) } } @@ -321,7 +320,7 @@ func TestReadString(t *testing.T) { }) str := "some string to read" buf := make([]byte, 2) - binary.BigEndian.PutUint16(buf, uint16(len(str))) //nolint:all + binary.BigEndian.PutUint16(buf, uint16(len(str))) //nolint:gosec buf = append(buf, []byte(str)...) table = append(table, item{ input: buf, @@ -340,11 +339,11 @@ func TestReadString(t *testing.T) { } str, err := d.readString() - assert.Truef(t, reflect.DeepEqual(err, tt.err), "invalid error '%v' '%v'", err, tt.err) + assert.Equal(t, tt.err, err) assert.Equal(t, tt.string, str) hash := d.h.Sum(nil) - assert.Truef(t, reflect.DeepEqual(hash, tt.hash[:]), "invalid hash '%v' '%v'", hash, tt.hash) + assert.Equal(t, tt.hash[:], hash) } } @@ -439,10 +438,10 @@ func TestReadCertificate(t *testing.T) { } cert, err := d.readCertificate(tt.version) - assert.Truef(t, reflect.DeepEqual(err, tt.err), "invalid error '%v' '%v'", err, tt.err) - assert.Truef(t, reflect.DeepEqual(cert, tt.cert), "invalid certificate '%v' '%v'", cert, tt.cert) + assert.Equal(t, tt.err, err) + assert.Equal(t, tt.cert, cert) hash := d.h.Sum(nil) - assert.Truef(t, reflect.DeepEqual(hash, tt.hash[:]), "invalid hash '%v' '%v'", hash, tt.hash) + assert.Equal(t, tt.hash[:], hash) } } diff --git a/encoder.go b/encoder.go index 276eb2f..932055c 100644 --- a/encoder.go +++ b/encoder.go @@ -95,7 +95,7 @@ func (e encoder) writePrivateKeyEntry(alias string, pke PrivateKeyEntry) error { return fmt.Errorf("write alias: %w", err) } - if err := e.writeUint64(uint64(pke.CreationTime.UnixMilli())); err != nil { //nolint:all + if err := e.writeUint64(uint64(pke.CreationTime.UnixMilli())); err != nil { //nolint:gosec return fmt.Errorf("write creation timestamp: %w", err) } @@ -140,7 +140,7 @@ func (e encoder) writeTrustedCertificateEntry(alias string, tce TrustedCertifica return fmt.Errorf("write alias: %w", err) } - if err := e.writeUint64(uint64(tce.CreationTime.UnixMilli())); err != nil { //nolint:all + if err := e.writeUint64(uint64(tce.CreationTime.UnixMilli())); err != nil { //nolint:gosec return fmt.Errorf("write creation timestamp: %w", err) } diff --git a/keystore.go b/keystore.go index 166d465..6567680 100644 --- a/keystore.go +++ b/keystore.go @@ -117,7 +117,7 @@ func (ks KeyStore) Store(w io.Writer, password []byte) error { return fmt.Errorf("write version: %w", err) } - if err := e.writeUint32(uint32(len(ks.m))); err != nil { //nolint:all + if err := e.writeUint32(uint32(len(ks.m))); err != nil { //nolint:gosec return fmt.Errorf("write number of entries: %w", err) } @@ -192,7 +192,7 @@ func (ks KeyStore) Load(r io.Reader, password []byte) error { computedDigest := d.h.Sum(nil) - actualDigest, err := d.readBytes(uint32(d.h.Size())) //nolint:all + actualDigest, err := d.readBytes(uint32(d.h.Size())) //nolint:gosec if err != nil { return fmt.Errorf("read digest: %w", err) } diff --git a/keystore_test.go b/keystore_test.go index 8f62898..ed70d89 100644 --- a/keystore_test.go +++ b/keystore_test.go @@ -3,7 +3,6 @@ package keystore import ( "encoding/pem" "os" - "reflect" "sort" "testing" "time" @@ -48,17 +47,15 @@ func TestSetGetMethods(t *testing.T) { pkeGet, err := ks.GetPrivateKeyEntry(pkeAlias, password) require.NoError(t, err) + assert.Equal(t, pke, pkeGet) chainGet, err := ks.GetPrivateKeyEntryCertificateChain(pkeAlias) require.NoError(t, err) + assert.Equal(t, pke.CertificateChain, chainGet) tceGet, err := ks.GetTrustedCertificateEntry(tceAlias) require.NoError(t, err) - - assert.True(t, reflect.DeepEqual(pke, pkeGet), "private key entries not equal") - assert.True(t, reflect.DeepEqual(pke.CertificateChain, chainGet), - "certificate chains of private key entries are not equal") - assert.True(t, reflect.DeepEqual(tce, tceGet), "private key entries not equal") + assert.Equal(t, tce, tceGet) _, err = ks.GetPrivateKeyEntry(nonExistentAlias, password) require.ErrorIs(t, err, ErrEntryNotFound) @@ -139,14 +136,12 @@ func TestAliases(t *testing.T) { require.NoError(t, err) expectedAliases := []string{pkeAlias, tceAlias} - sort.Strings(expectedAliases) actualAliases := ks.Aliases() - sort.Strings(actualAliases) - assert.True(t, reflect.DeepEqual(expectedAliases, actualAliases), "aliases must be equal") + assert.Equal(t, expectedAliases, actualAliases) } func TestLoad(t *testing.T) { @@ -182,7 +177,7 @@ func TestLoad(t *testing.T) { decodedPK, _ := pem.Decode(pkPEM) - assert.True(t, reflect.DeepEqual(actualPKE.PrivateKey, decodedPK.Bytes), "unexpected private key") + assert.Equal(t, decodedPK.Bytes, actualPKE.PrivateKey, "unexpected private key") } func TestLoadKeyPassword(t *testing.T) { @@ -222,8 +217,7 @@ func TestLoadKeyPassword(t *testing.T) { decodedPK, _ := pem.Decode(pkPEM) - assert.Truef(t, reflect.DeepEqual(actualPKE.PrivateKey, decodedPK.Bytes), - "unexpected private key %v \n %v", actualPKE.PrivateKey, decodedPK.Bytes) + assert.Equal(t, decodedPK.Bytes, actualPKE.PrivateKey, "unexpected private key") } func readPrivateKey(t *testing.T) []byte {