go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/testing/assertions/doc.go (about)

     1  // Copyright 2015 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 assertions is designed to be a collection of `.` importable, goconvey
    16  // compatible testing assertions, in the style of
    17  // "github.com/smarty/assertions".
    18  //
    19  // Due to a bug/feature in goconvey[1], files in this package end in
    20  // `_tests.go`.
    21  //
    22  // This is a signal to goconvey's internal stack traversal logic (used to print
    23  // helpful assertion messages) that the assertions in this package should be
    24  // considered 'testing code' and not 'tested code', and so should be skipped
    25  // over when searching for the first stack frame containing the code under test.
    26  //
    27  // [1]: https://github.com/smartystreets/goconvey/pull/316
    28  package assertions