ceph-csi/internal/cephfs/errors.go

/*
Copyright 2019 The Ceph-CSI 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 cephfs

import (
	"errors"
)

// Error strings for comparison with CLI errors.
const (
	// volumeNotFound is returned when a subvolume is not found in CephFS.
	volumeNotFound = "Error ENOENT"
	// invalidCommand is returned when a command is not known to the cluster
	invalidCommand = "Error EINVAL"
	// snapNotFound is returned when snap name passed is not found in the list
	// of snapshots for the given image.
	snapNotFound = "Error ENOENT"
	// snapProtectionExist is returned when the snapshot is already protected
	snapProtectionExist = "Error EEXIST"
	// volumeNotEmpty is returned when the volume is not empty.
	volumeNotEmpty = "Error ENOTEMPTY"
)

var (
	// ErrCloneInProgress is returned when snapshot clone state is `in progress`
	ErrCloneInProgress = errors.New("in progress")

	// ErrClonePending is returned when snapshot clone state is `pending`
	ErrClonePending = errors.New("pending")

	// ErrInvalidVolID is returned when a CSI passed VolumeID is not conformant to any known volume ID
	// formats.
	ErrInvalidVolID = errors.New("invalid VolumeID")
	// ErrNonStaticVolume is returned when a volume is detected as not being
	// statically provisioned.
	ErrNonStaticVolume = errors.New("volume not static")

	// ErrSnapProtectionExist is returned when the snapshot is already protected
	ErrSnapProtectionExist = errors.New("snapshot  protection already exists")

	// ErrSnapNotFound is returned when snap name passed is not found in the list
	// of snapshots for the given image.
	ErrSnapNotFound = errors.New("snapshot not found")

	// ErrVolumeNotFound is returned when a subvolume is not found in CephFS.
	ErrVolumeNotFound = errors.New("volume not found")

	// ErrInvalidCommand is returned when a command is not known to the cluster
	ErrInvalidCommand = errors.New("invalid command")

	// ErrVolumeHasSnapshots is returned when a subvolume has snapshots.
	ErrVolumeHasSnapshots = errors.New("volume has snapshots")
)