trunk/doc/faq.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html>
<head>
<title>JSCoverage - FAQ</title>
<link rel="stylesheet" type="text/css" href="reset-fonts-grids.css">
<link rel="stylesheet" type="text/css" href="style.css">
</head>
<body>
<div id="doc3" class="yui-t5"> 
  <div id="hd"><h1><a href="./">JSCoverage</a><br><span class="tag">code coverage for JavaScript</span></h1></div>  
  <div id="bd">
    <div id="yui-main"> 
      <div id="jscoverage-main" class="yui-b">
        <h2><abbr title="Frequently Asked Questions">FAQ</abbr></h2>

        <h3>Can I use JSCoverage to measure code coverage for a page on <code>http://example.com/</code>?</h3>

        <p>
        In order to measure the code coverage of a page on <code>http://example.com/</code>,
        you must run <code>jscoverage</code> to create a <code>jscoverage.html</code> file on the
        <code>example.com</code> server.  You cannot use <code>http://example.org/jscoverage.html</code>
        to measure the code coverage of a page located on <code>http://example.com/</code>.
        </p>

        <p>
        The fundamental reason for this limitation is the
        <a href="http://www.mozilla.org/projects/security/components/same-origin.html">Same Origin Policy</a>
        for untrusted JavaScript.
        </p>

        <p>
        (In fact, the current version of JSCoverage is slightly more restrictive
        than this: it requires that the JavaScript being measured reside under the
        same <strong>directory</strong> as the <code>jscoverage.html</code> file.)
        </p>

        <h3 id="jscoverage-vs-jscoverage-server">Should I use the <code>jscoverage</code> program or the <code>jscoverage-server</code> program?</h3>
        <p>
        First, note that the <code>jscoverage</code> program and the <code>jscoverage-server</code> program are mutually exclusive alternatives;
        you must use one or the other, but not both.  If you try to use both at the same time you will get strange results.
        </p>
        <p>
        Which of the two programs you use is largely a matter of personal preference.
        The <code>jscoverage-server</code> program has some additional features,
        such as the ability to store coverage reports to disk.
        However, the <code>jscoverage</code> program is the more mature of the two and is generally easier to use;
        this program is recommended if you do not need any of the additional features of <code>jscoverage-server</code>.
        </p>

        <h3>Why doesn't my test suite run under JSCoverage in Firefox 3?</h3>

        <p>
        Firefox 3 introduces <a
        href="http://tech.groups.yahoo.com/group/jsunit/message/1075">new
        security restrictions</a> on local files.  Depending on the way your
        test suite is organized, this may cause problems for JSCoverage.
        (You may get the error "uncaught exception: Permission denied to get property Window._$jscoverage".)
        There are several workarounds:
        </p>

        <ul class="list">
        <li><p>Place your files on a web server instead of loading them from the file system.
            This is usually the simplest solution.</p>
        <li><p>Organize your HTML files in your test suite in a flat directory structure.  For example, suppose that
            you instrument your test suite with this command:</p>
<pre>
jscoverage src instrumented
</pre>
            <p>If all your HTML files are located directly under the <code>src/</code> directory (i.e., not in a
            subdirectory of <code>src/</code>), then you should not have any problems using Firefox 3.</p>
        <li><p>Set the <a href="http://kb.mozillazine.org/Editing_configuration">Firefox preference</a> named 
            <code><a href="http://kb.mozillazine.org/Security.fileuri.origin_policy">security.fileuri.origin_policy</a></code>
            to 3.</p>
        </ul>

        <h3>I'm trying to load my code with the URL
        <code>file:///C:/foo/bar/jscoverage.html?foo/bar.html</code>
        and I'm getting all kinds of JavaScript errors.</h3>

        <p>
        Internet Explorer 6 seems to have problems with a <code>file:</code> URL
        that has a query string with a slash in it.
        </p>
        <p>
        As a workaround:
        </p>
        <ul class="list">
        <li><p>Place your files on a web server instead of loading them from the file system.
            (<code>http:</code> URLs work fine.)</p>
        <li><p>Do not use a query string; enter your URL in the "URL" field in the "Browser" tab.</p>
        <li><p>Rearrange your directory structure so that <code>bar.html</code>
            ends up in the same directory as <code>jscoverage.html</code>; then
            you can use the URL
            <code>file:///C:/foo/bar/jscoverage.html?bar.html</code>
            with no slash in the query string.</p>
        <li><p>Use a different browser.  (IE 7 seems to work.)</p>
        </ul>

        <h3>JSCoverage changes my cursor to a busy cursor, and it never changes back!</h3>

        <p>
        Certain browsers (<i>e. g</i>., Internet Explorer 6, Opera, Safari) have trouble changing
        the cursor.  Try moving the mouse and your cursor should change back to normal.
        </p>

        <p>
        See <a href="http://groups.google.com/group/Google-Web-Toolkit/browse_thread/thread/631908bd63241136/783c307480f95d8c">this discussion</a> for more information.
        </p>

        <h3>JSCoverage hangs sometimes when rendering the coverage report.</h3>

        <p>
        With Internet Explorer 6 (I think I see a pattern here), garbage collection can cause performance problems.
        (More information <a href="http://ajaxian.com/archives/garbage-collection-in-ie6">here</a>.)
        </p>

        <h3 id="jsunit">Can JSCoverage be used with <a href="http://www.jsunit.net/">JsUnit</a>?</h3>

        <p>
        It is necessary to run JSCoverage in <dfn>inverted mode</dfn>.  You will have to
        modify JsUnit to launch JSCoverage.
        </p>

        <p>
        See the directory <code>doc/example-jsunit</code> for an example. It
        contains a copy of JsUnit version 2.2alpha11, with the file
        <code>jsunit/app/main-data.html</code> slightly modified to add a button
        which launches JSCoverage.  It also contains a simple unit test file <code>test.html</code>.  You
        can instrument this example as follows:
        </p>

