env

package
Version: v3.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 27, 2020 License: Apache-2.0 Imports: 4 Imported by: 1

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

defer Patch(t, "PATH", "/custom/path")()
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

defer PatchAll(t, map[string]string{
	"ONE": "FOO",
	"TWO": "BAR",
})()
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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto