migratedb.v1.integrationtest.database.DbSystem.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of migratedb-integration-tests Show documentation
The newest version!
/*
 * Copyright 2022-2024 The MigrateDB contributors
 *
 * 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 migratedb.v1.integrationtest.database

import migratedb.v1.core.api.internal.database.base.DatabaseType
import migratedb.v1.integrationtest.database.mutation.IndependentDatabaseMutation
import migratedb.v1.integrationtest.util.base.SafeIdentifier
import migratedb.v1.integrationtest.util.base.SafeIdentifier.Companion.asSafeIdentifier
import migratedb.v1.integrationtest.util.container.SharedResources
import org.junit.jupiter.api.extension.ExtensionContext
import org.junit.jupiter.params.provider.Arguments
import org.junit.jupiter.params.provider.Arguments.arguments
import org.junit.jupiter.params.provider.ArgumentsProvider
import java.util.stream.Stream
import javax.sql.DataSource

/**
 * Adapter for the various supported database systems.
 */
interface DbSystem {
    interface Instance : AutoCloseable {
        val type: DatabaseType

        /**
         * Creates the schema or database with the given name if it doesn't exist. Some database systems don't support
         * either schema-level or database-level isolation, so it's undefined whether the namespace will be implemented
         * at the schema or at the database level.
         *
         * @return The identifier that must be used to qualify tables in the namespace. This can be null, which means
         * that qualified names are not supported.
         */
        fun createNamespaceIfNotExists(namespace: SafeIdentifier): SafeIdentifier?

        /**
         * Drops an existing schema or database.
         */
        fun dropNamespaceIfExists(namespace: SafeIdentifier)

        /**
         * Connects to the database with administrative privileges.
         */
        fun newAdminConnection(namespace: SafeIdentifier): DataSource

        /**
         * Generates a new database mutation within [schema] (or the current schema, if null) that is independent from
         * all previously generated database mutations in the same schema.
         */
        fun nextMutation(schema: SafeIdentifier?): IndependentDatabaseMutation

        /**
         * Normalizes the case of an identifier.
         */
        fun normalizeCase(s: CharSequence): String = s.toString().uppercase()

        /**
         * Normalizes the case of an identifier.
         */
        fun normalizeCase(s: SafeIdentifier): SafeIdentifier = normalizeCase(s.toString()).asSafeIdentifier()
    }

    fun get(sharedResources: SharedResources): Instance


    class All : ArgumentsProvider {
        override fun provideArguments(context: ExtensionContext): Stream = Stream.of(
            CockroachDb.entries,
            Derby.entries,
            Firebird.entries,
            H2.entries,
            Hsqldb.entries,
            Informix.entries,
            MariaDb.entries,
            MySql.entries,
            Oracle.entries,
            Postgres.entries,
            SqlServer.entries,
            Sqlite.entries,
        ).flatMap { it.stream() }.map { arguments(it) }
    }


    class JustOneForDebugging : ArgumentsProvider {
        override fun provideArguments(context: ExtensionContext): Stream = Stream.of(
            SomeInMemoryDb
        ).map { arguments(it) }
    }
}