使用ant与库项目的Android单元测试

时间:2011-12-21 19:08:44

标签: android unit-testing android-testing

似乎最新的Android SDK工具仍然不能正确支持包含链接库项目的应用程序的测试。

我有一个具有以下设置的项目:

TestLib(android库项目)< - TestMain(android项目)< - TestMainTest(android单元测试项目)

我在eclipse中创建了所有这些项目,然后使用android update (test-/lib-)project ...生成build.xml et。人

只要在TestMain中有一个类(我的示例中为InheritAddition.java)继承自TestLib(Addition.java)中的类并且您想在单元测试中引用此类,问题就会开始(InheritAdditionTest.java)。

TESTLIB

public class Addition {
    public int add2(int o1, int o2) {
      return o1 + o2;
    }
}

TestMain

public class InheritAddition extends Addition {
    public int sub(int p1, int p2) {
        return p1 - p2;
    }
}

TestMainTest

public class InheritAdditionTest extends AndroidTestCase {
    public void testSub() {
        Assert.assertEquals(2, new InheritAddition().sub(3, 1));
    }
}

在命令行上构建时,结果如下:

W/ClassPathPackageInfoSource(14871): Caused by: java.lang.NoClassDefFoundError: org/test/main/InheritAddition
W/ClassPathPackageInfoSource(14871):    ... 26 more
W/ClassPathPackageInfoSource(14871): Caused by: java.lang.IllegalAccessError: Class ref in pre-verified class resolved to unexpected implementation
W/ClassPathPackageInfoSource(14871):    at dalvik.system.DexFile.defineClass(Native Method)
W/ClassPathPackageInfoSource(14871):    at dalvik.system.DexFile.loadClassBinaryName(DexFile.java:195)
W/ClassPathPackageInfoSource(14871):    at dalvik.system.DexPathList.findClass(DexPathList.java:315)
W/ClassPathPackageInfoSource(14871):    at dalvik.system.BaseDexClassLoader.findClass(BaseDexClassLoader.java:58)
W/ClassPathPackageInfoSource(14871):    at java.lang.ClassLoader.loadClass(ClassLoader.java:501)
W/ClassPathPackageInfoSource(14871):    at java.lang.ClassLoader.loadClass(ClassLoader.java:461)
W/ClassPathPackageInfoSource(14871):    ... 26 more
W/dalvikvm(14871): Class resolved by unexpected DEX: Lorg/test/main/InheritAddition;(0x41356250):0x13772e0 ref [Lorg/test/lib/Addition;] Lorg/test/lib/Addition;(0x41356250):0x13ba910

我发现了一些适用于eclipse的解决方法:

Can't build and run an android test project created using "ant create test-project" when tested project has jars in libs directory

这就是诀窍,但我正在寻找一种适用于ANT的解决方案(更准确地说,我正在寻找一种同时兼有的解决方案)。

文档化的方法(通过将build.xml更改为将主项目中的jar包括到类路径中)在这里不适用,因为示例项目不使用任何库jar(我也相信这个特定的问题现在已经修复)使用SDK工具r16)。

我认为解决这个问题的蛮力方法是尝试以某种方式删除TestMainTestTestLib的依赖关系(通过修改project.properties),而是设法破解构建脚本将这些构建的jar放入类路径中(因此将-compile目标替换为修改javac的类路径的内容。由于我有很长的历史,试图跟上android SDK工具链的变化,这不是我最喜欢的选项,因为它是a)相当复杂,b)需要在工具链发生变化时不断修改build.xml(很频繁。)

所以我正在寻找如何在不使用大锤的情况下使这种设置工作的想法。也许我错过了一些完全显而易见的东西,但对我而言,这个用例是相当标准的,我很难理解为什么开箱即用不支持。

3 个答案:

答案 0 :(得分:9)

使用Android SDK工具r15和Eclipse。

假设您在eclipse中创建了三个项目:Lib(android库项目)< - App(android应用程序项目)< - Test(android单元测试项目)并定义以下类:

[库]

public class A {}

[应用]

public class A extends B {}

[测试]

public class MyUnitTest extends AndroidTestCase {
    public void test() {
        new A();
        new B();
    }
}

在此设置中,TestMain将TestLib引用为Android库,TestMainTest具有对TestMain的项目引用。

您应该看到Test无法编译,因为A无法解析。这是预期的,因为Test没有对Lib的可见性。一种解决方案是从Test到Lib添加库引用。虽然这解决了编译问题,但它在运行时中断。会产生一堆错误,但这很有趣:

