gin/render/protobuf/protobuf_test.go
Bo-Yi Wu d43f6a591b
feat(render)!: make msgpack/bson/yaml/toml/protobuf opt-in subpackages
- Move MessagePack, BSON, YAML, TOML and ProtoBuf rendering and binding out
  of core into github.com/gin-gonic/gin/render/<format> subpackages
- Add content-type registries to binding and render that each subpackage
  populates from init() so ShouldBind and Negotiate keep negotiating
- Slim binding.Default to core types and resolve the rest via the registry
- Drop the obsolete nomsgpack build tag and binding_nomsgpack.go
- Cut a minimal JSON-only binary from 13MB to 6.5MB; non-core codecs now
  cost binary size only when their subpackage is imported

BREAKING CHANGE: c.YAML, c.TOML, c.ProtoBuf, c.BSON, c.BindYAML, c.BindTOML,
c.ShouldBindYAML, c.ShouldBindTOML, c.ShouldBindBodyWithYAML and
c.ShouldBindBodyWithTOML are removed, along with binding.MsgPack/BSON/YAML/
TOML/ProtoBuf, the render.MsgPack/BSON/YAML/TOML/ProtoBuf types and the
nomsgpack build tag. Import the matching github.com/gin-gonic/gin/render/<format>
subpackage and use its Render(c, code, obj) / ShouldBind(c, &obj) helpers
(or pass <format>.Binding to c.ShouldBindWith). Importing the subpackage also
re-registers the content type so c.ShouldBind and c.Negotiate work as before.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-21 22:30:25 +08:00

66 lines
1.6 KiB
Go

// Copyright 2025 Gin Core Team. All rights reserved.
// Use of this source code is governed by a MIT style
// license that can be found in the LICENSE file.
package protobuf
import (
"net/http"
"net/http/httptest"
"testing"
"github.com/gin-gonic/gin"
"github.com/gin-gonic/gin/binding"
"github.com/gin-gonic/gin/render"
"github.com/gin-gonic/gin/testdata/protoexample"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"google.golang.org/protobuf/proto"
)
func sample() *protoexample.Test {
return &protoexample.Test{
Label: proto.String("yes"),
Reps: []int64{1, 2, 3},
}
}
func TestRender(t *testing.T) {
gin.SetMode(gin.TestMode)
w := httptest.NewRecorder()
c, _ := gin.CreateTestContext(w)
Render(c, http.StatusOK, sample())
assert.Equal(t, http.StatusOK, w.Code)
assert.Equal(t, "application/x-protobuf", w.Header().Get("Content-Type"))
var got protoexample.Test
require.NoError(t, proto.Unmarshal(w.Body.Bytes(), &got))
assert.Equal(t, "yes", got.GetLabel())
assert.Equal(t, []int64{1, 2, 3}, got.GetReps())
}
func TestBinding(t *testing.T) {
body, err := proto.Marshal(sample())
require.NoError(t, err)
var out protoexample.Test
require.NoError(t, Binding.BindBody(body, &out))
assert.Equal(t, "yes", out.GetLabel())
assert.Equal(t, "protobuf", Binding.Name())
}
func TestBindingNotProtoMessage(t *testing.T) {
err := Binding.BindBody([]byte("x"), &struct{ Foo string }{})
require.Error(t, err)
}
func TestRegistration(t *testing.T) {
assert.Equal(t, Binding, binding.Default(http.MethodPost, MIMEPROTOBUF))
r, ok := render.Negotiate(MIMEPROTOBUF, sample())
assert.True(t, ok)
assert.NotNil(t, r)
}