dendrite/test/testrig/base.go

// Copyright 2022 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package testrig

import (
	"errors"
	"fmt"
	"io/fs"
	"os"
	"strings"
	"testing"

	"github.com/nats-io/nats.go"

	"github.com/matrix-org/dendrite/setup/base"
	"github.com/matrix-org/dendrite/setup/config"
	"github.com/matrix-org/dendrite/test"
)

func CreateBaseDendrite(t *testing.T, dbType test.DBType) (*base.BaseDendrite, func()) {
	var cfg config.Dendrite
	cfg.Defaults(config.DefaultOpts{
		Generate:   false,
		Monolithic: true,
	})
	cfg.Global.JetStream.InMemory = true
	cfg.FederationAPI.KeyPerspectives = nil
	switch dbType {
	case test.DBTypePostgres:
		cfg.Global.Defaults(config.DefaultOpts{ // autogen a signing key
			Generate:   true,
			Monolithic: true,
		})
		cfg.MediaAPI.Defaults(config.DefaultOpts{ // autogen a media path
			Generate:   true,
			Monolithic: true,
		})
		cfg.SyncAPI.Fulltext.Defaults(config.DefaultOpts{ // use in memory fts
			Generate:   true,
			Monolithic: true,
		})
		cfg.Global.ServerName = "test"
		// use a distinct prefix else concurrent postgres/sqlite runs will clash since NATS will use
		// the file system event with InMemory=true :(
		cfg.Global.JetStream.TopicPrefix = fmt.Sprintf("Test_%d_", dbType)
		connStr, close := test.PrepareDBConnectionString(t, dbType)
		cfg.Global.DatabaseOptions = config.DatabaseOptions{
			ConnectionString:       config.DataSource(connStr),
			MaxOpenConnections:     10,
			MaxIdleConnections:     2,
			ConnMaxLifetimeSeconds: 60,
		}
		base := base.NewBaseDendrite(&cfg, "Test", base.DisableMetrics)
		return base, func() {
			base.ShutdownDendrite()
			base.WaitForShutdown()
			close()
		}
	case test.DBTypeSQLite:
		cfg.Defaults(config.DefaultOpts{
			Generate:   true,
			Monolithic: false, // because we need a database per component
		})
		cfg.Global.ServerName = "test"
		// use a distinct prefix else concurrent postgres/sqlite runs will clash since NATS will use
		// the file system event with InMemory=true :(
		cfg.Global.JetStream.TopicPrefix = fmt.Sprintf("Test_%d_", dbType)
		base := base.NewBaseDendrite(&cfg, "Test", base.DisableMetrics)
		return base, func() {
			base.ShutdownDendrite()
			base.WaitForShutdown()
			// cleanup db files. This risks getting out of sync as we add more database strings :(
			dbFiles := []config.DataSource{
				cfg.FederationAPI.Database.ConnectionString,
				cfg.KeyServer.Database.ConnectionString,
				cfg.MSCs.Database.ConnectionString,
				cfg.MediaAPI.Database.ConnectionString,
				cfg.RoomServer.Database.ConnectionString,
				cfg.SyncAPI.Database.ConnectionString,
				cfg.UserAPI.AccountDatabase.ConnectionString,
			}
			for _, fileURI := range dbFiles {
				path := strings.TrimPrefix(string(fileURI), "file:")
				err := os.Remove(path)
				if err != nil && !errors.Is(err, fs.ErrNotExist) {
					t.Fatalf("failed to cleanup sqlite db '%s': %s", fileURI, err)
				}
			}
		}
	default:
		t.Fatalf("unknown db type: %v", dbType)
	}
	return nil, nil
}

func Base(cfg *config.Dendrite) (*base.BaseDendrite, nats.JetStreamContext, *nats.Conn) {
	if cfg == nil {
		cfg = &config.Dendrite{}
		cfg.Defaults(config.DefaultOpts{
			Generate:   true,
			Monolithic: true,
		})
	}
	cfg.Global.JetStream.InMemory = true
	cfg.SyncAPI.Fulltext.InMemory = true
	cfg.FederationAPI.KeyPerspectives = nil
	base := base.NewBaseDendrite(cfg, "Tests", base.DisableMetrics)
	js, jc := base.NATS.Prepare(base.ProcessContext, &cfg.Global.JetStream)
	return base, js, jc
}