Version 3.4.4

Table of contents

	Preface
		How to use this manual
	Table of contents
	List of figures
	List of tables
I	User manual
1	Installation and startup
	1.1	Unix Installation
	1.2	Windows Installation
	1.3	The license file
	1.4	The configuration files
	1.5	Starting QF-Test
	1.6	Firewall Security Warning
2	The user interface
	2.1	The test-suite
	2.2	Basic editing
		2.2.1	Navigating the tree
		2.2.2	Insertion marker
		2.2.3	Moving nodes
		2.2.4	Transforming nodes
		2.2.5	Tables
		2.2.6	Packing and Unpacking
	2.3	Advanced editing
		2.3.1	Searching
		2.3.2	Replacing
		2.3.3	Complex searches and replace operations
		2.3.4	Multiple views
2.0+ 3	Quickstart
4	Running an application from QF-Test
	4.1	Connection with a JDK
	4.2	SWT instrumentation
		4.2.1	Preparation for manual SWT instrumentation
		4.2.2	Manual SWT instrumentation for eclipse based applications
		4.2.3	Manual instrumentation for standalone SWT applications
	4.3	Various methods to start the SUT
		4.3.1	A standalone script or executable file
		4.3.2	An application launched through Java WebStart
		4.3.3	An applet in a web browser
		4.3.4	An application started with java -jar <archive>
		4.3.5	An application started with java -classpath <classpath> <class>
		4.3.6	A web application in a browser
		4.3.7	An application started indirectly from an already connected SUT
	4.4	Program output and the Clients menu
5	Capture and replay
	5.1	Recording sequences
	5.2	Running tests
	5.3	Recording checks
	5.4	Recording components
	5.5	Recording of HTTP Requests (GET/POST)
6	Components
	6.1	GUI component hierarchy
	6.2	'Components' in QF-Test
	6.3	'Component' 'Ids'
	6.4	Component class
3.1+	6.5	Component inspection
	6.6	The importance of naming components
	6.7	Considerations for setting names
	6.8	Updating 'Components'
	6.9	Troubleshooting component recognition problems
	6.10	Accessing hidden fields on a web page
7	Sub-items of complex GUI components
	7.1	'Items'
	7.2	The 'Id' of an 'Item'
	7.3	Special 'Id'-syntax for direct element access
8	Variables
	8.1	Variable lookup
	8.2	Defining variables
	8.3	Variable example
	8.4	External data and special groups
	8.5	Expressions
3.0+	8.6	Immediate and lazy binding
9	Problem analysis and debugging
	9.1	The run-log
		9.1.1	Error states
		9.1.2	Navigating the run-log tree
		9.1.3	Accepting values of failed checks as good
3.0+		9.1.4	Split run-logs
		9.1.5	Run-log options
3.3+		9.1.6	Creating a test-suite from the run-log
	9.2	The debugger
		9.2.1	Entering the debugger
		9.2.2	The debugger window
		9.2.3	Debugger commands
		9.2.4	Manipulating breakpoints
10	Organizing the test-suite
	10.1	'Sequence' and 'Test' nodes
2.0+	10.2	Test management with 'Test-set' and 'Test-case' nodes
		10.2.1	Concepts
		10.2.2	Variables and special attributes
		10.2.3	Migration and backwards compatibility
	10.3	'Procedures' and 'Packages'
3.1+		10.3.1	Local 'Procedures' and 'Packages'
3.1+		10.3.2	Relative 'Procedures'
		10.3.3	Inserting 'Procedure call' nodes
3.1+		10.3.4	Parameterizing nodes
3.0+		10.3.5	Transforming a 'Sequence' into a 'Procedure'
	10.4	Documenting test-suites
11	The standard library
12	Dependencies
	12.1	'Dependency' basics
	12.2	The dependency stack
	12.3	Error escalation
	12.4	Special variables
	12.5	Error handling
13	Scripting
	13.1	Fundamentals of the Jython integration
	13.2	The run-context rc
	13.3	Scripting examples
		13.3.1	Logging messages
		13.3.2	Performing checks
		13.3.3	Accessing variables
		13.3.4	Setting variables
		13.3.5	Global Jython variables
		13.3.6	Exchanging Jython variables between interpreters
		13.3.7	Accessing the SUT's GUI components
		13.3.8	Calling 'Procedures'
3.1+		13.3.9	Setting options
		13.3.10	A complex example
		13.3.11	Override components
	13.4	Modules
	13.5	Post-mortem debugging of Jython scripts
	13.6	Differences between Jython version 2.2.1 and 2.5
		13.6.1	Boolean type
		13.6.2	Character encodings
		13.6.3	Getting the name of a Java class
	13.7	Scripting with Groovy
		13.7.1	Accessing variables in Groovy
		13.7.2	Global Groovy variables
		13.7.3	Groovy packages
