...

Source file src/k8s.io/kubernetes/test/utils/ktesting/doc.go

Documentation: k8s.io/kubernetes/test/utils/ktesting

     1  /*
     2  Copyright 2023 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 ktesting is a wrapper around k8s.io/klog/v2/ktesting. In contrast
    18  // to the klog package, this one is opinionated and tailored towards testing
    19  // Kubernetes.
    20  //
    21  // Importing it
    22  // - adds the -v command line flag
    23  // - enables better dumping of complex datatypes
    24  // - sets the default verbosity to 5 (can be changed with [SetDefaultVerbosity])
    25  //
    26  // It also adds additional APIs and types for unit and integration tests
    27  // which are too experimental for klog and/or are unrelated to logging.
    28  // The ktesting package itself takes care of managing a test context
    29  // with deadlines, timeouts, cancellation, and some common attributes
    30  // as first-class members of the API. Sub-packages have additional APIs
    31  // for propagating values via the context, implemented via [WithValue].
    32  package ktesting
    33  

View as plain text