We can use @testcase to write test case for java methods and generate them to one excel and html.

Why write this tool

In traditional test process, we are familiar with writing test cases in excel at first and then to implement the test cases’ automation one by one. At last,we add the java doc to every test method.

The problem is that when we change the test cases in excel we should found where is the related test scripts and located the code and change the test case java doc description to keep same.

On the other hand, for coder, they may like to write the test code as first and write test case in excel at later time.Maybe somebody doesn’t like any doc. So the tool can help them to generate the test cases in excel by automation.

Also the tool can provide the html style test case so that it can be integrated with Jenkins. Having it, you can check the daily run test cases in Jenkins and from the cases description you also can locate the position easier.

Requirements

1.maven project

How to use it

step 1: configure pom.xml

add followed two configure parts:dependency and plugin into pom.xml: note: the dependency’s last version can check the maven central:http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.googlecode.testcase-annotation%22

ALERT pls use the latest version.

<dependency>
    <groupid>com.googlecode.testcase-annotation</groupid>
    <artifactid>testcase-annotation</artifactid>
    <version>1.1.1</version></dependency>

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>apt-maven-plugin</artifactId>
    <version>1.0-alpha-5</version>
    <configuration>   
        <factory>
        com.googlecode.testcase.annotation.AnnotationProcessFactoryImpl
        </factory>
    </configuration></plugin>

step 2: use `@TestCase` in your code

publicclassNewTest{


        @TestCase(
                        module="module one",
                        id =1,
                        title ="case title 1",
                        preConditions={"condition"},
                        steps ={
                                "case step one",
                                "case step two"
                                },
                        results ={
                                "case result one",
                                "case result two"
                                  }
                 )
        @Test
        publicvoidYourTestMethod(){

        }
        
}

step 3: generate excel and html(with excel content)

execute: mvn apt:process or apt:test-process

the goals can refer to :http://mojo.codehaus.org/apt-maven-plugin/plugin-info.html

output excel’s dir: it is decided to outputDirectory configure by default: http://mojo.codehaus.org/apt-maven-plugin/process-mojo.html#outputDirectory

for apt:process, the output dir is targetgenerated-resourcesapt

for apt:test-process, the output dir is targetgenerated-test-sourcesapt

More use examples

Use 1: How to generate office 03xls excel file instead of 07xlsx’s?

add option: excelType=xls

<configuration><factory>
com.googlecode.testcase.annotation.AnnotationProcessFactoryImpl</factory><options>
    <option>excelType=xls</option></options></configuration>

Use 2: How to change the excel’s name instead of `TestCase_Date.xlsx?`

the excel file’s name is TestCase_Date.xlsx format. if you want to change it, you can:

add option: excelType=xls

<configuration><factory>
com.googlecode.testcase.annotation.AnnotationProcessFactoryImpl
</factory><options>
    <option>fileName=customizedName.xlsx</option></options></configuration>

Use 3: How to change the excel’s output dir instead of using outputdirectory ?

add configure: outputdirectory:

<configuration><factory>
com.googlecode.testcase.annotation.AnnotationProcessFactoryImpl
</factory><outputdirectory>C:aptDir</outputdirectory></configuration>

Use 4: How to bind to other maven lifecycle phrase?

if want to bind to test,add the executions to maven apt plugin:

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>apt-maven-plugin</artifactId>
    <version>1.0-alpha-5</version>
    <configuration>                                      
    <factory>
    com.googlecode.testcase.annotation.AnnotationProcessFactoryImpl
    </factory>    
    </configuration>
    <executions>
        <execution>
            <phase>test</phase>
            <goals>
                <goal>process</goal>
                <goal>test-process</goal>
           </goals>
        </execution>
    </executions></plugin>

and run mvn test can trigger both process and test-process for maven apt

Use 5: How to integrated with Jenkins?

1. set the output file to fixed name: can refer to <use 2> add set the option forceCreateFile to create file no matter is there any cases created so that the html publish plugin not to report build fail when no cases existed.

 <option>forceCreateFile=true</option>

whole configure:

<configuration><factory>
com.googlecode.testcase.annotation.AnnotationProcessFactoryImpl
</factory><options>
    <option>fileName=customizedName.xlsx</option>
    <option>forceCreateFile=true</option></options></configuration>