14	Data-driven testing
	14.1	Data-driver examples
	14.2	General use of 'Data drivers'
	14.3	Examples for 'Data drivers'
	14.4	Advanced use
15	Reports and test documentation
	15.1	Reports
		15.1.1	Report concepts
		15.1.2	Report contents
		15.1.3	Creating reports
	15.2	Testdoc documentation for 'Test-sets' and 'Test-cases'
	15.3	Pkgdoc documentation for 'Packages', 'Procedures' and 'Dependencies'
16	Test execution
	16.1	Test execution in batch mode
		16.1.1	Command line usage
		16.1.2	Windows batch script
3.0+		16.1.3	Groovy
	16.2	Executing tests in daemon mode
		16.2.1	Launching the daemon
3.0+		16.2.2	Controlling a daemon from QF-Test's command line
		16.2.3	Controlling a daemon with the daemon API
17	Distributed test development
	17.1	Referencing nodes in another test-suite
	17.2	Managing 'Components'
	17.3	Merging test-suites
		17.3.1	Importing Components
3.3+		17.3.2	Importing Procedures and Testcases
	17.4	Strategies for distributed development
3.0+ 18	Automated Creation of Basic Procedures
	18.1	Introduction
	18.2	How to use the Procedure Builder
	18.3	Configuration of the Procedure Builder
		18.3.1	The Procedure Builder definition file
3.0+ 19	Interaction with Test Management Tools
	19.1	General Information
	19.2	HP TestDirector for Quality Center
		19.2.1	Introduction
		19.2.2	Step-by-step integration guide
	19.3	Imbus TestBench
		19.3.1	Introduction
		19.3.2	Creating QF-Test template from interactions
		19.3.3	Importing test-execution results
	19.4	TestLink
		19.4.1	Introduction
		19.4.2	Generating template test-suites for QF-Test from test-cases
		19.4.3	Execution of test-cases
		19.4.4	Importing QF-Test results into TestLink
20	Integration with Build Tools
	20.1	Ant
	20.2	Maven
3.3+	20.3	Jenkins/Hudson
		20.3.1	Install and start Hudson
		20.3.2	Create a new job for QF-Test
		20.3.3	Install QF-Test Demo Project
21	Performing GUI-based load tests
	21.1	Background and comparison with other techniques
	21.2	Load tests with QF-Test
		21.2.1	Running tests with parallel threads
		21.2.2	Synchronization
		21.2.3	Coordinating tests on multiple machines
3.0+ 22	Executing Manual Tests in QF-Test
	22.1	Introduction
	22.2	Step-by-step Guide
	22.3	Structure of the Excel file
	22.4	The ManualTestRunner test-suite
	22.5	Results
II	Best Practices
23	Introduction
24	How to start a project
	24.1	Infrastructure and testing environment
	24.2	Location of files
		24.2.1	Network installation
	24.3	Component Recognition
25	Organizing test-suites
	25.1	Organizing tests
	25.2	Modularization
	25.3	Parameterization
	25.4	Working in multiple test-suites
	25.5	Roles and responsibilities
	25.6	Managing components at different levels
	25.7	Reverse includes
26	Efficient working techniques
	26.1	Creating test-suites from scratch
	26.2	The standard library qfs.qft
	26.3	Component storage
	26.4	Extending test-suites
	26.5	Working in the script editor
27	How to achieve robust component recognition
	27.1	Using the default configuration
	27.2	Using the 'Name overrides everything' mode
	27.3	Using regular expressions for working with dynamic window titles
	27.4	Influencing the names by implementing a NameResolver
	27.5	Handling class changes due to re-factoring by using 'Record system-classes only'
	27.6	Avoiding recording every component or using generic components
3.1+	27.7	Switching component recognition settings dynamically
28	Test execution
	28.1	Dependencies
	28.2	Timeout vs. delay
	28.3	What to do if the run-log contains an error
III	Reference manual
29	Options
	29.1	General options
		29.1.1	Editing
		29.1.2	Projects
		29.1.3	Bookmarks
		29.1.4	External tools
		29.1.5	Backup files
		29.1.6	Library path
		29.1.7	License
	29.2	Recording options
		29.2.1	Events to record
		29.2.2	Events to pack
		29.2.3	Components
		29.2.4	Recording sub-items
		29.2.5	Recording procedures
	29.3	Replay options
		29.3.1	Client options
		29.3.2	Event handling
		29.3.3	Component recognition
		29.3.4	Delays
		29.3.5	Timeouts
	29.4	Web options
	29.5	Debugger options
	29.6	Run-log options
		29.6.1	General run-log options
		29.6.2	Options determining run-log content
	29.7	Variables
