.. _koji:


koji - download builds and tags from koji
+++++++++++++++++++++++++++++++++++++++++


Synopsis
--------

.. versionadded:: 0.1

The koji directive interfaces with `Koji <http://koji.fedoraproject.org/>`_ to facilitate various Koji actions.


.. note:: This may end up being split into multiple koji download modules, one for builds and another directive for tags

Options
-------

.. raw:: html

    <table border=1 cellpadding=4>
    <tr>
    <th class="head">parameter</th>
    <th class="head">required</th>
    <th class="head">default</th>
    <th class="head">choices</th>
    <th class="head">comments</th>
    </tr>
            <tr>
    <td>arch</td>
    <td>yes</td>
    <td></td>
        <td><ul><li>i386</li><li>x86_64</li><li>noarch</li><li>src</li></ul></td>
        <td>buildarch of builds to download from koji</td>
    </tr>
            <tr>
    <td>command</td>
    <td>yes</td>
    <td></td>
        <td><ul><li>tag</li><li>build</li></ul></td>
        <td>choose whether to download a single build or an entire tag</td>
    </tr>
            <tr>
    <td>koji_build</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>nevr of koji build to download</td>
    </tr>
            <tr>
    <td>koji_tag</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>name of tag to download from koji</td>
    </tr>
            <tr>
    <td>target_dir</td>
    <td>yes</td>
    <td>${workdir}</td>
        <td><ul></ul></td>
        <td>directory in which to download builds</td>
    </tr>
        </table>


.. note:: Requires the koji package must be installed as an rpm, it can't be installed via pip


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

Returns a hashmap of ``{'downloaded_rpms': [file1, file2, ...]}``


Examples
--------


Download the single build ``foo-1.0-2.fc99``::

  - name: download foo
    koji:
      action: download
      envr: foo-1.0-2.fc99

Download the ``f99-updates-testing-tag`` to ``${workdir}/tagdownload/``::

  - name: download f99-updates-testing to tagdownload
    koji:
      action: download_tag
      tag: f99-updates-testing-pending
      target_dir: ${workdir}/tagdownload