W/dalvikvm( 9275): Class resolved by unexpected DEX: Lcom/example/B;(0x40513450):0x294c70 ref [Lcom/example/A;] Lcom/example/A;(0x40513450):0x8f600
W/dalvikvm( 9275): (Lcom/example/B; had used a different Lcom/example/A; during pre-verification)
W/dalvikvm( 9275): Unable to resolve superclass of Lcom/example/B; (1)
W/dalvikvm( 9275): Link of class 'Lcom/example/B;' failed
E/dalvikvm( 9275): Could not find class 'com.example.B', referenced from method com.example.test.MyUnitTest.test
W/dalvikvm( 9275): VFY: unable to resolve new-instance 3 (Lcom/example/B;) in Lcom/example/test/MyUnitTest;
D/dalvikvm( 9275): VFY: replacing opcode 0x22 at 0x0000
D/dalvikvm( 9275): VFY: dead code 0x0002-000a in Lcom/example/test/MyUnitTest;.test ()V

这是因为Test和App项目都引用了Lib库项目,因此两个生成的apks都包含com.example.A的副本。

不要在eclipse中将显式依赖项从测试项目添加到库项目(如果该库是受测试的应用程序项目的依赖项)。这样做会导致应用程序和测试项目在其生成的apks中包含相同类的副本,并且测试将在运行时失败。

我们需要找到解决编译时可见性问题的方法。在运行时,Test将可以看到App,因此可以看到Lib中的类。而不是从Test到Lib创建库引用,更新App的构建路径以导出它的库项目。现在测试编译并且单元测试成功运行。

在Eclipse中,要测试引用库项目的应用程序项目,请从应用程序项目的构建路径设置中导出库项目。

现在一切都在Eclipse中运行,但是关于Ant?使用android update [lib- | test-]项目命令创建必要的build.xml文件。确保在所有三个目录中运行Ant clean:Lib,App和Test。未能清理所有三个项目可能会导致编译成功。

Ant编译将失败:

[javac] ...Test/src/com/example/test/MyUnitTest.java:3: cannot find symbol
[javac] symbol  : class A
[javac] location: package com.example
[javac] import com.example.A;
[javac]                   ^
[javac] ...Test/src/com/example/test/MyUnitTest.java:10: cannot access com.example.A
[javac] class file for com.example.A not found
[javac]         new B();
[javac]         ^
[javac] ...Test/src/com/example/test/MyUnitTest.java:11: cannot find symbol
[javac] symbol  : class A
[javac] location: class com.example.test.MyUnitTest
[javac]         new A();
[javac]             ^
[javac] 3 errors

为什么在Eclipse构建成功时Ant构建失败? Eclipse和Ant构建系统是截然不同的。从Eclipse中的App导出库项目对Ant构建没有影响。构建失败,因为Test项目没有对Lib项目的可见性。如果我们尝试通过向Test / project.properties添加android.library.refernce属性来解决这个问题,那么我们就完成了与在Eclipse中从Test添加库引用完全相同的事情。 Ant构建会成功,但测试会在运行时因熟悉的“由意外DEX解析的类”错误而失败。

我们需要一种方法让测试项目针对库项目进行编译,但不要在dexing过程中包含它。这个过程有两个步骤。首先,包括一个不影响Eclipse的Test to Lib引用。其次,更新Ant构建系统,以便编译库,但不包括在dexing中。

在Test / build.xml的顶部,我定义了一个指向库的属性。这类似于添加对Test / project.properties的引用,但Eclipse不会看到它:

现在我们需要从dexing过程中排除库jar。这需要更新dex-helper宏。我将宏覆盖放在Test / build.xml文件中的行之后。新的dex-helper从dexing进程中排除了不在Test项目文件夹树中的所有jar文件:

<macrodef name="dex-helper">
  <element name="external-libs" optional="yes"/>
  <attribute name="nolocals" default="false"/>
  <sequential>
    <!-- sets the primary input for dex. If a pre-dex task sets it to
                 something else this has no effect -->
    <property name="out.dex.input.absolute.dir" value="${out.classes.absolute.dir}"/>
    <!-- set the secondary dx input: the project (and library) jar files
                 If a pre-dex task sets it to something else this has no effect -->
    <if>
      <condition>
        <isreference refid="out.dex.jar.input.ref"/>
      </condition>
      <else>
        <!--
                        out.dex.jar.input.ref is not set. Compile the list of jars to dex.
                        For test projects, only dex jar files included in the project
                        path
                    -->
        <if condition="${project.is.test}">
          <then>
            <!-- test project -->
            <pathconvert pathsep="," refid="jar.libs.ref" property="jars_to_dex_pattern"/>
            <path id="out.dex.jar.input.ref">
              <files includes="${jars_to_dex_pattern}">
                <!-- only include jar files actually in the test project -->
                <filename name="${basedir}/**/*"/>
              </files>
            </path>
            <property name="in_jars_to_dex" refid="jar.libs.ref"/>
            <property name="out_jars_to_dex" refid="out.dex.jar.input.ref"/>
            <echo message="Test project! Reducing jars to dex from ${in_jars_to_dex} to ${out_jars_to_dex}."/>
          </then>
          <else>
            <path id="out.dex.jar.input.ref"/>
          </else>
        </if>
      </else>
    </if>
    <dex executable="${dx}" output="${intermediate.dex.file}" nolocals="@{nolocals}" verbose="${verbose}">
      <path path="${out.dex.input.absolute.dir}"/>
      <path refid="out.dex.jar.input.ref"/>
      <external-libs/>
    </dex>
  </sequential>