30	Elements of a test-suite
	30.1	The test-suite and its structure
		30.1.1	'Test-suite'
	30.2	Test and Sequence nodes
		30.2.1	'Test-case'
		30.2.2	'Test-set'
		30.2.3	'Test call'
		30.2.4	'Test'
		30.2.5	'Sequence'
		30.2.6	'Test-step'
		30.2.7	'Sequence with time limit'
		30.2.8	'Extras'
	30.3	Dependencies
		30.3.1	'Dependency'
		30.3.2	'Dependency reference'
		30.3.3	'Setup'
		30.3.4	'Cleanup'
		30.3.5	'Error handler'
	30.4	Data driver
		30.4.1	'Data driver'
		30.4.2	'Data table'
		30.4.3	'Database'
		30.4.4	'Excel data file'
		30.4.5	'CSV data file'
		30.4.6	'Data loop'
	30.5	Procedures
		30.5.1	'Procedure'
		30.5.2	'Procedure call'
		30.5.3	'Return'
		30.5.4	'Package'
		30.5.5	'Procedures'
	30.6	Control structures
		30.6.1	'Loop'
		30.6.2	'While'
		30.6.3	'Break'
		30.6.4	'If'
		30.6.5	'Elseif'
		30.6.6	'Else'
		30.6.7	'Try'
		30.6.8	'Catch'
		30.6.9	'Finally'
		30.6.10	'Throw'
		30.6.11	'Rethrow'
		30.6.12	'Server script'
		30.6.13	'SUT script'
	30.7	Processes
		30.7.1	'Start Java SUT client'
		30.7.2	'Start SUT client'
		30.7.3	'Start browser'
		30.7.4	'Start process'
		30.7.5	'Execute shell command'
		30.7.6	'Wait for client to connect'
		30.7.7	'Stop client'
		30.7.8	'Wait for process to terminate'
	30.8	Events
		30.8.1	'Mouse event'
		30.8.2	'Key event'
		30.8.3	'Text input'
		30.8.4	'Window event'
		30.8.5	'Component event'
		30.8.6	'Selection'
		30.8.7	'File selection'
	30.9	Checks
		30.9.1	'Check text'
		30.9.2	'Boolean check'
		30.9.3	'Check items'
		30.9.4	'Check selectable items'
		30.9.5	'Check image'
		30.9.6	'Check geometry'
	30.10	Queries
		30.10.1	'Fetch text'
		30.10.2	'Fetch index'
		30.10.3	'Fetch geometry'
	30.11	Miscellaneous
		30.11.1	'Set variable'
		30.11.2	'Wait for component to appear'
		30.11.3	'Wait for document to load'
		30.11.4	'Wait for download to finish'
		30.11.5	'Load resources'
		30.11.6	'Load properties'
		30.11.7	'HTTP Request'
	30.12	Windows, Components and Items
		30.12.1	'Window'
		30.12.2	'Web page'
		30.12.3	'Component'
		30.12.4	'Item'
		30.12.5	'Window group'
		30.12.6	'Component group'
		30.12.7	'Windows and components'
31	Exceptions
IV	Technical reference
32	Command line arguments and exit codes
	32.1	Call syntax
	32.2	Command line arguments
		32.2.1	Arguments for the starter script
		32.2.2	Arguments for the Java VM
		32.2.3	Arguments for QF-Test
		32.2.4	Placeholders in the filename parameter for run-log and report
	32.3	Exit codes for QF-Test
33	JDK instrumentation
	33.1	Modifications to the JDK
	33.2	Effects of the instrumentation
34	GUI engines
35	Starting the SUT with the old connection mechanism
	35.1	Four methods to start the SUT
	35.2	Starting an application through Java WebStart
	35.3	Running an applet in the appletviewer
	35.4	Security
	35.5	Background information
36	Technical details about miscellaneous issues
	36.1	Drag&Drop
	36.2	Component recognition
	36.3	Timing
	36.4	Regular expressions
	36.5	Line breaks under Unix and Windows
	36.6	Quoting and escaping special characters
	36.7	Include file resolution
37	Jython and Groovy scripting
	37.1	Module load-path (Jython)
	37.2	The plugin directory
	37.3	The package cache (Jython)
	37.4	Initialization (Jython)
	37.5	Namespace environment for script execution (Jython)
	37.6	Run-context API
	37.7	The qf module
3.0+	37.8	Image API
		37.8.1	The ImageWrapper class
	37.9	Exception handling
	37.10	Debugging scripts (Jython)
