github.com/KinWaiYuen/client-go/v2@v2.5.4/util/failpoint.go (about)

     1  // Copyright 2021 TiKV 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  // NOTE: The code in this file is based on code from the
    16  // TiDB project, licensed under the Apache License v 2.0
    17  //
    18  // https://github.com/pingcap/tidb/tree/cc5e161ac06827589c4966674597c137cc9e809c/store/tikv/util/failpoint.go
    19  //
    20  
    21  // Copyright 2021 PingCAP, Inc.
    22  //
    23  // Licensed under the Apache License, Version 2.0 (the "License");
    24  // you may not use this file except in compliance with the License.
    25  // You may obtain a copy of the License at
    26  //
    27  //     http://www.apache.org/licenses/LICENSE-2.0
    28  //
    29  // Unless required by applicable law or agreed to in writing, software
    30  // distributed under the License is distributed on an "AS IS" BASIS,
    31  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    32  // See the License for the specific language governing permissions and
    33  // limitations under the License.
    34  
    35  package util
    36  
    37  import (
    38  	"errors"
    39  
    40  	"github.com/pingcap/failpoint"
    41  )
    42  
    43  const failpointPrefix = "tikvclient/"
    44  
    45  var (
    46  	failpointsEnabled bool
    47  	errDisabled       = errors.New("failpoints are disabled")
    48  )
    49  
    50  // EnableFailpoints enables use of failpoints.
    51  // It should be called before using client to avoid data race.
    52  func EnableFailpoints() {
    53  	failpointsEnabled = true
    54  }
    55  
    56  // EvalFailpoint injects code for testing. It is used to replace `failpoint.Inject`
    57  // to make it possible to be used in a library.
    58  func EvalFailpoint(name string) (interface{}, error) {
    59  	if !failpointsEnabled {
    60  		return nil, errDisabled
    61  	}
    62  	return failpoint.Eval(failpointPrefix + name)
    63  }