</macrodef>

通过这些更改,Test可以构建并运行Eclipse和Ant。

快乐测试!

其他说明: 如果事情没有在Eclipse中构建并且您认为它们应该存在,请尝试按以下顺序刷新项目:Lib,App,Test。在进行构建路径更改后,我经常需要这样做。我有时也必须建立干净的东西才能正常工作。

答案 1 :(得分:4)

@ wallacen60的答案很好。我昨天得出了同样的结论。尽管如此,还有另外一种选择:如果我们能找到一种方法将lib的jar包含在编译(javac,ant文件的编译阶段)中,而不是将lib的jar从测试项目的dexing中排除,那将是很好的。测试,只在编译阶段,而不是dexing阶段。

@ wallacen60的解决方案还引入了3项目及其依赖项的编译之间的巨大语义差异:在Eclipse App中依赖于lib,测试依赖于App。这是正确的方法。但是在蚂蚁中,App和Test都依赖于Lib,对我来说似乎是一个糟糕的冗余循环。

所以,就目前而言,我们所做的是修补测试项目的project.properties文件,使其包含以下行:

tested.android.library.reference.1=../SDK_android

我们修改了测试项目的ant文件,以便编译目标包含库:(查看更改的行,搜索“更改”一词)。

    <!-- override "compile" target in platform android_rules.xml to include tested app's external libraries -->
<!-- Compiles this project's .java files into .class files. -->
<target name="-compile" depends="-build-setup, -pre-build, -code-gen, -pre-compile">
    <do-only-if-manifest-hasCode elseText="hasCode = false. Skipping...">
        <!-- If android rules are used for a test project, its classpath should include
             tested project's location -->
        <condition property="extensible.classpath"
                value="${tested.project.absolute.dir}/bin/classes"
                else=".">
            <isset property="tested.project.absolute.dir" />
        </condition>
        <condition property="extensible.libs.classpath"
                value="${tested.project.absolute.dir}/${jar.libs.dir}"
                else="${jar.libs.dir}">
            <isset property="tested.project.absolute.dir" />
        </condition>
        <echo message="jar libs dir : ${tested.project.target.project.libraries.jars}"/>
        <javac encoding="${java.encoding}"
                source="${java.source}" target="${java.target}"
                debug="true" extdirs="" includeantruntime="false"
                destdir="${out.classes.absolute.dir}"
                bootclasspathref="android.target.classpath"
                verbose="${verbose}"
                classpath="${extensible.classpath}"
                classpathref="jar.libs.ref">
            <src path="${source.absolute.dir}" />
            <src path="${gen.absolute.dir}" />
            <classpath>
                <!-- steff: we changed one line here !-->
                <fileset dir="${tested.android.library.reference.1}/bin/" includes="*.jar"/>
                <fileset dir="${extensible.libs.classpath}" includes="*.jar" />
            </classpath>
            <compilerarg line="${java.compilerargs}" />
        </javac>
               <!-- if the project is instrumented, intrument the classes -->
                        <if condition="${build.is.instrumented}">
                            <then>
                                <echo>Instrumenting classes from ${out.absolute.dir}/classes...</echo>
                                <!-- It only instruments class files, not any external libs -->
                                <emma enabled="true">
                                    <instr verbosity="${verbosity}"
                                           mode="overwrite"
                                           instrpath="${out.absolute.dir}/classes"
                                           outdir="${out.absolute.dir}/classes">
                                    </instr>
                                    <!-- TODO: exclusion filters on R*.class and allowing custom exclusion from
                                         user defined file -->
                                </emma>
                            </then>
                        </if>           
    </do-only-if-manifest-hasCode>
</target>

事实上,这种机制似乎是正确的,因为它模仿了日食的作用。但是eclipse能够知道应用程序在编译测试时依赖于lib。唯一的区别是我们通过线路(在project.properties中)手动暴露这种关系

tested.android.library.reference.1=../SDK_android

但是可以自动完成。我找不到google ant工具用来从project.properties中的android.library。*语句生成librairy项目路径refid的机制。但是,如果我能找到这种机制,我可以在测试项目中传播这种依赖,就像eclipse那样。

所以我认为最好让google知道他们有一个补丁要做,并暂时保留手动导出应用程序项目对lib项目的依赖关系的解决方案,以便编译测试项目。

有人可以联系谷歌了解这个错误吗?

答案 2 :(得分:-1)

这里发布的答案有点令人费解。我不确定最近是否改变了但是在r15中,可以简单地将以下行添加到他们的project.properties中,一切都将构建。您无需修改​​任何构建脚本。

android.library.reference.1=../lib_project

我猜它不是递归地查找库项目,所以如果你在你正在测试的项目中引用它,你只需要在你的测试项目中引用它。