<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- Installation</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
<!--
function getWinHeight() {
var myHeight = 0;
if( typeof( window.innerHeight ) == 'number' ) {
//Non-IE
myHeight = window.innerHeight;
} else if( document.documentElement && ( document.documentElement.clientWidth ||
document.documentElement.clientHeight ) ) {
//IE 6+ in 'standards compliant mode'
myHeight = document.documentElement.clientHeight;
} else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
//IE 4 compatible
myHeight = document.body.clientHeight;
}
return myHeight;
}
function setscrollpos() {
var objf=document.getElementById('loadscrollpos');
document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
}
function addEvent(obj, evType, fn){
if (obj.addEventListener){
obj.addEventListener(evType, fn, true);
return true;
} else if (obj.attachEvent){
var r = obj.attachEvent("on"+evType, fn);
return r;
} else {
return false;
}
}
addEvent(window, 'load', setscrollpos);
//--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/common_test-1.4.7.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>Common Test</strong><br><strong>User's Guide</strong><br><small>Version 1.4.7</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Chapters</strong></small></p>
<ul class="flipMenu" imagepath="../../../../doc/js/flipmenu">
<li id="no" title="Common Test Basics" expanded="false">Common Test Basics<ul>
<li><a href="basics_chapter.html">
Top of chapter
</a></li>
<li title="Introduction"><a href="basics_chapter.html#id2257382">Introduction</a></li>
<li title="Test Suite Organisation"><a href="basics_chapter.html#id2262699">Test Suite Organisation</a></li>
<li title="Support Libraries"><a href="basics_chapter.html#id2262725">Support Libraries</a></li>
<li title="Suites and Test Cases"><a href="basics_chapter.html#id2252225">Suites and Test Cases</a></li>
<li title="External Interfaces"><a href="basics_chapter.html#id2252025">External Interfaces</a></li>
</ul>
</li>
<li id="loadscrollpos" title="Installation" expanded="true">Installation<ul>
<li><a href="install_chapter.html">
Top of chapter
</a></li>
<li title="General information"><a href="install_chapter.html#id2259791">General information</a></li>
<li title="Unix/Linux"><a href="install_chapter.html#id2259969">Unix/Linux</a></li>
<li title="Windows"><a href="install_chapter.html#id2252127">Windows</a></li>
</ul>
</li>
<li id="no" title="Writing Test Suites" expanded="false">Writing Test Suites<ul>
<li><a href="write_test_chapter.html">
Top of chapter
</a></li>
<li title="Support for test suite authors"><a href="write_test_chapter.html#id2263189">Support for test suite authors</a></li>
<li title="Test suites"><a href="write_test_chapter.html#id2263446">Test suites</a></li>
<li title="Init and end per suite"><a href="write_test_chapter.html#id2252033">Init and end per suite</a></li>
<li title="Init and end per test case"><a href="write_test_chapter.html#id2263397">Init and end per test case</a></li>
<li title="Test cases"><a href="write_test_chapter.html#id2252705">Test cases</a></li>
<li title="Test case info function"><a href="write_test_chapter.html#id2252952">Test case info function</a></li>
<li title="Test suite info function"><a href="write_test_chapter.html#id2264301">Test suite info function</a></li>
<li title="Test case groups"><a href="write_test_chapter.html#id2264393">Test case groups</a></li>
<li title="The parallel property and nested groups"><a href="write_test_chapter.html#id2264666">The parallel property and nested groups</a></li>
<li title="Repeated groups"><a href="write_test_chapter.html#id2264711">Repeated groups</a></li>
<li title="Shuffled test case order"><a href="write_test_chapter.html#id2264872">Shuffled test case order</a></li>
<li title="Data and Private Directories"><a href="write_test_chapter.html#id2264941">Data and Private Directories</a></li>
<li title="Execution environment"><a href="write_test_chapter.html#id2265020">Execution environment</a></li>
<li title="Illegal dependencies"><a href="write_test_chapter.html#id2265070">Illegal dependencies</a></li>
</ul>
</li>
<li id="no" title="Test Structure" expanded="false">Test Structure<ul>
<li><a href="test_structure_chapter.html">
Top of chapter
</a></li>
<li title="Test structure"><a href="test_structure_chapter.html#id2265289">Test structure</a></li>
<li title="Skipping test cases"><a href="test_structure_chapter.html#id2265306">Skipping test cases</a></li>
<li title="Definition of terms"><a href="test_structure_chapter.html#id2265390">Definition of terms</a></li>
</ul>
</li>
<li id="no" title="Examples and Templates" expanded="false">Examples and Templates<ul>
<li><a href="example_chapter.html">
Top of chapter
</a></li>
<li title="Test suite example"><a href="example_chapter.html#id2266177">Test suite example</a></li>
<li title="Test suite templates"><a href="example_chapter.html#id2266264">Test suite templates</a></li>
</ul>
</li>
<li id="no" title="Running Test Suites" expanded="false">Running Test Suites<ul>
<li><a href="run_test_chapter.html">
Top of chapter
</a></li>
<li title="Using the Common Test Framework"><a href="run_test_chapter.html#id2266562">Using the Common Test Framework</a></li>
<li title="Automatic compilation of test suites and help modules"><a href="run_test_chapter.html#id2266607">Automatic compilation of test suites and help modules</a></li>
<li title="Running tests from the UNIX command line"><a href="run_test_chapter.html#id2266741">Running tests from the UNIX command line</a></li>
<li title="Running tests from the Web based GUI"><a href="run_test_chapter.html#id2267056">Running tests from the Web based GUI</a></li>
<li title="Running tests from the Erlang shell or from an Erlang program"><a href="run_test_chapter.html#id2267143">Running tests from the Erlang shell or from an Erlang program</a></li>
<li title="Running the interactive shell mode"><a href="run_test_chapter.html#id2267199">Running the interactive shell mode</a></li>
<li title="Step by step execution of test cases with the Erlang Debugger"><a href="run_test_chapter.html#id2267375">Step by step execution of test cases with the Erlang Debugger</a></li>
<li title="Using test specifications"><a href="run_test_chapter.html#id2267476">Using test specifications</a></li>
<li title="Log files"><a href="run_test_chapter.html#id2267715">Log files</a></li>
<li title="HTML Style Sheets"><a href="run_test_chapter.html#id2267921">HTML Style Sheets</a></li>
<li title="Repeating tests"><a href="run_test_chapter.html#id2268107">Repeating tests</a></li>
<li title="Silent Connections"><a href="run_test_chapter.html#id2268354">Silent Connections</a></li>
</ul>
</li>
<li id="no" title="Config Files" expanded="false">Config Files<ul>
<li><a href="config_file_chapter.html">
Top of chapter
</a></li>
<li title="General"><a href="config_file_chapter.html#id2268593">General</a></li>
<li title="Syntax"><a href="config_file_chapter.html#id2268633">Syntax</a></li>
<li title="Requiring and reading configuration data"><a href="config_file_chapter.html#id2268657">Requiring and reading configuration data</a></li>
<li title="Using configuration variables defined in multiple files"><a href="config_file_chapter.html#id2268807">Using configuration variables defined in multiple files</a></li>
<li title="Encrypted configuration files"><a href="config_file_chapter.html#id2268839">Encrypted configuration files</a></li>
<li title="Opening connections by using configuration data"><a href="config_file_chapter.html#id2268904">Opening connections by using configuration data</a></li>
<li title="Examples"><a href="config_file_chapter.html#id2268977">Examples</a></li>
</ul>
</li>
<li id="no" title="Code Coverage Analysis" expanded="false">Code Coverage Analysis<ul>
<li><a href="cover_chapter.html">
Top of chapter
</a></li>
<li title="General"><a href="cover_chapter.html#id2269096">General</a></li>
<li title="Usage"><a href="cover_chapter.html#id2269123">Usage</a></li>
<li title="The cover specification file"><a href="cover_chapter.html#id2269250">The cover specification file</a></li>
<li title="Logging"><a href="cover_chapter.html#id2269317">Logging</a></li>
</ul>
</li>
<li id="no" title="Using Common Test for Large Scale Testing" expanded="false">Using Common Test for Large Scale Testing<ul>
<li><a href="ct_master_chapter.html">
Top of chapter
</a></li>
<li title="General"><a href="ct_master_chapter.html#id2269392">General</a></li>
<li title="Usage"><a href="ct_master_chapter.html#id2269436">Usage</a></li>
<li title="Test Specifications"><a href="ct_master_chapter.html#id2269594">Test Specifications</a></li>
</ul>
</li>
<li id="no" title="Event Handling" expanded="false">Event Handling<ul>
<li><a href="event_handler_chapter.html">
Top of chapter
</a></li>
<li title="General"><a href="event_handler_chapter.html#id2269865">General</a></li>
<li title="Usage"><a href="event_handler_chapter.html#id2269911">Usage</a></li>
</ul>
</li>
<li id="no" title="Dependencies between Test Cases and Suites" expanded="false">Dependencies between Test Cases and Suites<ul>
<li><a href="dependencies_chapter.html">
Top of chapter
</a></li>
<li title="General"><a href="dependencies_chapter.html#id2270845">General</a></li>
<li title="Saving configuration data"><a href="dependencies_chapter.html#id2271007">Saving configuration data</a></li>
<li title="Sequences"><a href="dependencies_chapter.html#id2271201">Sequences</a></li>
</ul>
</li>
<li id="no" title="Some thoughts about testing" expanded="false">Some thoughts about testing<ul>
<li><a href="why_test_chapter.html">
Top of chapter
</a></li>
<li title="Goals"><a href="why_test_chapter.html#id2271413">Goals</a></li>
<li title="What to test?"><a href="why_test_chapter.html#id2271438">What to test?</a></li>
</ul>
</li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<h1>2 Installation</h1>
<h3><a name="id2259791">2.1
General information</a></h3>
<a name="general"></a>
<p>The two main interfaces for running tests with Common Test
are an executable Bourne shell script named <span class="code">run_test</span> and an
erlang module named <span class="code">ct</span>. The shell script will work on Unix/Linux
(and Linux-like environments such as Cygwin on Windows) and the
<span class="code">ct</span> interface functions can be called from the Erlang shell
(or from any Erlang function) on any supported platform.</p>
<p>The Common Test application is installed with the Erlang/OTP
system and no explicit installation is required to start using
Common Test by means of the interface functions in the <span class="code">ct</span>
module. If you wish to use <span class="code">run_test</span>, however, this script
needs to be generated first, according to the instructions below.</p>
<h3><a name="id2259969">2.2
Unix/Linux</a></h3>
<p>Go to the <span class="code">common_test-<vsn></span> directory, located
among the other OTP applications (under the OTP lib directory). Here you
execute the <span class="code">install.sh</span> script with argument <span class="code">local</span>:</p>
<p><span class="code">
$ ./install.sh local
</span></p>
<p>This generates the executable <span class="code">run_test</span> script in the
<span class="code">common_test-<vsn>/priv/bin</span> directory. The script
will include absolute paths to the Common Test and Test Server
application directories, so it's possible to copy or move the script to
a different location on the file system, if desired, without having to
update it. It's of course possible to leave the script under the
<span class="code">priv/bin</span> directory and update the PATH variable accordingly (or
create a link or alias to it).</p>
<p>If you, for any reason, have copied Common Test and Test Server
to a different location than the default OTP lib directory, you can
generate a <span class="code">run_test</span> script with a different top level directory,
simply by specifying the directory, instead of <span class="code">local</span>, when running
<span class="code">install.sh</span>. Example:</p>
<p><span class="code">
$ install.sh /usr/local/test_tools
</span></p>
<p>Note that the <span class="code">common_test-<vsn></span> and
<span class="code">test_server-<vsn></span> directories must be located under the
same top directory. Note also that the install script does not copy files
or update environment variables. It only generates the <span class="code">run_test</span>
script.</p>
<p>Whenever you install a new version of Erlang/OTP, the <span class="code">run_test</span>
script needs to be regenerated, or updated manually with new directory names
(new version numbers), for it to "see" the latest Common Test and Test Server
versions.</p>
<p>For more information on the <span class="code">run_test</span> script and the <span class="code">ct</span>
module, please see the reference manual.</p>
<h3><a name="id2252127">2.3
Windows</a></h3>
<p>On Windows it is very convenient to use Cygwin (<span class="code">www.cygwin.com</span>)
for running Common Test and Erlang, since it enables you to use the
<span class="code">run_test</span> script for starting Common Test. If you are a Cygwin
user, simply follow the instructions above for generating the <span class="code">run_test</span>
script.</p>
<p>If you do not use Cygwin, you have to rely on the API functions
in the <span class="code">ct</span> module (instead of <span class="code">run_test</span>) for running
Common Test as described initially in this chapter.</p>
<p>If you, for any reason, have chosen to store Common Test and Test Server
in a different location than the default OTP lib directory, make
sure the <span class="code">ebin</span> directories of these applications are included
in the Erlang code server path (so the application modules can be loaded).</p>
</div>
<div class="footer">
<hr>
<p>Copyright © 2003-2010 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
f806c0f24240b25bde21a53f71766070
>
files
>
245
