[testng] 60/355: Standardized section heading HTML format for easier reading/maintenance.
Eugene Zhukov
eugene-guest at moszumanska.debian.org
Tue Aug 18 10:19:47 UTC 2015
This is an automated email from the git hooks/post-receive script.
eugene-guest pushed a commit to annotated tag OpenBSD
in repository testng.
commit fb46792d8166299d5fdb2054eb9ac266e58e932c
Author: The Main Function (Bryan) <bryan at themainfunction.com>
Date: Fri Mar 21 22:36:10 2014 -0500
Standardized section heading HTML format for easier reading/maintenance.
The HTML for the section headings varied between headings. Sometimes
the <h> tags were on surrounding lines, sometimes they wrapped the
content on a single line, and sometimes they were at the end of the
previous line of content. This made for difficult reading; it also made
changes difficult.
Now, all section heading <h> tags wrap the content on a single line,
in the following format:
<hx><a ...>content</a></hx>
so that they are easy to work with.
NOTE: I'm aware that this may not be compliant with some style guides,
and also that everybody has different preferences. I'm not trying to
enforce my particular preference over anyone else's; I picked this
format simply because A) section heading lines are generally short
enough to fit in screen-width even with <h> tags, and B) many of the
section headings were this way to begin with.
---
doc/documentation-main.html | 99 ++++++++++++++++++++-------------------------
1 file changed, 44 insertions(+), 55 deletions(-)
diff --git a/doc/documentation-main.html b/doc/documentation-main.html
index df5934c..9a372bf 100644
--- a/doc/documentation-main.html
+++ b/doc/documentation-main.html
@@ -73,7 +73,9 @@ google_ad_channel ="5560744946";
<!-------------------------------------
INTRODUCTION
------------------------------------>
-<h3><a class="section" name="introduction">Introduction</a></h3>TestNG is a testing framework designed to simplify a broad range of testing needs, from unit testing (testing a class in isolation of the others) to integration testing (testing entire systems made of several classes, several packages and even several external frameworks, such as application servers).
+<h3><a class="section" name="introduction">Introduction</a></h3>
+
+TestNG is a testing framework designed to simplify a broad range of testing needs, from unit testing (testing a class in isolation of the others) to integration testing (testing entire systems made of several classes, several packages and even several external frameworks, such as application servers).
<p>
@@ -120,7 +122,9 @@ The rest of this manual will explain the following:
ANNOTATIONS
------------------------------------>
- <h3><a class="section" name="annotations">Annotations</a></h3>Here is a quick overview of the annotations available in TestNG along with their attributes.
+<h3><a class="section" name="annotations">Annotations</a></h3>
+
+Here is a quick overview of the annotations available in TestNG along with their attributes.
<p>
@@ -490,7 +494,9 @@ invocationCount. <br>Note: this attribute is ignored if invocationCount is not
<!-------------------------------------
TESTNG.XML
------------------------------------>
- <h3><a class="section" name="testng-xml">testng.xml</a></h3><p>You can invoke TestNG in several different ways:</p><ul>
+<h3><a class="section" name="testng-xml">testng.xml</a></h3>
+
+<p>You can invoke TestNG in several different ways:</p><ul>
<li>With a <tt>testng.xml</tt> file</li><li><a href="http://testng.org/doc/ant.html">With ant</a></li><li>From the command line</li></ul><p>This section describes the format of <tt>testng.xml</tt> (you will find documentation
on ant and the command line below).</p><p>The current DTD for <tt>testng.xml</tt> can be found on the main Web site:
<a href="http://testng.org/testng-1.0.dtd">http://testng.org/testng-1.0.dtd</a>
@@ -595,7 +601,9 @@ Please see the DTD for a complete list of the features, or read on.</p>
RUNNING TESTNG
------------------------------------>
-<h3><a class="section" name="running-testng">Running TestNG</a></h3>TestNG can be invoked in different ways:
+<h3><a class="section" name="running-testng">Running TestNG</a></h3>
+
+TestNG can be invoked in different ways:
<ul>
<li>Command line
@@ -1011,9 +1019,9 @@ would define this in your property file:
EXCLUSION
------------------------------------>
-<h4><a class="section" indent=".." name="exclusions">Exclusion groups</a>
+<h4><a class="section" indent=".." name="exclusions">Exclusion groups</a></h4>
-</h4><p>TestNG allows you to include groups as well as exclude them.</p>
+<p>TestNG allows you to include groups as well as exclude them.</p>
For example, it is quite usual to have tests that temporarily break because
@@ -1056,14 +1064,14 @@ broken and need to be fixed later.</p>
<p><i>Note: you can also disable tests on an individual basis by using the
"enabled" property available on both @Test and @Before/After
annotations.</i></p>
-</blockquote><h4>
+</blockquote>
<!-------------------------------------
PARTIAL GROUPS
------------------------------------>
-<a class="section" indent=".." name="partial-groups">Partial groups</a></h4>
+<h4><a class="section" indent=".." name="partial-groups">Partial groups</a></h4>
You can define groups at the class level and then add groups at the method level:
@@ -1087,7 +1095,9 @@ at the class level, while method1() belongs to both "checkin-test" and
PARAMETERS
------------------------------------>
-<h4><a class="section" indent=".." name="parameters">Parameters</a></h4><p>
+<h4><a class="section" indent=".." name="parameters">Parameters</a></h4>
+
+<p>
Test methods don't have to be parameterless. You can use an arbitrary
@@ -1321,7 +1331,9 @@ Parameters used to invoke your test methods are shown in the HTML reports genera
------------------------------------>
-<h4><a class="section" indent=".." name="dependent-methods">Dependencies</a></h4><p>Sometimes, you need
+<h4><a class="section" indent=".." name="dependent-methods">Dependencies</a></h4>
+
+<p>Sometimes, you need
your test methods to be invoked in a certain order. Here are a
few examples:
@@ -1441,9 +1453,7 @@ The <tt><depends-on></tt> attribute contains a space-separated list of gro
FACTORIES
------------------------------------>
-<h4>
-<a class="section" indent=".." name="factories">Factories</a>
-</h4>
+<h4><a class="section" indent=".." name="factories">Factories</a></h4>
Factories allow you to create tests dynamically. For example, imagine you
want to create a test method that will access a page on a Web site several
@@ -1673,7 +1683,9 @@ In this example, the function <tt>testServer</tt> will be invoked ten times from
------------------------------------>
-<h4><a class="section" indent=".." name="rerunning">Rerunning failed tests</a></h4>Every time tests fail in a suite, TestNG creates a file called <tt>testng-failed.xml</tt> in the output directory.
+<h4><a class="section" indent=".." name="rerunning">Rerunning failed tests</a></h4>
+
+Every time tests fail in a suite, TestNG creates a file called <tt>testng-failed.xml</tt> in the output directory.
This XML file contains the necessary information to rerun only these methods
that failed, allowing you to quickly reproduce the failures without having to
run the entirety of your tests. Therefore, a typical session would look
@@ -1718,16 +1730,16 @@ property and set the <tt>testng.junit</tt> property to true:
</ul>
</li>
</ul>
- <!-------------------------------------
+
+<!-------------------------------------
JUNIT
- ------------------------------------><h4>
+--------------------------------------->
<!-------------------------------------
RUNNING TESTNG
- ------------------------------------><h4>
-<a class="section" indent=".." name="running-testng-programmatically">Running TestNG programmatically</a>
-</h4>
+ ------------------------------------>
+<h4><a class="section" indent=".." name="running-testng-programmatically">Running TestNG programmatically</a></h4>
You can invoke TestNG from your own programs very easily:
@@ -1785,9 +1797,7 @@ tng.run();
BEANSHELL
------------------------------------>
-<h4>
-<a class="section" indent=".." name="beanshell">BeanShell and advanced group selection</a>
-</h4>
+<h4><a class="section" indent=".." name="beanshell">BeanShell and advanced group selection</a></h4>
<p>If the <tt><include></tt> and <tt><exclude></tt> tags in <tt>testng.xml</tt> are not enough for your needs, you can use a <a href="http://beanshell.org">BeanShell</a> expression to decide whether a certain test method should be included in a test run or not. You specify this expression just under the <tt><test></tt> tag:</p>
@@ -1821,9 +1831,7 @@ You might want to surround your expression with a <tt>CDATA</tt> declaration (as
ANNOTATION TRANSFORMERS
------------------------------------>
-<h4>
-<a class="section" indent=".." name="annotationtransformers">Annotation Transformers</a>
-</h4>
+<h4><a class="section" indent=".." name="annotationtransformers">Annotation Transformers</a></h4>
TestNG allows you to modify the content of all the annotations at runtime. This is especially useful if the annotations in the source code are right most of the time, but there are a few situations where you'd like to override their value.
<p>
@@ -1900,9 +1908,8 @@ For example, here is how you would override the attribute <tt>invocationCount</t
METHOD INTERCEPTORS
------------------------------------>
-<h4>
-<a class="section" indent=".." name="methodinterceptors">Method Interceptors</a>
-</h4>
+<h4><a class="section" indent=".." name="methodinterceptors">Method Interceptors</a></h4>
+
Once TestNG has calculated in what order the test methods will be invoked, these methods are split in two groups:
<ul>
@@ -1968,9 +1975,7 @@ public List<IMethodInstance> intercept(List<IMethodInstance> methods
TESTNG LISTENERS
------------------------------------>
-<h4>
-<a class="section" indent=".." name="testng-listeners">TestNG Listeners</a>
-</h4>
+<h4><a class="section" indent=".." name="testng-listeners">TestNG Listeners</a></h4>
There are several interfaces that allow you to modify TestNG's behavior. These interfaces are broadly called "TestNG Listeners". Here are a few listeners:
@@ -2104,15 +2109,11 @@ This mechanism allows you to apply the same set of listeners to an entire organi
DEPENDENCY INJECTION
------------------------------------>
-<h4>
-<a class="section" indent=".." name="dependency-injection">Dependency injection</a>
-</h4>
+<h4><a class="section" indent=".." name="dependency-injection">Dependency injection</a></h4>
TestNG supports two different kinds of dependency injection: native (performed by TestNG itself) and external (performed by a dependency injection framework such as Guice).
-<h5>
-<a class="section" indent="..." name="native-dependency-injection">Native dependency injection</a>
-</h5>
+<h5><a class="section" indent="..." name="native-dependency-injection">Native dependency injection</a></h5>
TestNG lets you declare additional parameters in your methods. When this happens, TestNG will automatically fill these parameters with the right value. Dependency injection can be used in the following places:
@@ -2159,9 +2160,7 @@ public class NoInjectionTest {
}
</pre>
-<h5>
-<a class="section" indent="..." name="guice-dependency-injection">Guice dependency injection</a>
-</h5>
+<h5><a class="section" indent="..." name="guice-dependency-injection">Guice dependency injection</a></h5>
If you use Guice, TestNG gives you an easy way to inject your test objects with a Guice module:
@@ -2298,9 +2297,7 @@ This configuration ensures you that all tests in this suite will be run with sam
INVOKED METHOD LISTENERS
------------------------------------>
-<h4>
-<a class="section" indent=".." name="invokedmethodlistener">Listening to method invocations</a>
-</h4>
+<h4><a class="section" indent=".." name="invokedmethodlistener">Listening to method invocations</a></h4>
The listener <tt><a href="../javadocs/org/testng/IInvokedMethodListener.html">IInvokedMethodListener</a></tt> allows you to be notified whenever TestNG is about to invoke a test (annotated with <tt>@Test</tt>) or configuration (annotated with any of the <tt>@Before</tt> or <tt>@After</tt> annotation) method. You need to implement the following interface:
@@ -2320,9 +2317,7 @@ and declare it as a listener, as explained in <a href="#testng-listeners">the se
IHOOKABLE AND ICONFIGURABLE
------------------------------------>
-<h4>
-<a class="section" indent=".." name="ihookable">Overriding test methods</a></h4>
-</h4>
+<h4><a class="section" indent=".." name="ihookable">Overriding test methods</a></h4>
TestNG allows you to override and possibly skip the invocation of test methods. One example of where this is useful is if you need to your test methods with a specific security manager. You achieve this by providing a listener that implements <a href="../javadocs/org/testng/IHookable.html"><tt>IHookable</tt></a>.
<p>
@@ -2347,14 +2342,10 @@ public class MyHook implements IHookable {
TEST SUCCESS
------------------------------------>
-<h3>
-<a class="section" indent="." name="test-results">Test results</a>
-</h3>
+<h3><a class="section" indent="." name="test-results">Test results</a></h3>
-<h4>
-<a class="section" indent=".." name="success-failure">Success, failure and assert</a>
-</h4>
+<h4><a class="section" indent=".." name="success-failure">Success, failure and assert</a></h4>
<p>A test is considered successful if it completed without throwing any
@@ -2660,9 +2651,7 @@ TestNG offers an XML reporter capturing TestNG specific information that is not
YAML
------------------------------------>
-<h3>
-<a class="section" name="yaml">YAML</a>
-</h3>
+<h3><a class="section" name="yaml">YAML</a></h3>
TestNG supports <a href="http://www.yaml.org/">YAML</a> as an alternate way of specifying your suite file. For example, the following XML file:
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/testng.git
More information about the pkg-java-commits
mailing list