cmd/bpa-operator/vendor/go.uber.org/zap/internal/exit/exit.go

   1 // Copyright (c) 2016 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 exit provides stubs so that unit tests can exercise code that calls
  22 // os.Exit(1).
  23 package exit
  24
  25 import "os"
  26
  27 var real = func() { os.Exit(1) }
  28
  29 // Exit normally terminates the process by calling os.Exit(1). If the package
  30 // is stubbed, it instead records a call in the testing spy.
  31 func Exit() {
  32         real()
  33 }
  34
  35 // A StubbedExit is a testing fake for os.Exit.
  36 type StubbedExit struct {
  37         Exited bool
  38         prev   func()
  39 }
  40
  41 // Stub substitutes a fake for the call to os.Exit(1).
  42 func Stub() *StubbedExit {
  43         s := &StubbedExit{prev: real}
  44         real = s.exit
  45         return s
  46 }
  47
  48 // WithStub runs the supplied function with Exit stubbed. It returns the stub
  49 // used, so that users can test whether the process would have crashed.
  50 func WithStub(f func()) *StubbedExit {
  51         s := Stub()
  52         defer s.Unstub()
  53         f()
  54         return s
  55 }
  56
  57 // Unstub restores the previous exit function.
  58 func (se *StubbedExit) Unstub() {
  59         real = se.prev
  60 }
  61
  62 func (se *StubbedExit) exit() {
  63         se.Exited = true
  64 }