.. _bodhi_directive:


bodhi_directive - download updates from Bodhi
+++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 0.4

The bodhi directive interfaces with `Bodhi`_ to facilitate various actions.
At the moment, the only action supported is downloading updates (i.e. all RPMs
from all builds related to a specific update).

.. _Bodhi: https://bodhi.fedoraproject.org


Parameters
----------

.. raw:: html

    <table class="rawhtml" border=1 cellpadding=4>
    <tr>
    <th class="head">parameter</th>
    <th class="head">required</th>
    <th class="head">description</th>
    <th class="head">type</th>
    <th class="head">default</th>
    <th class="head">choices</th>
    </tr>
            <tr>
    <td class="bold"><p>action</p></td>
    <td>yes</td>
    <td><p>specify action type. The only action available at the moment is <tt class="docutils literal">download</tt>.</p></td>
    <td><p>str</p></td>
    <td></td>
    <td><ul></ul></td>
    </tr>
            <tr>
    <td class="bold"><p>arch</p></td>
    <td>yes</td>
    <td><p>a list of architectures for which to download RPMs.</p>
    <p>Note: <tt class="docutils literal">noarch</tt> RPMs are always automatically downloaded even when not
    requested, unless <tt class="docutils literal"><span class="pre">arch=[]</span></tt> and <tt class="docutils literal">src=True</tt>.</p></td>
    <td><p>list of str</p></td>
    <td></td>
    <td><ul></ul></td>
    </tr>
            <tr>
    <td class="bold"><p>src</p></td>
    <td>no</td>
    <td><p>download also <tt class="docutils literal">src</tt> RPM files</p></td>
    <td><p>bool</p></td>
    <td><p>False</p></td>
    <td><ul></ul></td>
    </tr>
            <tr>
    <td class="bold"><p>update_id</p></td>
    <td>yes</td>
    <td><p>Bodhi update ID to download, e.g. <tt class="docutils literal"><span class="pre">FEDORA-2014-7485</span></tt>.</p></td>
    <td><p>str</p></td>
    <td></td>
    <td><ul></ul></td>
    </tr>
        </table>

Return Values
-------------

A dictionary containing following items:

* ``downloaded_rpms``: (list of str) a list of local filenames of the
  downloaded RPMs


Exceptions
----------

* :class:`.TaskotronDirectiveError`: if no update with ``update_id`` has been
  found
* :class:`.TaskotronRemoteError`: if downloading failed
* :class:`.TaskotronValueError`: if ``arch=[]`` and ``src=False``, therefore
  there is nothing to download



Examples
--------


Download a Bodhi update provided on the command line and then check it with
rpmlint::

    - name: download update from Bodhi
      bodhi:
        action: download
        update_id: ${update_id}
        arch: ${arch}

    - name: run rpmlint on downloaded rpms
      python:
          file: run_rpmlint.py
          callable: run
          workdir: ${workdir}
      export: rpmlint_output