Difference between revisions of "QA/test automation guide"

Revision as of 13:55, 7 July 2018

Introduction

Two kind of approaches is supported by Apache OpenOffice.

GUI Testing: Simulating a common user to perform testing. It depends on a Java library named VCLAuto, which does testing like the old VCLTesttool. It can easily integrates with JUnit. VCLAuto provides APIs to generate user interface events such as keystrokes and mouse clicks, do GUI actions and get information from the GUI to validate functions.
UNO API Testing: Use UNO API to verify functions.

Notice

There are some reasons for test failures, so please prepare your testing machine before running test.

Getting the source code

Anyone can checkout source code from our Subversion repository. Run the following command.

svn co https://svn.apache.org/repos/asf/openoffice/trunk/test/ test

If you are not familiar with Subversion, see our Subversion Basics for more information.

Getting started with Eclipse

Prerequisites

Eclipse Java IDE: Eclipse Juno(4.2) IDE for Java Developers or above.
Apache OpenOffice

Setup project

Step 1. Open Eclipse, click menu "File->Import...", and then select "General->Existing Projects into Workspace".

Step 2. Click next, set "Select root directory" to the source code directory, and then check the following projects.

testcommon: The project includes the common test utilities and low-level implementation to do GUI testing
testgui:  The project includes the GUI testing scripts. 
testuno:  The project includes the UNO API testing scripts.

Step 3. Click "Finish" to import the projects.

Step 4. Click menu "Window->Preferences" ("Eclipse->Preferences" on Mac) and then select "Java->Build Path->Classpath Variables" page.

Click "New" to create one new variable "openoffice.home", and set its value to Apache OpenOffice installation directory.

The default installation directory of Apache OpenOffice

Mac OS X: "/Applications/OpenOffice.app/Contents"

Linux: "/opt/openoffice3"

Windows: "C:/Program Files/OpenOffice 3"

Windows 64b: "C:/Program Files (x86)/OpenOffice 3"

Click "OK" to close "New Variable Entry"dialog. Then click "OK" button of preferences dialog. A message box pops up. Click "Yes".

Run testing

Step 1. Select one test class. e.g. testcase.gui.AOOTest, and then click "Run" on the toolbar to start testing.

When testing is finished, JUnit view will show the result.

You also can select one package, click "Run", and then choose "JUnit test" to run all test classes under it.

Getting started with command line

Prerequisites

JDK: JDK 1.5, JDK 1.6 or above.
Ant: Apache Ant 1.8.2 or above.
JUnit: JUnit 4.10 or above. For lazy people, if internet is available, it can be automatically installed during testing.

Run testing

As a developer, how to run testing against an OpenOffice built by me?
It's easy for developers to run testing after building OpenOffice. One thing you need to do is to make sure you run the commands in the build environment. The script will automatically install your build and then start testing. e.g.

cd main
source MacOSXX86Env.Set.sh
cd ../test && ant

As a normal user, how to run testing against an installed OpenOffice?
Firstly compile the project with the command under test module.

ant -Dopenoffice.home="OpenOffice installation directory" compile

Then start testing with the command "run". e.g. Run all test classes under package bvt ("Build Verification Testing")

run -Dopenoffice.home="/Applications/OpenOffice.app/Contents" -tp bvt

e.g. Run the given test classes

run -Dopenoffice.home="/Applications/OpenOffice.app/Contents" -tc bvt.gui.BasicFunctionTest

On Linux use e.g. -Dopenoffice.home="/opt/openoffice4/program" instead.

Where to get the testing result?

By default, the testing output is stored in "test/testspace/output***". Open "test/testspace/output/result.html" in your browser to see the testing report.
File:Test automation report.png

Special stuff in the output directory.

result.xml: Test result in HTML. 
result.html: Test result in XML.
screenshot/: Screenshot pictures when test assert is failed.

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE: GUI Testing with VCLAuto}}
+{{DISPLAYTITLE: Getting Started with Test Automation}}
 [[Category: Quality Assurance]]
 [[Category: TestAutomation]]
@@ Line 6: / Line 6: @@
 == Introduction ==
-VCLAuto is a Java library for OpenOffice GUI testing like the old [[VCLTesttool]]. It can easily integrates with JUnit. VCLAuto provides APIs to generate user interface events such as keystrokes and mouse clicks, do GUI actions and get information from the GUI to validate functions.
+Two kind of approaches is supported by Apache OpenOffice.
+*GUI Testing: Simulating a common user to perform testing. It depends on a Java library named VCLAuto, which does testing like the old [[VCLTesttool]]. It can easily integrates with JUnit. VCLAuto provides APIs to generate user interface events such as keystrokes and mouse clicks, do GUI actions and get information from the GUI to validate functions.
+*UNO API Testing:  Use UNO API to verify functions.
 == Notice ==
