InterfaceCoreTest

/*
 * 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/interfaze/src/test/java/name/angoca/zemucan/interfaze/InterfaceCoreTest.java $:
 */
package name.angoca.zemucan.interfaze;

import name.angoca.zemucan.AbstractZemucanException;
import name.angoca.zemucan.ParameterNullException;
import name.angoca.zemucan.core.lexical.impl.ImplementationLexicalAnalyzer;
import name.angoca.zemucan.grammarReader.api.GrammarReaderController;
import name.angoca.zemucan.interfaze.model.ReturnOptions;
import name.angoca.zemucan.tools.Constants;
import name.angoca.zemucan.tools.configurator.Configurator;
import name.angoca.zemucan.tools.test.RandomTestRunner;

import org.junit.AfterClass;
import org.junit.Assert;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;

/**
 * Tests for the interface core. Tests the objects returned by this layer.
 * <p>
 * <b>Control Version</b>
 * <p>
 * <ul>
 * <li>0.0.1 Class creation.</li>
 * <li>0.1.0</li>
 * <li>0.2.0</li>
 * <li>0.3.0</li>
 * <li>0.3.1 Recommendations from PMD.</li>
 * <li>0.3.2 Organized.</li>
 * <li>0.4.0 Fewer tests (Two classes).</li>
 * <li>0.5.0 jUnit 4 annotations.</li>
 * <li>0.5.1 Messages in asserts.</li>
 * <li>0.6.0 Invalid graph exception.</li>
 * <li>0.6.1 Configurator.</li>
 * <li>0.6.2 Destroy instance.</li>
 * <li>0.7.0. Execute tests</li>
 * <li>0.7.1. finals</li>
 * <li>0.8.0. Setup and tearDown</li>
 * <li>1.0.0 Moved to version 1.</li>
 * <li>1.1.0 Exception hierarchy changed.</li>
 * <li>1.2.0 Exit test and take out intergration tests.</li>
 * <li>1.3.0 More tests and throws.</li>
 * <li>1.4.0 Refactored tests.</li>
 * <li>1.4.1 Grammar controller.</li>
 * <li>1.4.2 Completion fixed.</li>
 * <li>1.4.3 After class 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.4.3 2010-09-25
 */
@RunWith(RandomTestRunner.class)
public final class InterfaceCoreTest {
    /**
     * Load the graph.
     *
     * @throws AbstractZemucanException
     *             Never.
     */
    @BeforeClass
    public static void setUpBeforeClass() throws AbstractZemucanException {
        System.setProperty(Constants.ZEMUCAN_CONF_XML_PROPERTY,
                "sa_conf-test.xml"); //$NON-NLS-1$
        Configurator.getInstance().setProperty(
                Constants.GRAMMAR_READER_NAME_PROPERTY,
                Configurator.GRAMMAR_READER_NAME_VALUE);
        Configurator.getInstance()
                .setProperty(Constants.GRAMMAR_FILE_DESCRIPTORS_PROPERTY,
                        "grammar-test.xml"); //$NON-NLS-1$

        // Creates the lexical analyzer instance.
        ImplementationLexicalAnalyzer.getInstance();
    }

    /**
     * Clears the configuration file name property at the end of the test.
     */
    @AfterClass
    public static void tearDownAfterClass() {
        // Destroys any existent instance.
        ImplementationLexicalAnalyzer.destroyInstance();

        // Recreates the configurator instance.
        Configurator.destroyInstance();
        GrammarReaderController.destroyInstance();
        System.clearProperty(Constants.ZEMUCAN_CONF_XML_PROPERTY);
    }

    /**
     * Default constructor.
     */
    public InterfaceCoreTest() {
        // Nothing.
    }

    /**
     * Analyze exit token.
     *
     * @throws AbstractZemucanException
     *             Never.
     */
    @Test
    public void testAnalyzeExit() throws AbstractZemucanException {
        final String phrase = "exit"; //$NON-NLS-1$

        final String phraseOut = "exit"; //$NON-NLS-1$

        final String[] phrases = {};

        final String[] options = {};

        final ReturnOptions actual = InterfaceCore.analyzePhrase(phrase);

        final ReturnOptions expected = new ReturnOptions(phraseOut, phrases,
                options);

        Assert.assertEquals("Phrases and options for 'exit'", //$NON-NLS-1$
                expected, actual);
    }

    /**
     * Analyze a null token.
     *
     * @throws AbstractZemucanException
     *             Never.
     */
    @Test
    public void testAnalyzeNull() throws AbstractZemucanException {
        final String phrase = null;

        Exception e = null;
        try {
            InterfaceCore.analyzePhrase(phrase);
        } catch (final Exception exception) {
            e = exception;
        }
        Assert.assertTrue("ParameterNullException",
                e instanceof ParameterNullException);
    }

    /**
     * Test the completion of "create tab".
     *
     * @throws AbstractZemucanException
     *             Never.
     */
    @Test
    public void testAnalyzePhraseComplete1() throws AbstractZemucanException {
        final String phraseActual = "create tab"; //$NON-NLS-1$
        final String phraseExpected = "create table"; //$NON-NLS-1$

        final String[] phrases = { "tablespace" }; //$NON-NLS-1$
        final String[] options = {};

        final ReturnOptions actual = InterfaceCore.analyzePhrase(phraseActual);
        final ReturnOptions expected = new ReturnOptions(phraseExpected,
                phrases, options);

        Assert.assertEquals("Phrases for 'create tab'", expected, //$NON-NLS-1$
                actual);
    }

    /**
     * Test the completion of "crea".
     *
     * @throws AbstractZemucanException
     *             Never.
     */
    @Test
    public void testAnalyzePhraseComplete2() throws AbstractZemucanException {
        final String phraseActual = "crea"; //$NON-NLS-1$
        final String phraseExpected = "create"; //$NON-NLS-1$

        final String[] options = {};

        final ReturnOptions actual = InterfaceCore.analyzePhrase(phraseActual);
        final ReturnOptions expected = new ReturnOptions(phraseExpected,
                new String[] {}, options);

        Assert.assertEquals("Phrase for 'crea'", expected, actual); //$NON-NLS-1$
    }

    /**
     * Test the options of "create table".
     *
     * @throws AbstractZemucanException
     *             Never.
     */
    @Test
    public void testAnalyzePhraseOptions1() throws AbstractZemucanException {
        final String phraseIn = "create table"; //$NON-NLS-1$

        final String phraseOut = "create table"; //$NON-NLS-1$

        final String[] phrases = { "tablespace" }; //$NON-NLS-1$

        final String[] options = { "<tableName>" }; //$NON-NLS-1$

        final ReturnOptions actual = InterfaceCore.analyzePhrase(phraseIn);
        final ReturnOptions expected = new ReturnOptions(phraseOut, phrases,
                options);

        Assert.assertEquals("Phrases and options for 'create table'", //$NON-NLS-1$
                expected, actual);
    }
}