path: root/test/src/net/sf/antcontrib/design/VerifyDesignTest.java

/*
 * Copyright (c) 2001-2005 Ant-Contrib project.  All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.sf.antcontrib.design;

import java.io.File;

import junit.framework.TestSuite;
import junit.textui.TestRunner;

import org.apache.tools.ant.BuildFileTest;
import org.apache.tools.ant.util.JavaEnvUtils;

/**
 * BIG NOTE***************************************************
 * Always expect specific exceptions.  Most of these test cases when
 * first submitted were not and therefore were not testing what they said
 * they were testing.  Exceptions were being caused by other things and the
 * tests were still passing.  Now all tests expect a specific exception
 * so if any other is thrown we will fail the test case.
 * ************************************************************
 * 
 * Testcase for <propertycopy>.
 */
public class VerifyDesignTest extends BuildFileTest {

	private final static String REASON = "Build should have failed with proper message and did not";
    private String baseDir = "test"+File.separator
        +"resources"+File.separator
        +"design"+File.separator;
    private String c = File.separator;
    
    public VerifyDesignTest(String name) {
        super(name);
    }
    
    public void setUp() {    
   
        configureProject("test/resources/design/verifydesign.xml");
//        project.log("ASFDSADF", Project.MSG_INFO);
    }
    
    private static String s = "";
    
    public static void log(String msg) {
        s += msg+"\n";
    }
    
    public void tearDown() {
        executeTarget("cleanup");

        //System.out.println("test log=\n"+s);
    }

    public void testArrayDepend() {
        String class1 = "mod.arraydepend.ClassDependsOnArray";
        String class2 = "mod.dummy.DummyClass";
        expectDesignCheckFailure("testArrayDepend", Design.getErrorMessage(class1, class2));
    }

    public void testArrayDepend2() {
        executeTarget("testArrayDepend2");
    }
    
    public void testArrayDepend3() {
        String class1 = "mod.arraydepend3.ClassDependsOnArray";
        //
        //  The trailing semi-colon makes the test pass,
        //      but likely reflects a problem in the VerifyDesign task
        //
        String class2 = "mod.dummy.DummyClass;";
        expectDesignCheckFailure("testArrayDepend3", Design.getErrorMessage(class1, class2));
    }
    
    public void testBadXML() {
    	File designFile = new File("test/resources/design/designfiles/badxml.xml");
        String msg = "\nProblem parsing design file='"
			+ designFile.getAbsolutePath() + "'.  \nline=3 column=1 Reason:\nElement type \"design\" must be followed by either attribute specifications, \">\" or \"/>\".\n";
        expectSpecificBuildException("testBadXML", REASON, msg);    	
    }
    
    public void testCastDepend() {
        String class1 = "mod.castdepend.ClassDependsOnCast";
        String class2 = "mod.dummy.DummyInterface";
        expectDesignCheckFailure("testCastDepend", Design.getErrorMessage(class1, class2));
    }
    
    public void testCatchDepend() {
        String class1 = "mod.catchdepend.ClassDependsOnCatch";
        String class2 = "mod.dummy.DummyRuntimeException";
        expectDesignCheckFailure("testCatchDepend", Design.getErrorMessage(class1, class2));
    }
    
    public void testClassFiles() {
    	String class1 = "mod.castdepend.ClassDependsOnCast";
    	String class2 = "mod.dummy.DummyInterface";
    	expectDesignCheckFailure("testClassFiles", Design.getErrorMessage(class1, class2));
    }
    
    public void testDeclareJavaUtil() {
        executeTarget("testDeclareJavaUtil");
    }

    public void testDeclareJavaUtilFail() {
        String class1 = "mod.declarejavautil.ClassDependsOnJavaUtil";
        String class2 = "java.util.List";
        expectDesignCheckFailure("testDeclareJavaUtilFail", Design.getErrorMessage(class1, class2));
    }
    
    public void testDeclareJavax() {
        String class1 = "mod.declarejavax.ClassDependsOnJavax";
        String class2 = "javax.swing.JButton";
        expectDesignCheckFailure("testDeclareJavax", Design.getErrorMessage(class1, class2));
    }
    
    public void testDeclareJavaxPass() {
        executeTarget("testDeclareJavaxPass");
    }
    
    
    //tests to write

    //depend on java.util should pass by default
    //depend on java.util should fail after defining needDeclareTrue
    //depend on javax.swing should pass after needDeclareFalse
    
    //depend on dummy should pass after needDeclareFalse
    
    public void testFieldDepend() {
        String class1 = "mod.fielddepend.ClassDependsOnField";
        String class2 = "mod.dummy.DummyClass";
        expectDesignCheckFailure("testFieldDepend", Design.getErrorMessage(class1, class2));
    }

