go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/buildbucket/protoutil/step.go (about)

     1  // Copyright 2020 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package protoutil
    16  
    17  import (
    18  	"strings"
    19  
    20  	"go.chromium.org/luci/common/errors"
    21  )
    22  
    23  // StepNameSep is the separator between each node in step names.
    24  const StepNameSep = "|"
    25  
    26  // ParentStepName returns the name of the parent step.
    27  //
    28  // If stepName is empty or doesn't have a parent, an empty string is returned.
    29  func ParentStepName(stepName string) string {
    30  	i := strings.LastIndex(stepName, StepNameSep)
    31  	if i == -1 {
    32  		return ""
    33  	}
    34  	return stepName[:i]
    35  }
    36  
    37  // ValidateStepName validates a given step name.
    38  func ValidateStepName(stepName string) error {
    39  	if stepName == "" {
    40  		return errors.New("required")
    41  	}
    42  
    43  	nodes := strings.Split(stepName, StepNameSep)
    44  	for _, node := range nodes {
    45  		if node == "" {
    46  			return errors.Reason("there must be at least one character before and after %q (%q)",
    47  				StepNameSep, stepName).Err()
    48  		}
    49  	}
    50  	return nil
    51  }