[#168] refs: Implement binary/JSON encoders/decoders on Signature

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich 2020-11-13 16:23:41 +03:00 committed by Alex Vanin
parent 1519a02d63
commit 4b55b06780
6 changed files with 110 additions and 4 deletions

View file

@ -42,3 +42,35 @@ func (s *Signature) SetSign(v []byte) {
func (s *Signature) ToV2() *refs.Signature { func (s *Signature) ToV2() *refs.Signature {
return (*refs.Signature)(s) return (*refs.Signature)(s)
} }
// Marshal marshals Signature into a protobuf binary form.
//
// Buffer is allocated when the argument is empty.
// Otherwise, the first buffer is used.
func (s *Signature) Marshal(b ...[]byte) ([]byte, error) {
var buf []byte
if len(b) > 0 {
buf = b[0]
}
return (*refs.Signature)(s).
StableMarshal(buf)
}
// Unmarshal unmarshals protobuf binary representation of Signature.
func (s *Signature) Unmarshal(data []byte) error {
return (*refs.Signature)(s).
Unmarshal(data)
}
// MarshalJSON encodes Signature to protobuf JSON format.
func (s *Signature) MarshalJSON() ([]byte, error) {
return (*refs.Signature)(s).
MarshalJSON()
}
// UnmarshalJSON decodes Signature from protobuf JSON format.
func (s *Signature) UnmarshalJSON(data []byte) error {
return (*refs.Signature)(s).
UnmarshalJSON(data)
}

33
pkg/signature_test.go Normal file
View file

@ -0,0 +1,33 @@
package pkg
import (
"testing"
"github.com/stretchr/testify/require"
)
func TestSignatureEncoding(t *testing.T) {
s := NewSignature()
s.SetKey([]byte("key"))
s.SetSign([]byte("sign"))
t.Run("binary", func(t *testing.T) {
data, err := s.Marshal()
require.NoError(t, err)
s2 := NewSignature()
require.NoError(t, s2.Unmarshal(data))
require.Equal(t, s, s2)
})
t.Run("json", func(t *testing.T) {
data, err := s.MarshalJSON()
require.NoError(t, err)
s2 := NewSignature()
require.NoError(t, s2.UnmarshalJSON(data))
require.Equal(t, s, s2)
})
}

View file

@ -104,3 +104,23 @@ func (v *Version) UnmarshalJSON(data []byte) error {
return nil return nil
} }
func (s *Signature) MarshalJSON() ([]byte, error) {
return protojson.MarshalOptions{
EmitUnpopulated: true,
}.Marshal(
SignatureToGRPCMessage(s),
)
}
func (s *Signature) UnmarshalJSON(data []byte) error {
msg := new(refs.Signature)
if err := protojson.Unmarshal(data, msg); err != nil {
return err
}
*s = *SignatureFromGRPCMessage(msg)
return nil
}

View file

@ -69,3 +69,15 @@ func TestVersionSON(t *testing.T) {
require.Equal(t, v, v2) require.Equal(t, v, v2)
} }
func TestSignatureSON(t *testing.T) {
s := generateSignature("key", "sig")
data, err := s.MarshalJSON()
require.NoError(t, err)
s2 := new(refs.Signature)
require.NoError(t, s2.UnmarshalJSON(data))
require.Equal(t, s, s2)
}

View file

@ -266,6 +266,17 @@ func (s *Signature) StableSize() (size int) {
return size return size
} }
func (s *Signature) Unmarshal(data []byte) error {
m := new(refs.Signature)
if err := goproto.Unmarshal(data, m); err != nil {
return err
}
*s = *SignatureFromGRPCMessage(m)
return nil
}
func (v *Version) StableMarshal(buf []byte) ([]byte, error) { func (v *Version) StableMarshal(buf []byte) ([]byte, error) {
if v == nil { if v == nil {
return []byte{}, nil return []byte{}, nil

View file

@ -95,16 +95,14 @@ func TestChecksum_StableMarshal(t *testing.T) {
func TestSignature_StableMarshal(t *testing.T) { func TestSignature_StableMarshal(t *testing.T) {
signatureFrom := generateSignature("Public Key", "Signature") signatureFrom := generateSignature("Public Key", "Signature")
transport := new(grpc.Signature)
t.Run("non empty", func(t *testing.T) { t.Run("non empty", func(t *testing.T) {
wire, err := signatureFrom.StableMarshal(nil) wire, err := signatureFrom.StableMarshal(nil)
require.NoError(t, err) require.NoError(t, err)
err = goproto.Unmarshal(wire, transport) signatureTo := new(refs.Signature)
require.NoError(t, err) require.NoError(t, signatureTo.Unmarshal(wire))
signatureTo := refs.SignatureFromGRPCMessage(transport)
require.Equal(t, signatureFrom, signatureTo) require.Equal(t, signatureFrom, signatureTo)
}) })
} }