k8s.io/perf-tests/clusterloader2@v0.0.0-20240304094227-64bdb12da87e/pkg/errors/metric_violation_error.go (about)

     1  /*
     2  Copyright 2018 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package errors
    18  
    19  type metricViolationError struct {
    20  	metric string
    21  	reason string
    22  }
    23  
    24  func (m *metricViolationError) Error() string {
    25  	return m.metric + ": " + m.reason
    26  }
    27  
    28  // NewMetricViolationError creates new metric violation error.
    29  func NewMetricViolationError(metric, reason string) error {
    30  	return &metricViolationError{
    31  		metric: metric,
    32  		reason: reason,
    33  	}
    34  }
    35  
    36  // IsMetricViolationError checks if given error is MetricViolation type.
    37  func IsMetricViolationError(err error) bool {
    38  	_, ok := err.(*metricViolationError)
    39  	return ok
    40  }