maintenance_manager_test.go

/*******************************************************************************
The MIT License (MIT)

Copyright (c) 2023-2024 Artyom Smirnov <artyom_smirnov@me.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*******************************************************************************/

package firebirdsql

import (
	"fmt"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"os"
	"path"
	"regexp"
	"testing"
)

func cleanFirebirdLog(t *testing.T) {
	m, err := NewServiceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	defer m.Close()

	var logFile string
	if logFile = os.Getenv("FIREBIRD_LOG"); logFile == "" {
		logFile, err = m.GetHomeDir()
		require.NoError(t, err)
		logFile = path.Join(logFile, "firebird.log")
	}

	_, err = os.Stat(logFile)
	if os.IsNotExist(err) {
		return
	}
	require.NoError(t, os.Truncate(logFile, 0))
}

func getFirebirdLog(t *testing.T) string {
	m, err := NewServiceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	defer m.Close()
	log, err := m.GetFbLogString()
	require.NoError(t, err)
	log = regexp.MustCompile(`(Database).*`).ReplaceAllString(log, "$1 xxxxx")
	log = regexp.MustCompile(`\w+\s+\w+\s+\w+\s+\d+\s+\d+:\d+:\d+\s+\d+`).ReplaceAllString(log, "")
	log = regexp.MustCompile(`(?m)^\s+`).ReplaceAllString(log, "")
	log = regexp.MustCompile(`(?m)\s+$`).ReplaceAllString(log, "")
	log = regexp.MustCompile(`(OIT|OAT|OST|Next) \d+`).ReplaceAllString(log, "$1 xxx")
	log = regexp.MustCompile(`\d+ (workers|errors|warnings|fixed)`).ReplaceAllString(log, "x $1")
	log = regexp.MustCompile(`(time) \d+\.\d+`).ReplaceAllString(log, "$1 x.xxx")
	return log
}

func grabStringOutput(run func() error, resChan chan string) (string, error) {
	done := make(chan bool)
	var result string
	var err error

	go func() {
		err = run()
		done <- true
	}()

	for loop, s := true, ""; loop; {
		select {
		case <-done:
			loop = false
			break
		case s = <-resChan:
			result += s + "\n"
		}
	}
	return result, err
}

