au.net.causal.maven.plugins.boxdb.db.Oracle12Database Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of boxdb-maven-plugin Show documentation
Maven plugin to start databases using Docker and VMs
There is a newer version: 3.3
package au.net.causal.maven.plugins.boxdb.db;

import au.net.causal.maven.plugins.boxdb.db.DatabaseUtils.DatabaseRunningPrecondition;
import com.google.common.collect.ImmutableList;
import io.fabric8.maven.docker.config.RunImageConfiguration;
import io.fabric8.maven.docker.wait.HttpPingChecker;
import io.fabric8.maven.docker.wait.PreconditionFailedException;
import io.fabric8.maven.docker.wait.WaitChecker;
import io.fabric8.maven.docker.wait.WaitUtil;

import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.StandardCopyOption;
import java.sql.SQLException;
import java.time.Duration;
import java.util.List;
import java.util.concurrent.TimeoutException;

public class Oracle12Database extends OracleDatabase
{
    public Oracle12Database(BoxConfiguration boxConfiguration, ProjectConfiguration projectConfiguration, BoxContext context, String dockerImageName)
    throws IOException
    {
        super(boxConfiguration, projectConfiguration, context, dockerImageName);
    }

    @Override
    protected String oracleHomePath()
    {
        return "/u01/app/oracle-product/12.1.0/xe/bin/";
    }

    @Override
    protected void configureRunImage(RunImageConfiguration.Builder builder)
    {
        super.configureRunImage(builder);
        builder.ports(ImmutableList.of(
                getBoxConfiguration().getDatabasePort() + ":" + containerDatabasePort(),
                getWebConsolePort() + ":8080"));
    }

    protected int getWebConsolePort()
    {
        return getBoxConfiguration().getDatabasePort() + 1;
    }

    @Override
    public void waitUntilStarted(Duration maxTimeToWait) throws TimeoutException, BoxDatabaseException
    {
        long startTime = System.currentTimeMillis();
        long maxEndTime = startTime + maxTimeToWait.toMillis();

        getContext().getLog().info("Note: Oracle 12 can take over five minutes to start up when first run, please be patient...");
        super.waitUntilStarted(maxTimeToWait);

        int waitMillis = Math.toIntExact(maxEndTime - System.currentTimeMillis());

        //Check HTTP endpoint instead of just TCP because TCP sockets are bugged with some dockers
        WaitChecker checker = new HttpPingChecker("http://" + getContext().getDockerHostAddress() + ":" + getWebConsolePort(), "GET", "401");
        getContext().getLog().debug("Waiting for Web console to start up...");
        try
        {
            WaitUtil.wait(new DatabaseRunningPrecondition(this, getContext()), waitMillis, checker);
            long time = System.currentTimeMillis() - startTime;
            getContext().getLog().info("Oracle 12 startup completed in " + time / 1000.0 + " seconds.");
        }
        catch (PreconditionFailedException e)
        {
            throw new BoxDatabaseException("Error occurred while waiting for database to start up: " + e, e);
        }
    }

    @Override
    public void restore(Path backupFile)
    throws BoxDatabaseException, IOException, SQLException
    {
        //Copy backup file to host script directory so Oracle can access it
        Path mountedBackupFile = Files.createTempFile(getHostScriptDirectory(), "backup", ".dmp");
        Files.copy(backupFile, mountedBackupFile, StandardCopyOption.REPLACE_EXISTING);

        //Shell script to create dump directory if needed and set it up
        runShellScript(Oracle12Database.class.getResource("oracle12-pre-backup.sh"));

        //and copy the backup dmp file to the dump directory
        runShellScript(Oracle12Database.class.getResource("oracle12-pre-restore.sh"));

        //Set up directory and give database user permission to use it
        runFilteredScript("oracle12-prepare-backup.sql");

        //Run tool
        String args = "schemas=" + getBoxConfiguration().getDatabaseUser() +
                " directory=backup_dir dumpfile=" + mountedBackupFile.getFileName().toString() +
                " logfile=" + mountedBackupFile.getFileName().toString() + ".log";
        executeImpDp(args, DatabaseTarget.USER, getProjectConfiguration().getBackupTimeout());

        //Clean up dmp file
        runShellScript(Oracle12Database.class.getResource("oracle12-post-restore.sh"));
    }

    @Override
    public void backup(Path backupFile, BackupFileTypeHint backupFileTypeHint)
    throws BoxDatabaseException, IOException, SQLException
    {
        //This is the backup file created by Oracle, move it at the end
        //If the file name specified has no extension then it gets ".dmp" by Oracle tool
        //Thanks Oracle
        String oracleFileName = backupFile.getFileName().toString();
        if (!oracleFileName.contains("."))
            oracleFileName = oracleFileName + ".dmp";

        Path targetFile = getHostScriptDirectory().resolve(oracleFileName);

        //Run shell script to initialize /data/dump directory
        //We can't use /data/scripts because permissions might be wrong on some docker instances
        //and oracle user doesn't have write access to it
        runShellScript(Oracle12Database.class.getResource("oracle12-pre-backup.sh"));

        //Set up directory and give database user permission to use it
        runFilteredScript("oracle12-prepare-backup.sql");

        //Run the dump tool
        String args = "schemas=" + getBoxConfiguration().getDatabaseUser() +
                " directory=backup_dir dumpfile=" + backupFile.getFileName().toString() +
                " logfile=" + backupFile.getFileName().toString() + ".log";
        executeExpDp(args, DatabaseTarget.USER, getProjectConfiguration().getBackupTimeout());

        //Now run shell script to move file to proper location
        runShellScript(Oracle12Database.class.getResource("oracle12-post-backup.sh"));

        //Move backup file to target
        Files.move(targetFile, backupFile, StandardCopyOption.REPLACE_EXISTING);
    }

    @Override
    public List logFiles() throws BoxDatabaseException, IOException 
    {
        return logFilesInContainer(true, StandardCharsets.UTF_8, "/u01/app/oracle/cfgtoollogs/dbca/xe/", 
                    "xe.log", "postDBCreation.log", "trace.log");
    }
}