root / TestingTools / readme.txt

==============================================================================
IT Mill Testing Tools
==============================================================================

---------------
README Contents
---------------

1. Important files
2. Quick Installation Instructions
3. Quick Configuration Instructions

---------------
1. Important Files
---------------

The installation folder contains the following important files.

  itmill-testingtools-x.x.x
    |
    |-- StartTestingServer.sh or Start Testing Server.bat
    |   (Starts Testing Server)
    |
    `-- StartTestingHost.sh or Start Testing Host.bat
        (Starts Testing Host Controller or running scheduled tests.)

----------------------------------
2. Quick Installation Instructions
----------------------------------

Please see IT Mill Testing Tools Manual for detailed installation
instructions.

Below are installation instructions or Windows, Mac OS X, and Linux. The
Linux package is suitable also for Unix systems, such as Solaris.

------------
2.1. Windows
------------

Download the installation package itmill-testingtools-x.x.x-windows.zip
and follow the following steps.

  1. Uncompress the installation package in some suitable folder. The contents
     will be uncompressed under itmill-testingtools-x.x.x folder.

  2. Open the installation folder with a file browser and double-click on the
     Start Testing Server.bat file. This starts the server in a command
     window. It displays the port number of the server, 8099 by default.

  3. Open URL http://localhost:8099/TestingToolsServer/ with a web browser
     (or some other address if you installed the server on another computer).

-------------
2.2. Mac OS X
-------------

Download the installation package itmill-testingtools-x.x.x-mac.zip and
follow the following steps.

  1. Uncompress the installation package in some suitable folder. The contents
     will be uncompressed under itmill-testingtools-x.x.x folder.

  2. Open a terminal window, change to the installation folder, and run command
     “sh StartTestingServer.sh”. The server starts and displays the port number
     of the server on the screen, 8099 by default.

  3. Open URL http://localhost:8099/TestingToolsServer/ with a web browser (or
     some other address if you installed the server on another computer).

Before testing a target application, you need to configure the application for
the Testing Tools. Please see below for quick configuration or the manual for
detailed instructions.

----------------------
2.3. Linux and Solaris
----------------------

The installation package for Linux is suitable also for Solaris and other
Unix-based operating systems. You need to have a Java Runtime Environment
installed and the path defined in the JAVA_HOME environment variable.

Download the installation package itmill-testingtools-x.x.x-linux.zip and
follow the following steps.

  1. Uncompress the installation package in some suitable folder. The contents
     will be uncompressed under itmill-testingtools-x.x.x folder.

  2. Open a terminal window, change to the installation folder, and run
     command “sh StartTestingServer.sh”. The server starts and displays
     the port number of the server on the screen, 8099 by default.

  3. Open URL http://localhost:8099/TestingToolsServer/ with a web browser
     (or some other address if you installed the server on another computer).

Before testing a target application, you need to configure the application for
the Testing Tools. Please see below for quick configuration or the manual for
detailed instructions.

-----------------------------------
3. Quick Configuration Instructions
-----------------------------------

These instructions assume that you run the testing server and the application
to be tested in the same server. Please see IT Mill Testing Tools Manual
for detailed installation instructions.

----------------------------------------
3.1. Activation of IT Mill Testing Tools
----------------------------------------

You need to activate IT Mill Testing Tools for your web application(s) by adding
following parameter to web.xml deployment descriptor of the application you want
to test:

<web-app>
  

  <context-param>
    <param-name>testingToolsActive</param-name>
    <param-value>true</param-value>
    <description>IT Mill Testing Tools activation</description>
  </context-param>
  

</web-app>

The context-wide parameter is common for all the applications in the context.
If the Testing Tools Server is located on the same host as the IT Mill Toolkit
applications that you want to test, no further configuration is required.