graphnode.go

package gaia

import (
	"fmt"
	"time"

	"github.com/mitchellh/copystructure"
	"go.aporeto.io/elemental"
)

// GraphNodeTypeValue represents the possible values for attribute "type".
type GraphNodeTypeValue string

const (
	// GraphNodeTypeClaim represents the value Claim.
	GraphNodeTypeClaim GraphNodeTypeValue = "Claim"

	// GraphNodeTypeDocker represents the value Docker.
	GraphNodeTypeDocker GraphNodeTypeValue = "Docker"

	// GraphNodeTypeExternalNetwork represents the value ExternalNetwork.
	GraphNodeTypeExternalNetwork GraphNodeTypeValue = "ExternalNetwork"

	// GraphNodeTypeNode represents the value Node.
	GraphNodeTypeNode GraphNodeTypeValue = "Node"

	// GraphNodeTypeVolume represents the value Volume.
	GraphNodeTypeVolume GraphNodeTypeValue = "Volume"
)

// GraphNode represents the model of a graphnode
type GraphNode struct {
	// Identifier of object represented by the node.
	ID string `json:"ID" msgpack:"ID" bson:"-" mapstructure:"ID,omitempty"`

	// Enforcement status of processing unit represented by the node.
	EnforcementStatus string `json:"enforcementStatus" msgpack:"enforcementStatus" bson:"-" mapstructure:"enforcementStatus,omitempty"`

	// ID of the group the node is eventually part of.
	GroupID string `json:"groupID" msgpack:"groupID" bson:"-" mapstructure:"groupID,omitempty"`

	// List of images.
	Images []string `json:"images" msgpack:"images" bson:"-" mapstructure:"images,omitempty"`

	// Last update of the node.
	LastUpdate time.Time `json:"lastUpdate" msgpack:"lastUpdate" bson:"-" mapstructure:"lastUpdate,omitempty"`

	// Name of object represented by the node.
	Name string `json:"name" msgpack:"name" bson:"-" mapstructure:"name,omitempty"`

	// Namespace of object represented by the node.
	Namespace string `json:"namespace" msgpack:"namespace" bson:"-" mapstructure:"namespace,omitempty"`

	// Status of object represented by the node.
	Status string `json:"status" msgpack:"status" bson:"-" mapstructure:"status,omitempty"`

	// Tags of object represented by the node.
	Tags []string `json:"-" msgpack:"-" bson:"-" mapstructure:"-,omitempty"`

	// Type of object represented by the node.
	Type GraphNodeTypeValue `json:"type" msgpack:"type" bson:"-" mapstructure:"type,omitempty"`

	// If `true` the node is marked as unreachable.
	Unreachable bool `json:"unreachable" msgpack:"unreachable" bson:"-" mapstructure:"unreachable,omitempty"`

	// Tags of object represented by the node.
	VulnerabilityLevel string `json:"vulnerabilityLevel" msgpack:"vulnerabilityLevel" bson:"-" mapstructure:"vulnerabilityLevel,omitempty"`

	ModelVersion int `json:"-" msgpack:"-" bson:"_modelversion"`
}

// NewGraphNode returns a new *GraphNode
func NewGraphNode() *GraphNode {

	return &GraphNode{
		ModelVersion: 1,
		Images:       []string{},
		Tags:         []string{},
	}
}

// BleveType implements the bleve.Classifier Interface.
func (o *GraphNode) BleveType() string {

	return "graphnode"
}

// DeepCopy returns a deep copy if the GraphNode.
func (o *GraphNode) DeepCopy() *GraphNode {

	if o == nil {
		return nil
	}

	out := &GraphNode{}
	o.DeepCopyInto(out)

	return out
}

// DeepCopyInto copies the receiver into the given *GraphNode.
func (o *GraphNode) DeepCopyInto(out *GraphNode) {

	target, err := copystructure.Copy(o)
	if err != nil {
		panic(fmt.Sprintf("Unable to deepcopy GraphNode: %s", err))
	}

	*out = *target.(*GraphNode)
}

// Validate valides the current information stored into the structure.
func (o *GraphNode) Validate() error {

	errors := elemental.Errors{}
	requiredErrors := elemental.Errors{}

	if err := elemental.ValidateStringInList("type", string(o.Type), []string{"Docker", "ExternalNetwork", "Volume", "Claim", "Node"}, false); err != nil {
		errors = errors.Append(err)
	}

	if len(requiredErrors) > 0 {
		return requiredErrors
	}

	if len(errors) > 0 {
		return errors
	}

	return nil
}