Documentation

Overview

    Package env provides functions to test code that read environment variables or the current working directory.

    Index

    Examples

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func ChangeWorkingDir

    func ChangeWorkingDir(t assert.TestingT, dir string) func()

      ChangeWorkingDir to the directory, and return a function which restores the previous working directory.

      When used with Go 1.14+ the previous working directory will be restored automatically when the test ends, unless the TEST_NOCLEANUP env var is set to true.

      func Patch

      func Patch(t assert.TestingT, key, value string) func()

        Patch changes the value of an environment variable, and returns a function which will reset the the value of that variable back to the previous state.

        When used with Go 1.14+ the unpatch function will be called automatically when the test ends, unless the TEST_NOCLEANUP env var is set to true.

        Example

          Patch an environment variable and defer to return to the previous state

          Output:
          
          

          func PatchAll

          func PatchAll(t assert.TestingT, env map[string]string) func()

            PatchAll sets the environment to env, and returns a function which will reset the environment back to the previous state.

            When used with Go 1.14+ the unpatch function will be called automatically when the test ends, unless the TEST_NOCLEANUP env var is set to true.

            Example

              Patch all environment variables

              Output:
              
              

              func ToMap

              func ToMap(env []string) map[string]string

                ToMap takes a list of strings in the format returned by os.Environ() and returns a mapping of keys to values.

                Types

                This section is empty.

                Source Files