/*
    * Copyright (C) 2016 B3Partners B.V.
    */
   package nl.b3p;
   
   import static org.junit.jupiter.api.Assumptions.assumeFalse;
   
   import java.io.IOException;
   import java.util.Properties;
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.junit.jupiter.api.AfterEach;
  import org.junit.jupiter.api.BeforeAll;
  import org.junit.jupiter.api.BeforeEach;
  import org.junit.jupiter.api.TestInfo;
  
  /**
   * Utility om database properties te laden en methods te loggen.
   *
   * @author mprins
   */
  public abstract class AbstractDatabaseIntegrationTest {
  
    private static final Log LOG = LogFactory.getLog(AbstractDatabaseIntegrationTest.class);
  
    /**
     * test of de database properties zijn aangegeven, zo niet dan skippen we alle tests in deze test.
     */
    @BeforeAll
    public static void checkDatabaseIsProvided() {
      // als je vanuit de IDE wilt draaien kun je hier de database property instellen
      // System.setProperty("database.properties.file", "postgis.properties");
      // System.setProperty("database.properties.file", "oracle.properties");
      assumeFalse(
          null == System.getProperty("database.properties.file"),
          "Geen database omgeving aangegeven. Stel `database.properties.file` in.");
    }
  
    /**
     * properties uit {@code <DB smaak>.properties} en {@code local.<DB smaak>.properties}.
     *
     * @see #loadProps()
     */
    protected final Properties params = new Properties();
  
    /** {@code true} als we met een Oracle database bezig zijn. */
    protected boolean isOracle;
  
    /** {@code true} als we met een Postgis database bezig zijn. */
    protected boolean isPostgis;
  
    /**
     * subklassen dienen zelf een setup te hebben.
     *
     * @throws Exception if any
     */
    @BeforeEach
    public abstract void setUp() throws Exception;
  
    /**
     * Laadt de database property file en eventuele overrides.
     *
     * @throws IOException als laden van property file mislukt
     */
    @BeforeEach
    public void loadProps() throws IOException {
      // de `database.properties.file` is in de pom.xml of via commandline ingesteld
      params.load(
          AbstractDatabaseIntegrationTest.class
              .getClassLoader()
              .getResourceAsStream(System.getProperty("database.properties.file")));
      try {
        // probeer een local (override) versie te laden als die bestaat
        params.load(
            AbstractDatabaseIntegrationTest.class
                .getClassLoader()
                .getResourceAsStream("local." + System.getProperty("database.properties.file")));
      } catch (IOException | NullPointerException e) {
        // negeren; het override bestand is normaal niet aanwezig
      }
      isOracle = "oracle".equalsIgnoreCase(params.getProperty("dbtype"));
      isPostgis = "postgis".equalsIgnoreCase(params.getProperty("dbtype"));
  
      try {
        Class.forName(params.getProperty("rsgb.jdbc.driverClassName"));
        Class.forName(params.getProperty("staging.jdbc.driverClassName"));
        Class.forName(params.getProperty("rsgbbgt.jdbc.driverClassName"));
        Class.forName(params.getProperty("rsgbbrk.jdbc.driverClassName"));
        Class.forName(params.getProperty("topnl.jdbc.driverClassName"));
      } catch (ClassNotFoundException ex) {
        LOG.error("Database driver niet gevonden.", ex);
      }
    }
  
    /** Log de naam van de test als deze begint. */
    @BeforeEach
    public void startTest(TestInfo testInfo) {
      LOG.info("==== Start test methode: " + testInfo.getDisplayName());
    }
 
   /** Log de naam van de test als deze eindigt. */
   @AfterEach
   public void endTest(TestInfo testInfo) {
     LOG.info("==== Einde test methode: " + testInfo.getDisplayName());
   }
 }