    public void testFieldRefDepend() {
        if (JavaEnvUtils.isJavaVersion(JavaEnvUtils.JAVA_1_1)
            || JavaEnvUtils.isJavaVersion(JavaEnvUtils.JAVA_1_2)
            || JavaEnvUtils.isJavaVersion(JavaEnvUtils.JAVA_1_3)) {
            return;
        }
        
        String class1 = "mod.fieldrefdepend.ClassDependsOnReferenceInFieldDeclaration";
        String class2 = "mod.dummy.DummyClass";
        expectDesignCheckFailure("testFieldRefDepend", Design.getErrorMessage(class1, class2));
    }

    public void testInnerClassDepend() {
        String class1 = "mod.innerclassdepend.InnerClassDependsOnSuper$Inner";
        String class2 = "mod.dummy.DummyClass";
        expectDesignCheckFailure("testInnerClassDepend", Design.getErrorMessage(class1, class2));
    }

    public void testInstanceOfDepend() {
        String class1 = "mod.instanceofdepend.ClassDependsOnInstanceOf";
        String class2 = "mod.dummy.DummyInterface";
        expectDesignCheckFailure("testInstanceOfDepend", Design.getErrorMessage(class1, class2));
    } 
    
    public void testInterfaceDepend() {
        String class1 = "mod.interfacedepend.ClassDependsOnInterfaceMod2";
        String class2 = "mod.dummy.DummyInterface";
        expectDesignCheckFailure("testInterfaceDepend", Design.getErrorMessage(class1, class2));
    } 
    
    public void testLocalVarDepend() {
        String class1 = "mod.localvardepend.ClassDependsOnLocalVar";
        String class2 = "mod.dummy.DummyClass";
        expectDesignCheckFailure("testLocalVarDepend", Design.getErrorMessage(class1, class2));
    }   

    public void testLocalVarRefDepend() {
        if (JavaEnvUtils.isJavaVersion(JavaEnvUtils.JAVA_1_1)
            || JavaEnvUtils.isJavaVersion(JavaEnvUtils.JAVA_1_2)
            || JavaEnvUtils.isJavaVersion(JavaEnvUtils.JAVA_1_3)) {
            return;
        }
        String class1 = "mod.localvarrefdepend.ClassDependsOnLocalVariableReference";
        String class2 = "mod.dummy.DummyInterface";
        expectDesignCheckFailure("testLocalVarRefDepend", Design.getErrorMessage(class1, class2));
    }  
    
    public void testMissingAttribute() {
    	File designFile = new File("test/resources/design/designfiles/missingattribute.xml");
        String msg = "\nProblem parsing design file='"
			+ designFile.getAbsolutePath() + "'.  \nline=3 column=31 Reason:\nError in file="
			+ designFile.getAbsolutePath() + ", package element must contain the 'name' attribute\n";
        expectSpecificBuildException("testMissingAttribute", REASON, msg); 
    }
    
    public void testMultipleErrors() {
    	File jarFile = new File(baseDir+File.separator+"build"+File.separator+"jar"
		    +File.separator+"test.jar");
        String class1 = "mod.arraydepend.ClassDependsOnArray";
        String class2 = "mod.dummy.DummyClass";
        //executeTarget("testMultipleErrors");
        String error1 = Design.getWrapperMsg(jarFile, Design.getErrorMessage(class1, class2));
        class1 = "mod.castdepend.ClassDependsOnCast";
        String error2 = Design.getWrapperMsg(jarFile, Design.getNoDefinitionError(class1));
        class1 = "mod.catchdepend.ClassDependsOnCatch";
        class2 = "mod.dummy.DummyRuntimeException";
        String error3 = Design.getWrapperMsg(jarFile, Design.getErrorMessage(class1, class2));
        String s = "\nEvaluating package=mod.arraydepend"+error1;
        s += "\nEvaluating package=mod.castdepend"+error2;
        s += "\nEvaluating package=mod.catchdepend"+error3;
        s += "\nEvaluating package=mod.dummy";
        
//        executeTarget("testMultipleErrors");
        expectDesignCheckFailure("testMultipleErrors", s);
    }
    
    public void testNewDepend() {
        String class1 = "mod.newdepend.ClassDependsOnNew";
        String class2 = "mod.dummy.DummyClass";
        expectDesignCheckFailure("testNewDepend", Design.getErrorMessage(class1, class2));
    }  
    
    public void testNewDepend2() {
        String class1 = "mod.newdepend2.ClassDependsOnNewInField";
        String class2 = "mod.dummy.DummyClass";
        expectDesignCheckFailure("testNewDepend2", Design.getErrorMessage(class1, class2));
    }  
    
