source: general/genlib/umockdev.xml

<?xml version="1.0" encoding="UTF-8"?>
<!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 umockdev-download-http "https://github.com/martinpitt/umockdev/releases/download/&umockdev-version;/umockdev-&umockdev-version;.tar.xz">
  <!ENTITY umockdev-download-ftp  " ">
  <!ENTITY umockdev-md5sum        "74342306a6d25e266dfa2a7b7695c2e1">
  <!ENTITY umockdev-size          "484 KB">
  <!ENTITY umockdev-buildsize     "6.8 MB (with tests)">
  <!ENTITY umockdev-time          "0.1 SBU (with tests)">
]>

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


  <title>Umockdev-&umockdev-version;</title>

  <indexterm zone="umockdev">
    <primary sortas="a-umockdev">umockdev</primary>
  </indexterm>

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

    <para>
      The <application>Umockdev</application> package contains a framework
      that allows a developer to mock devices for use in unit testing.
    </para>

    &lfs121_checked;

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

    <bridgehead renderas="sect3">Umockdev Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libgudev"/>,
      <xref linkend="libpcap"/>, and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      <ulink url="http://www.gphoto.org/">libgphoto2</ulink> (optional for tests)
    </para>

  </sect2>

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

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue as the &root; user: <command>ninja test</command>.
      One test needs to be run in an X session.
    </para>

    <para>
      Now, as the &root; user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>
  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <option>-Dgtk_doc=true</option>: Use this switch if you have
      <xref linkend="gtk-doc" role="nodep"/> installed and wish to rebuild and
      install the API documentation.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
           umockdev-record,
           umockdev-run, and
           umockdev-wrapper
        </seg>
        <seg>
          libumockdev-preload.so <!-- Only intended for use by
          umockdev-wrapper. Don't put in a short description for this--> and
          libumockdev.so
        </seg>
        <seg>
          /usr/include/umockdev-1.0
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="umockdev-record">
        <term><command>umockdev-record</command></term>
        <listitem>
          <para>
            records Linux devices and their ancestors from sysfs/udev or
            records ioctls for a device
          </para>
          <indexterm zone="umockdev umockdev-record">
            <primary sortas="b-umockdev-record">umockdev-record</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="umockdev-run">
        <term><command>umockdev-run</command></term>
        <listitem>
          <para>
            runs a program under an <application>umockdev</application>
            testbed
          </para>
          <indexterm zone="umockdev umockdev-run">
            <primary sortas="b-umockdev-run">umockdev-run</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="umockdev-wrapper">
        <term><command>umockdev-wrapper</command></term>
        <listitem>
          <para>
            wraps a program around
            <filename class="libraryfile">libumockdev-preload.so.0</filename>
            through LD_PRELOAD
          </para>
          <indexterm zone="umockdev umockdev-wrapper">
            <primary sortas="b-umockdev-wrapper">umockdev-wrapper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libumockdev">
        <term><filename class="libraryfile">libumockdev.so</filename></term>
        <listitem>
          <para>
            provides API functions that allow mocking hardware devices for unit
            testing
          </para>
          <indexterm zone="umockdev libumockdev">
            <primary sortas="c-libumockdev">libumockdev.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>