lib/go/test/tests/required_fields_test.go

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package tests

import (
	"context"
	"testing"

	"github.com/golang/mock/gomock"

	"github.com/apache/thrift/lib/go/test/gopath/src/optionalfieldstest"
	"github.com/apache/thrift/lib/go/test/gopath/src/requiredfieldtest"
	"github.com/apache/thrift/lib/go/thrift"
)

func TestRequiredField_SucecssWhenSet(t *testing.T) {
	// create a new RequiredField instance with the required field set
	source := &requiredfieldtest.RequiredField{Name: "this is a test"}
	sourceData, err := thrift.NewTSerializer().Write(context.Background(), source)
	if err != nil {
		t.Fatalf("failed to serialize %T: %v", source, err)
	}

	d := thrift.NewTDeserializer()
	err = d.Read(context.Background(), &requiredfieldtest.RequiredField{}, sourceData)
	if err != nil {
		t.Fatalf("Did not expect an error when trying to deserialize the requiredfieldtest.RequiredField: %v", err)
	}
}

func TestRequiredField_ErrorWhenMissing(t *testing.T) {
	// create a new OtherThing instance, without setting the required field
	source := &requiredfieldtest.OtherThing{}
	sourceData, err := thrift.NewTSerializer().Write(context.Background(), source)
	if err != nil {
		t.Fatalf("failed to serialize %T: %v", source, err)
	}

	// attempt to deserialize into a different type (which should fail)
	d := thrift.NewTDeserializer()
	err = d.Read(context.Background(), &requiredfieldtest.RequiredField{}, sourceData)
	if err == nil {
		t.Fatal("Expected an error when trying to deserialize an object which is missing a required field")
	}
}

func TestStructReadRequiredFields(t *testing.T) {
	mockCtrl := gomock.NewController(t)
	protocol := NewMockTProtocol(mockCtrl)
	testStruct := optionalfieldstest.NewStructC()

	// None of required fields are set
	gomock.InOrder(
		protocol.EXPECT().ReadStructBegin(context.Background()).Return("StructC", nil),
		protocol.EXPECT().ReadFieldBegin(context.Background()).Return("_", thrift.TType(thrift.STOP), int16(1), nil),
		protocol.EXPECT().ReadStructEnd(context.Background()).Return(nil),
	)

	err := testStruct.Read(context.Background(), protocol)
	mockCtrl.Finish()
	mockCtrl = gomock.NewController(t)
	if err == nil {
		t.Fatal("Expected read to fail")
	}
	err2, ok := err.(thrift.TProtocolException)
	if !ok {
		t.Fatal("Expected a TProtocolException")
	}
	if err2.TypeId() != thrift.INVALID_DATA {
		t.Fatal("Expected INVALID_DATA TProtocolException")
	}

	// One of the required fields is set
	gomock.InOrder(
		protocol.EXPECT().ReadStructBegin(context.Background()).Return("StructC", nil),
		protocol.EXPECT().ReadFieldBegin(context.Background()).Return("I", thrift.TType(thrift.I32), int16(2), nil),
		protocol.EXPECT().ReadI32(context.Background()).Return(int32(1), nil),
		protocol.EXPECT().ReadFieldEnd(context.Background()).Return(nil),
		protocol.EXPECT().ReadFieldBegin(context.Background()).Return("_", thrift.TType(thrift.STOP), int16(1), nil),
		protocol.EXPECT().ReadStructEnd(context.Background()).Return(nil),
	)

	err = testStruct.Read(context.Background(), protocol)
	mockCtrl.Finish()
	mockCtrl = gomock.NewController(t)
	if err == nil {
		t.Fatal("Expected read to fail")
	}
	err2, ok = err.(thrift.TProtocolException)
	if !ok {
		t.Fatal("Expected a TProtocolException")
	}
	if err2.TypeId() != thrift.INVALID_DATA {
		t.Fatal("Expected INVALID_DATA TProtocolException")
	}

	// Both of the required fields are set
	gomock.InOrder(
		protocol.EXPECT().ReadStructBegin(context.Background()).Return("StructC", nil),
		protocol.EXPECT().ReadFieldBegin(context.Background()).Return("i", thrift.TType(thrift.I32), int16(2), nil),
		protocol.EXPECT().ReadI32(context.Background()).Return(int32(1), nil),
		protocol.EXPECT().ReadFieldEnd(context.Background()).Return(nil),
		protocol.EXPECT().ReadFieldBegin(context.Background()).Return("s2", thrift.TType(thrift.STRING), int16(4), nil),
		protocol.EXPECT().ReadString(context.Background()).Return("test", nil),
		protocol.EXPECT().ReadFieldEnd(context.Background()).Return(nil),
		protocol.EXPECT().ReadFieldBegin(context.Background()).Return("_", thrift.TType(thrift.STOP), int16(1), nil),
		protocol.EXPECT().ReadStructEnd(context.Background()).Return(nil),
	)

	err = testStruct.Read(context.Background(), protocol)
	mockCtrl.Finish()
	if err != nil {
		t.Fatal("Expected read to succeed")
	}
}