add CBT bitmap implementation

Signed-off-by: Lyndon-Li <lyonghui@vmware.com>

Author: Lyndon-Li

pkg/uploader/cbt/bitmap.go

@@ -20,49 +20,9 @@ import (
 	"math/bits"
 
 	"github.com/RoaringBitmap/roaring"
-)
-
-// Bitmap defines the methods to store and iterate the CBT bitmap
-type Bitmap interface {
-	// Set sets bits within the provided range
-	Set(uint64, uint64)
-
-	// SetFull sets all bits to the bitmap
-	SetFull()
-
-	// Snapshot returns snapshot of the bitmap
-	Snapshot() string
-
-	// ChangeID returns the changeID of the bitmap
-	ChangeID() string
-
-	// VolumeID return ID of the volume from which the snapshot is taken
-	VolumeID() string
-
-	// Iterator returns the iterator for the CBT Bitmap
-	Iterator() Iterator
-}
 
-// Iterator defines the methods to iterate the CBT bitmap and query the associated information
-type Iterator interface {
-	// ChangeID returns the changeID of the bitmap
-	ChangeID() string
-
-	// Snapshot returns snapshot of the bitmap
-	Snapshot() string
-
-	// VolumeID return ID of the volume from which the snapshot is taken
-	VolumeID() string
-
-	// BlockSize returns the granularity of the bitmap
-	BlockSize() uint
-
-	// Count returns the toal number of count in the bitmap
-	Count() uint64
-
-	// Next returns the offset of the next set block and whether it comes to the end of the iteration
-	Next() (uint64, bool)
-}
+	"github.com/vmware-tanzu/velero/pkg/uploader/cbt/types"
+)
 
 const (
 	InvalidOffset64 = ^uint64(0)
@@ -83,7 +43,7 @@ type bitmapIterator struct {
 	iterator roaring.IntPeekable
 }
 
-func NewBitmap(blockSize uint, length uint64, snapshot string, changeID string, volumeID string) Bitmap {
+func NewBitmap(blockSize uint, length uint64, snapshot string, changeID string, volumeID string) types.Bitmap {
 	return &bitmapImpl{
 		bitmap:       roaring.New(),
 		blockSize:    blockSize,
@@ -105,14 +65,14 @@ func (c *bitmapImpl) Set(offset, length uint64) {
 	}
 
 	start := offset >> c.blockSizeLog
-	end := uint64((offset + length + uint64(c.blockSize) - 1) >> c.blockSizeLog)
+	end := (offset + length + uint64(c.blockSize) - 1) >> c.blockSizeLog
 
 	c.bitmap.AddRange(start, end)
 }
 
 func (c *bitmapImpl) SetFull() {
 	start := uint64(0)
-	end := uint64((c.length + uint64(c.blockSize) - 1) >> c.blockSizeLog)
+	end := (c.length + uint64(c.blockSize) - 1) >> c.blockSizeLog
 
 	c.bitmap.AddRange(start, end)
 }
@@ -129,7 +89,7 @@ func (c *bitmapImpl) VolumeID() string {
 	return c.volumeID
 }
 
-func (c *bitmapImpl) Iterator() Iterator {
+func (c *bitmapImpl) Iterator() types.Iterator {
 	if c.bitmap == nil {
 		return nil
 	}

pkg/uploader/cbt/set.go

@@ -22,10 +22,11 @@ import (
 	"github.com/pkg/errors"
 
 	"github.com/vmware-tanzu/velero/pkg/cbtservice"
+	"github.com/vmware-tanzu/velero/pkg/uploader/cbt/types"
 )
 
 // SetBitmapOrFull translates the allocated/changed blocks from CBT service to the given bitmap or set the bitmap to full when error happens
-func SetBitmapOrFull(ctx context.Context, service cbtservice.Service, bitmap Bitmap) (err error) {
+func SetBitmapOrFull(ctx context.Context, service cbtservice.Service, bitmap types.Bitmap) (err error) {
 	defer func() {
 		if err != nil {
 			bitmap.SetFull()

pkg/uploader/cbt/set_test.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package cbt_test
+package cbt
 
 import (
 	"context"
@@ -27,8 +27,7 @@ import (
 
 	"github.com/vmware-tanzu/velero/pkg/cbtservice"
 	cbtservicemocks "github.com/vmware-tanzu/velero/pkg/cbtservice/mocks"
-	"github.com/vmware-tanzu/velero/pkg/uploader/cbt"
-	cbtmocks "github.com/vmware-tanzu/velero/pkg/uploader/cbt/mocks"
+	cbtmocks "github.com/vmware-tanzu/velero/pkg/uploader/cbt/types/mocks"
 )
 
 func TestSetBitmapOrFull(t *testing.T) {
@@ -126,13 +125,7 @@ func TestSetBitmapOrFull(t *testing.T) {
 				svc = svcMock
 			}
 
-			// Use type assertion to bypass gopls false positive on mock type
-			var bmp cbt.Bitmap
-			if bmpMock != nil {
-				bmp = interface{}(bmpMock).(cbt.Bitmap)
-			}
-
-			err := cbt.SetBitmapOrFull(context.Background(), svc, bmp)
+			err := SetBitmapOrFull(context.Background(), svc, bmpMock)
 
 			if tt.expectedErrStr != "" {
 				require.Error(t, err)

pkg/uploader/cbt/mocks/Bitmap.go pkg/uploader/cbt/types/mocks/Bitmap.gopkg/uploader/cbt/mocks/Bitmap.go renamed to pkg/uploader/cbt/types/mocks/Bitmap.go

@@ -0,0 +1,59 @@
+/*
+Copyright The Velero Contributors.
+
+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 types
+
+// Bitmap defines the methods to store and iterate the CBT bitmap
+type Bitmap interface {
+	// Set sets bits within the provided range
+	Set(uint64, uint64)
+
+	// SetFull sets all bits to the bitmap
+	SetFull()
+
+	// Snapshot returns snapshot of the bitmap
+	Snapshot() string
+
+	// ChangeID returns the changeID of the bitmap
+	ChangeID() string
+
+	// VolumeID return ID of the volume from which the snapshot is taken
+	VolumeID() string
+
+	// Iterator returns the iterator for the CBT Bitmap
+	Iterator() Iterator
+}
+
+// Iterator defines the methods to iterate the CBT bitmap and query the associated information
+type Iterator interface {
+	// ChangeID returns the changeID of the bitmap
+	ChangeID() string
+
+	// Snapshot returns snapshot of the bitmap
+	Snapshot() string
+
+	// VolumeID return ID of the volume from which the snapshot is taken
+	VolumeID() string
+
+	// BlockSize returns the granularity of the bitmap
+	BlockSize() uint
+
+	// Count returns the toal number of count in the bitmap
+	Count() uint64
+
+	// Next returns the offset of the next set block and whether it comes to the end of the iteration
+	Next() (uint64, bool)
+}