states.go

// Copyright 2018 Bull S.A.S. Atos Technologies - Bull, Rue Jean Jaures, B.P.68, 78340, Les Clayes-sous-Bois, France.
//
// 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 tosca

import (
	"fmt"
	"strings"

	"github.com/pkg/errors"
)

type customNodeStateError struct {
	state string
}

func (cnse customNodeStateError) Error() string {
	return fmt.Sprintf("State %q is not TOSCA normative", cnse.state)
}

// IsCustomNodeStateError checks if the given error is due to a conversion of an non-normative state and if so returns this state as string
func IsCustomNodeStateError(err error) (bool, string) {
	if cnse, ok := errors.Cause(err).(customNodeStateError); ok {
		return true, cnse.state
	}
	return false, ""
}

// NodeState represent the state of a node instance this part is normative
//
// We added a non-normative special step "deleted" in order to track deleted instances
type NodeState int

const (
	// NodeStateInitial is a non-transitional state indicating that the node is not yet created.  Node only exists as a template definition.
	NodeStateInitial NodeState = iota
	// NodeStateCreating is a transitional state indicating that the Node is transitioning from initial state to created state.
	NodeStateCreating
	// NodeStateCreated is a non-transitional state indicating that Node software has been installed.
	NodeStateCreated
	// NodeStateConfiguring is a transitional state indicating that Node is transitioning from created state to configured state.
	NodeStateConfiguring
	// NodeStateConfigured is a non-transitional state indicating that Node has been configured prior to being started.
	NodeStateConfigured
	// NodeStateStarting is a transitional state indicating that Node is transitioning from configured state to started state.
	NodeStateStarting
	// NodeStateStarted is a non-transitional state indicating that Node is started.
	NodeStateStarted
	// NodeStateStopping is a transitional state indicating that Node is transitioning from its current state to a configured state.
	NodeStateStopping
	// NodeStateDeleting is a transitional state indicating that Node is transitioning from its current state to one where it is deleted.
	//
	// We diverge here from the specification that states "and its state is no longer tracked by the instance model".
	NodeStateDeleting
	// NodeStateError is a non-transitional state indicating that the Node is in an error state.
	NodeStateError
	// NodeStateDeleted is a non-transitional state indicating that the Node is deleted.
	NodeStateDeleted
)

const _NodeState_name = "initialcreatingcreatedconfiguringconfiguredstartingstartedstoppingdeletingerrordeleted"

var _NodeState_index = [...]uint8{0, 7, 15, 22, 33, 43, 51, 58, 66, 74, 79, 86}

func (i NodeState) String() string {
	if i < 0 || i >= NodeState(len(_NodeState_index)-1) {
		return fmt.Sprintf("State(%d)", i)
	}
	return _NodeState_name[_NodeState_index[i]:_NodeState_index[i+1]]
}

var _NodeStateNameToValue_map = map[string]NodeState{
	_NodeState_name[0:7]:   0,
	_NodeState_name[7:15]:  1,
	_NodeState_name[15:22]: 2,
	_NodeState_name[22:33]: 3,
	_NodeState_name[33:43]: 4,
	_NodeState_name[43:51]: 5,
	_NodeState_name[51:58]: 6,
	_NodeState_name[58:66]: 7,
	_NodeState_name[66:74]: 8,
	_NodeState_name[74:79]: 9,
	_NodeState_name[79:86]: 10,
}

// NodeStateString returns the NodeState corresponding to the given string representation.
//
// The given string is lowercased before checking it against node states representations.
func NodeStateString(s string) (NodeState, error) {
	s = strings.ToLower(s)
	if val, ok := _NodeStateNameToValue_map[s]; ok {
		return val, nil
	}
	return 0, errors.WithStack(customNodeStateError{s})
}