func TestServiceManager_Sweep(t *testing.T) {
	if get_firebird_major_version(t) < 3 {
		t.Skip("skip for 2.5, because it running in container")
	}

	db, _, err := CreateTestDatabase("test_sweep_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)
	cleanFirebirdLog(t)
	err = m.Sweep(db)
	assert.NoError(t, err)
	log := getFirebirdLog(t)
	fmt.Println(log)
	assert.Contains(t, log, `Sweep is started by SYSDBA
Database xxxxx
OIT xxx, OAT xxx, OST xxx, Next xxx`)
	assert.Contains(t, log, `Sweep is finished
Database xxxxx`)
	assert.Contains(t, log, `
OIT xxx, OAT xxx, OST xxx, Next xxx`)
}

func TestServiceManager_Validate(t *testing.T) {
	if get_firebird_major_version(t) < 3 {
		t.Skip("skip for 2.5, because it running in container")
	}

	db, _, err := CreateTestDatabase("test_validate_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)

	cleanFirebirdLog(t)
	err = m.Validate(db, isc_spb_rpr_check_db)
	assert.NoError(t, err)
	log := getFirebirdLog(t)
	assert.Contains(t, log, `Database xxxxx
Validation started`)
	assert.Contains(t, log, `Database xxxxx
Validation finished: x errors, x warnings, x fixed`)

	cleanFirebirdLog(t)
	err = m.Validate(db, isc_spb_rpr_full)
	assert.NoError(t, err)
	log = getFirebirdLog(t)
	assert.Contains(t, log, `Database xxxxx
Validation started`)
	assert.Contains(t, log, `Database xxxxx
Validation finished: x errors, x warnings, x fixed`)
}

func TestServiceManager_Mend(t *testing.T) {
	if get_firebird_major_version(t) < 3 {
		t.Skip("skip for 2.5, because it running in container")
	}

	db, _, err := CreateTestDatabase("test_mend_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)

	cleanFirebirdLog(t)
	err = m.Mend(db)
	assert.NoError(t, err)
	log := getFirebirdLog(t)
	assert.Contains(t, log, `Database xxxxx
Validation started`)
	assert.Contains(t, log, `Database xxxxx
Validation finished: x errors, x warnings, x fixed`)
}

func TestServiceManager_ListLimboTransactions(t *testing.T) {
	db, _, err := CreateTestDatabase("test_list_limbo_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)
	_, err = m.GetLimboTransactions(db)
	assert.NoError(t, err)
}

func TestServiceManager_CommitTransaction(t *testing.T) {
	db, _, err := CreateTestDatabase("test_commit_transaction_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)
	err = m.CommitTransaction(db, 1)
	if err == nil && get_firebird_major_version(t) < 3 {
		//FIXME: Not sure if bug
		t.Log("This tests should fail, but on 2.5 it passing. Ignoring this error as 2.5 is obsolete")
		return
	}
	assert.EqualError(t, err, fmt.Sprintf(`failed to reconnect to a transaction in database %s
transaction is not in limbo
transaction 1 is committed
`, db))
}

func TestServiceManager_RollbackTransaction(t *testing.T) {
	db, _, err := CreateTestDatabase("test_rollback_transaction_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)
	err = m.RollbackTransaction(db, 1)
	if err == nil && get_firebird_major_version(t) < 3 {
		//FIXME: Not sure if bug
		t.Log("This tests should fail, but on 2.5 it passing. Ignoring this error as 2.5 is obsolete")
		return
	}
	assert.EqualError(t, err, fmt.Sprintf(`failed to reconnect to a transaction in database %s
transaction is not in limbo
transaction 1 is committed
`, db))
}

func TestServiceManager_SetDatabaseMode(t *testing.T) {
	db, _, err := CreateTestDatabase("test_set_mode_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)
	err = m.SetAccessModeReadOnly(db)
	assert.NoError(t, err)
	err = m.SetAccessModeReadWrite(db)
	assert.NoError(t, err)
}

func TestServiceManager_SetDatabaseDialect(t *testing.T) {
	db, _, err := CreateTestDatabase("test_set_dialect_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)
	err = m.SetDialect(db, 1)
	assert.NoError(t, err)
	err = m.SetDialect(db, 3)
	assert.NoError(t, err)
	err = m.SetDialect(db, 10)
	assert.Error(t, err)
}

func TestServiceManager_SetPageBuffers(t *testing.T) {
	db, _, err := CreateTestDatabase("test_set_buffers_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)
	err = m.SetPageBuffers(db, 0)
	assert.NoError(t, err)
	err = m.SetPageBuffers(db, 30)
	assert.Error(t, err)
	err = m.SetPageBuffers(db, 100)
	assert.NoError(t, err)
}

func TestServiceManager_SetWriteMode(t *testing.T) {
	db, _, err := CreateTestDatabase("test_set_write_mode_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)
	err = m.SetWriteModeAsync(db)
	assert.NoError(t, err)
	err = m.SetWriteModeSync(db)
	assert.NoError(t, err)
}

func TestServiceManager_SetPageFill(t *testing.T) {
	db, _, err := CreateTestDatabase("test_set_page_fill_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)
	err = m.SetPageFillNoReserve(db)
	assert.NoError(t, err)
	err = m.SetPageFillReserve(db)
	assert.NoError(t, err)
}

func TestServiceManager_DatabaseShutdown(t *testing.T) {
	db, _, err := CreateTestDatabase("test_shutdown_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)

	for _, mode := range []ShutdownMode{ShutdownModeDenyNewAttachments, ShutdownModeDenyNewTransactions, ShutdownModeForce} {
		err = m.Shutdown(db, mode, 0)
		assert.NoError(t, err)
		err = m.Online(db)
		assert.NoError(t, err)
	}
}

func TestServiceManager_DatabaseShutdownEx(t *testing.T) {
	db, _, err := CreateTestDatabase("test_shutdown_ex_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)

	err = m.ShutdownEx(db, OperationModeFull, ShutdownModeExForce, 0)
	assert.NoError(t, err)
	err = m.OnlineEx(db, OperationModeNormal)
	assert.NoError(t, err)
}

func TestServiceManager_SetSweepInterval(t *testing.T) {
	db, _, err := CreateTestDatabase("test_set_sweep_interval_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)

	err = m.SetSweepInterval(db, 20000)
	assert.NoError(t, err)
}

func TestServiceManager_NoLinger(t *testing.T) {
	if get_firebird_major_version(t) < 3 {
		t.Skip("firebird 2.5 do not support isc_spb_prp_nolinger")
	}

	db, _, err := CreateTestDatabase("test_nolinger_")
	require.NoError(t, err)

	m, err := NewMaintenanceManager("localhost:3050", GetTestUser(), GetTestPassword(), GetDefaultServiceManagerOptions())
	require.NoError(t, err)
	require.NotNil(t, m)

	err = m.NoLinger(db)
	assert.NoError(t, err)
}