Ant、Ivy 和 JUnit 找不到类 - build.xml 中的错误？

Posted 2023-03-24

【中文标题】Ant、Ivy 和 JUnit 找不到类 - build.xml 中的错误？

【英文标题】：Class not found with Ant, Ivy and JUnit - error in build.xml?

【发布时间】：2013-04-05 10:55:02

【问题描述】：

我正在尝试使用 Ant、Ivy 和 JUnit 构建一个简单的（？）测试项目。基本思路是，Ivy 会下载 junit.jar，然后 Ant 会使用它。

请注意，junit jar 位于类路径中，否则（在 junit 任务中没有 classpath 元素）我看到“ 的 必须包含 junit.jar，如果不在 Ant 自己的类路径中”。此外，下面给出的类 (junit.framework.TestListener) 在 junit-4.8.2.jar 中。

但是，当我在下面尝试 ant test 时，我看到了：

test:

BUILD FAILED
/home/andrew/project/guice/hg/build.xml:33: java.lang.NoClassDefFoundError: junit/framework/TestListener
        at java.lang.ClassLoader.defineClass1(Native Method)
        at java.lang.ClassLoader.defineClass(ClassLoader.java:791)
...
        at org.apache.tools.ant.launch.Launcher.run(Launcher.java:280)
        at org.apache.tools.ant.launch.Launcher.main(Launcher.java:109)
Caused by: java.lang.ClassNotFoundException: junit.framework.TestListener
        at java.net.URLClassLoader$1.run(URLClassLoader.java:366)
        at java.net.URLClassLoader$1.run(URLClassLoader.java:355)
...

所以我猜我的 build.xml 有问题？什么？

这里是 build.xml：

<project xmlns:ivy="antlib:org.apache.ivy.ant" 
         name="java-example" default="dist" basedir=".">

  <description>
    simple example build file
  </description>

  <property name="src" location="src"/>
  <property name="build" location="build"/>
  <property name="dist" location="dist"/>
  <property name="lib" location="lib"/>

  <path id="lib.path">
    <fileset dir="$lib"/>
  </path>

  <target name="init">
    <tstamp/>
    <mkdir dir="$build"/>
  </target>

  <target name="compile" depends="init,resolve"
          description="compile the source">
    <javac srcdir="$src" destdir="$build" classpathref="lib.path"
           includeantruntime="false">
      <compilerarg value="-Xlint"/>
    </javac>
  </target>

  <target name="test" depends="compile"
          description="run the tests">
    <junit>
      <classpath refid="lib.path"/>
      <batchtest>
        <fileset dir="$build">
          <include name="**/*Test.class"/>
        </fileset>
      </batchtest>
    </junit>
  </target>

  <target name="dist" depends="compile"
          description="generate the distribution">
    <mkdir dir="$dist/lib"/>
    <jar jarfile="$dist/lib/example-$DSTAMP.jar" basedir="$build"/>
  </target>

  <target name="clean"
          description="clean up">
    <delete dir="$build"/>
    <delete dir="$dist"/>
  </target>

  <target name="resolve"
          description="download required dependencies">
    <ivy:retrieve/>
  </target>

</project>

以及编译后的现有目录结构：

.
├── build
│   └── com
│       └── isti
│           └── example
│               ├── AppendToList.class
│               ├── DumpToStdout.class
│               ├── LimitedCounter.class
│               ├── MessageSink.class
│               ├── MessageSource.class
│               └── SinkToSourceTest.class
├── build.xml
├── dist
│   └── lib
│       └── example-20130412.jar
├── ivy.xml
├── lib
│   ├── junit-4.8.2.jar
│   ├── junit-4.8.2-javadoc.jar
│   └── junit-4.8.2-sources.jar
├── README.md
└── src
    ├── main
    │   └── java
    │       └── com
    │           └── isti
    │               └── example
    │                   ├── AppendToList.java
    │                   ├── DumpToStdout.java
    │                   ├── LimitedCounter.java
    │                   ├── MessageSink.java
    │                   └── MessageSource.java
    └── test
        └── java
            └── com
                └── isti
                    └── example
                        └── SinkToSourceTest.java

