...

Source file src/go.uber.org/zap/zaptest/testingt.go

Documentation: go.uber.org/zap/zaptest

     1  // Copyright (c) 2017 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package zaptest
    22  
    23  // TestingT is a subset of the API provided by all *testing.T and *testing.B
    24  // objects.
    25  type TestingT interface {
    26  	// Logs the given message without failing the test.
    27  	Logf(string, ...interface{})
    28  
    29  	// Logs the given message and marks the test as failed.
    30  	Errorf(string, ...interface{})
    31  
    32  	// Marks the test as failed.
    33  	Fail()
    34  
    35  	// Returns true if the test has been marked as failed.
    36  	Failed() bool
    37  
    38  	// Returns the name of the test.
    39  	Name() string
    40  
    41  	// Marks the test as failed and stops execution of that test.
    42  	FailNow()
    43  }
    44  
    45  // Note: We currently only rely on Logf. We are including Errorf and FailNow
    46  // in the interface in anticipation of future need since we can't extend the
    47  // interface without a breaking change.
    48  

View as plain text