////////////////////////////////////////////////////////////////////////////////
   // MillScript: an Open Spice interpreter and batch website creation tool
   // Copyright (C) 2001-2004 Open World Ltd
   // Copyright (C) 2005 Kevin Rogers
   //
   // This file is part of MillScript.
   //
   // MillScript is free software; you can redistribute it and/or modify it under
   // the terms of the GNU General Public License as published by the Free
  // Software Foundation; either version 2 of the License, or (at your option)
  // any later version.
  //
  // MillScript 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 General Public License along with
  // MillScript; if not, write to the Free Software Foundation, Inc., 59 Temple
  // Place, Suite 330, Boston, MA  02111-1307  USA
  ////////////////////////////////////////////////////////////////////////////////
  package org.millscript.millscript;
  
  import org.millscript.commons.alert.EscapeException;
  import org.millscript.millscript.expr.ApplyExpr;
  import org.millscript.millscript.expr.ConstantExpr;
  import org.millscript.millscript.expr.NameExpr;
  import org.millscript.millscript.expr.SkipExpr;
  import org.millscript.millscript.vm.CompilerState;
  import org.millscript.millscript.vm.Package;
  
  import junit.framework.Test;
  import junit.framework.TestSuite;
  
  /**
   * Unit test for Millscript autoloading system. This actually allows us to test
   * a large portion of the Millscript sub system. We cannot check the results of
   * autoloading if large portions of the language are not functioning.
   *
   * @author  <a href="mailto:moya@users.sourceforge.net">Kevin Rogers</a>
   */
  public class NameExprTest extends AbstractTestCase {
  
      /**
       * bug53 Package.
       */
      private Package bug53Package;
  
      /**
       * bug53a Package.
       */
      private Package bug53aPackage;
  
      /**
       * String used as the argument for millscript test functions
       */
      private static final ConstantExpr arg = new ConstantExpr( "argument" );
  
      /**
       * Create the test case
       *
       * @param   testName    name of the test case
       */
      public NameExprTest( String testName ) {
          super( testName );
      }
  
      /**
       * @return  the suite of tests being tested
       */
      public static Test suite() {
        return new TestSuite( NameExprTest.class );
      }
  
      /**
       * Initialize the test fixture. In this instance we require a machine with a
       * standard environment, from which we get the "bug53" and "bug53a" package
       * environments(i.e. we import it). We can then proceed with testing that
       * NameExpr, or at least NameExpr.shareIdent, works properly.
       */
      @Override
      public void setUp() {
  
          super.setUp();
  
          // We want to load packages from here..
          engine.addInventory( getResource( "test/millscript" ) );
  
          // Try to import the test packages
          bug53Package = engine.getPackage( "bug53" );
          bug53aPackage = engine.getPackage( "bug53a" );
  
          // Check the test packages were imported
          assertNotNull( bug53Package );
          assertNotNull( bug53aPackage );
  
      }
  
      /**
      * Clean up the test fixture by reseting the millscript machine.
      */
     @Override
     public void tearDown() {
         engine.getMachine().reset();
     }
 
     /**
      * Check that NameExpr is working properly by executing some statements from
      * both packages that are expected to return a true result.
      */
     public void testTrueStatements() {
 
         // Checks for package bug53
         try {
             CompilerState state = bug53Package.getCompilerState();
 
             Object result = state.compileExprToValue(
                 new ApplyExpr(
                     new NameExpr( "true_first" ),
                     arg
                 )
             );
 
             assertTrue( result instanceof Boolean );
             assertEquals( ((Boolean)result).booleanValue(), true );
 
             result = state.compileExprToValue(
                 new ApplyExpr(
                     new NameExpr( "true_second" ),
                     arg
                 )
             );
 
             assertTrue( result instanceof Boolean );
             assertEquals( ((Boolean)result).booleanValue(), true );
 
         } catch ( Exception ex ) {
             System.out.println( ex.getMessage() );
             System.out.println( ex );
         }
 
         // Checks for package bug53a
         try {
             CompilerState state = bug53aPackage.getCompilerState();
 
             Object result = state.compileExprToValue(
                 new ApplyExpr(
                     new NameExpr( "true_first" ),
                     arg
                 )
             );
 
             assertTrue( result instanceof Boolean );
             assertEquals( ((Boolean)result).booleanValue(), true );
 
             result = state.compileExprToValue(
                 new ApplyExpr(
                     new NameExpr( "true_second" ),
                     arg
                 )
             );
 
             assertTrue( result instanceof Boolean );
             assertEquals( ((Boolean)result).booleanValue(), true );
 
         } catch ( Exception ex ) {
             System.out.println( ex.getMessage() );
             System.out.println( ex );
         }
 
     }
 
     /**
      * Check that NameExpr is working properly by executing some statements from
      * both packages that are expected to return a false result.
      */
     public void testFalseStatements() {
 
         // Checks for package bug53
         try {
             CompilerState state = bug53Package.getCompilerState();
 
             Object result = state.compileExprToValue(
                 new ApplyExpr(
                     new NameExpr( "false_first" ),
                     arg
                 )
             );
 
             assertTrue( result instanceof Boolean );
             assertEquals( ((Boolean)result).booleanValue(), false );
 
         } catch ( Exception ex ) {
             System.out.println( ex.getMessage() );
             System.out.println( ex );
         }
 
         // Checks for package bug53a
         try {
             CompilerState state = bug53aPackage.getCompilerState();
 
             Object result = state.compileExprToValue(
                 new ApplyExpr(
                     new NameExpr( "false_first" ),
                     arg
                 )
             );
 
             assertTrue( result instanceof Boolean );
             assertEquals( ((Boolean)result).booleanValue(), false );
 
         } catch ( Exception ex ) {
             System.out.println( ex.getMessage() );
             System.out.println( ex );
         }
 
     }
 
     /**
      * Check that NameExpr is working properly by executing some statements from
      * both packages that are expected to cause the compiler to fail.
      */
     public void testCompilerFailures() {
 
         // Checks for package bug53
         try {
             CompilerState state = bug53Package.getCompilerState();
 
             state.compileExprToValue(
                 new ApplyExpr(
                     new NameExpr( "compiler_failure_first" ),
                     arg
                 )
             );
 
         } catch ( EscapeException ex ) {
             // Yippee! This actually means it worked...
         } catch ( Exception ex ) {
             System.out.println( ex.getMessage() );
             System.out.println( ex );
         }
 
         try {
             CompilerState state = bug53Package.getCompilerState();
 
             state.compileExprToValue(
                 new ApplyExpr(
                     new NameExpr( "compiler_failure_second" ),
                     arg
                 )
             );
 
         } catch ( EscapeException ex ) {
             // Yippee! This actually means it worked...
         } catch ( Exception ex ) {
             System.out.println( ex.getMessage() );
             System.out.println( ex );
         }
 
         // Checks for package bug53a
         try {
             CompilerState state = bug53aPackage.getCompilerState();
 
             state.compileExprToValue(
                 new ApplyExpr(
                     new NameExpr( "compiler_failure_first" ),
                     arg
                 )
             );
 
         } catch ( EscapeException ex ) {
             // Yippee! This actually means it worked...
         } catch ( Exception ex ) {
             System.out.println( ex.getMessage() );
             System.out.println( ex );
         }
 
     }
 
     /**
      * Check that NameExpr is working properly by executing some statements in
      * one package that assign to a variable in another package.
      */
     public void testAssignment() {
 
         // Checks for package bug53a
         try {
             CompilerState state = bug53aPackage.getCompilerState();
 
             state.compileExpr(
                 new ApplyExpr(
                     new NameExpr( "assign_first" ),
                     arg
                 )
             );
 
             // Change to the bug53 package, so that we can test bug53::foo.
             state.changePackage( bug53Package );
 
             // Get the value of bug53::foo
             Object result = state.compileExprToValue(
                 new NameExpr( "foo" )
             );
 
             // Check we got a String, which is equal to "ok"
             assertTrue( result instanceof String );
             assertEquals( "ok", (String)result );
 
             // Change back to the bug53a package, so we can continue testing.
             state.changePackage( bug53aPackage );
 
             // Now the for loop test
             state.compileExpr(
                 new ApplyExpr(
                     new NameExpr( "assign_second" ),
                     new SkipExpr()
                 )
             );
 
             // Change to the bug53 package, so that we can test bug53::foo.
             state.changePackage( bug53Package );
 
             // Get the value of bug53::foo
             result = state.compileExprToValue(
                 new NameExpr( "foo" )
             );
 
             // Check we got a String, which is equal to "ok"
             assertTrue( result instanceof String );
             assertEquals( "worked", (String)result );
 
         } catch ( Exception ex ) {
             System.out.println( ex.getMessage() );
             System.out.println( ex );
         }
 
     }
 
 }