File: safeio_test.go

package info (click to toggle)
chasquid 1.15.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,636 kB
  • sloc: sh: 1,262; python: 325; makefile: 78
file content (246 lines) | stat: -rw-r--r-- 5,650 bytes parent folder | download
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
package safeio

import (
	"bytes"
	"errors"
	"fmt"
	"os"
	"strings"
	"testing"

	"blitiri.com.ar/go/chasquid/internal/testlib"
)

func testWriteFile(fname string, data []byte, perm os.FileMode, ops ...FileOp) error {
	err := WriteFile("file1", data, perm, ops...)
	if err != nil {
		return fmt.Errorf("error writing new file: %v", err)
	}

	// Read and compare the contents.
	c, err := os.ReadFile(fname)
	if err != nil {
		return fmt.Errorf("error reading: %v", err)
	}

	if !bytes.Equal(data, c) {
		return fmt.Errorf("expected %q, got %q", data, c)
	}

	// Check permissions.
	st, err := os.Stat("file1")
	if err != nil {
		return fmt.Errorf("error in stat: %v", err)
	}
	if st.Mode() != perm {
		return fmt.Errorf("permissions mismatch, expected %#o, got %#o",
			st.Mode(), perm)
	}

	return nil
}

func TestWriteFile(t *testing.T) {
	dir := testlib.MustTempDir(t)
	defer testlib.RemoveIfOk(t, dir)

	// Write a new file.
	content := []byte("content 1")
	if err := testWriteFile("file1", content, 0660); err != nil {
		t.Error(err)
	}

	// Write an existing file.
	content = []byte("content 2")
	if err := testWriteFile("file1", content, 0660); err != nil {
		t.Error(err)
	}

	// Write again, but this time change permissions.
	content = []byte("content 3")
	if err := testWriteFile("file1", content, 0600); err != nil {
		t.Error(err)
	}
}

func TestWriteFileWithOp(t *testing.T) {
	dir := testlib.MustTempDir(t)
	defer testlib.RemoveIfOk(t, dir)

	var opFile string
	op := func(f string) error {
		opFile = f
		return nil
	}

	content := []byte("content 1")
	if err := testWriteFile("file1", content, 0660, op); err != nil {
		t.Error(err)
	}

	if opFile == "" {
		t.Error("operation was not called")
	}
	if !strings.Contains(opFile, "file1") {
		t.Errorf("operation called with suspicious file: %s", opFile)
	}
}

func TestWriteFileWithFailingOp(t *testing.T) {
	dir := testlib.MustTempDir(t)
	defer testlib.RemoveIfOk(t, dir)

	var opFile string
	opOK := func(f string) error {
		opFile = f
		return nil
	}

	opError := errors.New("operation failed")
	opFail := func(f string) error {
		return opError
	}

	content := []byte("content 1")
	err := WriteFile("file1", content, 0660, opOK, opOK, opFail)
	if err != opError {
		t.Errorf("different error, got %v, expected %v", err, opError)
	}

	if _, err := os.Stat(opFile); err == nil {
		t.Errorf("temporary file was not removed after failure (%v)", opFile)
	}
}

type testFile struct {
	t *testing.T

	name string

	expectChmod os.FileMode
	chmodErr    error

	expectChownUid, expectChownGid int
	chownErr                       error

	expectWrite []byte
	writeN      int
	writeErr    error

	closeErr error
}

func (f *testFile) Name() string {
	return f.name
}

func (f *testFile) Chmod(perm os.FileMode) error {
	if f.expectChmod != perm {
		f.t.Errorf("unexpected Chmod(%v), expected Chmod(%v)",
			perm, f.expectChmod)
	}
	return f.chmodErr
}

func (f *testFile) Chown(uid, gid int) error {
	if f.expectChownUid != uid || f.expectChownGid != gid {
		f.t.Errorf("unexpected Chown(%v, %v), expected Chown(%v, %v)",
			uid, gid, f.expectChownUid, f.expectChownGid)
	}
	return f.chownErr
}

func (f *testFile) Write(b []byte) (int, error) {
	if !bytes.Equal(b, f.expectWrite) {
		f.t.Errorf("unexpected Write(%q), expected Write(%q)",
			b, f.expectWrite)
	}
	return f.writeN, f.writeErr
}

func (f *testFile) Close() error {
	return f.closeErr
}

var _ osFile = &testFile{}

func TestErrors(t *testing.T) {
	dir := testlib.MustTempDir(t)
	defer testlib.RemoveIfOk(t, dir)

	oldCreateTemp := createTemp
	defer func() { createTemp = oldCreateTemp }()

	// createTemp failure.
	ctError := errors.New("createTemp error")
	createTemp = func(dir, pattern string) (osFile, error) {
		return nil, ctError
	}
	err := WriteFile("fname", []byte("new content"), 0660)
	if err != ctError {
		t.Errorf("expected %v, got %v", ctError, err)
	}

	// Have a real backing file for some of the operations, like getting the
	// owner.
	fname := dir + "/file1"

	// Test file to simulate failures on.
	tf := &testFile{name: fname, t: t}
	createTemp = func(dir, pattern string) (osFile, error) {
		return tf, nil
	}

	// Test Chmod error.
	testlib.Rewrite(t, fname, "old content")
	tf.expectChmod = 0660
	tf.chmodErr = errors.New("chmod error")
	err = WriteFile(fname, []byte("new content"), 0660)
	if err != tf.chmodErr {
		t.Errorf("expected %v, got %v", tf.chmodErr, err)
	}
	checkNotExists(t, fname)

	// Test Chown error.
	testlib.Rewrite(t, fname, "old content")
	tf.chmodErr = nil
	tf.expectChownUid, tf.expectChownGid = getOwner(fname)
	if tf.expectChownUid < 0 {
		t.Fatalf("error getting owner of %v", fname)
	}
	tf.chownErr = errors.New("chown error")
	err = WriteFile(fname, []byte("new content"), 0660)
	if err != tf.chownErr {
		t.Errorf("expected %v, got %v", tf.chownErr, err)
	}
	checkNotExists(t, fname)

	// Test Write error.
	testlib.Rewrite(t, fname, "old content")
	tf.chownErr = nil
	tf.expectWrite = []byte("new content")
	tf.writeErr = errors.New("write error")
	err = WriteFile(fname, []byte("new content"), 0660)
	if err != tf.writeErr {
		t.Errorf("expected %v, got %v", tf.writeErr, err)
	}
	checkNotExists(t, fname)

	// Test Close error.
	testlib.Rewrite(t, fname, "old content")
	tf.writeErr = nil
	tf.writeN = len(tf.expectWrite)
	tf.closeErr = errors.New("close error")
	err = WriteFile(fname, []byte("new content"), 0660)
	if err != tf.closeErr {
		t.Errorf("expected %v, got %v", tf.closeErr, err)
	}
	checkNotExists(t, fname)
}

func checkNotExists(t *testing.T, fname string) {
	t.Helper()
	if _, err := os.Stat(fname); err == nil {
		t.Fatalf("file %v exists", fname)
	}
}