Repository navigation
Expand file tree
/
Copy pathservice_restore_integration_test.go
More file actions
570 lines (501 loc) · 17.1 KB
/
Copy pathservice_restore_integration_test.go
File metadata and controls
570 lines (501 loc) · 17.1 KB
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
package fbx_test
import (
"bytes"
"context"
"fmt"
"os"
"path/filepath"
"strings"
"testing"
"time"
"github.com/firebirdsql/fbx"
"github.com/firebirdsql/fbx/fbservice"
"github.com/stretchr/testify/require"
)
type restoreIntegrationCapabilities struct {
ignoreBLRErrors bool
includeData bool
replicaMode bool
encryption bool
directIO bool
parallelWorkers bool
schemaFilters bool
tablespaces bool
}
func TestServiceRestoreIntegration(t *testing.T) {
if testing.Short() {
t.Skip("service restore integration test is disabled in short mode")
}
connString := os.Getenv("FBX_TEST_DATABASE")
if connString == "" {
t.Skip("service restore integration test requires FBX_TEST_DATABASE")
}
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
server := restoreIntegrationServerFromEnvironment(ctx, t, connString)
capabilities := server.restoreCapabilities()
t.Logf(
"restore integration profile: name=%s kind=%s version=%s capabilities=%+v",
server.profile,
server.kind,
server.version,
capabilities,
)
serviceConfig, err := fbservice.ParseConfig(connString)
require.NoError(t, err)
manager, err := fbservice.NewManagerConfig(serviceConfig)
require.NoError(t, err)
fixture := newRestoreIntegrationBackup(
ctx,
t,
manager,
connString,
"common",
populateCommonRestoreIntegrationDatabase,
)
t.Run("verbose interval and statistics", func(t *testing.T) {
var output bytes.Buffer
database := fixture.restore(ctx, t, fbservice.RestoreOptions{
Output: &output,
VerboseInterval: 100,
Statistics: fbservice.RestoreStatisticsAll,
})
conn := connectRestoreIntegrationDatabase(ctx, t, connString, database)
defer closeConn(t, conn)
require.EqualValues(t, 150, restoreIntegrationTableCount(ctx, t, conn, "RESTORE_KEEP_DATA"))
require.EqualValues(t, 75, restoreIntegrationTableCount(ctx, t, conn, "RESTORE_SKIP_DATA"))
outputText := strings.ToLower(output.String())
require.Contains(t, outputText, "100 records restored")
require.Contains(t, outputText, "total statistics")
})
t.Run("FSS repair parameters accepted", func(t *testing.T) {
database := fixture.restore(ctx, t, fbservice.RestoreOptions{
FixFSSData: "WIN1251",
FixFSSMetadata: "WIN1251",
})
conn := connectRestoreIntegrationDatabase(ctx, t, connString, database)
defer closeConn(t, conn)
require.EqualValues(t, 150, restoreIntegrationTableCount(ctx, t, conn, "RESTORE_KEEP_DATA"))
})
t.Run("metadata only", func(t *testing.T) {
database := fixture.restore(ctx, t, fbservice.RestoreOptions{MetadataOnly: true})
conn := connectRestoreIntegrationDatabase(ctx, t, connString, database)
defer closeConn(t, conn)
require.Zero(t, restoreIntegrationTableCount(ctx, t, conn, "RESTORE_KEEP_DATA"))
require.Zero(t, restoreIntegrationTableCount(ctx, t, conn, "RESTORE_SKIP_DATA"))
})
t.Run("skip data", func(t *testing.T) {
database := fixture.restore(ctx, t, fbservice.RestoreOptions{SkipData: "RESTORE_SKIP_DATA"})
conn := connectRestoreIntegrationDatabase(ctx, t, connString, database)
defer closeConn(t, conn)
require.EqualValues(t, 150, restoreIntegrationTableCount(ctx, t, conn, "RESTORE_KEEP_DATA"))
require.Zero(t, restoreIntegrationTableCount(ctx, t, conn, "RESTORE_SKIP_DATA"))
})
t.Run("ignore BLR errors parameter accepted", func(t *testing.T) {
if !capabilities.ignoreBLRErrors {
t.Skipf("ignore-BLR-errors restore is not supported by %s %s", server.kind, server.version)
}
database := fixture.restore(ctx, t, fbservice.RestoreOptions{IgnoreBLRErrors: true})
conn := connectRestoreIntegrationDatabase(ctx, t, connString, database)
defer closeConn(t, conn)
require.EqualValues(t, 150, restoreIntegrationTableCount(ctx, t, conn, "RESTORE_KEEP_DATA"))
})
t.Run("include data", func(t *testing.T) {
if !capabilities.includeData {
if server.kind == "rdb" && server.version.Major == 3 {
t.Skip("Red Database 3 requires the legacy KEEP_DATA tag, which RestoreOptions does not emit")
}
t.Skipf("include-data restore is not supported by %s %s", server.kind, server.version)
}
database := fixture.restore(ctx, t, fbservice.RestoreOptions{IncludeData: "RESTORE_KEEP_DATA"})
conn := connectRestoreIntegrationDatabase(ctx, t, connString, database)
defer closeConn(t, conn)
require.EqualValues(t, 150, restoreIntegrationTableCount(ctx, t, conn, "RESTORE_KEEP_DATA"))
require.Zero(t, restoreIntegrationTableCount(ctx, t, conn, "RESTORE_SKIP_DATA"))
})
t.Run("replica mode", func(t *testing.T) {
if !capabilities.replicaMode {
t.Skipf("replica-mode restore is not supported by %s %s", server.kind, server.version)
}
database := fixture.restore(ctx, t, fbservice.RestoreOptions{
ReplicaMode: fbservice.RestoreReplicaModeReadOnly,
})
conn := connectRestoreIntegrationDatabase(ctx, t, connString, database)
defer closeConn(t, conn)
var replicaMode string
err := conn.QueryRow(
ctx,
"select rdb$get_context('SYSTEM', 'REPLICA_MODE') from rdb$database",
).Scan(&replicaMode)
require.NoError(t, err)
require.Equal(t, "READ-ONLY", replicaMode)
})
t.Run("direct I/O", func(t *testing.T) {
if !capabilities.directIO {
t.Skipf("direct-I/O restore is not supported by %s %s", server.kind, server.version)
}
database := fixture.restore(ctx, t, fbservice.RestoreOptions{DirectIO: true})
conn := connectRestoreIntegrationDatabase(ctx, t, connString, database)
defer closeConn(t, conn)
require.EqualValues(t, 150, restoreIntegrationTableCount(ctx, t, conn, "RESTORE_KEEP_DATA"))
})
t.Run("parallel workers", func(t *testing.T) {
if !capabilities.parallelWorkers {
if server.kind == "rdb" && server.version.Major == 3 {
t.Skip("Red Database 3 requires the legacy parallel-workers tag, which RestoreOptions does not emit")
}
t.Skipf("parallel restore is not supported by %s %s", server.kind, server.version)
}
database := fixture.restore(ctx, t, fbservice.RestoreOptions{ParallelWorkers: 2})
conn := connectRestoreIntegrationDatabase(ctx, t, connString, database)
defer closeConn(t, conn)
require.EqualValues(t, 150, restoreIntegrationTableCount(ctx, t, conn, "RESTORE_KEEP_DATA"))
})
t.Run("encryption parameters reach server", func(t *testing.T) {
if !capabilities.encryption {
t.Skipf("encrypted restore is not supported by %s %s", server.kind, server.version)
}
const missingKeyHolder = "fbx_missing_key_holder"
database := fixture.nextDatabase(t)
var output bytes.Buffer
err := manager.Restore(ctx, fixture.backupFile, database, fbservice.RestoreOptions{
Output: &output,
KeyHolder: missingKeyHolder,
KeyName: "fbx_test_key",
CryptPlugin: "fbx_missing_crypt_plugin",
})
require.Error(t, err)
require.Contains(t, strings.ToLower(err.Error()), missingKeyHolder)
})
t.Run("schema filters", func(t *testing.T) {
if !capabilities.schemaFilters {
t.Skipf("schema-data filters are not supported by %s %s", server.kind, server.version)
}
testRestoreIntegrationSchemaFilters(ctx, t, manager, connString)
})
t.Run("tablespace paths", func(t *testing.T) {
if !capabilities.tablespaces {
t.Skipf("tablespace restore paths are not supported by %s %s", server.kind, server.version)
}
testRestoreIntegrationTablespaces(ctx, t, manager, connString)
})
}
func (server serviceIntegrationServer) restoreCapabilities() restoreIntegrationCapabilities {
var capabilities restoreIntegrationCapabilities
switch server.kind {
case "firebird":
capabilities.includeData = server.version.AtLeast(4, 0, 0)
capabilities.replicaMode = server.version.AtLeast(4, 0, 0)
capabilities.encryption = server.version.AtLeast(4, 0, 0)
capabilities.directIO = server.version.AtLeast(5, 0, 0)
capabilities.parallelWorkers = server.version.AtLeast(5, 0, 0)
capabilities.schemaFilters = server.version.AtLeast(6, 0, 0)
case "rdb":
capabilities.ignoreBLRErrors = server.version.AtLeast(3, 0, 0)
capabilities.includeData = server.version.AtLeast(5, 0, 0)
capabilities.replicaMode = server.version.AtLeast(5, 0, 0)
capabilities.encryption = server.version.AtLeast(5, 0, 0)
capabilities.directIO = server.version.AtLeast(5, 0, 0)
capabilities.parallelWorkers = server.version.AtLeast(5, 0, 0)
capabilities.schemaFilters = server.version.AtLeast(6, 0, 0)
capabilities.tablespaces = server.version.AtLeast(5, 2, 0) &&
(server.version.Major != 6 || server.version.Minor != 0)
}
return capabilities
}
func restoreIntegrationServerFromEnvironment(
ctx context.Context,
t *testing.T,
connString string,
) serviceIntegrationServer {
t.Helper()
server, err := serviceIntegrationServerFromEnvironment()
require.NoError(t, err)
if server.kind == "" {
t.Skip("service restore integration test requires DB_KIND/DB_VERSION, RDB_VERSION, or FB_VERSION")
}
conn, err := fbx.Connect(ctx, connString)
require.NoError(t, err)
defer closeConn(t, conn)
require.NoError(t, server.setVersion(conn.ServerVersion()))
return server
}
type restoreIntegrationBackup struct {
manager *fbservice.Manager
directory string
backupFile string
nextDatabaseID int
}
func newRestoreIntegrationBackup(
ctx context.Context,
t *testing.T,
manager *fbservice.Manager,
connString string,
name string,
populate func(context.Context, *testing.T, *fbx.Conn, string),
) *restoreIntegrationBackup {
t.Helper()
serviceRoot := strings.TrimSpace(os.Getenv("FBX_TEST_SERVICE_DIR"))
if serviceRoot == "" {
serviceRoot = os.TempDir()
}
require.Truef(t, filepath.IsAbs(serviceRoot), "FBX_TEST_SERVICE_DIR must be absolute: %q", serviceRoot)
rootInfo, err := os.Stat(serviceRoot)
require.NoError(t, err)
require.Truef(t, rootInfo.IsDir(), "FBX_TEST_SERVICE_DIR is not a directory: %q", serviceRoot)
directory, err := os.MkdirTemp(serviceRoot, "fbx-service-restore-"+name+"-*")
require.NoError(t, err)
require.NoError(t, os.Chmod(directory, 0o777))
t.Cleanup(func() {
if err := os.RemoveAll(directory); err != nil {
t.Errorf("remove restore integration directory %q: %v", directory, err)
}
})
sourceDatabase := filepath.Join(directory, "source.fdb")
createConfig, err := fbx.ParseConfig(connString)
require.NoError(t, err)
createConfig.Database = sourceDatabase
conn, err := fbx.CreateDatabaseConfig(ctx, createConfig)
require.NoError(t, err)
populate(ctx, t, conn, directory)
closeConn(t, conn)
backupFile := filepath.Join(directory, "source.fbk")
err = manager.Backup(ctx, sourceDatabase, backupFile)
require.NoError(t, err)
backupInfo, err := os.Stat(backupFile)
require.NoError(t, err)
require.Positive(t, backupInfo.Size())
err = fbx.DropDatabaseConfig(ctx, createConfig)
require.NoError(t, err)
return &restoreIntegrationBackup{
manager: manager,
directory: directory,
backupFile: backupFile,
}
}
func (fixture *restoreIntegrationBackup) nextDatabase(t *testing.T) string {
t.Helper()
fixture.nextDatabaseID++
database := filepath.Join(
fixture.directory,
fmt.Sprintf("restored-%02d.fdb", fixture.nextDatabaseID),
)
return database
}
func (fixture *restoreIntegrationBackup) restore(
ctx context.Context,
t *testing.T,
options fbservice.RestoreOptions,
) string {
t.Helper()
database := fixture.nextDatabase(t)
err := fixture.manager.Restore(ctx, fixture.backupFile, database, options)
require.NoError(t, err)
return database
}
func populateCommonRestoreIntegrationDatabase(
ctx context.Context,
t *testing.T,
conn *fbx.Conn,
_ string,
) {
t.Helper()
_, err := conn.Exec(ctx, "create table RESTORE_KEEP_DATA (ID integer not null)")
require.NoError(t, err)
_, err = conn.Exec(ctx, "create table RESTORE_SKIP_DATA (ID integer not null)")
require.NoError(t, err)
_, err = conn.Exec(ctx, `
execute block as
declare variable N integer;
begin
N = 1;
while (N <= 150) do
begin
insert into RESTORE_KEEP_DATA (ID) values (:N);
if (N <= 75) then
insert into RESTORE_SKIP_DATA (ID) values (:N);
N = N + 1;
end
end`)
require.NoError(t, err)
}
func connectRestoreIntegrationDatabase(
ctx context.Context,
t *testing.T,
connString string,
database string,
) *fbx.Conn {
t.Helper()
config, err := fbx.ParseConfig(connString)
require.NoError(t, err)
config.Database = database
config.CreateDatabase = false
conn, err := fbx.ConnectConfig(ctx, config)
require.NoError(t, err)
return conn
}
func restoreIntegrationTableCount(
ctx context.Context,
t *testing.T,
conn *fbx.Conn,
relation string,
) int64 {
t.Helper()
var count int64
err := conn.QueryRow(ctx, "select count(*) from "+relation).Scan(&count)
require.NoError(t, err)
return count
}
func testRestoreIntegrationSchemaFilters(
ctx context.Context,
t *testing.T,
manager *fbservice.Manager,
connString string,
) {
t.Helper()
fixture := newRestoreIntegrationBackup(
ctx,
t,
manager,
connString,
"schemas",
func(ctx context.Context, t *testing.T, conn *fbx.Conn, _ string) {
_, err := conn.Exec(ctx, "create schema RESTORE_KEEP_SCHEMA")
require.NoError(t, err)
_, err = conn.Exec(ctx, "create schema RESTORE_SKIP_SCHEMA")
require.NoError(t, err)
_, err = conn.Exec(ctx, "create table RESTORE_KEEP_SCHEMA.DATA_ROWS (ID integer)")
require.NoError(t, err)
_, err = conn.Exec(ctx, "create table RESTORE_SKIP_SCHEMA.DATA_ROWS (ID integer)")
require.NoError(t, err)
_, err = conn.Exec(ctx, "insert into RESTORE_KEEP_SCHEMA.DATA_ROWS values (1)")
require.NoError(t, err)
_, err = conn.Exec(ctx, "insert into RESTORE_SKIP_SCHEMA.DATA_ROWS values (2)")
require.NoError(t, err)
},
)
t.Run("skip schema data", func(t *testing.T) {
database := fixture.restore(ctx, t, fbservice.RestoreOptions{
SkipSchemaData: "RESTORE_SKIP_SCHEMA",
})
conn := connectRestoreIntegrationDatabase(ctx, t, connString, database)
defer closeConn(t, conn)
require.EqualValues(
t,
1,
restoreIntegrationTableCount(ctx, t, conn, "RESTORE_KEEP_SCHEMA.DATA_ROWS"),
)
require.Zero(
t,
restoreIntegrationTableCount(ctx, t, conn, "RESTORE_SKIP_SCHEMA.DATA_ROWS"),
)
})
t.Run("include schema data", func(t *testing.T) {
database := fixture.restore(ctx, t, fbservice.RestoreOptions{
IncludeSchemaData: "RESTORE_KEEP_SCHEMA",
})
conn := connectRestoreIntegrationDatabase(ctx, t, connString, database)
defer closeConn(t, conn)
require.EqualValues(
t,
1,
restoreIntegrationTableCount(ctx, t, conn, "RESTORE_KEEP_SCHEMA.DATA_ROWS"),
)
require.Zero(
t,
restoreIntegrationTableCount(ctx, t, conn, "RESTORE_SKIP_SCHEMA.DATA_ROWS"),
)
})
}
func testRestoreIntegrationTablespaces(
ctx context.Context,
t *testing.T,
manager *fbservice.Manager,
connString string,
) {
t.Helper()
var originalTablespacePath string
fixture := newRestoreIntegrationBackup(
ctx,
t,
manager,
connString,
"tablespaces",
func(ctx context.Context, t *testing.T, conn *fbx.Conn, directory string) {
originalTablespacePath = filepath.Join(directory, "original-tablespace.dat")
_, err := conn.Exec(
ctx,
fmt.Sprintf(
"create tablespace RESTORE_TS file '%s'",
restoreIntegrationSQLString(originalTablespacePath),
),
)
require.NoError(t, err)
_, err = conn.Exec(ctx, "create table RESTORE_TS_DATA (ID integer) tablespace RESTORE_TS")
require.NoError(t, err)
_, err = conn.Exec(ctx, "insert into RESTORE_TS_DATA values (42)")
require.NoError(t, err)
},
)
require.NoError(t, os.RemoveAll(originalTablespacePath))
t.Run("explicit path", func(t *testing.T) {
tablespacePath := filepath.Join(fixture.directory, "explicit-tablespace.dat")
database := fixture.restore(ctx, t, fbservice.RestoreOptions{
TablespacePaths: []fbservice.RestoreTablespacePath{{
Name: "RESTORE_TS",
Path: tablespacePath,
}},
})
requireRestoreIntegrationTablespace(ctx, t, connString, database, tablespacePath)
})
t.Run("mapping file", func(t *testing.T) {
tablespacePath := filepath.Join(fixture.directory, "mapped-tablespace.dat")
mappingFile := filepath.Join(fixture.directory, "tablespaces.map")
err := os.WriteFile(
mappingFile,
[]byte("RESTORE_TS "+tablespacePath+"\n"),
0o644,
)
require.NoError(t, err)
database := fixture.restore(ctx, t, fbservice.RestoreOptions{
TablespaceMappingFile: mappingFile,
})
requireRestoreIntegrationTablespace(ctx, t, connString, database, tablespacePath)
})
t.Run("original path", func(t *testing.T) {
database := fixture.restore(ctx, t, fbservice.RestoreOptions{
UseOriginalTablespacePaths: true,
})
requireRestoreIntegrationTablespace(
ctx,
t,
connString,
database,
originalTablespacePath,
)
})
}
func requireRestoreIntegrationTablespace(
ctx context.Context,
t *testing.T,
connString string,
database string,
wantTablespacePath string,
) {
t.Helper()
conn := connectRestoreIntegrationDatabase(ctx, t, connString, database)
defer closeConn(t, conn)
require.EqualValues(t, 1, restoreIntegrationTableCount(ctx, t, conn, "RESTORE_TS_DATA"))
var gotTablespacePath string
err := conn.QueryRow(
ctx,
"select rdb$file_name from rdb$tablespaces where rdb$tablespace_name = 'RESTORE_TS'",
).Scan(&gotTablespacePath)
require.NoError(t, err)
require.Equal(t, filepath.Clean(wantTablespacePath), filepath.Clean(strings.TrimSpace(gotTablespacePath)))
_, err = os.Stat(wantTablespacePath)
require.NoError(t, err)
}
func restoreIntegrationSQLString(value string) string {
return strings.ReplaceAll(value, "'", "''")
}