2. configure the jenkins’ job with html publish plugin

the result is similar with:

FAQ

Problem 1: `java.lang.NoClassDefFoundError: org/apache/poi/ss/formula/udf/IndexedUDFFinder`

the root cause is that:

the tool use 3.10’s poi dependency version, but if your pom.xml had existed lower verison for it which not supported IndexedUDFFinder, it will popup the error.

the solution is to remove the dependency for the lower’s version’s. for jar dependency can use exclude configure such as followed configure:

<dependency>
  <groupId>com.googlecode.server-test-toolkit</groupId>
  <artifactId>server-test-toolkit</artifactId>
  <version>1.0</version>
  <type>jar</type>
  <scope>compile</scope>
  <exclusions>
    <exclusion>
        <artifactId>poi</artifactId>
        <groupId>org.apache.poi</groupId>
    </exclusion>
  </exclusions></dependency>

Problem 2: how to format the annotation to good style

change the eclipse’s formmater:

->windows->preferences->java->code style->formmater ->Line Wrapping

Problem 3: jenkins: html publish plugin report build fail when no any cases existed

set the option to force creating file so that it can avoid copy fail.

<configuration><factory>
com.googlecode.testcase.annotation.AnnotationProcessFactoryImpl
</factory><options>
    <option>fileName=customizedName.xlsx</option>
    <option>forceCreateFile=true</option></options></configuration>

Problem 4: error: annotations are not supported in -source 1.3

the jdk1.3 not support annotations. so you can change maven compile plugin’s compile level to 1.6.

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>2.0.2</version>
    <configuration>
        <source>1.6</source>
        <target>1.6</target>
        <encoding>UTF-8</encoding>
    </configuration></plugin>

Problem 5: can’t show Chinese rightly in excel

should config encoding method.

<plugin><groupId>org.codehaus.mojo</groupId><artifactId>apt-maven-plugin</artifactId><version>1.0-alpha-5</version><configuration><factory>com.googlecode.testcase.annotation.AnnotationProcessFactoryImpl
</factory><encoding>UTF-8</encoding></configuration></plugin>

分类：Open source

Open source: weibo plugin for jenkins

Open source: testcase-annotation

Why write this tool

Requirements

How to use it

step 1: configure pom.xml

step 2: use `@TestCase` in your code

step 3: generate excel and html(with excel content)

More use examples

Use 1: How to generate office 03xls excel file instead of 07xlsx’s?

Use 2: How to change the excel’s name instead of `TestCase_Date.xlsx?`

Use 3: How to change the excel’s output dir instead of using outputdirectory ?

Use 4: How to bind to other maven lifecycle phrase?

Use 5: How to integrated with Jenkins?

FAQ

Problem 1: `java.lang.NoClassDefFoundError: org/apache/poi/ss/formula/udf/IndexedUDFFinder`

Problem 2: how to format the annotation to good style

Problem 3: jenkins: html publish plugin report build fail when no any cases existed

Problem 4: error: annotations are not supported in -source 1.3

Problem 5: can’t show Chinese rightly in excel

Why write this tool

Requirements

How to use it

step 1: configure pom.xml

step 2: use @TestCase in your code

step 3: generate excel and html(with excel content)

More use examples

Use 1: How to generate office 03xls excel file instead of 07xlsx’s?

Use 2: How to change the excel’s name instead of TestCase_Date.xlsx?

Use 3: How to change the excel’s output dir instead of using outputdirectory ?

Use 4: How to bind to other maven lifecycle phrase?

Use 5: How to integrated with Jenkins?

FAQ

Problem 1: java.lang.NoClassDefFoundError: org/apache/poi/ss/formula/udf/IndexedUDFFinder

Problem 2: how to format the annotation to good style

Problem 3: jenkins: html publish plugin report build fail when no any cases existed

Problem 4: error: annotations are not supported in -source 1.3

Problem 5: can’t show Chinese rightly in excel

step 2: use `@TestCase` in your code

Use 2: How to change the excel’s name instead of `TestCase_Date.xlsx?`

Problem 1: `java.lang.NoClassDefFoundError: org/apache/poi/ss/formula/udf/IndexedUDFFinder`