Add tests for lz4 and snappy

hunkeelin · Jul 2, 2018 · 1b8bebd · 1b8bebd
1 parent 4b43636
commit 1b8bebd
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 1 deletion.
diff --git a/compression.go b/compression.go
@@ -7,6 +7,8 @@ const (
 	CompressionLZ4
 )
 
+// CompressionCodec represents a compression codec to encode and decode
+// the messages.
 type CompressionCodec struct {
 	str    func() string
 	encode func(src []byte, level int) ([]byte, error)

diff --git a/gzip/gzip_test.go b/gzip/gzip_test.go
@@ -32,5 +32,4 @@ func TestGzip(t *testing.T) {
 			t.Log("got: ", r2)
 		}
 	})
-
 }
diff --git a/lz4/lz4_test.go b/lz4/lz4_test.go
@@ -0,0 +1,35 @@
+package lz4
+
+import (
+	"bytes"
+	"testing"
+)
+
+func TestLZ4(t *testing.T) {
+	var r1, r2 []byte
+	var err error
+	payload := []byte("message")
+
+	t.Run("encode", func(t *testing.T) {
+		r1, err = Encode(payload, 1)
+		if err != nil {
+			t.Error(err)
+		}
+		if bytes.Equal(payload, r1) {
+			t.Error("failed to encode payload")
+			t.Log("got: ", r1)
+		}
+	})
+
+	t.Run("decode", func(t *testing.T) {
+		r2, err = Decode(r1)
+		if err != nil {
+			t.Error(err)
+		}
+		if !bytes.Equal(payload, r2) {
+			t.Error("failed to decode payload")
+			t.Log("expected: ", payload)
+			t.Log("got: ", r2)
+		}
+	})
+}
diff --git a/message.go b/message.go
@@ -10,6 +10,7 @@ import (
 // See : https://cwiki.apache.org/confluence/display/KAFKA/Compression
 var codecs map[int8]CompressionCodec
 
+// RegisterCompressionCodec registers a compression codec so it can be used by a Writer.
 func RegisterCompressionCodec(code int8, str func() string, encode func(src []byte, level int) ([]byte, error), decode func(src []byte) ([]byte, error)) error {
 	if codecs == nil {
 		codecs = make(map[int8]CompressionCodec)
@@ -66,6 +67,7 @@ func (msg Message) message() message {
 	return m
 }
 
+// Encode encodes the Message using the CompressionCodec and CompressionLevel.
 func (msg Message) Encode() (Message, error) {
 	codec, ok := codecs[msg.CompressionCodec]
 	if !ok {
@@ -81,6 +83,7 @@ func (msg Message) Encode() (Message, error) {
 	return msg, nil
 }
 
+// Decode decodes the Message using the CompressionCodec.
 func (msg Message) Decode() (Message, error) {
 	c := msg.message().Attributes & compressionCodecMask
 	codec, ok := codecs[c]

diff --git a/snappy/snappy_test.go b/snappy/snappy_test.go
@@ -0,0 +1,35 @@
+package snappy
+
+import (
+	"bytes"
+	"testing"
+)
+
+func TestSnappy(t *testing.T) {
+	var r1, r2 []byte
+	var err error
+	payload := []byte("message")
+
+	t.Run("encode", func(t *testing.T) {
+		r1, err = Encode(payload, 1)
+		if err != nil {
+			t.Error(err)
+		}
+		if bytes.Equal(payload, r1) {
+			t.Error("failed to encode payload")
+			t.Log("got: ", r1)
+		}
+	})
+
+	t.Run("decode", func(t *testing.T) {
+		r2, err = Decode(r1)
+		if err != nil {
+			t.Error(err)
+		}
+		if !bytes.Equal(payload, r2) {
+			t.Error("failed to decode payload")
+			t.Log("expected: ", payload)
+			t.Log("got: ", r2)
+		}
+	})
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -32,5 +32,4 @@ func TestGzip(t *testing.T) { @@
     			t.Log("got: ", r2)
     		}
     	})
     }