add unit-tests (#136)

Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>

.gitea/workflows/job_tests.yml

@@ -39,7 +39,7 @@ jobs:
       run: |
         go work init
         go work use .
-        go work use micro-tests        
+        go work use micro-tests
     - name: setup deps
       env:
         GOWORK: /workspace/${{ github.repository_owner }}/go.work
@@ -50,4 +50,4 @@ jobs:
         GOWORK: /workspace/${{ github.repository_owner }}/go.work
       run: |
         cd micro-tests
-        go test -mod readonly -v ./... || true        
+        go test -mod readonly -v ./... || true

codec_test.go

@@ -4,7 +4,7 @@ import (
 	"bytes"
 	"testing"
 
-	"go.unistack.org/micro/v4/codec"
+	"go.unistack.org/micro/v3/codec"
 )
 
 func TestFrame(t *testing.T) {
@@ -28,7 +28,7 @@ func TestFrameFlatten(t *testing.T) {
 		Name: &codec.Frame{Data: []byte("test")},
 	}
 
-	buf, err := NewCodec().Marshal(s)
+	buf, err := NewCodec(codec.Flatten(true)).Marshal(s)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -36,15 +36,3 @@ func TestFrameFlatten(t *testing.T) {
 		t.Fatalf("bytes not equal %s != %s", buf, `test`)
 	}
 }
-
-func TestReadBody(t *testing.T) {
-	s := &struct {
-		Name string
-	}{}
-	c := NewCodec()
-	b := bytes.NewReader(nil)
-	err := c.ReadBody(b, s)
-	if err != nil {
-		t.Fatal(err)
-	}
-}

go.mod

@@ -1,10 +1,19 @@
-module go.unistack.org/micro-codec-xml/v4
+module go.unistack.org/micro-codec-xml/v3
 
-go 1.19
+go 1.21
+
+toolchain go1.23.4
 
 require (
-	go.unistack.org/micro-proto/v4 v4.0.0
-	go.unistack.org/micro/v4 v4.0.1
+	github.com/stretchr/testify v1.10.0
+	go.unistack.org/micro-proto/v3 v3.4.1
+	go.unistack.org/micro/v3 v3.10.88
 )
 
-require google.golang.org/protobuf v1.28.1 // indirect
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	google.golang.org/protobuf v1.35.2 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -1,12 +1,18 @@
-github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
-github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
-github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-go.unistack.org/micro-proto/v4 v4.0.0 h1:+TAwKSlx48eLsNO2E2cO0JLE8we1KU2AuWe9Q310FuU=
-go.unistack.org/micro-proto/v4 v4.0.0/go.mod h1:ArmK7o+uFvxSY3dbJhKBBX4Pm1rhWdLEFf3LxBrMtec=
-go.unistack.org/micro/v4 v4.0.1 h1:xo1IxbVfgh8i0eY0VeYa3cbb13u5n/Mxnp3FOgWD4Jo=
-go.unistack.org/micro/v4 v4.0.1/go.mod h1:p/J5UcSJjfHsWGT31uKoghQ5rUQZzQJBAFy+Z4+ZVMs=
-golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
-golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
-google.golang.org/protobuf v1.28.1 h1:d0NfwRgPtno5B1Wa6L2DAG+KivqkdutMf1UhdNx175w=
-google.golang.org/protobuf v1.28.1/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
+github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+go.unistack.org/micro-proto/v3 v3.4.1 h1:UTjLSRz2YZuaHk9iSlVqqsA50JQNAEK2ZFboGqtEa9Q=
+go.unistack.org/micro-proto/v3 v3.4.1/go.mod h1:okx/cnOhzuCX0ggl/vToatbCupi0O44diiiLLsZ93Zo=
+go.unistack.org/micro/v3 v3.10.88 h1:MxlzP+77Y6Kphb3lzHxROL4XfE/WdCQMQpnPv4D9Z8U=
+go.unistack.org/micro/v3 v3.10.88/go.mod h1:erMgt3Bl7vQQ0e9UpQyR5NlLiZ9pKeEJ9+1tfYFaqUg=
+google.golang.org/protobuf v1.35.2 h1:8Ar7bF+apOIoThw1EdZl0p1oWvMqTHmpA2fRTyZO8io=
+google.golang.org/protobuf v1.35.2/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

reader_test.go

@@ -0,0 +1,40 @@
+package xml
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestReader_Read(t *testing.T) {
+	tests := []struct {
+		name     string
+		input    []byte
+		expected []byte
+	}{
+		{
+			name:     "with replacement",
+			input:    []byte(`<?xml version="1.1" encoding="UTF-8"?><root name="NAME"><item>ITEM</item></root>`),
+			expected: []byte(`<?xml version="1.0" encoding="UTF-8"?><root name="NAME"><item>ITEM</item></root>`),
+		},
+		{
+			name:     "without replacement",
+			input:    []byte(`<?xml version="1.0" encoding="UTF-8"?><root name="NAME"><item>ITEM</item></root>`),
+			expected: []byte(`<?xml version="1.0" encoding="UTF-8"?><root name="NAME"><item>ITEM</item></root>`),
+		},
+		{
+			name:     "check invalid replacement",
+			input:    []byte(`<?xml version="1.0" encoding="UTF-8"?><root version="1.1"><item>ITEM</item></root>`),
+			expected: []byte(`<?xml version="1.0" encoding="UTF-8"?><root version="1.1"><item>ITEM</item></root>`),
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			buf := make([]byte, len(tt.input))
+			n, err := newReader(tt.input).Read(buf)
+			require.NoError(t, err)
+			require.Equal(t, tt.expected, buf[:n])
+		})
+	}
+}

