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