cephmount

func ContextWithTestLogger ¶

func ContextWithTestLogger(t *testing.T) context.Context

ContextWithTestLogger creates a context with a configured logger for testing. The log level can be controlled with CEPHMOUNT_TEST_LOG_LEVEL environment variable. Valid values: debug, info, warn, error, fatal, panic, disabled Default: error (quiet tests - only errors and above are shown)

Usage:

ctx := ContextWithTestLogger(t)
fs, err := newCephAdminConn(ctx, config)

To see verbose logs during testing:

CEPHMOUNT_TEST_LOG_LEVEL=debug go test -tags ceph -v ./pkg/storage/fs/cephmount/

func CreateCephMountFSForIntegration ¶

func CreateCephMountFSForIntegration(t *testing.T, ctx context.Context, config map[string]any) *cephmountfs

CreateCephMountFSForIntegration creates an cephmountfs instance for integration tests. Integration tests use the real fstab entry from CEPHMOUNT_FSTAB_ENTRY environment variable.

func CreateCephMountFSForTesting ¶

func CreateCephMountFSForTesting(t *testing.T, ctx context.Context, config map[string]any, cephVolumePath string, localMountPoint string) *cephmountfs

CreateCephMountFSForTesting creates an cephmountfs instance for unit tests. Unit tests use synthetic configuration and temporary directories. The CEPHMOUNT_FSTAB_ENTRY environment variable is ignored for unit tests.

func GetCephConfig ¶

func GetCephConfig() map[string]any

GetCephConfig returns the Ceph configuration to use for tests. It only uses the CEPHMOUNT_FSTAB_ENTRY environment variable now.

Environment variables:

• CEPHMOUNT_FSTAB_ENTRY: Complete fstab entry (required for integration tests)
• CEPHMOUNT_TEST_CHROOT_DIR: Override chroot directory for testing (optional)

Usage:

export CEPHMOUNT_FSTAB_ENTRY="cephfs.cephfs /mnt/cephfs ceph defaults,name=admin,secretfile=/etc/ceph/ceph.client.admin.keyring,conf=/etc/ceph/ceph.conf 0 2"
go test -tags ceph -ceph-integration -v

func GetCurrentTestUser ¶

func GetCurrentTestUser(t *testing.T) *userv1beta1.User

GetCurrentTestUser returns the current user information for use in tests

func GetTestDir ¶

func GetTestDir(t *testing.T, prefix string) (string, func())

GetTestDir returns a directory for testing. It checks for the CEPHMOUNT_TEST_DIR environment variable. If set, it creates a subdirectory within that path. If not set, it falls back to creating a temporary directory.

The returned cleanup function should be called to remove the test directory unless CEPHMOUNT_TEST_DIR is set and CEPHMOUNT_TEST_PRESERVE is also set to "true".

Usage:

testDir, cleanup := GetTestDir(t, "test-prefix")
defer cleanup()

Environment variables:

CEPHMOUNT_TEST_DIR: Base directory for tests (e.g., "/mnt/ceph/test")
CEPHMOUNT_TEST_PRESERVE: If "true", preserves test directories when CEPHMOUNT_TEST_DIR is set

func GetTestSubDir ¶

func GetTestSubDir(t *testing.T, baseDir, subDirName string) string

GetTestSubDir creates a subdirectory within an existing test directory. This is useful when you need multiple directories for a single test.

func New ¶

func New(ctx context.Context, m map[string]any) (storage.FS, error)

New returns an implementation of the storage.FS interface that talks to the local filesystem using os.Root operations instead of libcephfs.

func NewForTesting ¶

func NewForTesting(t *testing.T, ctx context.Context, config map[string]any, cephVolumePath string, localMountPoint string) *cephmountfs

func NewUserThreadPool ¶

func NewUserThreadPool(config UserThreadPoolConfig) (*UserThreadPool, *PrivilegeVerificationResult, error)

NewUserThreadPool creates a new thread pool for managing per-user threads

func RequireCephIntegration ¶

func RequireCephIntegration(t *testing.T)

RequireCephIntegration checks if Ceph integration configuration is valid and Ceph is accessible. Integration tests run automatically when the ceph build tag is used and CEPHMOUNT_FSTAB_ENTRY is set. If CEPHMOUNT_FSTAB_ENTRY is not set or Ceph is not accessible, the test is skipped.

Usage:

func TestCephFeature(t *testing.T) {
    RequireCephIntegration(t)
    // ... rest of test
}

Run with: go test -tags ceph -v (requires CEPHMOUNT_FSTAB_ENTRY to be set and Ceph accessible)

func SetupTestDir ¶

func SetupTestDir(t *testing.T, prefix string, uid, gid int) (string, func())

SetupTestDir is a convenience function that calls GetTestDir and sets up appropriate permissions for the returned directory. It also handles the common pattern of changing ownership to allow test users to write.

The uid and gid parameters specify the desired ownership. If uid is 0, no ownership change is attempted.

func ValidateCephConfig ¶

func ValidateCephConfig(t *testing.T) bool

ValidateCephConfig checks if the required Ceph configuration is available. It returns true if configuration appears to be valid, false otherwise.