38	Special features for web applications
	38.1	Pseudo DOM API
		38.1.1	The abstract Node class
		38.1.2	The DocumentNode class
		38.1.3	The FrameNode class
		38.1.4	The DomNode class
		38.1.5	The DialogNode class
	38.2	Special support for various AJAX toolkits
		38.2.1	AJAX resolver concepts
		38.2.2	Supported AJAX toolkits
39	Extension APIs
	39.1	Resolver hooks
		39.1.1	Overview over the supported kinds of resolvers
3.1+		39.1.2	The ClassNameResolver interface
3.1+		39.1.3	The NameResolver2 interface
		39.1.4	The IdResolver interface
3.1+		39.1.5	The FeatureResolver2 interface
		39.1.6	The ExtraFeatureResolver interface
3.1+		39.1.7	The ItemNameResolver2 interface
3.1+		39.1.8	The ItemValueResolver2 interface
		39.1.9	The TreeTableResolver interface
		39.1.10	Simplified resolver creation with the resolvers module
		39.1.11	The ResolverRegistry
		39.1.12	Error handling
3.1+	39.2	Implementing custom item types with the ItemResolver interface
		39.2.1	ItemResolver concepts
		39.2.2	The ItemResolver interface
		39.2.3	The class SubItemIndex
		39.2.4	The ItemRegistry
		39.2.5	Default item representations
3.1+	39.3	Implementing custom checks with the Checker interface
		39.3.1	The Checker interface
		39.3.2	The class Pair
		39.3.3	The CheckType interface and its implementation DefaultCheckType
		39.3.4	The class CheckDataType
		39.3.5	The class CheckData and its subclasses
		39.3.6	The CheckerRegistry
		39.3.7	Custom checker example
3.2+	39.4	Working with the Eclipse Graphical Editing Framework (GEF)
		39.4.1	Recording GEF items
		39.4.2	Implementing a GEF ItemNameResolver2
		39.4.3	Implementing a GEF ItemValueResolver2
3.1+	39.5	Test-run listeners
		39.5.1	The TestRunListener interface
		39.5.2	The class TestRunEvent
		39.5.3	The class TestSuiteNode
	39.6	DOM processors
		39.6.1	The DOMProcessor interface
		39.6.2	The DOMProcessorRegistry
		39.6.3	Error handling
3.0+	39.7	Image API extensions
		39.7.1	The ImageRep class
		39.7.2	The ImageComparator interface
40	Daemon mode
	40.1	The DaemonLocator
	40.2	The Daemon
	40.3	The TestRunDaemon
		40.3.1	Miscellaneous
		40.3.2	Global variable handling
		40.3.3	Test execution
		40.3.4	Identification
	40.4	The DaemonRunContext
3.1+	40.5	The DaemonTestRunListener
41	The Procedure Builder definition file
	41.1	Placeholders
	41.2	Conditions for Package and Procedure Definition
	41.3	Interpretation of the Component Hierarchy
3.4+	41.4	Details about the @CONDITION tag
42	The ManualStepDialog
	42.1	The ManualStepDialog API
3.1+ 43	Details about transforming nodes
	43.1	Introduction
	43.2	Transformation with type changes
	43.3	Additional transformations below the 'Extras' node
		43.3.1	Transformations without side-effects
		43.3.2	Transformations with side-effects
3.3+ 44	Details about the algorithm for image comparison
	44.1	Introduction
	44.2	Description of algorithms
		44.2.1	Classic image check
		44.2.2	Pixel-based identity check
		44.2.3	Pixel-based similarity check
		44.2.4	Block-based identity check
		44.2.5	Block-based similarity check
		44.2.6	Histogram check
		44.2.7	Analysis with Discrete Cosine Transformation
		44.2.8	Block-based analysis with Discrete Cosine Transformation
		44.2.9	Bilinear Filter
A	FAQ - Frequently Asked Questions
B	Release notes
	B.1	Version 3.4.4
	B.2	Version 3.4.3
	B.3	Version 3.4.2
	B.4	Version 3.4.1
	B.5	Main new features in version 3.4
	B.6	Version 3.4.0
	B.7	Version 3.4M2
	B.8	Version 3.4M1
	B.9	Version 3.3.0
	B.10	Version 3.2.2
	B.11	Version 3.2.1
	B.12	New features in QF-Test version 3.2
	B.13	Version 3.2.0
	B.14	Version 3.1.4
	B.15	Version 3.1.3
	B.16	Version 3.1.2
	B.17	Version 3.1.1
	B.18	Version 3.1.0
	B.19	Version 3.0.2
	B.20	Version 3.0.1
	B.21	New features in QF-Test version 3
C	Keyboard shortcuts
	C.1	Navigation and editing
	C.2	Record and replay functions
	C.3	Keyboard helper
D	Glossary
E	Third party software

Last update: 01/27/2012 Copyright © 1999-2012 Quality First Software GmbH