<pre>
jscoverage --no-instrument=jsunit doc/example-jsunit doc/instrumented-jsunit
</pre>

       <p>
       You can then run the <code>test.html</code> file in JsUnit's <code>jsunit/testRunner.html</code>.
       The simplest way to do this is probably to copy the contents of <code>doc/instrumented-jsunit</code>
       to the root of a web server and then access the URL
       </p>

<pre>
http://127.0.0.1/jsunit/testRunner.html?testPage=http://127.0.0.1/test.html&amp;autoRun=true
</pre>

      <p>
      After the test suite has been run, click on the "Coverage report" button
      to get a coverage report.
      </p>

      <h3 id="ie-proxy">Does Internet Explorer work with <code>jscoverage-server --proxy</code>?</h3>

      <p>
      Internet Explorer <a href="http://www.fiddler2.com/fiddler/help/hookup.asp#Q-LocalTraffic">does
      not use a proxy for URLs with host <code>127.0.0.1</code> or
      <code>localhost</code></a>.
      The proxy <em>will</em> be used if you use your machine's actual IP
      address or host name.
      For example, if your IP address is <code>192.168.100.100</code>, you can
      access a URL like <code>http://192.168.100.100/jscoverage.html</code> in
      Internet Explorer and it will work.
      (Under Windows, you can get your machine's IP address with the <code>ipconfig</code> command.)
      </p>
      </div>
    </div> 
    <div id="jscoverage-sidebar" class="yui-b">
      <ul>
      <li><a href="./">Home</a>
      <li><a href="news.html">News</a> <a href="http://siliconforks.com/jscoverage/news.xml" type="application/rss+xml" title="RSS feed for JSCoverage"><img src="feed-icon-14x14.png" alt="RSS feed"></a>
      <li><a href="manual.html">Documentation</a>
      <li><a href="demo.html">Demo</a>
      <li><a href="http://siliconforks.com/jscoverage/download.html">Download</a>
      <li>FAQ
      <li><a href="help.html">Help</a>
      <li><a href="license.html">License</a>
      <li><a href="links.html">Links</a>
      <li><a href="users.html">Users</a>
      <li><a href="http://siliconforks.com/jscoverage/bugs/">Bug tracker</a>
      </ul>
    </div> 
  </div>  
  <div id="ft">
    <address>
      Copyright &copy; 2007, 2008, 2009, 2010 <a href="http://siliconforks.com/"><img src="siliconforks-16x16.png" width="16" height="16" class="icon" alt="Silicon Forks"></a> <a href="http://siliconforks.com/">siliconforks.com</a><br>
      <a href="mailto:jscoverage@siliconforks.com">jscoverage@siliconforks.com</a>
    </address>
  </div>  
</div>
</body>
</html>
1	siliconforks	29	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
2			<html>
3			<head>
4	siliconforks	75	<title>JSCoverage - FAQ</title>
5	siliconforks	29	<link rel="stylesheet" type="text/css" href="reset-fonts-grids.css">
6			<link rel="stylesheet" type="text/css" href="style.css">
7			</head>
8			<body>
9			<div id="doc3" class="yui-t5">
10			<div id="hd"><h1><a href="./">JSCoverage</a><br><span class="tag">code coverage for JavaScript</span></h1></div>
11			<div id="bd">
12			<div id="yui-main">
13			<div id="jscoverage-main" class="yui-b">
14			<h2><abbr title="Frequently Asked Questions">FAQ</abbr></h2>
15
16	siliconforks	368	<h3>Can I use JSCoverage to measure code coverage for a page on <code>http://example.com/</code>?</h3>
17	siliconforks	65
18			<p>
19			In order to measure the code coverage of a page on <code>http://example.com/</code>,
20			you must run <code>jscoverage</code> to create a <code>jscoverage.html</code> file on the
21			<code>example.com</code> server. You cannot use <code>http://example.org/jscoverage.html</code>
22			to measure the code coverage of a page located on <code>http://example.com/</code>.
23			</p>
24
25			<p>
26			The fundamental reason for this limitation is the
27	siliconforks	66	<a href="http://www.mozilla.org/projects/security/components/same-origin.html">Same Origin Policy</a>
28	siliconforks	65	for untrusted JavaScript.
29			</p>
30
31			<p>
32			(In fact, the current version of JSCoverage is slightly more restrictive
33			than this: it requires that the JavaScript being measured reside under the
34			same <strong>directory</strong> as the <code>jscoverage.html</code> file.)
35			</p>
36
37	siliconforks	527	<h3 id="jscoverage-vs-jscoverage-server">Should I use the <code>jscoverage</code> program or the <code>jscoverage-server</code> program?</h3>
38			<p>
39			First, note that the <code>jscoverage</code> program and the <code>jscoverage-server</code> program are mutually exclusive alternatives;
40			you must use one or the other, but not both. If you try to use both at the same time you will get strange results.
41			</p>
42			<p>
43			Which of the two programs you use is largely a matter of personal preference.
44			The <code>jscoverage-server</code> program has some additional features,
45			such as the ability to store coverage reports to disk.
46			However, the <code>jscoverage</code> program is the more mature of the two and is generally easier to use;
47			this program is recommended if you do not need any of the additional features of <code>jscoverage-server</code>.
48			</p>
49
50	siliconforks	137	<h3>Why doesn't my test suite run under JSCoverage in Firefox 3?</h3>
51
52			<p>
53	siliconforks	148	Firefox 3 introduces <a
54	siliconforks	137	href="http://tech.groups.yahoo.com/group/jsunit/message/1075">new
55			security restrictions</a> on local files. Depending on the way your
56			test suite is organized, this may cause problems for JSCoverage.
57			(You may get the error "uncaught exception: Permission denied to get property Window._$jscoverage".)
58	siliconforks	148	There are several workarounds:
59	siliconforks	137	</p>
60
61	siliconforks	148	<ul class="list">
62			<li><p>Place your files on a web server instead of loading them from the file system.
63			This is usually the simplest solution.</p>
64			<li><p>Organize your HTML files in your test suite in a flat directory structure. For example, suppose that
65			you instrument your test suite with this command:</p>
66			<pre>
67			jscoverage src instrumented
68			</pre>
69			<p>If all your HTML files are located directly under the <code>src/</code> directory (i.e., not in a
70			subdirectory of <code>src/</code>), then you should not have any problems using Firefox 3.</p>
71			<li><p>Set the <a href="http://kb.mozillazine.org/Editing_configuration">Firefox preference</a> named
72			<code><a href="http://kb.mozillazine.org/Security.fileuri.origin_policy">security.fileuri.origin_policy</a></code>
73			to 3.</p>
74			</ul>
75
76	siliconforks	29	<h3>I'm trying to load my code with the URL
77			<code>file:///C:/foo/bar/jscoverage.html?foo/bar.html</code>
78			and I'm getting all kinds of JavaScript errors.</h3>
79
80			<p>
81			Internet Explorer 6 seems to have problems with a <code>file:</code> URL
82			that has a query string with a slash in it.
83			</p>
84			<p>
85			As a workaround:
86			</p>
87			<ul class="list">
88	siliconforks	137	<li><p>Place your files on a web server instead of loading them from the file system.
89			(<code>http:</code> URLs work fine.)</p>
90			<li><p>Do not use a query string; enter your URL in the "URL" field in the "Browser" tab.</p>
91			<li><p>Rearrange your directory structure so that <code>bar.html</code>
92	siliconforks	29	ends up in the same directory as <code>jscoverage.html</code>; then
93			you can use the URL
94			<code>file:///C:/foo/bar/jscoverage.html?bar.html</code>
95	siliconforks	137	with no slash in the query string.</p>
96			<li><p>Use a different browser. (IE 7 seems to work.)</p>
97	siliconforks	29	</ul>
98
99			<h3>JSCoverage changes my cursor to a busy cursor, and it never changes back!</h3>
100
101			<p>
102			Certain browsers (<i>e. g</i>., Internet Explorer 6, Opera, Safari) have trouble changing
103			the cursor. Try moving the mouse and your cursor should change back to normal.
104			</p>
105
106			<p>
107	siliconforks	41	See <a href="http://groups.google.com/group/Google-Web-Toolkit/browse_thread/thread/631908bd63241136/783c307480f95d8c">this discussion</a> for more information.
108	siliconforks	29	</p>
109
110			<h3>JSCoverage hangs sometimes when rendering the coverage report.</h3>
111
112			<p>
113			With Internet Explorer 6 (I think I see a pattern here), garbage collection can cause performance problems.
114			(More information <a href="http://ajaxian.com/archives/garbage-collection-in-ie6">here</a>.)
115			</p>
116
117	siliconforks	273	<h3 id="jsunit">Can JSCoverage be used with <a href="http://www.jsunit.net/">JsUnit</a>?</h3>
118	siliconforks	41
119			<p>
120			It is necessary to run JSCoverage in <dfn>inverted mode</dfn>. You will have to
121			modify JsUnit to launch JSCoverage.
122			</p>
123
124			<p>
125			See the directory <code>doc/example-jsunit</code> for an example. It
126			contains a copy of JsUnit version 2.2alpha11, with the file
127			<code>jsunit/app/main-data.html</code> slightly modified to add a button
128			which launches JSCoverage. It also contains a simple unit test file <code>test.html</code>. You
129			can instrument this example as follows:
130			</p>
131
132			<pre>
133			jscoverage --no-instrument=jsunit doc/example-jsunit doc/instrumented-jsunit
134			</pre>
135
136			<p>
137			You can then run the <code>test.html</code> file in JsUnit's <code>jsunit/testRunner.html</code>.
138			The simplest way to do this is probably to copy the contents of <code>doc/instrumented-jsunit</code>
139			to the root of a web server and then access the URL
140			</p>
141
142			<pre>
143	siliconforks	55	http://127.0.0.1/jsunit/testRunner.html?testPage=http://127.0.0.1/test.html&autoRun=true
144	siliconforks	41	</pre>
145
146			<p>
147			After the test suite has been run, click on the "Coverage report" button
148			to get a coverage report.
149			</p>
150
151	siliconforks	498	<h3 id="ie-proxy">Does Internet Explorer work with <code>jscoverage-server --proxy</code>?</h3>
152
153			<p>
154			Internet Explorer <a href="http://www.fiddler2.com/fiddler/help/hookup.asp#Q-LocalTraffic">does
155			not use a proxy for URLs with host <code>127.0.0.1</code> or
156			<code>localhost</code></a>.
157			The proxy <em>will</em> be used if you use your machine's actual IP
158			address or host name.
159			For example, if your IP address is <code>192.168.100.100</code>, you can
160			access a URL like <code>http://192.168.100.100/jscoverage.html</code> in
161			Internet Explorer and it will work.
162			(Under Windows, you can get your machine's IP address with the <code>ipconfig</code> command.)
163			</p>
164	siliconforks	29	</div>
165			</div>
166			<div id="jscoverage-sidebar" class="yui-b">
167			<ul>
168			<li><a href="./">Home</a>
169			<li><a href="news.html">News</a> <a href="http://siliconforks.com/jscoverage/news.xml" type="application/rss+xml" title="RSS feed for JSCoverage"><img src="feed-icon-14x14.png" alt="RSS feed"></a>
170			<li><a href="manual.html">Documentation</a>
171			<li><a href="demo.html">Demo</a>
172	siliconforks	73	<li><a href="http://siliconforks.com/jscoverage/download.html">Download</a>
173	siliconforks	29	<li>FAQ
174			<li><a href="help.html">Help</a>
175			<li><a href="license.html">License</a>
176			<li><a href="links.html">Links</a>
177	siliconforks	243	<li><a href="users.html">Users</a>
178	siliconforks	329	<li><a href="http://siliconforks.com/jscoverage/bugs/">Bug tracker</a>
179	siliconforks	29	</ul>
180			</div>
181			</div>
182			<div id="ft">
183			<address>
184	siliconforks	505	Copyright © 2007, 2008, 2009, 2010 <a href="http://siliconforks.com/"><img src="siliconforks-16x16.png" width="16" height="16" class="icon" alt="Silicon Forks"></a> <a href="http://siliconforks.com/">siliconforks.com</a><br>
185	siliconforks	29	<a href="mailto:jscoverage@siliconforks.com">jscoverage@siliconforks.com</a>
186			</address>
187			</div>
188			</div>
189			</body>
190			</html>