package fr.ifremer.quadrige2.core.test;
   
   /*-
    * #%L
    * Quadrige2 Core :: Quadrige2 Test Shared
    * %%
    * Copyright (C) 2017 Ifremer
    * %%
    * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU Affero General Public License as published by
   * the Free Software Foundation, either version 3 of the License, or
   * (at your option) any later version.
   * 
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   * 
   * You should have received a copy of the GNU Affero General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   * #L%
   */
  
  import com.google.common.base.Charsets;
  import com.google.common.io.Files;
  import fr.ifremer.quadrige2.core.config.Quadrige2Configuration;
  import fr.ifremer.quadrige2.core.config.Quadrige2ConfigurationOption;
  import fr.ifremer.quadrige2.core.dao.technical.Daos;
  import fr.ifremer.quadrige2.core.dao.technical.DatabaseSchemaDao;
  import fr.ifremer.quadrige2.core.dao.technical.hibernate.DatabaseSchemaDaoImpl;
  import fr.ifremer.quadrige2.core.exception.DatabaseSchemaUpdateException;
  import fr.ifremer.quadrige2.core.exception.Quadrige2TechnicalException;
  import fr.ifremer.quadrige2.core.service.ServiceLocator;
  import org.apache.commons.io.FileUtils;
  import org.apache.commons.io.IOUtils;
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.dbunit.DatabaseUnitException;
  import org.dbunit.database.DatabaseConnection;
  import org.dbunit.database.IDatabaseConnection;
  import org.dbunit.dataset.IDataSet;
  import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
  import org.dbunit.ext.hsqldb.HsqldbDataTypeFactory;
  import org.dbunit.operation.DatabaseOperation;
  import org.junit.Assume;
  import org.junit.rules.ExternalResource;
  import org.nuiton.i18n.I18n;
  import org.nuiton.i18n.init.DefaultI18nInitializer;
  import org.nuiton.i18n.init.UserI18nInitializer;
  
  import java.io.BufferedReader;
  import java.io.BufferedWriter;
  import java.io.File;
  import java.io.IOException;
  import java.net.URL;
  import java.sql.Connection;
  import java.sql.SQLException;
  import java.util.Locale;
  import java.util.Properties;
  import java.util.StringTokenizer;
  
  /**
   * @author peck7 on 13/10/2017.
   */
  public abstract class InitTests extends ExternalResource {
  
      private static final String DATASET_COMMON_XML_FILE = "quadrige2.core.test.dataset.common";
      private static final String DATASET_CLIENT_XML_FILE = "quadrige2.core.test.dataset.client";
  
      private static final Log log = LogFactory.getLog(InitTests.class);
  
      protected Quadrige2Configuration config;
  
      protected abstract String getHsqlDbSourceDatabaseDirectory();
  
      protected abstract String getModuleName();
  
      protected void initConfig() {
  
          config = new Quadrige2Configuration(getModuleName() + "-test-write.properties",
                  "--option", Quadrige2ConfigurationOption.DB_DIRECTORY.getKey(), getHsqlDbSourceDatabaseDirectory(),
                  "--option", Quadrige2ConfigurationOption.DB_ENUMERATION_RESOURCE.getKey(), "classpath*:quadrige2-db-enumerations.properties"
          );
          Quadrige2Configuration.setInstance(config);
  
      }
  
      protected void initServiceLocator() {
  
          ServiceLocator.initQuadrige2Default();
      }
  
      @Override
      protected void before() throws Throwable {
  
          File dbDirectory = new File(getHsqlDbSourceDatabaseDirectory());
          File dbConfigFile = new File(dbDirectory, DatabaseResource.HSQLDB_SRC_DATABASE_PROPERTIES_FILE);
          File dbScriptFile = new File(dbDirectory, DatabaseResource.HSQLDB_SRC_DATABASE_SCRIPT_FILE);
  
         initConfig();
 
         initServiceLocator();
 
         initI18n();
 
         boolean isFileDatabase = Daos.isFileDatabase(config.getJdbcURL());
 
         if (isFileDatabase) {
             log.info("Init test data in database... [" + config.getJdbcURL() + "]");
 
             // db not exists: create it
             if (!dbConfigFile.exists() || !dbScriptFile.exists()) {
                 createDb(dbConfigFile.getParentFile());
             }
 
             // Set database to readonly=false
             try {
                 setProperty(dbConfigFile, "readonly", "false");
             } catch (IOException e) {
                 Assume.assumeNoException(e);
             }
         }
 
         // Reload test data into DB
         Connection conn = Daos.createConnection(config.getConnectionProperties());
 
         // Disable integrity constraints
         Daos.setIntegrityConstraints(conn, false);
 
         // Remove some lines that dbUnit can't handle
         Daos.sqlUpdate(conn, "DELETE FROM SURVEY_QUSER");
         Daos.sqlUpdate(conn, "DELETE FROM RULE_PRECONDITION");
         conn.commit();
 
         // Import Common dataset
         {
             String importFileName = config.getApplicationConfig().getOption(DATASET_COMMON_XML_FILE);
             Assume.assumeTrue(
                     String.format("Missing value for configuration option [%s].\nPlease set this properties in the test configuration.",
                             DATASET_COMMON_XML_FILE),
                     importFileName != null);
 
             log.info("Importing test data... [" + importFileName + "]");
             URL importFileUrl = getClass().getResource("/" + importFileName);
             Assume.assumeTrue(
                     String.format("Unable to find resource for configuration option [%s] resource = %s. \nPlease review your properties in the test configuration.",
                             DATASET_COMMON_XML_FILE, importFileName),
                     importFileUrl != null);
 
             // Clean & Insert
             fullDatabaseImport(importFileUrl, conn, true);
         }
 
         // Import client dataset
         {
             String importFileNames = config.getApplicationConfig().getOption(DATASET_CLIENT_XML_FILE);
             Assume.assumeTrue(
                     String.format("Missing value for configuration option [%s].\nPlease set this properties in the test configuration.",
                             DATASET_CLIENT_XML_FILE),
                     importFileNames != null);
 
             log.info("Importing test data... [" + importFileNames + "]");
 
             // If multiple files, split and loop over
             StringTokenizer st = new StringTokenizer(importFileNames, ",");
             while (st.hasMoreTokens()) {
                 String importFileName = st.nextToken();
 
                 URL importFileUrl = getClass().getResource("/" + importFileName);
                 Assume.assumeTrue(
                         String.format("Unable to find resource for configuration option [%s] resource = %s. \nPlease review your properties in the test configuration.",
                                 DATASET_CLIENT_XML_FILE, importFileName),
                         importFileUrl != null);
 
                 // Insert (no Clean)
                 fullDatabaseImport(importFileUrl, conn, false);
             }
         }
 
         // Enable integrity constraints
         Daos.setIntegrityConstraints(conn, true);
 
         // DEV ONLY: on server DB, cleaning all previous database change log
         // if (!isFileDatabase) {
         // Daos.sqlUpdate(conn, "DELETE FROM DATABASECHANGELOG");
         // Daos.sqlUpdate(conn, "DELETE FROM DATABASECHANGELOGLOCK");
         // conn.commit();
         // }
 
         // Update DB schema
         log.info("Updating database schema...");
         ServiceLocator.instance().getDatabaseSchemaService().updateSchema();
 
         // Shutdown database
         if (isFileDatabase) {
             Daos.shutdownDatabase(conn);
         }
 
         // Shutdown spring context
         IOUtils.closeQuietly(ServiceLocator.instance());
 
         if (isFileDatabase) {
             // Set database to readonly=true
             try {
                 setProperty(dbConfigFile, "readonly", "true");
             } catch (IOException e) {
                 Assume.assumeNoException(e);
             }
         }
 
         log.info("Test database has been loaded");
     }
 
     public static void setProperty(File file, String key, String value) throws IOException {
         // Load old properties values
         Properties props = new Properties();
         try (BufferedReader reader = Files.newReader(file, Charsets.UTF_8)) {
             props.load(reader);
         }
 
         // Store new properties values
         props.setProperty(key, value);
         try (BufferedWriter writer = Files.newWriter(file, Charsets.UTF_8)) {
             props.store(writer, "");
         }
     }
 
     public static void fullDatabaseImport(URL fileURL, Connection jdbcConnection, boolean cleanBeforeInsert)
             throws ClassNotFoundException, IOException, SQLException, DatabaseUnitException {
 
         IDatabaseConnection connection = new DatabaseConnection(jdbcConnection);
         connection.getConfig().setProperty("http://www.dbunit.org/properties/datatypeFactory", new HsqldbDataTypeFactory());
         IDataSet dataSet = new FlatXmlDataSetBuilder().setColumnSensing(true).build(fileURL);
         if (cleanBeforeInsert) {
             DatabaseOperation.CLEAN_INSERT.execute(connection, dataSet);
         } else {
             DatabaseOperation.INSERT.execute(connection, dataSet);
         }
     }
 
 	/* -- internal methods -- */
 
     protected void initI18n() throws IOException {
         Quadrige2Configuration config = Quadrige2Configuration.getInstance();
 
         // --------------------------------------------------------------------//
         // init i18n
         // --------------------------------------------------------------------//
         File i18nDirectory = new File(config.getDataDirectory(), "i18n");
         if (i18nDirectory.exists()) {
             // clean i18n cache
             FileUtils.cleanDirectory(i18nDirectory);
         }
 
         FileUtils.forceMkdir(i18nDirectory);
 
         if (log.isDebugEnabled()) {
             log.debug("I18N directory: " + i18nDirectory);
         }
 
         Locale i18nLocale = config.getI18nLocale();
 
         if (log.isDebugEnabled()) {
             log.debug(String.format("Starts i18n with locale [%s] at [%s]",
                     i18nLocale, i18nDirectory));
         }
         I18n.init(new UserI18nInitializer(
                         i18nDirectory, new DefaultI18nInitializer(getI18nBundleName())),
                 i18nLocale);
     }
 
     protected String getI18nBundleName() {
         return getModuleName() + "-i18n";
     }
 
     protected void createDb(File outputDirectory) {
         Quadrige2Configuration config = Quadrige2Configuration.getInstance();
         DatabaseSchemaDao databaseSchemaDao = new DatabaseSchemaDaoImpl(config);
 
         try {
             // Create the database
             databaseSchemaDao.generateNewDb(outputDirectory, false);
 
             // Update the DB schema
             databaseSchemaDao.updateSchema(outputDirectory);
         } catch (Quadrige2TechnicalException | DatabaseSchemaUpdateException e1) {
             log.error(e1.getMessage());
         }
     }
 }