更新顺便说一句，ant -lib lib test（明确给出 lib 目录）有效。并且在随机网络搜索结果中有很多对此处理的混淆描述 - 但我的印象是上面的方法与latest docs一致（我使用的是ant 1.9） - 见第5点。所以我在想这个可能是bug； bug.

【参考方案1】：

示例

项目包含以下文件：

├── build.xml
├── ivy.xml
└── src
    ├── main
    │   ├── java
    │   │   └── org
    │   │       └── demo
    │   │           └── App.java
    │   └── resources
    │       └── log4j.properties
    └── test
        └── java
            └── org
                └── demo
                    └── AppTest.java

构建运行如下：

$ ant 
Buildfile: /home/mark/Files/Dev/ivy/demo/build.xml

resolve:
[ivy:resolve] :: Apache Ivy 2.3.0 - 20130110142753 :: http://ant.apache.org/ivy/ ::
[ivy:resolve] :: loading settings :: url = jar:file:/home/mark/.ant/lib/ivy.jar!/org/apache/ivy/core/settings/ivysettings.xml
[ivy:resolve] :: resolving dependencies :: com.myspotontheweb#demo;working@mark-Lemur-Ultra
[ivy:resolve]   confs: [compile, runtime, test]
[ivy:resolve]   found org.slf4j#slf4j-api;1.7.5 in public
[ivy:resolve]   found org.slf4j#slf4j-log4j12;1.7.5 in public
[ivy:resolve]   found log4j#log4j;1.2.17 in public
[ivy:resolve]   found junit#junit;4.11 in public
[ivy:resolve]   found org.hamcrest#hamcrest-core;1.3 in public
[ivy:resolve] :: resolution report :: resolve 347ms :: artifacts dl 14ms
    ---------------------------------------------------------------------
    |                  |            modules            ||   artifacts   |
    |       conf       | number| search|dwnlded|evicted|| number|dwnlded|
    ---------------------------------------------------------------------
    |      compile     |   1   |   0   |   0   |   0   ||   1   |   0   |
    |      runtime     |   3   |   0   |   0   |   0   ||   3   |   0   |
    |       test       |   5   |   0   |   0   |   0   ||   5   |   0   |
    ---------------------------------------------------------------------
[ivy:report] Processing /home/mark/.ivy2/cache/com.myspotontheweb-demo-compile.xml to /home/mark/Files/Dev/ivy/demo/build/ivy-reports/com.myspotontheweb-demo-compile.html
[ivy:report] Processing /home/mark/.ivy2/cache/com.myspotontheweb-demo-runtime.xml to /home/mark/Files/Dev/ivy/demo/build/ivy-reports/com.myspotontheweb-demo-runtime.html
[ivy:report] Processing /home/mark/.ivy2/cache/com.myspotontheweb-demo-test.xml to /home/mark/Files/Dev/ivy/demo/build/ivy-reports/com.myspotontheweb-demo-test.html

resources:
     [copy] Copying 1 file to /home/mark/Files/Dev/ivy/demo/build/classes

compile:
    [javac] Compiling 1 source file to /home/mark/Files/Dev/ivy/demo/build/classes

compile-tests:
    [mkdir] Created dir: /home/mark/Files/Dev/ivy/demo/build/test-classes
    [javac] Compiling 1 source file to /home/mark/Files/Dev/ivy/demo/build/test-classes

test:
    [mkdir] Created dir: /home/mark/Files/Dev/ivy/demo/build/test-reports
    [junit] Running org.demo.AppTest
    [junit] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 0.085 sec

build:
[ivy:retrieve] :: retrieving :: com.myspotontheweb#demo
[ivy:retrieve]  confs: [runtime]
[ivy:retrieve]  3 artifacts copied, 0 already retrieved (512kB/16ms)
      [jar] Building jar: /home/mark/Files/Dev/ivy/demo/build/dist/demo.jar

BUILD SUCCESSFUL
Total time: 4 seconds

ivy.xml

ivy 的一个非常强大的功能是configurations。这些允许您将依赖项组合在一起。

