// Copyright 2021 The Prometheus Authors // 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 tsdb import ( "fmt" "sync" "testing" "github.com/stretchr/testify/require" "github.com/prometheus/prometheus/model/labels" "github.com/prometheus/prometheus/tsdb/chunkenc" "github.com/prometheus/prometheus/tsdb/chunks" ) func TestBoundedChunk(t *testing.T) { tests := []struct { name string inputChunk chunkenc.Chunk inputMinT int64 inputMaxT int64 initialSeek int64 seekIsASuccess bool expSamples []sample }{ { name: "if there are no samples it returns nothing", inputChunk: newTestChunk(0), expSamples: nil, }, { name: "bounds represent a single sample", inputChunk: newTestChunk(10), expSamples: []sample{ {0, 0, nil, nil}, }, }, { name: "if there are bounds set only samples within them are returned", inputChunk: newTestChunk(10), inputMinT: 1, inputMaxT: 8, expSamples: []sample{ {1, 1, nil, nil}, {2, 2, nil, nil}, {3, 3, nil, nil}, {4, 4, nil, nil}, {5, 5, nil, nil}, {6, 6, nil, nil}, {7, 7, nil, nil}, {8, 8, nil, nil}, }, }, { name: "if bounds set and only maxt is less than actual maxt", inputChunk: newTestChunk(10), inputMinT: 0, inputMaxT: 5, expSamples: []sample{ {0, 0, nil, nil}, {1, 1, nil, nil}, {2, 2, nil, nil}, {3, 3, nil, nil}, {4, 4, nil, nil}, {5, 5, nil, nil}, }, }, { name: "if bounds set and only mint is more than actual mint", inputChunk: newTestChunk(10), inputMinT: 5, inputMaxT: 9, expSamples: []sample{ {5, 5, nil, nil}, {6, 6, nil, nil}, {7, 7, nil, nil}, {8, 8, nil, nil}, {9, 9, nil, nil}, }, }, { name: "if there are bounds set with seek before mint", inputChunk: newTestChunk(10), inputMinT: 3, inputMaxT: 7, initialSeek: 1, seekIsASuccess: true, expSamples: []sample{ {3, 3, nil, nil}, {4, 4, nil, nil}, {5, 5, nil, nil}, {6, 6, nil, nil}, {7, 7, nil, nil}, }, }, { name: "if there are bounds set with seek between mint and maxt", inputChunk: newTestChunk(10), inputMinT: 3, inputMaxT: 7, initialSeek: 5, seekIsASuccess: true, expSamples: []sample{ {5, 5, nil, nil}, {6, 6, nil, nil}, {7, 7, nil, nil}, }, }, { name: "if there are bounds set with seek after maxt", inputChunk: newTestChunk(10), inputMinT: 3, inputMaxT: 7, initialSeek: 8, seekIsASuccess: false, }, } for _, tc := range tests { t.Run(fmt.Sprintf("name=%s", tc.name), func(t *testing.T) { iterable := boundedIterable{tc.inputChunk, tc.inputMinT, tc.inputMaxT} var samples []sample it := iterable.Iterator(nil) if tc.initialSeek != 0 { // Testing Seek() val := it.Seek(tc.initialSeek) require.Equal(t, tc.seekIsASuccess, val == chunkenc.ValFloat) if val == chunkenc.ValFloat { t, v := it.At() samples = append(samples, sample{t, v, nil, nil}) } } // Testing Next() for it.Next() == chunkenc.ValFloat { t, v := it.At() samples = append(samples, sample{t, v, nil, nil}) } // it.Next() should keep returning no value. for i := 0; i < 10; i++ { require.Equal(t, chunkenc.ValNone, it.Next()) } require.Equal(t, tc.expSamples, samples) }) } } func newTestChunk(numSamples int) chunkenc.Chunk { xor := chunkenc.NewXORChunk() a, _ := xor.Appender() for i := 0; i < numSamples; i++ { a.Append(int64(i), float64(i)) } return xor } // TestMemSeries_chunk runs a series of tests on memSeries.chunk() calls. // It will simulate various conditions to ensure all code paths in that function are covered. func TestMemSeries_chunk(t *testing.T) { const chunkRange int64 = 100 const chunkStep int64 = 5 appendSamples := func(t *testing.T, s *memSeries, start, end int64, cdm *chunks.ChunkDiskMapper) { for i := start; i < end; i += chunkStep { ok, _ := s.append(i, float64(i), 0, chunkOpts{ chunkDiskMapper: cdm, chunkRange: chunkRange, samplesPerChunk: DefaultSamplesPerChunk, }) require.True(t, ok, "sample append failed") } } type setupFn func(*testing.T, *memSeries, *chunks.ChunkDiskMapper) type callOutput uint8 const ( outOpenHeadChunk callOutput = iota // memSeries.chunk() call returned memSeries.headChunks with headChunk=true & isOpen=true outClosedHeadChunk // memSeries.chunk() call returned memSeries.headChunks with headChunk=true & isOpen=false outMmappedChunk // memSeries.chunk() call returned a chunk from memSeries.mmappedChunks with headChunk=false outErr // memSeries.chunk() call returned an error ) tests := []struct { name string setup setupFn // optional function called just before the test memSeries.chunk() call inputID chunks.HeadChunkID // requested chunk id for memSeries.chunk() call expected callOutput }{ { name: "call ix=0 on empty memSeries", inputID: 0, expected: outErr, }, { name: "call ix=1 on empty memSeries", inputID: 1, expected: outErr, }, { name: "firstChunkID > ix", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange, cdm) require.Empty(t, s.mmappedChunks, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, int64(0), s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, chunkRange-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") s.firstChunkID = 5 }, inputID: 1, expected: outErr, }, { name: "call ix=0 on memSeries with no mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange, cdm) require.Empty(t, s.mmappedChunks, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, int64(0), s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, chunkRange-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 0, expected: outOpenHeadChunk, }, { name: "call ix=1 on memSeries with no mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange, cdm) require.Empty(t, s.mmappedChunks, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, int64(0), s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, chunkRange-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 1, expected: outErr, }, { name: "call ix=10 on memSeries with no mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange, cdm) require.Empty(t, s.mmappedChunks, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, int64(0), s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, chunkRange-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 10, expected: outErr, }, { name: "call ix=0 on memSeries with 3 mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*4)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 0, expected: outMmappedChunk, }, { name: "call ix=1 on memSeries with 3 mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*4)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 1, expected: outMmappedChunk, }, { name: "call ix=3 on memSeries with 3 mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*4)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 3, expected: outOpenHeadChunk, }, { name: "call ix=0 on memSeries with 3 mmapped chunks and no headChunk", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*4)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") s.headChunks = nil }, inputID: 0, expected: outMmappedChunk, }, { name: "call ix=2 on memSeries with 3 mmapped chunks and no headChunk", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*4)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") s.headChunks = nil }, inputID: 2, expected: outMmappedChunk, }, { name: "call ix=3 on memSeries with 3 mmapped chunks and no headChunk", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*4)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") s.headChunks = nil }, inputID: 3, expected: outErr, }, { name: "call ix=1 on memSeries with 3 mmapped chunks and closed ChunkDiskMapper", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*4)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") cdm.Close() }, inputID: 1, expected: outErr, }, { name: "call ix=3 on memSeries with 3 mmapped chunks and closed ChunkDiskMapper", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*4)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") cdm.Close() }, inputID: 3, expected: outOpenHeadChunk, }, { name: "call ix=0 on memSeries with 3 head chunks and no mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*3, cdm) require.Empty(t, s.mmappedChunks, "wrong number of mmappedChunks") require.Equal(t, 3, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, int64(0), s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*3)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 0, expected: outClosedHeadChunk, }, { name: "call ix=1 on memSeries with 3 head chunks and no mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*3, cdm) require.Empty(t, s.mmappedChunks, "wrong number of mmappedChunks") require.Equal(t, 3, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, int64(0), s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*3)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 1, expected: outClosedHeadChunk, }, { name: "call ix=10 on memSeries with 3 head chunks and no mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*3, cdm) require.Empty(t, s.mmappedChunks, "wrong number of mmappedChunks") require.Equal(t, 3, s.headChunks.len(), "wrong number of headChunks") require.Equal(t, int64(0), s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*3)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 10, expected: outErr, }, { name: "call ix=0 on memSeries with 3 head chunks and 3 mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") appendSamples(t, s, chunkRange*4, chunkRange*6, cdm) require.Equal(t, 3, s.headChunks.len(), "wrong number of headChunks") require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*6)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 0, expected: outMmappedChunk, }, { name: "call ix=2 on memSeries with 3 head chunks and 3 mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") appendSamples(t, s, chunkRange*4, chunkRange*6, cdm) require.Equal(t, 3, s.headChunks.len(), "wrong number of headChunks") require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*6)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 2, expected: outMmappedChunk, }, { name: "call ix=3 on memSeries with 3 head chunks and 3 mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") appendSamples(t, s, chunkRange*4, chunkRange*6, cdm) require.Equal(t, 3, s.headChunks.len(), "wrong number of headChunks") require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*6)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 3, expected: outClosedHeadChunk, }, { name: "call ix=5 on memSeries with 3 head chunks and 3 mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") appendSamples(t, s, chunkRange*4, chunkRange*6, cdm) require.Equal(t, 3, s.headChunks.len(), "wrong number of headChunks") require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*6)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 5, expected: outOpenHeadChunk, }, { name: "call ix=6 on memSeries with 3 head chunks and 3 mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") appendSamples(t, s, chunkRange*4, chunkRange*6, cdm) require.Equal(t, 3, s.headChunks.len(), "wrong number of headChunks") require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*6)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 6, expected: outErr, }, { name: "call ix=10 on memSeries with 3 head chunks and 3 mmapped chunks", setup: func(t *testing.T, s *memSeries, cdm *chunks.ChunkDiskMapper) { appendSamples(t, s, 0, chunkRange*4, cdm) s.mmapChunks(cdm) require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, 1, s.headChunks.len(), "wrong number of headChunks") appendSamples(t, s, chunkRange*4, chunkRange*6, cdm) require.Equal(t, 3, s.headChunks.len(), "wrong number of headChunks") require.Len(t, s.mmappedChunks, 3, "wrong number of mmappedChunks") require.Equal(t, chunkRange*3, s.headChunks.oldest().minTime, "wrong minTime on last headChunks element") require.Equal(t, (chunkRange*6)-chunkStep, s.headChunks.maxTime, "wrong maxTime on first headChunks element") }, inputID: 10, expected: outErr, }, } memChunkPool := &sync.Pool{ New: func() interface{} { return &memChunk{} }, } for _, tc := range tests { t.Run(tc.name, func(t *testing.T) { dir := t.TempDir() chunkDiskMapper, err := chunks.NewChunkDiskMapper(nil, dir, chunkenc.NewPool(), chunks.DefaultWriteBufferSize, chunks.DefaultWriteQueueSize) require.NoError(t, err) defer func() { require.NoError(t, chunkDiskMapper.Close()) }() series := newMemSeries(labels.EmptyLabels(), 1, 0, true) if tc.setup != nil { tc.setup(t, series, chunkDiskMapper) } chk, headChunk, isOpen, err := series.chunk(tc.inputID, chunkDiskMapper, memChunkPool) switch tc.expected { case outOpenHeadChunk: require.NoError(t, err, "unexpected error") require.True(t, headChunk, "expected a chunk with headChunk=true but got headChunk=%v", headChunk) require.True(t, isOpen, "expected a chunk with isOpen=true but got isOpen=%v", isOpen) case outClosedHeadChunk: require.NoError(t, err, "unexpected error") require.True(t, headChunk, "expected a chunk with headChunk=true but got headChunk=%v", headChunk) require.False(t, isOpen, "expected a chunk with isOpen=false but got isOpen=%v", isOpen) case outMmappedChunk: require.NoError(t, err, "unexpected error") require.False(t, headChunk, "expected a chunk with headChunk=false but got gc=%v", headChunk) case outErr: require.Nil(t, chk, "got a non-nil chunk reference returned with an error") require.Error(t, err) } }) } }