validation.go

// Copyright 2018 The Kubeflow 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 validation

import (
	"errors"
	"fmt"

	msv1 "gitee.com/mindspore/ms-operator/pkg/apis/mindspore/v1"
	"gitee.com/mindspore/ms-operator/pkg/util"
)

// ValidateMSJobSpec checks that the MSJobSpec is valid.
func ValidateMSJobSpec(c *msv1.MSJobSpec) error {
	if c.TerminationPolicy == nil || c.TerminationPolicy.Master == nil {
		return fmt.Errorf("invalid termination policy: %v", c.TerminationPolicy)
	}

	masterExists := false

	// Check that each replica has a MS container and a master.
	for _, r := range c.ReplicaSpecs {
		found := false
		if r.Template == nil {
			return fmt.Errorf("Replica is missing Template; %v", util.Pformat(r))
		}

		if r.MSReplicaType == msv1.MSReplicaType(c.TerminationPolicy.Master.ReplicaName) {
			masterExists = true
		}

		if r.MasterPort == nil {
			return errors.New("MSReplicaSpec.MasterPort can't be nil.")
		}

		// Make sure the replica type is valid.
		validReplicaTypes := []msv1.MSReplicaType{msv1.MASTER, msv1.WORKER}

		isValidReplicaType := false
		for _, t := range validReplicaTypes {
			if t == r.MSReplicaType {
				isValidReplicaType = true
				break
			}
		}

		if !isValidReplicaType {
			return fmt.Errorf("msReplicaSpec.MSReplicaType is %v but must be one of %v", r.MSReplicaType, validReplicaTypes)
		}

		for _, c := range r.Template.Spec.Containers {
			if c.Name == msv1.DefaultMSContainer {
				found = true
				break
			}
		}
		if !found {
			return fmt.Errorf("Replica type %v is missing a container named %s", r.MSReplicaType, msv1.DefaultMSContainer)
		}
	}

	if !masterExists {
		return fmt.Errorf("Missing ReplicaSpec for master: %v", c.TerminationPolicy.Master.ReplicaName)
	}

	return nil
}