<ivy-module version="2.0">
    <info organisation="com.myspotontheweb" module="demo"/>

    <configurations>
        <conf name="compile" description="Required to compile application"/>
        <conf name="runtime" description="Additional run-time dependencies" extends="compile"/>
        <conf name="test"    description="Required for test only" extends="runtime"/>
    </configurations>

    <dependencies>
        <!-- compile dependencies -->
        <dependency org="org.slf4j" name="slf4j-api" rev="1.7.5" conf="compile->default"/>

        <!-- runtime dependencies -->
        <dependency org="org.slf4j" name="slf4j-log4j12" rev="1.7.5" conf="runtime->default"/>

        <!-- test dependencies -->
        <dependency org="junit" name="junit" rev="4.11" conf="test->default"/>
    </dependencies>

</ivy-module>

注意事项：

配置使用“扩展”功能来模拟 Maven“编译”、“运行时”和“测试”Maven 范围。 注意每个依赖项的特殊“conf”属性。这是从本地到远程的映射。有关 ivy 如何管理远程 Maven 模块的更多详细信息，请参阅：How are maven scopes mapped to ivy configurations by ivy

build.xml

cachepath（创建 ANT 路径）和retrieve（将文件复制到您的构建中）等任务可以利用 Ivy 配置。 我还建议使用report 目标，这样您就可以看到每个配置中出现了哪些jar（对管理传递依赖很有用）

<project name="demo" default="build" xmlns:ivy="antlib:org.apache.ivy.ant">

    <!--
    ================
    Build properties
    ================
    -->
    <property name="src.dir"          location="src/main/java"/>
    <property name="resources.dir"    location="src/main/resources"/>
    <property name="test.src.dir"     location="src/test/java"/>
    <property name="build.dir"        location="build"/>
    <property name="classes.dir"      location="$build.dir/classes"/>
    <property name="test.classes.dir" location="$build.dir/test-classes"/>
    <property name="ivy.reports.dir"  location="$build.dir/ivy-reports"/>
    <property name="test.reports.dir" location="$build.dir/test-reports"/>
    <property name="dist.dir"         location="$build.dir/dist"/>

    <property name="jar.main.class" value="org.demo.App"/>
    <property name="jar.file"       value="$dist.dir/$ant.project.name.jar"/>

    <available classname="org.apache.ivy.Main" property="ivy.installed"/>

    <!--
    ===========
    Build setup
    ===========
    -->
    <target name="install-ivy" description="Install ivy" unless="ivy.installed">
        <mkdir dir="$user.home/.ant/lib"/>
        <get dest="$user.home/.ant/lib/ivy.jar" src="http://search.maven.org/remotecontent?filepath=org/apache/ivy/ivy/2.3.0/ivy-2.3.0.jar"/>
        <fail message="Ivy has been installed. Run the build again"/>
    </target>

    <target name="resolve" depends="install-ivy" description="Use ivy to resolve classpaths">
        <ivy:resolve/>

        <ivy:report todir='$ivy.reports.dir' graph='false' xml='false'/>

        <ivy:cachepath pathid="compile.path" conf="compile"/>
        <ivy:cachepath pathid="test.path"    conf="test"/>
    </target>

    <!--
    ===============
    Compile targets
    ===============
    -->
    <target name="resources" description="Copy resources into classpath">
        <copy todir="$classes.dir">
            <fileset dir="$resources.dir"/>
        </copy>
    </target>

    <target name="compile" depends="resolve,resources" description="Compile code">
        <mkdir dir="$classes.dir"/>
        <javac srcdir="$src.dir" destdir="$classes.dir" includeantruntime="false" debug="true" classpathref="compile.path"/>
    </target>

    <target name="compile-tests" depends="compile" description="Compile tests">
        <mkdir dir="$test.classes.dir"/>
        <javac srcdir="$test.src.dir" destdir="$test.classes.dir" includeantruntime="false" debug="true">
            <classpath>
                <path refid="test.path"/>
                <pathelement path="$classes.dir"/>
            </classpath>
        </javac>
    </target>

    <!--
    ============
    Test targets
    ============
    -->
    <target name="test" depends="compile-tests" description="Run unit tests">
        <mkdir dir="$test.reports.dir"/>
        <junit printsummary="yes" haltonfailure="yes">
            <classpath>
                <path refid="test.path"/>
                <pathelement path="$classes.dir"/>
                <pathelement path="$test.classes.dir"/>
            </classpath>
            <formatter type="xml"/>
            <batchtest fork="yes" todir="$test.reports.dir">
                <fileset dir="$test.src.dir">
                    <include name="**/*Test*.java"/>
                    <exclude name="**/AllTests.java"/>
                </fileset>
            </batchtest>
        </junit>
    </target>

    <!--
    =====================
    Build and run targets
    =====================
    -->
    <target name="build" depends="test" description="Create executable jar archive">
        <ivy:retrieve pattern="$dist.dir/lib/[artifact]-[revision](-[classifier]).[ext]" conf="runtime"/>

        <manifestclasspath property="jar.classpath" jarfile="$jar.file">
            <classpath>
                <fileset dir="$dist.dir/lib" includes="*.jar"/>
            </classpath>
        </manifestclasspath>

        <jar destfile="$jar.file" basedir="$classes.dir">
            <manifest>
                <attribute name="Main-Class" value="$jar.main.class" />
                <attribute name="Class-Path" value="$jar.classpath" />
            </manifest>
        </jar>
    </target>

    <target name="run" depends="build" description="Run code">
        <java jar="$jar.file" fork="true"/>
    </target>

    <!--
    =============
    Clean targets
    =============
    -->
    <target name="clean" description="Cleanup build files">
        <delete dir="$build.dir"/>
    </target>

    <target name="clean-all" depends="clean" description="Additionally purge ivy cache">
        <ivy:cleancache/>
    </target>

