1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY umockdev-download-http "https://github.com/martinpitt/umockdev/releases/download/&umockdev-version;/umockdev-&umockdev-version;.tar.xz">
|
---|
8 | <!ENTITY umockdev-download-ftp " ">
|
---|
9 | <!ENTITY umockdev-md5sum "a9ff284518c034aa334b58237074e313">
|
---|
10 | <!ENTITY umockdev-size "484 KB">
|
---|
11 | <!ENTITY umockdev-buildsize "6.8 MB (with tests)">
|
---|
12 | <!ENTITY umockdev-time "0.2 SBU (with tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="umockdev" xreflabel="umockdev-&umockdev-version;">
|
---|
16 | <?dbhtml filename="umockdev.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>Umockdev-&umockdev-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="umockdev">
|
---|
22 | <primary sortas="a-umockdev">umockdev</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to Umockdev</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>Umockdev</application> package contains a framework
|
---|
30 | that allows a developer to mock devices for use in unit testing.
|
---|
31 | </para>
|
---|
32 |
|
---|
33 | &lfs120_checked;
|
---|
34 |
|
---|
35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
36 | <itemizedlist spacing="compact">
|
---|
37 | <listitem>
|
---|
38 | <para>
|
---|
39 | Download (HTTP): <ulink url="&umockdev-download-http;"/>
|
---|
40 | </para>
|
---|
41 | </listitem>
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (FTP): <ulink url="&umockdev-download-ftp;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download MD5 sum: &umockdev-md5sum;
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download size: &umockdev-size;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Estimated disk space required: &umockdev-buildsize;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated build time: &umockdev-time;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | </itemizedlist>
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect3">Umockdev Dependencies</bridgehead>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
72 | <para role="required">
|
---|
73 | <xref linkend="libgudev"/>,
|
---|
74 | <xref linkend="libpcap"/>, and
|
---|
75 | <xref linkend="vala"/>
|
---|
76 | </para>
|
---|
77 |
|
---|
78 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
79 | <para role="optional">
|
---|
80 | <xref linkend="gtk-doc"/> and
|
---|
81 | <ulink url="http://www.gphoto.org/">libgphoto2</ulink> (optional for tests)
|
---|
82 | </para>
|
---|
83 |
|
---|
84 | </sect2>
|
---|
85 |
|
---|
86 | <sect2 role="installation">
|
---|
87 | <title>Installation of Umockdev</title>
|
---|
88 |
|
---|
89 | <para>
|
---|
90 | Install <application>Umockdev</application> by running the following
|
---|
91 | commands:
|
---|
92 | </para>
|
---|
93 |
|
---|
94 | <screen><userinput>mkdir build &&
|
---|
95 | cd build &&
|
---|
96 |
|
---|
97 | meson setup --prefix=/usr --buildtype=release .. &&
|
---|
98 | ninja</userinput></screen>
|
---|
99 |
|
---|
100 | <para>
|
---|
101 | To test the results, issue: <command>ninja test</command>. One test
|
---|
102 | needs to be run in an X session.
|
---|
103 | </para>
|
---|
104 |
|
---|
105 | <para>
|
---|
106 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
107 | </para>
|
---|
108 |
|
---|
109 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
110 | </sect2>
|
---|
111 |
|
---|
112 | <sect2 role="commands">
|
---|
113 | <title>Command Explanations</title>
|
---|
114 |
|
---|
115 | <!--
|
---|
116 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
117 | href="../../xincludes/static-libraries.xml"/>
|
---|
118 |
|
---|
119 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
120 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
121 | -->
|
---|
122 | <para>
|
---|
123 | <option>-Dgtk_doc=true</option>: Use this switch if you have
|
---|
124 | <xref linkend="gtk-doc" role="nodep"/> installed and wish to rebuild and
|
---|
125 | install the API documentation.
|
---|
126 | </para>
|
---|
127 |
|
---|
128 | </sect2>
|
---|
129 |
|
---|
130 | <sect2 role="content">
|
---|
131 | <title>Contents</title>
|
---|
132 |
|
---|
133 | <segmentedlist>
|
---|
134 | <segtitle>Installed Programs</segtitle>
|
---|
135 | <segtitle>Installed Libraries</segtitle>
|
---|
136 | <segtitle>Installed Directories</segtitle>
|
---|
137 |
|
---|
138 | <seglistitem>
|
---|
139 | <seg>
|
---|
140 | umockdev-record,
|
---|
141 | umockdev-run, and
|
---|
142 | umockdev-wrapper
|
---|
143 | </seg>
|
---|
144 | <seg>
|
---|
145 | libumockdev-preload.so <!-- Only intended for use by
|
---|
146 | umockdev-wrapper. Don't put in a short description for this--> and
|
---|
147 | libumockdev.so
|
---|
148 | </seg>
|
---|
149 | <seg>
|
---|
150 | /usr/include/umockdev-1.0
|
---|
151 | </seg>
|
---|
152 | </seglistitem>
|
---|
153 | </segmentedlist>
|
---|
154 |
|
---|
155 | <variablelist>
|
---|
156 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
157 | <?dbfo list-presentation="list"?>
|
---|
158 | <?dbhtml list-presentation="table"?>
|
---|
159 |
|
---|
160 | <varlistentry id="umockdev-record">
|
---|
161 | <term><command>umockdev-record</command></term>
|
---|
162 | <listitem>
|
---|
163 | <para>
|
---|
164 | records Linux devices and their ancestors from sysfs/udev or
|
---|
165 | records ioctls for a device
|
---|
166 | </para>
|
---|
167 | <indexterm zone="umockdev umockdev-record">
|
---|
168 | <primary sortas="b-umockdev-record">umockdev-record</primary>
|
---|
169 | </indexterm>
|
---|
170 | </listitem>
|
---|
171 | </varlistentry>
|
---|
172 |
|
---|
173 | <varlistentry id="umockdev-run">
|
---|
174 | <term><command>umockdev-run</command></term>
|
---|
175 | <listitem>
|
---|
176 | <para>
|
---|
177 | runs a program under an <application>umockdev</application>
|
---|
178 | testbed
|
---|
179 | </para>
|
---|
180 | <indexterm zone="umockdev umockdev-run">
|
---|
181 | <primary sortas="b-umockdev-run">umockdev-run</primary>
|
---|
182 | </indexterm>
|
---|
183 | </listitem>
|
---|
184 | </varlistentry>
|
---|
185 |
|
---|
186 | <varlistentry id="umockdev-wrapper">
|
---|
187 | <term><command>umockdev-wrapper</command></term>
|
---|
188 | <listitem>
|
---|
189 | <para>
|
---|
190 | wraps a program around
|
---|
191 | <filename class="libraryfile">libumockdev-preload.so.0</filename>
|
---|
192 | through LD_PRELOAD
|
---|
193 | </para>
|
---|
194 | <indexterm zone="umockdev umockdev-wrapper">
|
---|
195 | <primary sortas="b-umockdev-wrapper">umockdev-wrapper</primary>
|
---|
196 | </indexterm>
|
---|
197 | </listitem>
|
---|
198 | </varlistentry>
|
---|
199 |
|
---|
200 | <varlistentry id="libumockdev">
|
---|
201 | <term><filename class="libraryfile">libumockdev.so</filename></term>
|
---|
202 | <listitem>
|
---|
203 | <para>
|
---|
204 | provides API functions that allow mocking hardware devices for unit
|
---|
205 | testing
|
---|
206 | </para>
|
---|
207 | <indexterm zone="umockdev libumockdev">
|
---|
208 | <primary sortas="c-libumockdev">libumockdev.so</primary>
|
---|
209 | </indexterm>
|
---|
210 | </listitem>
|
---|
211 | </varlistentry>
|
---|
212 | </variablelist>
|
---|
213 | </sect2>
|
---|
214 |
|
---|
215 | </sect1>
|
---|