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