</project>

注意：

有条件的“install-ivy”目标将自动安装 ivy。只需重新运行构建，只需执行一次。

App.java

Hello world 日志记录示例。

package org.demo;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Hello world!
 *
 */
public class App 
    static final Logger log = LoggerFactory.getLogger(App.class);

    public static void main( String[] args ) 
        App a = new App();
        a.speak("hello world");
    

    public void speak(String message) 
        log.info(message);
    

AppTest.java

这是我档案中的一个旧示例。不使用 Junit 断言。

ackage org.demo;

import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;

/**
 * Unit test for simple App.
 */
public class AppTest 
    extends TestCase

    /**
     * Create the test case
     *
     * @param testName name of the test case
     */
    public AppTest( String testName )
    
        super( testName );
    

    /**
     * @return the suite of tests being tested
     */
    public static Test suite()
    
        return new TestSuite( AppTest.class );
    

    /**
     * Rigourous Test :-)
     */
    public void testApp()
    
        assertTrue( true );
    

log4j.properties

# Set root logger level to DEBUG and its only appender to A1.
log4j.rootLogger=DEBUG, A1

# A1 is set to be a ConsoleAppender.
log4j.appender.A1=org.apache.log4j.ConsoleAppender

# A1 uses PatternLayout.
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r [%t] %-5p %c %x - %m%n

【讨论】：

谢谢；我花了一些时间来理解这一点，我仍然需要对其进行测试（当我这样做并发表评论和/或投票时会回来）。你知道为什么我没有工作吗？我可以看到这有什么不同（并且更好），但无法解释为什么我所做的事情是错误。

好的，这并不能修复上述错误。我仍然得到类未找到错误。临时修复是在引导目标中包含 junit jar。但这会重复信息。

@andrewcooke 修订示例。

@andrewcooke 您使用的是哪个版本的 ANT？上例使用 ant 1.8.2

我使用的是 1.9.0。你确定你没有在 ant/lib 或类似文件中安装 junit jar 吗？不确定我是否解释得足够清楚，以至于我试图让它在没有它的情况下工作（根据我链接到的说明应该是可能的）。感谢您的更新-不确定它如何解决我的问题，但我想我可以尝试一下，如果有效，请慢慢减少它，直到我回到问题为止。