    public void testNoDebugOption() {
        String class1 = "mod.nodebugoption.ClassDependsOnLocalVar";
        expectDesignCheckFailure("testNoDebugOption", VisitorImpl.getNoDebugMsg(class1));
    } 
    public void testNoJar() {
    	File jar = new File("test/resources/design/build/jar/test.jar");
        expectSpecificBuildException("testNoJar", REASON, VisitorImpl.getNoFileMsg(jar));
    }
    
    public void testParamDepend() {
        String class1 = "mod.paramdepend.ClassDependsOnParameter";
        String class2 = "mod.dummy.DummyClass";
        expectDesignCheckFailure("testParamDepend", Design.getErrorMessage(class1, class2));
    }  
    
    public void testPassLocalDepend() {
        executeTarget("testPassLocalDepend");
    }
    
    public void testPathElementLocation() {
    	executeTarget("testPathElementLocation");
    }
    
    public void testPathElementPath() {
    	executeTarget("testPathElementPath");
    }
    
    public void testPutStatic() {
    	executeTarget("testPutStatic");
    }
    
    public void testRecursion() {
        executeTarget("testRecursion");         
    }

    public void testRecursion2() {
        executeTarget("testRecursion2");        
    }

    public void testRecursion3() {
        executeTarget("testRecursion3");
    }
    
    public void testReturnValDepend() {
        String class1 = "mod.returnvaldepend.ClassDependsOnReturnValue";
        String class2 = "mod.dummy.DummyInterface";
        expectDesignCheckFailure("testReturnValDepend", Design.getErrorMessage(class1, class2));
    }  
    
    public void testSignatureExceptionDepend() {
        String class1 = "mod.signatureexceptiondepend.ClassDependsOnExceptionInMethodSignature";
        String class2 = "mod.dummy.DummyException";
        expectDesignCheckFailure("testSignatureExceptionDepend", Design.getErrorMessage(class1, class2));
    }  

    public void testStaticDepend() {
        String class1 = "mod.staticdepend.ClassDependsOnStatic";
        String class2 = "mod.dummy.DummyClass";
        expectDesignCheckFailure("testStaticDepend", Design.getErrorMessage(class1, class2));
    }    

    public void testStaticField2Depend() {
        String class1 = "mod.staticfield2depend.ClassDependsOnStaticField";
        String class2 = "mod.dummy.DummyClass";
        expectDesignCheckFailure("testStaticField2Depend", Design.getErrorMessage(class1, class2));
    }
    
    public void testStaticFieldDepend() {       
        String class1 = "mod.staticfielddepend.ClassDependsOnStaticField";
        String class2 = "mod.dummy.DummyClass";
        expectDesignCheckFailure("testStaticFieldDepend", Design.getErrorMessage(class1, class2));
    }    

    public void testStaticFinalDepend() {
        //This is an impossible test since javac compiles String and primitive constants into the code
        //losing any reference to the class that contains the constant...In this one instance,
        //verifydesign can't verify that constant imports don't violate the design!!!!
        //check out mod.staticfinaldepend.ClassDependsOnStaticField to see the code
        //that will pass the design even if it is violating it.         
        //      String class1 = "mod.staticfinaldepend.ClassDependsOnConstant";
        //      String class2 = "mod.dummy.DummyClass";
        //      expectDesignCheckFailure("testStaticFinalDepend", Design.getErrorMessage(class1, class2));
    }
    
    public void testSuperDepend() {
        String s = File.separator;
        File f = new File("test"+s+"resources"+s+"design"+s+"build"+s+"jar"+s+"test.jar");
        
        //      executeTarget("testSuperDepend");
        String class1 = "mod.superdepend.ClassDependsOnSuperMod2";
        String class2 = "mod.dummy.DummyClass";
        expectDesignCheckFailure("testSuperDepend", Design.getErrorMessage(class1, class2));
        
        //jar file should have been deleted
        assertTrue("jar file should not exist yet still does", !f.exists());
    }
    
    public void testWarSuccess() {
    	executeTarget("testWarSuccess");
    }
    
    public void testWarFailure() {
        String class1 = "mod.warfailure.ClassDependsOnSuperMod2";
        String class2 = "mod.dummy.DummyClass";
        expectDesignCheckFailure("testWarFailure", Design.getErrorMessage(class1, class2));
    }
    
    public static void main(String[] args) {
        TestSuite suite = new TestSuite();
        suite.addTest(new VerifyDesignTest("testArrayDepend2"));
        TestRunner.run(suite);
    }

    private void expectDesignCheckFailure(String target, String message) {
        expectSpecificBuildException(target, "Design is broken",
                                     "Design check failed due to previous "
                                     + "errors");
        assertLogContaining(message);
    }
}