xml.go

@@ -1,13 +1,14 @@
 // Package xml provides a xml codec
-package xml // import "go.unistack.org/micro-codec-xml/v4"
+package xml // import "go.unistack.org/micro-codec-xml/v3"
 
 import (
+	"bytes"
 	"encoding/xml"
 	"io"
 
-	pb "go.unistack.org/micro-proto/v4/codec"
-	"go.unistack.org/micro/v4/codec"
-	rutil "go.unistack.org/micro/v4/util/reflect"
+	pb "go.unistack.org/micro-proto/v3/codec"
+	"go.unistack.org/micro/v3/codec"
+	rutil "go.unistack.org/micro/v3/util/reflect"
 )
 
 var _ codec.Codec = &xmlCodec{}
@@ -20,6 +21,18 @@ const (
 	flattenTag = "flatten"
 )
 
+type unmarshalStrictKey struct{}
+
+func UnmarshalStrict(b bool) codec.Option {
+	return codec.SetOption(unmarshalStrictKey{}, b)
+}
+
+type unmarshalXML11Key struct{}
+
+func UnmarshalXML11(b bool) codec.Option {
+	return codec.SetOption(unmarshalXML11Key{}, b)
+}
+
 func (c *xmlCodec) Marshal(v interface{}, opts ...codec.Option) ([]byte, error) {
 	if v == nil {
 		return nil, nil
@@ -29,8 +42,11 @@ func (c *xmlCodec) Marshal(v interface{}, opts ...codec.Option) ([]byte, error)
 	for _, o := range opts {
 		o(&options)
 	}
-	if nv, nerr := rutil.StructFieldByTag(v, options.TagName, flattenTag); nerr == nil {
-		v = nv
+
+	if options.Flatten {
+		if nv, nerr := rutil.StructFieldByTag(v, options.TagName, flattenTag); nerr == nil {
+			v = nv
+		}
 	}
 
 	switch m := v.(type) {
@@ -38,6 +54,10 @@ func (c *xmlCodec) Marshal(v interface{}, opts ...codec.Option) ([]byte, error)
 		return m.Data, nil
 	case *pb.Frame:
 		return m.Data, nil
+	case codec.RawMessage:
+		return []byte(m), nil
+	case *codec.RawMessage:
+		return []byte(*m), nil
 	}
 
 	return xml.Marshal(v)
@@ -53,8 +73,10 @@ func (c *xmlCodec) Unmarshal(b []byte, v interface{}, opts ...codec.Option) erro
 		o(&options)
 	}
 
-	if nv, nerr := rutil.StructFieldByTag(v, options.TagName, flattenTag); nerr == nil {
-		v = nv
+	if options.Flatten {
+		if nv, nerr := rutil.StructFieldByTag(v, options.TagName, flattenTag); nerr == nil {
+			v = nv
+		}
 	}
 
 	switch m := v.(type) {
@@ -64,44 +86,74 @@ func (c *xmlCodec) Unmarshal(b []byte, v interface{}, opts ...codec.Option) erro
 	case *pb.Frame:
 		m.Data = b
 		return nil
-	}
-
-	return xml.Unmarshal(b, v)
-}
-
-func (c *xmlCodec) ReadHeader(conn io.Reader, m *codec.Message, t codec.MessageType) error {
-	return nil
-}
-
-func (c *xmlCodec) ReadBody(conn io.Reader, v interface{}) error {
-	if v == nil {
+	case *codec.RawMessage:
+		*m = append((*m)[0:0], b...)
+		return nil
+	case codec.RawMessage:
+		copy(m, b)
 		return nil
 	}
 
-	buf, err := io.ReadAll(conn)
-	if err != nil {
-		return err
-	} else if len(buf) == 0 {
-		return nil
+	var unmarshalStrict bool
+	var unmarshalXML11 bool
+	if options.Context != nil {
+		if v, ok := options.Context.Value(unmarshalStrictKey{}).(bool); ok {
+			unmarshalStrict = v
+		}
+		if v, ok := options.Context.Value(unmarshalXML11Key{}).(bool); ok {
+			unmarshalXML11 = v
+		}
 	}
 
-	return c.Unmarshal(buf, v)
+	var r io.Reader
+
+	if unmarshalXML11 {
+		r = newReader(b)
+	} else {
+		r = bytes.NewReader(b)
+	}
+
+	d := xml.NewDecoder(r)
+
+	if unmarshalStrict {
+		d.Strict = true
+	}
+
+	return d.Decode(v)
 }
 
-func (c *xmlCodec) Write(conn io.Writer, m *codec.Message, v interface{}) error {
-	if v == nil {
-		return nil
+type reader struct {
+	s        []byte
+	i        int64 // current reading index
+	prevRune int   // index of previous rune; or < 0
+	skip     bool
+}
+
+func newReader(b []byte) io.Reader {
+	return &reader{b, 0, -1, false}
+}
+
+var (
+	srcP = []byte(`<?xml version="1.1"`)
+	srcL = len(srcP)
+	dstP = []byte(`<?xml version="1.0"`)
+)
+
+func (r *reader) Read(b []byte) (n int, err error) {
+	if r.i >= int64(len(r.s)) {
+		return 0, io.EOF
+	}
+	r.prevRune = -1
+	n = copy(b, r.s[r.i:])
+	if !r.skip {
+		if idx := bytes.Index(b, srcP); idx >= 0 {
+			copy(b[idx:idx+srcL], dstP)
+			r.skip = true
+		}
 	}
 
-	buf, err := c.Marshal(v)
-	if err != nil {
-		return err
-	} else if len(buf) == 0 {
-		return codec.ErrInvalidMessage
-	}
-
-	_, err = conn.Write(buf)
-	return err
+	r.i += int64(n)
+	return
 }
 
 func (c *xmlCodec) String() string {

xml_test.go

@@ -0,0 +1,70 @@
+package xml
+
+import (
+	"encoding/xml"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"go.unistack.org/micro/v3/codec"
+)
+
+func TestXmlCodec_Unmarshal(t *testing.T) {
+	type result struct {
+		XMLName xml.Name `xml:"root"`
+		Name    string   `xml:"name,attr"`
+		Item    string   `xml:"item"`
+	}
+
+	tests := []struct {
+		name     string
+		input    []byte
+		isXML11  bool
+		expected result
+	}{
+		{
+			name:  "without version",
+			input: []byte(`<root name="NAME"><item>ITEM</item></root>`),
+			expected: result{
+				XMLName: xml.Name{Local: "root"},
+				Name:    "NAME",
+				Item:    "ITEM",
+			},
+		},
+		{
+			name:  "version 1.0",
+			input: []byte(`<?xml version="1.0" encoding="UTF-8"?><root name="NAME"><item>ITEM</item></root>`),
+			expected: result{
+				XMLName: xml.Name{Local: "root"},
+				Name:    "NAME",
+				Item:    "ITEM",
+			},
+		},
+		{
+			name:    "version 1.1",
+			input:   []byte(`<?xml version="1.1" encoding="UTF-8"?><root name="NAME"><item>ITEM</item></root>`),
+			isXML11: true,
+			expected: result{
+				XMLName: xml.Name{Local: "root"},
+				Name:    "NAME",
+				Item:    "ITEM",
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			var (
+				r    result
+				opts []codec.Option
+			)
+
+			if tt.isXML11 {
+				opts = append(opts, UnmarshalXML11(true))
+			}
+
+			err := NewCodec(opts...).Unmarshal(tt.input, &r)
+			require.NoError(t, err)
+			require.Equal(t, tt.expected, r)
+		})
+	}
+}