+There are some reasons for test failures, so please [[QA/test_env|prepare your testing machine]] before running test.
-TCP/IP will be used during testing. It may lead your firewall to show some warning messages.
 == Getting the source code ==
 Anyone can checkout source code from our Subversion repository. Run the following command.
- svn co https://svn.apache.org/repos/asf/incubator/ooo/trunk/main/test/ test
+<source lang="bash">
-If you are not familiar with Subversion, see our [http://incubator.apache.org/openofficeorg/svn-basics.html Subversion Basics] for more information.
+svn co https://svn.apache.org/repos/asf/openoffice/trunk/test/ test
+</source>
+If you are not familiar with Subversion, see our [http://openoffice.apache.org/svn-basics.html Subversion Basics] for more information.
 == Getting started with Eclipse ==
 === Prerequisites ===
 *Eclipse Java IDE: [http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/junor Eclipse Juno(4.2) IDE for Java Developers] or above.<br />
+*Apache OpenOffice
 === Setup project ===
 '''Step 1.''' Open Eclipse, click menu "File->Import...", and then select "General->Existing Projects into Workspace".<br />
-[[File:vclauto_guide_1.png]]<br />
+[[File:test_automation_guide_1.png]]<br />
 '''Step 2.''' Click next, set "Select root directory" to the source code directory, and then check the following projects.<br />
-  '''testcommon''': The project contains the common test utilities and low-level implementation to do GUI testing
+  '''testcommon''': The project includes the common test utilities and low-level implementation to do GUI testing
-  '''testgui''':  The project contains the GUI testing scripts. Test case should be written in this project.
+  '''testgui''':  The project includes the GUI testing scripts.
-[[File:vclauto_guide_2.png]]<br />
+ '''testuno''':  The project includes the UNO API testing scripts.
+[[File:test_automation_guide_2.png]]<br />
 '''Step 3.''' Click "Finish" to import the projects.
+'''Step 4.''' Click menu "Window->Preferences" ("Eclipse->Preferences" on Mac) and then select "Java->Build Path->Classpath Variables" page.<br />
+[[File:test_automation_guide_10.png]]<br />
+Click "New" to create one new variable "'''openoffice.home'''", and set its value to Apache OpenOffice installation directory.<br />
+[[File:test_automation_guide_11.png]]<br />
+{{Note| '''The default installation directory of Apache OpenOffice'''<br />
+ Mac OS X: "''/Applications/OpenOffice.app/Contents"''<br />
+ Linux: "''/opt/openoffice3''"<br />
+ Windows: "''C:/Program Files/OpenOffice 3''"<br />
+ Windows 64b: "''C:/Program Files (x86)/OpenOffice 3''"
+}}
+Click "OK" to close "New Variable Entry"dialog. Then click "OK" button of preferences dialog. A message box pops up. Click "Yes".<br />
+[[File:test_automation_guide_12.png]]<br />
 === Run testing ===
-'''Step 1.''' Set AOO's installation location firstly. If AOO is installed in the default directory
+'''Step 1.''' Select one test class. e.g. testcase.gui.AOOTest, and then click "Run" on the toolbar to start testing. <br />
-<ref name="Foot1">
+[[File:test_automation_guide_13.png]]<br />
-{{Template:Documentation/Note| '''The default value of openoffice.home'''<br />
- Mac OS X: "''/Applications/OpenOffice.org.app/Contents/MacOS"''<br />
- Linux: "''/opt/openoffice.org3/program''"<br />
- Windows: "''C:/Program Files/OpenOffice.org 3/program''"<br />
- Windows 64b: "''C:/Program Files (x86)/OpenOffice.org 3/program''"
-}}
-</ref>, you can skip this step. <br />
-Otherwise, click menu "Window->Preferences" ("Eclipse->Preferences" on Mac), select "Java->Installed JREs" page and then select the checked JRE.<br />
-[[File:vclauto_guide_10.png]]<br />
-Click "Edit" button and then add the following line in "Default VM Arguments"<br />
- -Dopenoffice.home="Your OpenOffice installation directory which contains soffice.bin"
-[[File:vclauto_guide_12.png]]<br />
-Click "Finish".<br />
-'''Step 2.''' Select one test class. e.g. testcase.gui.AOOTest, and then click "Run" on the toolbar to start testing. <br />
-[[File:vclauto_guide_14.png]]<br />
 When testing is finished, JUnit view will show the result.<br />
-[[File:vclauto_guide_16.png]]<br />
+[[File:test_automation_guide_14.png]]<br />
 You also can select one package, click "Run", and then choose "JUnit test" to run all test classes under it.
@@ Line 59: / Line 63: @@
 === Run testing  ===
-'''How do I run testing on OpenOffice?'''<br />
+'''As a developer, how to run testing against an OpenOffice built by me?''' <br />
-Run the following commands.
+It's easy for developers to run testing after building OpenOffice. One thing you need to do is to make sure you run the commands in the build environment. The script will automatically install your build and then start testing. e.g.
 <source lang="bash">
-cd test
+cd main
-ant -Dtest.classes="Test class list" -Dopenoffice.home="Your OpenOffice installation directory which contains soffice.bin"
+source MacOSXX86Env.Set.sh
+cd ../test && ant
 </source>
-e.g. Run testcase.gui.AOOTest and testcase.gui.SmokeTest against OpenOffice installed in "/Applications/OpenOffice.org.app"
+'''As a normal user, how to run testing against an installed OpenOffice?'''<br />
+Firstly compile the project with the command under test module.
 <source lang="bash">
-cd test
+ant -Dopenoffice.home="OpenOffice installation directory" compile
-ant -Dtest.classes="testcase/gui/AOOTest.class,testcase/gui/SmokeTest.class" -Dopenoffice.home="/Applications/OpenOffice.org.app/Contents/MacOS"
 </source>
-e.g. Run all test classes under package testcase.gui.sc
+Then start testing with the command "run".
+e.g. Run all test classes under package bvt ("Build Verification Testing")
 <source lang="bash">
-cd test
+run -Dopenoffice.home="/Applications/OpenOffice.app/Contents" -tp bvt
-ant -Dtest.classes="testcase/gui/sc/**/*.class" -Dopenoffice.home="/Applications/OpenOffice.org.app/Contents/MacOS"
 </source>
+e.g. Run the given test classes
-If test.classes is not specified, [http://wiki.services.openoffice.org/wiki/QA/Build_Verification_Test%28BVT%29 BVT] will be executed. If openoffice.home is not specified,  it will try to test OpenOffice installed in the default directory<ref name="Foot1"></ref>. e.g. Run BVT against OpenOffice  in the default directory.
 <source lang="bash">
-cd test
+run -Dopenoffice.home="/Applications/OpenOffice.app/Contents" -tc bvt.gui.BasicFunctionTest
-ant
 </source>
+On Linux use e.g. -Dopenoffice.home="/opt/openoffice4/program" instead.
-'''As a developer, how do I run testing against my own build?''' <br />
-It's easy for developers to run testing after building OpenOffice. One thing you need to do is to make sure you run the commands in the build environment. The script will automatically install your build and then start testing. e.g.
-<source lang="bash">
-source MacOSXX86Env.Set.sh
-cd test && ant
-</source>
 ''' Where to get the testing result? '''
-By default, the testing output is stored in "test/testspace/output". Open "test/testspace/output/report/index.html" in your browser to see the testing report.<br />
+By default, the testing output is stored in "test/testspace/output***". Open "test/testspace/output/result.html" in your browser to see the testing report.<br />
-[[File:vclautoreport.png]]<br />
+[[File:test_automation_report.png]]<br />
-There are several directories to store special stuff.
+Special stuff in the output directory.
-  report/: Test result in HTML.
+  result.xml: Test result in HTML.
-  result/: Test result in XML.
+  result.html: Test result in XML.
   screenshot/: Screenshot pictures when test assert is failed.
- logs/: The detail log.
-== Development ==
-Now, all things have been ready for developing new test code.  If you are interested, please read [[QA/dev_gui_testing|GUI Testing Development]] to get more information.
-== Note ==
+== Next ==
-<references/>
+Now, all things have been ready for developing new test code. If you are interested, please read [[QA/dev_gui_testing|GUI Testing Development]] and [[QA/dev_api_testing|UNO API Testing Development]] to get more information.

Difference between revisions of "QA/test automation guide"

Revision as of 13:55, 7 July 2018

Contents

Introduction

Notice

Getting the source code

Getting started with Eclipse

Prerequisites

Setup project

Run testing

Getting started with command line

Prerequisites

Run testing

Next

Views

Personal tools

Navigation

Search

Tools