github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/debug/ext/ext_test.go (about)

     1  // Copyright (c) 2021 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 extdebug
    22  
    23  import (
    24  	"archive/zip"
    25  	"bytes"
    26  	"io"
    27  	"net/http"
    28  	"testing"
    29  	"time"
    30  
    31  	"github.com/m3db/m3/src/cluster/placementhandler/handleroptions"
    32  	debugtest "github.com/m3db/m3/src/x/debug/test"
    33  	"github.com/m3db/m3/src/x/instrument"
    34  
    35  	"github.com/golang/mock/gomock"
    36  	"github.com/stretchr/testify/require"
    37  )
    38  
    39  func TestDefaultSources(t *testing.T) {
    40  	defaultSources := []string{
    41  		"cpu.prof",
    42  		"heap.prof",
    43  		"host.json",
    44  		"goroutine.prof",
    45  		"namespace.json",
    46  		"placement-m3db.json",
    47  	}
    48  
    49  	handlerOpts, mockKV, mockClient := debugtest.NewTestHandlerOptsAndClient(t)
    50  	mockClient.EXPECT().Store(gomock.Any()).Return(mockKV, nil)
    51  	svcDefaults := []handleroptions.ServiceNameAndDefaults{{
    52  		ServiceName: handleroptions.M3DBServiceName,
    53  	}}
    54  	zw, err := NewPlacementAndNamespaceZipWriterWithDefaultSources(
    55  		1*time.Second, mockClient, handlerOpts, svcDefaults, instrument.NewOptions())
    56  	require.NoError(t, err)
    57  	require.NotNil(t, zw)
    58  
    59  	// Check writing ZIP is ok
    60  	buff := bytes.NewBuffer([]byte{})
    61  	err = zw.WriteZip(buff, &http.Request{})
    62  	require.NoError(t, err)
    63  	require.NotZero(t, buff.Len())
    64  
    65  	// Check written ZIP is not empty
    66  	bytesReader := bytes.NewReader(buff.Bytes())
    67  	zipReader, err := zip.NewReader(bytesReader, int64(bytesReader.Len()))
    68  	require.NoError(t, err)
    69  	require.NotNil(t, zipReader)
    70  
    71  	actualFnames := make(map[string]bool)
    72  	for _, f := range zipReader.File {
    73  		actualFnames[f.Name] = true
    74  
    75  		rc, ferr := f.Open()
    76  		require.NoError(t, ferr)
    77  		defer func() {
    78  			require.NoError(t, rc.Close())
    79  		}()
    80  
    81  		content := []byte{}
    82  		if _, err := rc.Read(content); err != nil {
    83  			require.Equal(t, io.EOF, err)
    84  		}
    85  		require.NotZero(t, content)
    86  	}
    87  
    88  	for _, source := range defaultSources {
    89  		_, ok := actualFnames[source]
    90  		require.True(t, ok)
    91  	}
    92  }