File: file_store_test.go

package info (click to toggle)
golang-github-theupdateframework-go-tuf 0.5.2-5~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 7,596 kB
  • sloc: python: 163; sh: 37; makefile: 12
file content (197 lines) | stat: -rw-r--r-- 5,525 bytes parent folder | download | duplicates (2)
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
package client

import (
	"bytes"
	"io"
	"io/fs"
	"os"
	"path/filepath"
	"runtime"
	"strings"
	"testing"
)

const targetsDir = "targets"

func TestCreates(t *testing.T) {
	runningWindows := false
	if runtime.GOOS == "windows" {
		runningWindows = true
	}
	tmpDir := t.TempDir()
	defer os.RemoveAll(tmpDir)
	dir := filepath.Join(tmpDir, "repository")
	os.Mkdir(dir, os.ModePerm)
	os.Mkdir(filepath.Join(dir, "targets"), os.ModePerm)
	if !runningWindows {
		targetDirThatIsFile := filepath.Join(dir, "targets-that-isfile")
		f, err := os.Create(targetDirThatIsFile)
		if err != nil {
			t.Fatalf("failed to create file: %s: %v", targetDirThatIsFile, err)
		}
		defer f.Close()
	}
	t.Cleanup(func() { rmrf(dir, t.Logf) })
	t.Cleanup(func() { rmrf(tmpDir, t.Logf) })

	tests := []struct {
		name              string
		fsys              fs.FS
		td                string
		wantErr           string
		doNotRunOnWindows bool
	}{{
		name:    "nil, error",
		wantErr: "nil fs.FS",
	}, {
		name:    "missing targets directory",
		fsys:    os.DirFS(dir),
		td:      "targets-not-there",
		wantErr: "failed to open targets directory targets-not-there",
	}, {
		name:              "targets directory is not a file",
		fsys:              os.DirFS(dir),
		td:                "targets-that-isfile",
		wantErr:           "targets directory not a directory targets-that-isfile",
		doNotRunOnWindows: true,
	}, {
		name: "works, explicit targets",
		fsys: os.DirFS(dir),
		td:   "targets",
	}, {
		name: "works, explicit targets",
		fsys: os.DirFS(dir),
		td:   "targets",
	}}

	for _, tc := range tests {
		if tc.doNotRunOnWindows {
			t.Skip("Can't figure out how to make this work on windows")
		}
		_, err := NewFileRemoteStore(tc.fsys, tc.td)
		if tc.wantErr != "" && err == nil {
			t.Errorf("%q wanted error %s, got none", tc.name, tc.wantErr)
		} else if tc.wantErr == "" && err != nil {
			t.Errorf("%q did not want error, got: %v", tc.name, err)
		} else if err != nil && !strings.Contains(err.Error(), tc.wantErr) {
			t.Errorf("%q wanted error %s but got: %s", tc.name, tc.wantErr, err)
		}
	}
}

func TestBasicOps(t *testing.T) {
	metas := map[string][]byte{
		"root.json":     []byte("root"),
		"snapshot.json": []byte("snapshot"),
		"timestamp":     []byte("timestamp"),
	}

	fsys, dir, err := newTestFileStoreFS()
	if err != nil {
		t.Fatalf("Failed to create test FileStore")
	}
	t.Cleanup(func() { rmrf(dir, t.Logf) })
	defer os.RemoveAll(dir)

	// Add targets and metas and check them.
	for k, v := range targetFiles {
		if err := fsys.addTarget(k, v); err != nil {
			t.Errorf("failed to add target %s: %v", k, err)
		}
		rc, size, err := fsys.GetTarget(k)
		if err != nil {
			t.Errorf("failed to GetTarget %s: %v", k, err)
		}
		if size != int64(len(v)) {
			t.Errorf("unexpected size returned for GetTarget: %s want %d got %d", k, len(v), size)
		}
		got, err := io.ReadAll(rc)
		if err != nil {
			t.Errorf("failed to ReadAll returned ReacCloser %s: %v", k, err)
		}
		if !bytes.Equal(v, got) {
			t.Errorf("Read unexpected bytes, want: %s got: %s", string(k), string(got))
		}
	}
	for k, v := range metas {
		if err := fsys.addMeta(k, v); err != nil {
			t.Errorf("failed to add meta %s %v", k, err)
		}
		rc, size, err := fsys.GetMeta(k)
		if err != nil {
			t.Errorf("failed to GetMeta %s: %v", k, err)
		}
		if size != int64(len(v)) {
			t.Errorf("unexpected size returned for GetMeta: %s want %d got %d", k, len(v), size)
		}
		got, err := io.ReadAll(rc)
		if err != nil {
			t.Errorf("failed to ReadAll returned ReacCloser %s: %v", k, err)
		}
		if !bytes.Equal(v, got) {
			t.Errorf("Read unexpected bytes, want: %s got: %s", string(k), string(got))
		}
	}
}

// Test helper methods
func (f *FileRemoteStore) addMeta(name string, data []byte) error {
	return os.WriteFile(filepath.Join(f.testDir, name), data, os.ModePerm)
}

func (f *FileRemoteStore) addTarget(name string, data []byte) error {
	fname := filepath.Join(f.testDir, targetsDir, name)
	err := os.WriteFile(fname, data, os.ModePerm)
	return err
}

func (f *FileRemoteStore) deleteMeta(name string) error {
	return os.Remove(filepath.Join(f.testDir, name))
}

func (f *FileRemoteStore) deleteTarget(name string) error {
	return os.Remove(filepath.Join(f.testDir, targetsDir, name))
}

func newTestFileStoreFS() (*FileRemoteStore, string, error) {
	tmpDir := os.TempDir()
	tufDir := filepath.Join(tmpDir, "tuf-file-store-test")
	// Clean it in case there is cruft left around
	os.RemoveAll(tufDir)
	os.Mkdir(tufDir, os.ModePerm)
	os.Mkdir(filepath.Join(tufDir, targetsDir), os.ModePerm)
	fs, err := NewFileRemoteStore(os.DirFS(tufDir), targetsDir)
	fs.testDir = tufDir
	return fs, tufDir, err
}

// goes through a dir and removes everything. This is to work around:
// https://github.com/golang/go/issues/51442
func rmrf(dir string, logger func(string, ...interface{})) {
	if dir == "" {
		logger("cowardly refusing to remove a not fully specified fir")
		return
	}
	logger("Removing %s", dir)
	d, err := os.Open(dir)
	if err != nil {
		logger("Failed to open %s: %v", dir, err)
		return
	}
	defer d.Close()
	// -1 means give me everything, we don't have that many entries, so
	// fine here.
	names, err := d.Readdirnames(-1)
	if err != nil {
		logger("Failed to ReaddirNames %s: %v", dir, err)
		return
	}
	for _, name := range names {
		toRemove := filepath.Join(dir, name)
		err = os.RemoveAll(toRemove)
		if err != nil {
			logger("Failed to RemoveAll %s: %v", toRemove, err)
			// Do not want to fail here, just keep doing the best we can
		}
	}
}