Snider/Mining
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

ax(ueps): align comment examples with predictable variable names
Some checks are pending
Security Scan / security (push) Waiting to run
Details
Test / test (push) Waiting to run
Details

Browse source 
Use sharedSecret in doc-comment examples to match actual test body
variable names — resolves AX principle 1+2 violation where comment
examples used the abbreviated form secret while code used sharedSecret.

Co-Authored-By: Charon <charon@lethean.io>
This commit is contained in:
Claude 2026-04-02 14:07:29 +01:00
parent 07281659da
commit 35342e2349
No known key found for this signature in database
GPG key ID: AF404715446AEB41
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
pkg/ueps/reader_test.go
View file

@ -6,8 +6,8 @@ import (
"testing"
)
// builder := NewPacketBuilder(0x01, []byte("hello")); frame, _ := builder.MarshalAndSign(secret)
// packet, err := ReadAndVerify(bufio.NewReader(bytes.NewReader(frame)), secret)
// builder := NewPacketBuilder(0x01, []byte("hello")); frame, _ := builder.MarshalAndSign(sharedSecret)
// packet, err := ReadAndVerify(bufio.NewReader(bytes.NewReader(frame)), sharedSecret)
// packet.Header.IntentID == 0x01; packet.Payload == []byte("hello")
func TestReader_ReadAndVerify_Good(t *testing.T) {
sharedSecret := []byte("test-shared-secret")
@ -40,9 +40,9 @@ func TestReader_ReadAndVerify_Good(t *testing.T) {
}
}
// frame, _ := NewPacketBuilder(0x02, []byte("sensitive data")).MarshalAndSign(secret)
// frame, _ := NewPacketBuilder(0x02, []byte("sensitive data")).MarshalAndSign(sharedSecret)
// corrupted := append([]byte(nil), frame...); corrupted[len(corrupted)-1] ^= 0xFF
// packet, err := ReadAndVerify(bufio.NewReader(bytes.NewReader(corrupted)), secret)
// packet, err := ReadAndVerify(bufio.NewReader(bytes.NewReader(corrupted)), sharedSecret)
// err == errIntegrityViolation (HMAC mismatch on tampered payload)
func TestReader_ReadAndVerify_Bad(t *testing.T) {
sharedSecret := []byte("test-shared-secret")
@ -72,7 +72,7 @@ func TestReader_ReadAndVerify_Bad(t *testing.T) {
}
// frameWithoutHMAC := []byte{TagVersion, 0x01, 0x09, TagPayload, 'x'}
// packet, err := ReadAndVerify(bufio.NewReader(bytes.NewReader(frameWithoutHMAC)), secret)
// packet, err := ReadAndVerify(bufio.NewReader(bytes.NewReader(frameWithoutHMAC)), sharedSecret)
// err == errMissingHMAC (no 0x06 HMAC tag present in stream)
func TestReader_ReadAndVerify_Ugly(t *testing.T) {
frameWithoutHMAC := []byte{