.. _yumrepoinfo_directive:


yumrepoinfo_directive - translate Koji tags into YUM repository URLs
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 0.4

Translate a Koji tag into a set of YUM repositories. This is useful when you
want to work with YUM metadata for a specific Fedora repository, but you only
know its Koji tag.


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>arch</p></td>
    <td>yes</td>
    <td><p>list of architectures. In this list, all &quot;meta architectures&quot; like <tt class="docutils literal">all</tt>, <tt class="docutils literal">src</tt> and <tt class="docutils literal">noarch</tt> are ignored, list of &quot;real architectures&quot; is expected there (e.g. <tt class="docutils literal">x86_64</tt> or <tt class="docutils literal">i386</tt>).</p></td>
    <td><p>list of str</p></td>
    <td></td>
    <td><ul></ul></td>
    </tr>
            <tr>
    <td class="bold"><p>koji_tag</p></td>
    <td>yes</td>
    <td><p>name of the Koji tag, e.g. <tt class="docutils literal">f20</tt>, <tt class="docutils literal"><span class="pre">f20-updates</span></tt>,
    <tt class="docutils literal"><span class="pre">f20-updates-testing</span></tt>, or <tt class="docutils literal">rawhide</tt>.</p>
    <p>If the tag ends with <tt class="docutils literal"><span class="pre">-pending</span></tt> suffix, this suffix is stripped (because
    pending tags are not real repositories), and the resulting tag is used.</p></td>
    <td><p>str</p></td>
    <td></td>
    <td><ul></ul></td>
    </tr>
        </table>

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

A dictionary of dictionaries. Main key is ``koji_tag`` with value of
dictionary that contains ``arch`` as key and URL for the respective
repository is its value.

If the repository in question has some parent repositories (e.g.
``f20-updates`` is a child of ``f20``), all its parents names and their
repository URLs are returned in the dictionary as well as additional keys.
Example::

    {'f20': {'x86_64': 'http://...',
             'i386': 'http://...'},
     'f20-updates': {'x86_64': 'http://...',
                     'i386': 'http://...'}}


Exceptions
----------

* :class:`.TaskotronDirectiveError`: if there are zero "real architectures"
  inside ``arch`` or when ``koji_tag`` is not found among known repositories.



Examples
--------


For a koji tag received from the command line, get a list of its YUM
repositories and save it to a variable::

    - name: get yum repos
      yumrepoinfo:
          koji_tag: ${koji_tag}
          arch: ${arch}
      export: yumrepos

Now you can pass ``${yumrepos}`` dictionary to your python script and run your
check::

    - name: run my check
      python:
          file: my_check.py
          callable: run
          repos: ${yumrepos}
          arch: ${arch}
      export: my_check_output