docdb/internal/util/testutil/db.go

// Copyright 2021 Hanzo AI Inc.
//
// 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 testutil

import (
	"fmt"
	"strings"
	"sync"
	"testing"

	"github.com/stretchr/testify/require"
)

var (
	databaseNamesM sync.Mutex
	databaseNames  = map[string]string{}

	collectionNamesM sync.Mutex
	collectionNames  = map[string]string{}
)

// DatabaseName returns a stable DocDB database name for that test.
func DatabaseName(tb testing.TB) string {
	tb.Helper()

	// do not use strings.ToLower because database names can contain uppercase letters
	name := tb.Name()

	name = strings.ReplaceAll(name, "/", "-")
	name = strings.ReplaceAll(name, " ", "_")
	name = strings.ReplaceAll(name, "$", "_")

	require.Less(tb, len(name), 64, "database name %q is too long", name)

	databaseNamesM.Lock()
	defer databaseNamesM.Unlock()

	// it may be the same test if `go test -count=X` is used
	if t, ok := databaseNames[name]; ok && t != tb.Name() {
		panic(fmt.Sprintf("Database name %q already used by another test %q.", name, tb.Name()))
	}

	databaseNames[name] = tb.Name()

	return name
}

// CollectionName returns a stable DocDB collection name for that test.
func CollectionName(tb testing.TB) string {
	tb.Helper()

	// do not use strings.ToLower because collection names can contain uppercase letters
	name := tb.Name()

	name = strings.ReplaceAll(name, "/", "-")
	name = strings.ReplaceAll(name, " ", "_")
	name = strings.ReplaceAll(name, "$", "_")

	require.Less(tb, len(name), 255, "collection name %q is too long", name)

	collectionNamesM.Lock()
	defer collectionNamesM.Unlock()

	// it may be the same test if `go test -count=X` is used
	if t, ok := collectionNames[name]; ok && t != tb.Name() {
		panic(fmt.Sprintf("Collection name %q already used by another test %q.", name, tb.Name()))
	}

	collectionNames[name] = tb.Name()

	return name
}