source: general/prog/junit.xml@ 3153e82

<?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://github.com/junit-team/junit&junit-major;/archive/r&junit-version;/junit-&junit-version;.tar.gz">
  <!ENTITY junit-download-ftp  " ">
  <!ENTITY junit-md5sum        "22578a9b35cbb71d556a2e625c576c81">
  <!ENTITY junit-size          "433 KB">
  <!ENTITY junit-buildsize     "27 MB">
  <!ENTITY junit-time          "0.2 SBU (with dicumentation, using 4 cores; add maven <quote>artifacts</quote> download time)">
]>

<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>

    <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>

    &lfs82_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>
<!-- maven downloads this for us:
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required file: <ulink
             url="http://repo1.maven.org/maven2/org/hamcrest/hamcrest-core/&hamcrest-version;/hamcrest-core-&hamcrest-version;.jar"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Required file: <ulink
             url="http://repo1.maven.org/maven2/org/hamcrest/hamcrest-core/&hamcrest-version;/hamcrest-core-&hamcrest-version;-sources.jar"/>
        </para>
      </listitem>
    </itemizedlist>
-->
    <bridgehead renderas="sect3">JUnit Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="maven"/> and
      <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>
      First remove a test, which fails with <application>Java 9</application>.
    </para>

<screen><userinput>sed -e '/MethodsSorted/i    @Ignore' \
    -i src/test/java/org/junit/runners/model/TestClassTest.java</userinput></screen>

    <para>
      Install <application>Junit</application> by running the following
      commands:
    </para>

<screen><userinput>mvn -DjdkVersion=1.6 install</userinput></screen>

    <para>
      The tests are run as part of the command above.
    </para>

    <para>
      If you wish to generate the documentation, issue:
    </para>

<screen><userinput>mvn site</userinput></screen>

    <para>
      Install the files in the final location as the
      <systemitem class="username">root</systemitem> user:
    </para>

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

    <para>
      if the documentation was built, install it as the
      <systemitem class="username">root</systemitem> user:
    </para>
<screen role="root"><userinput>install -v -m755 -d    /usr/share/doc/junit-&junit-version; &amp;&amp;
cp -v -R target/site/* /usr/share/doc/junit-&junit-version;</userinput></screen>


    <para>
      If you have followed the instructions in <xref linkend="ojdk-conf"/>,
      there is nothing more to do: the <envar>CLASSPATH</envar> variable
      would be automatically updated.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>None</seg>
        <seg>hamcrest-core and junit jar files</seg>
        <seg>/usr/share/doc/junit-&junit-version; and
             /usr/share/java/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>

      <varlistentry id="hamcrest-core">
        <term><filename class='libraryfile'>hamcrest-core-1.3.jar</filename></term>
        <listitem>
          <para>contains java classes to support matchers used in xUnit
          tests.</para>
          <indexterm zone="junit hamcrest-core">
            <primary sortas="c-hamcrest-core">hamcrest-core-1.3.jar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>