summaryrefslogtreecommitdiff
path: root/tests/shared_test.go
blob: 2e945ae10681a4f19e19dff3d7bfa4c8a21bda7c (plain)
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
// SPDX-FileCopyrightText: 2018 Stefan Majewsky <majewsky@gmx.net>
// SPDX-License-Identifier: Apache-2.0

package tests

import (
	"crypto/md5" //nolint:gosec // Etag uses md5
	"crypto/rand"
	"encoding/hex"
	"math"
	"os"
	"testing"

	"github.com/gophercloud/gophercloud/v2"
	"github.com/gophercloud/gophercloud/v2/openstack"
	"github.com/gophercloud/gophercloud/v2/openstack/objectstorage/v1/swauth"
	"github.com/gophercloud/utils/v2/openstack/clientconfig"

	"go.xyrillian.de/schwift/v2"
	"go.xyrillian.de/schwift/v2/gopherschwift"
)

func testWithAccount(t *testing.T, testCode func(a *schwift.Account)) {
	stAuth := os.Getenv("ST_AUTH")
	stUser := os.Getenv("ST_USER")
	stKey := os.Getenv("ST_KEY")
	var client *gophercloud.ServiceClient

	if stAuth == "" && stUser == "" && stKey == "" {
		// option 1: Keystone authentication
		provider, err := clientconfig.AuthenticatedClient(t.Context(), nil)
		if err != nil {
			t.Error("clientconfig.AuthenticatedClient returned: " + err.Error())
			t.Error("probably missing Swift credentials (need either ST_AUTH, ST_USER, ST_KEY or OS_* variables)")
			return
		}
		client, err = openstack.NewObjectStorageV1(provider, gophercloud.EndpointOpts{})
		if err != nil {
			t.Error("openstack.NewObjectStorageV1 returned: " + err.Error())
			return
		}
	} else {
		// option 2: Swift authentication v1
		provider, err := openstack.NewClient(stAuth)
		if err != nil {
			t.Error("openstack.NewClient returned: " + err.Error())
			return
		}
		client, err = swauth.NewObjectStorageV1(t.Context(), provider, swauth.AuthOpts{User: stUser, Key: stKey})
		if err != nil {
			t.Error("swauth.NewObjectStorageV1 returned: " + err.Error())
			return
		}
	}

	account, err := gopherschwift.Wrap(client, nil)
	if err != nil {
		t.Error(err.Error())
		return
	}
	account, err = schwift.InitializeAccount(
		&RequestCountingBackend{Inner: account.Backend()},
	)
	if err != nil {
		t.Error(err.Error())
		return
	}
	testCode(account)
}

func testWithContainer(t *testing.T, testCode func(c *schwift.Container)) {
	testWithAccount(t, func(a *schwift.Account) {
		containerName := getRandomName()
		container, err := a.Container(containerName).EnsureExists(t.Context())
		expectSuccess(t, err)

		testCode(container)

		// cleanup
		exists, err := container.Exists(t.Context())
		expectSuccess(t, err)
		if exists {
			expectSuccess(t, container.Objects().Foreach(t.Context(), func(o *schwift.Object) error {
				return o.Delete(t.Context(), nil, nil)
			}))
			err = container.Delete(t.Context(), nil)
			expectSuccess(t, err)
		}
	})
}

////////////////////////////////////////////////////////////////////////////////

func etagOf(buf []byte) string {
	hash := md5.Sum(buf) //nolint:gosec // Etag uses md5
	return hex.EncodeToString(hash[:])
}

func etagOfString(buf string) string {
	return etagOf([]byte(buf))
}

func getRandomName() string {
	var buf [16]byte
	_, err := rand.Read(buf[:])
	if err != nil {
		panic(err.Error())
	}
	return hex.EncodeToString(buf[:])
}

func getRandomSegmentContent(length int) string { //nolint:unparam
	buf := make([]byte, length/2)
	_, err := rand.Read(buf)
	if err != nil {
		panic(err.Error())
	}
	return hex.EncodeToString(buf)
}

////////////////////////////////////////////////////////////////////////////////

func expectBool(t *testing.T, actual, expected bool) {
	t.Helper()
	if actual != expected {
		t.Errorf("expected value %#v, got %#v instead\n", expected, actual)
	}
}

func expectFloat64(t *testing.T, actual, expected float64) {
	t.Helper()
	if math.Abs((actual-expected)/expected) > 1e-8 {
		t.Errorf("expected value %g, got %g instead\n", expected, actual)
	}
}

func expectInt(t *testing.T, actual, expected int) {
	t.Helper()
	if actual != expected {
		t.Errorf("expected value %d, got %d instead\n", expected, actual)
	}
}

func expectInt64(t *testing.T, actual, expected int64) {
	t.Helper()
	if actual != expected {
		t.Errorf("expected value %d, got %d instead\n", expected, actual)
	}
}

func expectUint64(t *testing.T, actual, expected uint64) {
	t.Helper()
	if actual != expected {
		t.Errorf("expected value %d, got %d instead\n", expected, actual)
	}
}

func expectString(t *testing.T, actual, expected string) {
	t.Helper()
	if actual != expected {
		t.Errorf("expected value %q, got %q instead\n", expected, actual)
	}
}

func expectError(t *testing.T, actual error, expected string) {
	t.Helper()
	if actual == nil {
		t.Errorf("expected error %q, got no error\n", expected)
	} else if expected != actual.Error() {
		t.Errorf("expected error %q, got %q instead\n", expected, actual.Error())
	}
}

func expectSuccess(t *testing.T, actual error) (ok bool) {
	t.Helper()
	if actual != nil {
		t.Errorf("expected success, got error %q instead\n", actual.Error())
		return false
	}
	return true
}

func expectHeaders(t *testing.T, actual, expected map[string]string) {
	t.Helper()
	reported := make(map[string]bool)

	for k, av := range actual {
		ev, exists := expected[k]
		if !exists {
			ev = "<not set>"
		}
		if av != ev {
			t.Errorf(`expected "%s: %s", got "%s: %s" instead`, k, ev, k, av)
			reported[k] = true
		}
	}

	for k, ev := range expected {
		av, exists := actual[k]
		if !exists {
			av = "<not set>"
		}
		if av != ev && !reported[k] {
			t.Errorf(`expected "%s: %s", got "%s: %s" instead`, k, ev, k, av)
		}
	}
}