/*
    * Zemucan: A Syntax Assistant for DB2
    * Copyright (C) 2009, 2010 Andres Gomez Casanova
    *
    * This file is part of Zemucan.
    *
    * Zemucan is free software: you can redistribute it and/or modify
    * it under the terms of the GNU Lesser General Public License as published by
    * the Free Software Foundation; either version 3 of the License, or
   * (at your option) any later version.
   *
   * Zemucan 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 Lesser General Public License for more details.
   *
   * You should have received a copy of the GNU Lesser General Public License
   * along with this library; if not, see <http://www.gnu.org/licenses/>.
   *
   * Contact:
   * a n g o c a  at  y a h o o  dot  c o m
   * Cra. 45 No 61 - 31, Bogota, Colombia.
   *
   * Author:   $LastChangedBy: angoca $:
   * Date:     $LastChangedDate: 2011-03-06 22:39:08 -0500 (dom, 06 mar 2011) $:
   * Revision: $LastChangedRevision: 1916 $:
   * URL:      $HeadURL: https://zemucan.svn.sourceforge.net/svnroot/zemucan/branches/zemucan_v1/source-code/tools/src/test/java/name/angoca/zemucan/tools/configurator/ConfiguratorTest.java $:
   */
  package name.angoca.zemucan.tools.configurator;
  
  import name.angoca.zemucan.tools.Constants;
  import name.angoca.zemucan.tools.test.RandomTestRunner;
  
  import org.junit.After;
  import org.junit.AfterClass;
  import org.junit.Assert;
  import org.junit.Before;
  import org.junit.Test;
  import org.junit.runner.RunWith;
  
  /**
   * Tests for the configurator.
   * <p>
   * <b>Control Version</b>
   * <p>
   * <ul>
   * <li>0.0.1 Class creation.</li>
   * <li>0.1.0 More tests.</li>
   * <li>0.1.1 imports and final.</li>
   * <li>0.2.0 Setup class, and configuration file name.</li>
   * <li>1.0.0 Moved to version 1.</li>
   * <li>1.0.1 Grammar file for tests.</li>
   * <li>1.1.0 Delimiters deleted.</li>
   * <li>1.1.1 Exit and prompt properties.</li>
   * <li>1.2.0 New tests.</li>
   * <li>1.2.1 Extra tokens problem.</li>
   * <li>1.2.2 Destroy instance in after method.</li>
   * </ul>
   *
   * @author Andres Gomez Casanova <a
   *         href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
   * @version 1.2.2 2010-09-25
   */
  @RunWith(RandomTestRunner.class)
  public class ConfiguratorTest {
  
      /**
       * Word 'A'.
       */
      private static final String A = "A"; //$NON-NLS-1$
      /**
       * Words 'About token'.
       */
      private static final String ABOUT_TOKEN = "About token"; //$NON-NLS-1$
      /**
       * Words 'Grammar fileName'.
       */
      private static final String GRAMMAR_FILE_NAME = "Grammar fileName"; //$NON-NLS-1$
      /**
       * Words 'Help token'.
       */
      private static final String HELP_TOKEN = "Help token"; //$NON-NLS-1$
      /**
       * Words 'sa_conf-test.xml'.
       */
      private static final String SA_CONF_TEST_XML = "sa_conf-test.xml"; //$NON-NLS-1$
  
      /**
       * Clears the configuration file name property at the end of the test.
       */
      @AfterClass
      public static final void tearDownAfterClass() {
          System.clearProperty(Constants.ZEMUCAN_CONF_XML_PROPERTY);
      }
  
      /**
       * Clears the configuration file name property before each test.
       */
      @Before
     public final void setUp() {
         System.setProperty(Constants.ZEMUCAN_CONF_XML_PROPERTY,
                 ConfiguratorTest.SA_CONF_TEST_XML);
     }
 
     /**
      * Destroys the configurator instance.
      */
     @After
     public void tearDown() {
         Configurator.destroyInstance();
     }
 
     /**
      * Tests a configuration file.
      */
     @Test
     public final void testGetInstanceConf() {
         // Sets a configuration file.
         System.clearProperty(Constants.ZEMUCAN_CONF_XML_PROPERTY);
 
         final Configurator instance = Configurator.getInstance();
 
         Assert.assertNotNull("Configurator instanced", instance); //$NON-NLS-1$
     }
 
     /**
      * Tests a configuration file for tests.
      */
     @Test
     public final void testGetInstanceConfFileTest() {
         // Sets a configuration file.
         System.setProperty(Constants.ZEMUCAN_CONF_XML_PROPERTY,
                 ConfiguratorTest.SA_CONF_TEST_XML);
 
         // Compares all the default values.
         String actual = Configurator.getInstance().getProperty(
                 Constants.ABOUT_TOKEN_PROPERTY);
         String expected = "about"; //$NON-NLS-1$
         Assert.assertEquals(ConfiguratorTest.ABOUT_TOKEN, expected, actual);
 
         actual = Configurator.getInstance().getProperty(
                 Constants.GRAMMAR_FILE_DESCRIPTORS_PROPERTY);
         expected = "grammar-test.xml"; //$NON-NLS-1$
         Assert.assertEquals(ConfiguratorTest.GRAMMAR_FILE_NAME, expected,
                 actual);
 
         actual = Configurator.getInstance().getProperty(
                 Constants.HELP_TOKEN_PROPERTY);
         expected = "?"; //$NON-NLS-1$
         Assert.assertEquals(ConfiguratorTest.HELP_TOKEN, expected, actual);
     }
 
     /**
      * Tests the default values, when the configuration file cannot be found.
      */
     @Test
     public final void testGetInstanceNoFile() {
         // Sets an inexistent configuration file.
         System
                 .setProperty(Constants.ZEMUCAN_CONF_XML_PROPERTY,
                         "NoFileSpecified"); //$NON-NLS-1$
 
         // Compares all the default values.
         String actual = Configurator.getInstance().getProperty(
                 Constants.ABOUT_TOKEN_PROPERTY);
         String expected = Constants.ABOUT_TOKEN_VALUE;
         Assert.assertEquals(ConfiguratorTest.ABOUT_TOKEN, expected, actual);
 
         actual = Configurator.getInstance().getProperty(
                 Constants.GRAMMAR_FILE_DESCRIPTORS_PROPERTY);
         expected = Configurator.GRAMMAR_FILE_DESCRIPTORS_VALUE;
         Assert.assertEquals(ConfiguratorTest.GRAMMAR_FILE_NAME, expected,
                 actual);
 
         actual = Configurator.getInstance().getProperty(
                 Constants.HELP_TOKEN_PROPERTY);
         expected = Constants.HELP_TOKEN_VALUE;
         Assert.assertEquals(ConfiguratorTest.HELP_TOKEN, expected, actual);
     }
 
     /**
      * Tests a required property cannot be null.
      */
     @Test(expected = AssertionError.class)
     public final void testGetNull() {
         Configurator.getInstance().getProperty(null);
     }
 
     /**
      * Tests the load of the default properties after the read of a
      * configuration file with an invalid structure.
      */
     @Test
     public final void testReadInvalidFile() {
         // Deletes the property, loading other configuration file.
         System.setProperty(Constants.ZEMUCAN_CONF_XML_PROPERTY,
                 "sa_conf-test-InvalidFormat.properties"); //$NON-NLS-1$
 
         final String actual = Configurator.getInstance().getProperty(
                 Constants.HELP_TOKEN_PROPERTY);
 
         final String expected = Constants.HELP_TOKEN_VALUE;
 
         Assert.assertEquals("Defaults Loaded", expected, actual); //$NON-NLS-1$
     }
 
     /**
      *Test that the key cannot be null when setting.
      */
     @Test(expected = AssertionError.class)
     public final void testSetNull1() {
         Configurator.getInstance().setProperty(null, ConfiguratorTest.A);
     }
 
     /**
      * Tests that the value cannot be null when setting.
      */
     @Test(expected = AssertionError.class)
     public final void testSetNull2() {
         Configurator.getInstance().setProperty(ConfiguratorTest.A, null);
     }
 }