Difference between revisions of "QA/test automation guide"

Latest revision as of 15:56, 14 September 2021

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: @@
-== VCLAuto [Planning] ==
+{{DISPLAYTITLE: Getting Started with Test Automation}}
+[[Category: Quality Assurance]]
+[[Category: TestAutomation]]
 == Introduction ==
-VCLAuto is a Java library for OpenOffice UI/functional testing like VCL TestTool.
+Two kind of approaches is supported by Apache OpenOffice.
-VCLAuto can be used with JUnit. The project is under developing and  will be released in Apache OpenOffice 4.0.
+*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.
-'''There are a lot of testing codes in the OO project, e.g. junit/cppunit test, qadevooo and smoketestoo_native. Why do we need the library?'''
+== Notice ==
-Generally, unit test code (pure junit/cppunit test) is executed in the build process before OO is created. It's low-level and used to verify if the source code is right before they are linked to a real product. It's a white-box testing. If you want to verify a function/method/interface is correct, put your test code in unit test.
+There are some reasons for test failures, so please [[QA/test_env|prepare your testing machine]] before running test.
-qadevooo & smoketestoo_native uses UNO API/Macro to perform testing. To run them, a real OO product must be available. It's middle-level and used to verify if UNO api and business model work correctly. It's a gray-box testing. User interaction is not involved in this testing. It can't fully simulate a user behavior or check if GUI is correct. For example, check if user can draw a shape by dragging, check if OO automatically capitalize the first letter after typing a word, check if a button's checked when user change the selection, etc.
-Vclauto is high-level black-box testing. It performs testing more like a real user.  It generates keyboard/mouse events, does GUI actions  and gets information from the GUI to validate the function.
-'''Background'''
+== Getting the source code ==
-Actually VCLAuto is a java version of  VCL TestTool, which connects to the automation server (automation module) in OpenOffice with socket. With the "-enableautomation" argument, OpenOffice will start the server with listening on the port 12479 be default.
+Anyone can checkout source code from our Subversion repository. Run the following command.
-VCL TestTool is heavily used by the QA team in SUN/Oracle, but many people doesn't like it because of its drawbacks.
+<source lang="bash">
-*The poor IDE.  (Java has many enough powerful IDEs to make writing code easily, e.g. Eclipse / Netbeans)
+svn co https://svn.apache.org/repos/asf/openoffice/trunk/test/ test
-*Hard to debug.
+</source>
-*Hard to read the code and analyze the testing result. (A lot of code is written in Non-English. Maybe German)
+If you are not familiar with Subversion, see our [https://openoffice.apache.org/svn-basics.html Subversion Basics] for more information.
-*Too many errors
-*Basic language is not popular.
-I found http://wiki.services.openoffice.org/wiki/Test_Cleanup starts to unify all testing code to following the standard xUnit style, so I think it's time to clean up GUI test as well.
+== Getting started with Eclipse ==
+=== Prerequisites ===
+*Eclipse Java IDE: [https://www.eclipse.org/downloads/packages/ Eclipse Juno(4.2) IDE for Java Developers] or above.<br />
+*Apache OpenOffice
-== Code ==
+=== Setup project ===
-Write UI testing case following JUnit 4 style like the following:
+'''Step 1.''' Open Eclipse, click menu "File->Import…", and then select "General->Existing Projects into Workspace".<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 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.
+[[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 />
-<source lang="java">
+=== Run testing ===
-public class UITest {
+'''Step 1.''' Select one test class. e.g. testcase.gui.AOOTest, and then click "Run" on the toolbar to start testing. <br />
+[[File:test_automation_guide_13.png]]<br />
+When testing is finished, JUnit view will show the result.<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.
-  @Before
+== Getting started with command line ==
-  public void setUp() throws Exception() {
-    initApp();
-  }
-  @Test
+=== Prerequisites ===
-  public void test() throws Exception() {
+*JDK: [http://java.sun.com/j2se/1.5/ JDK 1.5], [http://java.sun.com/javase/6/ JDK 1.6] or above.<br />
-    // Create a new text document via main menu
+*Ant: [http://ant.apache.org/bindownload.cgi Apache Ant 1.8.2] or above.
-    startcenter.menuItem("File->New->Text Document").select();
+*JUnit: [https://github.com/KentBeck/junit/downloads JUnit 4.10] or above. For lazy people, if internet is available, it can be automatically installed during testing.
-    typeKeys("Hello OpenOffice");
-    writer.menuItem("Edit->Select All").select();
-    // Copy the text
-    typeKeys("<$copy>");
-    assert("Text is inputted successfully.", "Hello OpenOffice", App.getClipboard());
-  }
-  @After
+=== Run testing  ===
-  public void tearDown() throws Exception() {
+'''As a developer, how to run testing against an OpenOffice built by me?''' <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">
+cd main
+source MacOSXX86Env.Set.sh
+cd ../test && ant
+</source>
-  }
+'''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">
+ant -Dopenoffice.home="OpenOffice installation directory" compile
+</source>
+Then start testing with the command "run".
+e.g. Run all test classes under package bvt ("Build Verification Testing")
+<source lang="bash">
+run -Dopenoffice.home="/Applications/OpenOffice.app/Contents" -tp bvt
+</source>
+e.g. Run the given test classes
+<source lang="bash">
+run -Dopenoffice.home="/Applications/OpenOffice.app/Contents" -tc bvt.gui.BasicFunctionTest
+</source>
+On Linux use e.g. -Dopenoffice.home="/opt/openoffice4/program" instead.
-}
-</source>
+''' Where to get the testing result? '''
-'''TODO'''
-Provide command to run the test after OpenOffice installation set is built out.
+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:test_automation_report.png]]<br />
-'''Use Apache Ant to Run Testing and Generate Report'''
+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.
-[[File:vclautoreport.png]]
+== Next ==
+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"

Latest revision as of 15:56, 14 September 2021

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