github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/generics/hashmap/idkey/map_pool_test.go (about)

     1  // Copyright (c) 2018 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package idkey
    22  
    23  import (
    24  	"testing"
    25  	"unsafe"
    26  
    27  	"github.com/m3db/m3/src/x/ident"
    28  	"github.com/m3db/m3/src/x/pool"
    29  
    30  	"github.com/golang/mock/gomock"
    31  	"github.com/mauricelam/genny/generic"
    32  	"github.com/stretchr/testify/require"
    33  )
    34  
    35  // nolint: structcheck
    36  func TestMapWithPooling(t *testing.T) {
    37  	ctrl := gomock.NewController(t)
    38  	defer ctrl.Finish()
    39  
    40  	key := ident.StringID("foo")
    41  	value := generic.Type("a")
    42  
    43  	pool := pool.NewMockBytesPool(ctrl)
    44  
    45  	m := NewMap(MapOptions{KeyCopyPool: pool})
    46  
    47  	mockPooledSlice := make([]byte, 0, 3)
    48  	pool.EXPECT().Get(len(key.Bytes())).Return(mockPooledSlice)
    49  	m.Set(key, value)
    50  	require.Equal(t, 1, m.Len())
    51  
    52  	// Now ensure that the key is from the pool and not our original key
    53  	for _, entry := range m.Iter() {
    54  		type slice struct {
    55  			array unsafe.Pointer
    56  			len   int
    57  			cap   int
    58  		}
    59  
    60  		keyBytes := []byte(entry.Key().(ident.BytesID))
    61  
    62  		rawPooledSlice := (*slice)(unsafe.Pointer(&mockPooledSlice))
    63  		rawKeySlice := (*slice)(unsafe.Pointer(&keyBytes))
    64  
    65  		require.True(t, rawPooledSlice.array == rawKeySlice.array)
    66  	}
    67  
    68  	// Now delete the key to simulate returning to pool
    69  	pool.EXPECT().Put(mockPooledSlice[:3])
    70  	m.Delete(key)
    71  	require.Equal(t, 0, m.Len())
    72  }