source: general/prog/junit.xml@ debb88bf

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY junit-download-http "https://launchpad.net/debian/+archive/primary/+files/junit4_4.11.orig.tar.gz">
  <!ENTITY junit-download-ftp  " ">
  <!ENTITY junit-md5sum        " ">
  <!ENTITY junit-size          "1.7 MB">
  <!ENTITY junit-buildsize     "15 MB">
  <!ENTITY junit-time          "less than 0.1 SBU">
]>

<sect1 id="junit" xreflabel="JUnit-&junit-version;">
  <?dbhtml filename="junit.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>JUnit-&junit-version;</title>

  <indexterm zone="junit">
    <primary sortas="a-JUnit">JUnit</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to JUnit</title>

    <warning><para>Under revison do not use for now.</para></warning>


    <para>The <application>JUnit</application> package contains a simple, open
    source framework to write and run repeatable tests. It is an instance of
    the xUnit architecture for unit testing frameworks. JUnit features include
    assertions for testing expected results, test fixtures for sharing common
    test data, and test runners for running tests.</para>

<!--    &lfs73_checked; -->

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&junit-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&junit-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &junit-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &junit-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &junit-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &junit-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Required Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          <ulink url="http://anduin.linuxfromscratch.org/sources/other/junit-4.11.jar">junit-4.11.jar
          (http//anduin.linuxfromscratch.org/sources/other/junit-4.11.jar)
          </ulink>
        </para>
      </listitem>
      <listitem>
        <para>
          <ulink url="http://hamcrest.googlecode.com/files/hamcrest-1.3.tgz">hamcrest-1.3.tgz
          (http//hamcrest.googlecode.com/files/hamcrest-1.3.tgz)
          </ulink>
        </para>
      </listitem>
    </itemizedlist>
 
    <bridgehead renderas="sect3">JUnit Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="unzip"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/junit"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of JUnit</title>

    <para>To do a full build of JUnit from source, <xref linkend='apache-ant'/>
    is required.  However JUnit is a circular depedency of Apache Ant.  Copy
    the JUnit jar file to get started.  Then come back to build from source, if
    desired.</para>

    <para>Install the <application>JUnit</application> jar file by running the following
    commands as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/java &amp;&amp;
cp -v junit.jar  /usr/share/java</userinput></screen>

    <para>Now install the required hamcrest jar files.  Extract the hamcrest-1.3.tgz
    files change to the extracted directory.  Then, as the 
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/java/hamcrest        &amp;&amp;
cp -v hamcrest-all-1.3.jar /usr/share/java/hamcrest &amp;&amp; 
ln -sv  hamcrest/hamcrest-all-1.3.jar /usr/share/java/hamcrest.jar </userinput></screen>

    <para>Add the <filename
    class='libraryfile'>junit-&junit-version;.jar</filename> and <filename
    class='directory'>/usr/share/junit-&junit-version;</filename> directory to
    your system <envar>CLASSPATH</envar> environment variable:</para>

<screen><userinput>export CLASSPATH=$CLASSPATH:\
/usr/share/java/junit-&junit-version;.jar:/usr/share/java/hamcrest.jar</userinput></screen>
<!--
    <para>To run the <application>JUnit</application> regression self-tests,
    you'll need to have <xref linkend="openjdk"/>,<!- - <xref linkend="jdk"/>,- -> or
    <ulink url="http://jikes.sourceforge.net/">Jikes</ulink> installed and the
    <envar>CLASSPATH</envar> environment variable updated. Then, as an
    unprivileged user, issue:</para>

<screen><userinput>java org.junit.runner.JUnitCore org.junit.tests.AllTests</userinput></screen>
-->
  </sect2>
<!--
  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>junit-&junit-version;.jar</seg>
        <seg>/usr/share/junit-&junit-version;,
        /usr/share/doc/junit-&junit-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="junit.jar">
        <term><filename class='libraryfile'>junit-&junit-version;.jar</filename></term>
        <listitem>
          <para>contains java classes to support the xUnit framework testing
          architecture.</para>
          <indexterm zone="junit junit.jar">
            <primary sortas="c-junit.jar">junit-&junit-version;.jar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>
-->
</sect1>