github.com/datastax/go-cassandra-native-protocol@v0.0.0-20220706104457-5e8aad05cf90/datacodec/float_test.go

// Copyright 2021 DataStax
//
// Licensed 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 datacodec

import (
	"fmt"
	"math"
	"testing"

	"github.com/stretchr/testify/assert"

	"github.com/datastax/go-cassandra-native-protocol/datatype"
	"github.com/datastax/go-cassandra-native-protocol/primitive"
)

var (
	floatZeroBytes       = encodeUint32(0x00000000)
	floatOneBytes        = encodeUint32(0x3f800000)
	floatMinusOneBytes   = encodeUint32(0xbf800000)
	floatMaxFloat32Bytes = encodeUint32(0x7f7fffff)
)

func Test_floatCodec_DataType(t *testing.T) {
	assert.Equal(t, datatype.Float, Float.DataType())
}

func Test_floatCodec_Encode(t *testing.T) {
	for _, version := range primitive.SupportedProtocolVersions() {
		t.Run(version.String(), func(t *testing.T) {
			tests := []struct {
				name     string
				source   interface{}
				expected []byte
				err      string
			}{
				{"nil", nil, nil, ""},
				{"nil pointer", float32NilPtr(), nil, ""},
				{"non nil", 1.0, floatOneBytes, ""},
				{"conversion failed", int32(42), nil, fmt.Sprintf("cannot encode int32 as CQL float with %v: cannot convert from int32 to float32: conversion not supported", version)},
			}
			for _, tt := range tests {
				t.Run(tt.name, func(t *testing.T) {
					actual, err := Float.Encode(tt.source, version)
					assert.Equal(t, tt.expected, actual)
					assertErrorMessage(t, tt.err, err)
				})
			}
		})
	}
}

func Test_floatCodec_Decode(t *testing.T) {
	for _, version := range primitive.SupportedProtocolVersions() {
		t.Run(version.String(), func(t *testing.T) {
			tests := []struct {
				name     string
				source   []byte
				dest     interface{}
				expected interface{}
				wasNull  bool
				err      string
			}{
				{"null", nil, new(float32), new(float32), true, ""},
				{"non null", floatOneBytes, new(float32), float32Ptr(1), false, ""},
				{"non null interface", floatOneBytes, new(interface{}), interfacePtr(float32(1.0)), false, ""},
				{"read failed", []byte{1}, new(float32), new(float32), false, fmt.Sprintf("cannot decode CQL float as *float32 with %v: cannot read float32: expected 4 bytes but got: 1", version)},
				{"conversion failed", floatOneBytes, new(int64), new(int64), false, fmt.Sprintf("cannot decode CQL float as *int64 with %v: cannot convert from float32 to *int64: conversion not supported", version)},
			}
			for _, tt := range tests {
				t.Run(tt.name, func(t *testing.T) {
					wasNull, err := Float.Decode(tt.source, tt.dest, version)
					assert.Equal(t, tt.expected, tt.dest)
					assert.Equal(t, tt.wasNull, wasNull)
					assertErrorMessage(t, tt.err, err)
				})
			}
		})
	}
}

func Test_convertToFloat32(t *testing.T) {
	tests := []struct {
		name     string
		input    interface{}
		expected float32
		wasNil   bool
		err      string
	}{
		{"from float64", float64(1), 1, false, ""},
		{"from float64 out of range", math.MaxFloat64, 0, false, "cannot convert from float64 to float32: value out of range: 1.7976931348623157e+308"},
		{"from *float64 non nil", float64Ptr(1), 1, false, ""},
		{"from *float64 nil", float64NilPtr(), 0, true, ""},
		{"from *float64 out of range", float64Ptr(math.MaxFloat64), 0, false, "cannot convert from *float64 to float32: value out of range: 1.7976931348623157e+308"},
		{"from float32", float32(1), 1, false, ""},
		{"from *float32 non nil", float32Ptr(1), 1, false, ""},
		{"from *float32 nil", float32NilPtr(), 0, true, ""},
		{"from untyped nil", nil, 0, true, ""},
		{"from unsupported value type", 42, 0, false, "cannot convert from int to float32: conversion not supported"},
		{"from unsupported pointer type", int32Ptr(42), 0, false, "cannot convert from *int32 to float32: conversion not supported"},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			dest, wasNil, err := convertToFloat32(tt.input)
			assert.Equal(t, tt.expected, dest)
			assert.Equal(t, tt.wasNil, wasNil)
			assertErrorMessage(t, tt.err, err)
		})
	}
}

