root / doc / devnotes.rst @ 35bdbec3
History | View | Annotate | Download (8.2 kB)
1 |
Developer notes |
---|---|
2 |
=============== |
3 |
|
4 |
.. highlight:: shell-example |
5 |
|
6 |
Build dependencies |
7 |
------------------ |
8 |
|
9 |
Most dependencies from :doc:`install-quick`, including ``qemu-img`` |
10 |
(marked there as optional) plus (for Python): |
11 |
|
12 |
- `GNU make <http://www.gnu.org/software/make/>`_ |
13 |
- `GNU tar <http://www.gnu.org/software/tar/>`_ |
14 |
- `Gzip <http://www.gnu.org/software/gzip/>`_ |
15 |
- `pandoc <http://johnmacfarlane.net/pandoc/>`_ |
16 |
- `python-epydoc <http://epydoc.sourceforge.net/>`_ |
17 |
- `python-sphinx <http://sphinx.pocoo.org/>`_ |
18 |
(tested with version 1.1.3) |
19 |
- `python-mock <http://www.voidspace.org.uk/python/mock/>`_ |
20 |
(tested with version 1.0.1) |
21 |
- `graphviz <http://www.graphviz.org/>`_ |
22 |
- the `en_US.UTF-8` locale must be enabled on the system |
23 |
- `pylint <http://www.logilab.org/857>`_ and its associated |
24 |
dependencies |
25 |
- `pep8 <https://github.com/jcrocholl/pep8/>`_ |
26 |
- `PyYAML <http://pyyaml.org/>`_ |
27 |
|
28 |
For older developement (Ganeti < 2.4) ``docbook`` was used instead of |
29 |
``pandoc``. |
30 |
|
31 |
Note that for pylint, at the current moment the following versions |
32 |
must be used:: |
33 |
|
34 |
$ pylint --version |
35 |
pylint 0.26.0, |
36 |
astng 0.24.1, common 0.58.3 |
37 |
|
38 |
The same with pep8, other versions may give you errors:: |
39 |
|
40 |
$ pep8 --version |
41 |
1.3.3 |
42 |
|
43 |
Both these versions are the ones shipped with Ubuntu 13.04. |
44 |
|
45 |
To generate unittest coverage reports (``make coverage``), `coverage |
46 |
<http://pypi.python.org/pypi/coverage>`_ needs to be installed. |
47 |
|
48 |
Installation of all dependencies listed here:: |
49 |
|
50 |
$ apt-get install python-setuptools automake git fakeroot |
51 |
$ apt-get install pandoc python-epydoc graphviz |
52 |
$ apt-get install python-yaml |
53 |
$ cd / && sudo easy_install \ |
54 |
sphinx \ |
55 |
logilab-astng==0.24.1 \ |
56 |
logilab-common==0.58.3 \ |
57 |
pylint==0.26.0 \ |
58 |
pep8==1.3.3 \ |
59 |
mock==1.0.1 \ |
60 |
coverage |
61 |
|
62 |
For Haskell development, again all things from the quick install |
63 |
document, plus: |
64 |
|
65 |
- `haddock <http://www.haskell.org/haddock/>`_, documentation |
66 |
generator (equivalent to epydoc for Python) |
67 |
- `HsColour <http://hackage.haskell.org/package/hscolour>`_, again |
68 |
used for documentation (it's source-code pretty-printing) |
69 |
- `hlint <http://community.haskell.org/~ndm/hlint/>`_, a source code |
70 |
linter (equivalent to pylint for Python), recommended version 1.8 or |
71 |
above (tested with 1.8.43) |
72 |
- the `QuickCheck <http://hackage.haskell.org/package/QuickCheck>`_ |
73 |
library, version 2.x |
74 |
- the `HUnit <http://hunit.sourceforge.net/>`_ library (tested with |
75 |
1.2.x) |
76 |
- the `test-framework |
77 |
<http://batterseapower.github.com/test-framework/>`_ libraries, |
78 |
tested versions: ``test-framework``: 0.6, ``test-framework-hunit``: |
79 |
0.2.7, ``test-framework-quickcheck2``: 0.2.12.1 |
80 |
- ``hpc``, which comes with the compiler, so you should already have |
81 |
it |
82 |
- `shelltestrunner <http://joyful.com/shelltestrunner>`_, used for |
83 |
running shell-based unit-tests |
84 |
- `temporary <https://github.com/batterseapower/temporary/>`_ library, |
85 |
tested with version 1.1.2.3 |
86 |
|
87 |
Under Debian Wheezy or later, these can be installed (on top of the |
88 |
required ones from the quick install document) via:: |
89 |
|
90 |
$ apt-get install libghc-quickcheck2-dev libghc-hunit-dev \ |
91 |
libghc-test-framework-dev \ |
92 |
libghc-test-framework-quickcheck2-dev \ |
93 |
libghc-test-framework-hunit-dev \ |
94 |
libghc-temporary-dev \ |
95 |
hscolour hlint |
96 |
|
97 |
Or alternatively via ``cabal``:: |
98 |
|
99 |
$ cabal install QuickCheck HUnit \ |
100 |
test-framework test-framework-quickcheck2 test-framework-hunit \ |
101 |
temporary hscolour hlint shelltestrunner |
102 |
|
103 |
|
104 |
Configuring for development |
105 |
--------------------------- |
106 |
|
107 |
Run the following command (only use ``PYTHON=...`` if you need to use a |
108 |
different python version):: |
109 |
|
110 |
$ ./autogen.sh && \ |
111 |
./configure --prefix=/usr/local --sysconfdir=/etc --localstatedir=/var |
112 |
|
113 |
Note that doing development on a machine which already has Ganeti |
114 |
installed is problematic, as ``PYTHONPATH`` behaviour can be confusing |
115 |
(see Issue 170 for a bit of history/details; in general it works if |
116 |
the installed and developed versions are very similar, and/or if |
117 |
PYTHONPATH is customised correctly). As such, in general it's |
118 |
recommended to use a "clean" machine for ganeti development. |
119 |
|
120 |
Haskell development notes |
121 |
------------------------- |
122 |
|
123 |
There are a few things which can help writing or debugging the Haskell |
124 |
code. |
125 |
|
126 |
You can run the Haskell linter :command:`hlint` via:: |
127 |
|
128 |
$ make hlint |
129 |
|
130 |
This is not enabled by default (as the htools component is |
131 |
optional). The above command will generate both output on the terminal |
132 |
and, if any warnings are found, also an HTML report at |
133 |
``doc/hs-lint.html``. |
134 |
|
135 |
When writing or debugging TemplateHaskell code, it's useful to see |
136 |
what the splices are converted to. This can be done via:: |
137 |
|
138 |
$ make HEXTRA="-ddump-splices" |
139 |
|
140 |
Or, more interactively:: |
141 |
|
142 |
$ ghci |
143 |
λ> :set -ddump-splices |
144 |
λ> :l src/Ganeti/Objects.hs |
145 |
|
146 |
And you will get the spliced code as the module is loaded. |
147 |
|
148 |
To build profiling code you must install the ``ghc-prof`` (or |
149 |
``gch6-prof``) package, and all the relevant libraries with their |
150 |
``-prof`` counterparts. If installing libraries through cabal the config |
151 |
file should include ``library-profiling: True`` or the ``-p`` flag |
152 |
should be used. Any library already installed can be updated by passing |
153 |
``--reinstall`` as well. |
154 |
|
155 |
Due to the way TemplateHaskell works, it's not straightforward to |
156 |
build profiling code. The recommended way is to run ``make hs-prof``, |
157 |
or alternatively the manual sequence is:: |
158 |
|
159 |
$ make clean |
160 |
$ make src/htools HEXTRA="-osuf .o" |
161 |
$ rm src/htools |
162 |
$ make src/htools HEXTRA="-osuf .prof_o -prof -auto-all" |
163 |
|
164 |
This will build the binary twice, per the TemplateHaskell |
165 |
documentation, the second one with profiling enabled. |
166 |
|
167 |
The binary files generated by compilation and the profiling/coverage |
168 |
files can "break" tab-completion in the sources; they can be ignored, |
169 |
for example, in bash via ``.bashrc``:: |
170 |
|
171 |
FIGNORE='.o:.hi:.prof_o:.tix' |
172 |
|
173 |
or in emacs via ``completion-ignored-extensions`` (run ``M-x |
174 |
customize-var completion-ignored-extensions``). |
175 |
|
176 |
Running individual tests |
177 |
~~~~~~~~~~~~~~~~~~~~~~~~ |
178 |
|
179 |
When developing code, running the entire test suite can be |
180 |
slow. Running individual tests is possible. There are different |
181 |
Makefile targets for running individual Python and Haskell tests. |
182 |
|
183 |
For Python tests:: |
184 |
|
185 |
$ export PYTHONPATH=$PWD |
186 |
$ python ./test/py/ganeti.%mytest% |
187 |
|
188 |
For Haskell tests:: |
189 |
|
190 |
$ make hs-test-%pattern% |
191 |
|
192 |
Where ``pattern`` can be a simple test pattern (e.g. ``comma``, |
193 |
matching any test whose name contains ``comma``), a test pattern |
194 |
denoting a group (ending with a slash, e.g. ``Utils/``), or more |
195 |
complex glob pattern. For more details, search for glob patterns in |
196 |
the documentation of `test-framework |
197 |
<http://batterseapower.github.com/test-framework/>`_). |
198 |
|
199 |
For individual Haskell shelltests:: |
200 |
|
201 |
$ make hs-shell-%name% |
202 |
|
203 |
which runs the test ``test/hs/shelltests/htools-%name%.test``. For |
204 |
example, to run the test ``test/hs/shelltests/htools-balancing.test``, |
205 |
use:: |
206 |
|
207 |
$ make hs-shell-balancing |
208 |
|
209 |
For combined Haskell shelltests:: |
210 |
|
211 |
$ make hs-shell-{%name1%,%name2%,...} |
212 |
|
213 |
for example:: |
214 |
|
215 |
$ make hs-shell-{balancing,basic} |
216 |
|
217 |
Checking for the correct style of the NEWS file is also possible, by running:: |
218 |
|
219 |
$ make check-news |
220 |
|
221 |
Packaging notes |
222 |
=============== |
223 |
|
224 |
Ganeti is mostly developed and tested on `Debian |
225 |
<http://www.debian.org/>`_-based distributions, while still keeping |
226 |
adaptability to other Linux distributions in mind. |
227 |
|
228 |
The ``doc/examples/`` directory contains a number of potentially useful |
229 |
scripts and configuration files. Some of them might need adjustment |
230 |
before use. |
231 |
|
232 |
``daemon-util`` |
233 |
--------------- |
234 |
|
235 |
This script, in the source code as ``daemons/daemon-util.in``, is used |
236 |
to start/stop Ganeti and do a few other things related to system |
237 |
daemons. It is recommended to use ``daemon-util`` also from the system's |
238 |
init scripts. That way the code starting and stopping daemons is shared |
239 |
and future changes have to be made in only one place. |
240 |
|
241 |
``daemon-util`` reads extra arguments from variables (``*_ARGS``) in |
242 |
``/etc/default/ganeti``. When modifying ``daemon-util``, keep in mind to |
243 |
not remove support for the ``EXTRA_*_ARGS`` variables for starting |
244 |
daemons. Some parts of Ganeti use them to pass additional arguments when |
245 |
starting a daemon. |
246 |
|
247 |
The ``reload_ssh_keys`` function can be adjusted to use another command |
248 |
for reloading the OpenSSH daemon's host keys. |
249 |
|
250 |
.. vim: set textwidth=72 : |