-
Notifications
You must be signed in to change notification settings - Fork 18
/
environments.go
160 lines (144 loc) · 3.67 KB
/
environments.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
// Tideland Go Library - Audit
//
// Copyright (C) 2013-2017 Frank Mueller / Tideland / Oldenburg / Germany
//
// All rights reserved. Use of this source code is governed
// by the new BSD license.
package audit
//--------------------
// IMPORTS
//--------------------
import (
"crypto/rand"
"fmt"
"os"
"path/filepath"
)
//--------------------
// TEMPDIR
//--------------------
// TempDir represents a temporary directory and possible subdirectories
// for testing purposes. It simply is created with
//
// assert := audit.NewTestingAssertion(t, false)
// td := audit.NewTempDir(assert)
// defer td.Restore()
//
// tdName := td.String()
// subName:= td.Mkdir("my", "sub", "directory")
//
// The deferred Restore() removes the temporary directory with all
// contents.
type TempDir struct {
assert Assertion
dir string
}
// NewTempDir creates a new temporary directory usable for direct
// usage or further subdirectories.
func NewTempDir(assert Assertion) *TempDir {
id := make([]byte, 8)
td := &TempDir{
assert: assert,
}
for i := 0; i < 256; i++ {
_, err := rand.Read(id[:])
td.assert.Nil(err)
dir := filepath.Join(os.TempDir(), fmt.Sprintf("gots-%x", id))
if err = os.Mkdir(dir, 0700); err == nil {
td.dir = dir
break
}
if td.dir == "" {
msg := fmt.Sprintf("cannot create temporary directory %q: %v", td.dir, err)
td.assert.Fail(msg)
return nil
}
}
return td
}
// Restore deletes the temporary directory and all contents.
func (td *TempDir) Restore() {
err := os.RemoveAll(td.dir)
if err != nil {
msg := fmt.Sprintf("cannot remove temporary directory %q: %v", td.dir, err)
td.assert.Fail(msg)
}
}
// Mkdir creates a potentially nested directory inside the
// temporary directory.
func (td *TempDir) Mkdir(name ...string) string {
innerName := filepath.Join(name...)
fullName := filepath.Join(td.dir, innerName)
if err := os.MkdirAll(fullName, 0700); err != nil {
msg := fmt.Sprintf("cannot create nested temporary directory %q: %v", fullName, err)
td.assert.Fail(msg)
}
return fullName
}
// String returns the temporary directory.
func (td *TempDir) String() string {
return td.dir
}
//--------------------
// ENVVARS
//--------------------
// EnvVars allows to change and restore environment variables. The
// same variable can be set multiple times. Simply do
//
// assert := audit.NewTestingAssertion(t, false)
// ev := audit.NewEnvVars(assert)
// defer ev.Restore()
//
// ev.Set("MY_VAR", myValue)
//
// ...
//
// ev.Set("MY_VAR", anotherValue)
//
// The deferred Restore() resets to the original values.
type EnvVars struct {
assert Assertion
vars map[string]string
}
// NewEnvVars creates
func NewEnvVars(assert Assertion) *EnvVars {
ev := &EnvVars{
assert: assert,
vars: make(map[string]string),
}
return ev
}
// Restore resets all changed environment variables
func (ev *EnvVars) Restore() {
for key, value := range ev.vars {
if err := os.Setenv(key, value); err != nil {
msg := fmt.Sprintf("cannot reset environment variable %q: %v", key, err)
ev.assert.Fail(msg)
}
}
}
// Set sets an environment variable to a new value.
func (ev *EnvVars) Set(key, value string) {
v := os.Getenv(key)
_, ok := ev.vars[key]
if !ok {
ev.vars[key] = v
}
if err := os.Setenv(key, value); err != nil {
msg := fmt.Sprintf("cannot set environment variable %q: %v", key, err)
ev.assert.Fail(msg)
}
}
// Unset unsets an environment variable.
func (ev *EnvVars) Unset(key string) {
v := os.Getenv(key)
_, ok := ev.vars[key]
if !ok {
ev.vars[key] = v
}
if err := os.Unsetenv(key); err != nil {
msg := fmt.Sprintf("cannot unset environment variable %q: %v", key, err)
ev.assert.Fail(msg)
}
}
// EOF