func Test_convertFromFloat32(t *testing.T) {
	tests := []struct {
		name     string
		val      float32
		wasNull  bool
		dest     interface{}
		expected interface{}
		err      string
	}{
		{"to *interface{} nil dest", 1, false, interfaceNilPtr(), interfaceNilPtr(), "cannot convert from float32 to *interface {}: destination is nil"},
		{"to *interface{} nil source", 0, true, new(interface{}), new(interface{}), ""},
		{"to *interface{} non nil", 1, false, new(interface{}), interfacePtr(float32(1)), ""},
		{"to *float64 nil dest", 1, false, float64NilPtr(), float64NilPtr(), "cannot convert from float32 to *float64: destination is nil"},
		{"to *float64 nil source", 0, true, new(float64), float64Ptr(0), ""},
		{"to *float64 non nil", 1, false, new(float64), float64Ptr(1), ""},
		{"to *float32 nil dest", 1, false, float32NilPtr(), float32NilPtr(), "cannot convert from float32 to *float32: destination is nil"},
		{"to *float32 nil source", 0, true, new(float32), float32Ptr(0), ""},
		{"to *float32 non nil", 1, false, new(float32), float32Ptr(1), ""},
		{"to untyped nil", 1, false, nil, nil, "cannot convert from float32 to <nil>: destination is nil"},
		{"to non pointer", 1, false, int64(0), int64(0), "cannot convert from float32 to int64: destination is not pointer"},
		{"to unsupported pointer type", 1, false, new(int64), new(int64), "cannot convert from float32 to *int64: conversion not supported"},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			err := convertFromFloat32(tt.val, tt.wasNull, tt.dest)
			assert.Equal(t, tt.expected, tt.dest)
			assertErrorMessage(t, tt.err, err)
		})
	}
}

func Test_writeFloat32(t *testing.T) {
	tests := []struct {
		name     string
		val      float32
		expected []byte
	}{
		{"zero", 0, floatZeroBytes},
		{"1", 1, floatOneBytes},
		{"-1", -1, floatMinusOneBytes},
		{"simple pos", 123.4, encodeUint32(0x42f6cccd)},
		{"simple neg", -123.4, encodeUint32(0xc2f6cccd)},
		{"max", math.MaxFloat32, floatMaxFloat32Bytes},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			actual := writeFloat32(tt.val)
			assert.Equal(t, tt.expected, actual)
		})
	}
}

func Test_readFloat32(t *testing.T) {
	tests := []struct {
		name     string
		source   []byte
		expected float32
		wasNull  bool
		err      string
	}{
		{"nil", nil, 0, true, ""},
		{"empty", []byte{}, 0, true, ""},
		{"wrong length", []byte{1}, 0, false, "cannot read float32: expected 4 bytes but got: 1"},
		{"zero", floatZeroBytes, 0, false, ""},
		{"1", floatOneBytes, 1, false, ""},
		{"-1", floatMinusOneBytes, -1, false, ""},
		{"simple pos", encodeUint32(0x42f6cccd), 123.4, false, ""},
		{"simple neg", encodeUint32(0xc2f6cccd), -123.4, false, ""},
		{"max", floatMaxFloat32Bytes, math.MaxFloat32, false, ""},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			actual, wasNull, err := readFloat32(tt.source)
			assert.Equal(t, tt.expected, actual)
			assert.Equal(t, tt.wasNull, wasNull)
			assertErrorMessage(t, tt.err, err)
		})
	}
}