2019-03-27 23:44:14 +00:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2019-07-29 22:17:38 +00:00
< title > pylorax.api.gitrpm — Lorax 31.9 documentation< / title >
2019-03-27 23:44:14 +00:00
< script type = "text/javascript" src = "../../../_static/js/modernizr.min.js" > < / script >
< script type = "text/javascript" id = "documentation_options" data-url_root = "../../../" src = "../../../_static/documentation_options.js" > < / script >
< script type = "text/javascript" src = "../../../_static/jquery.js" > < / script >
< script type = "text/javascript" src = "../../../_static/underscore.js" > < / script >
< script type = "text/javascript" src = "../../../_static/doctools.js" > < / script >
< script type = "text/javascript" src = "../../../_static/language_data.js" > < / script >
< script type = "text/javascript" src = "../../../_static/js/theme.js" > < / script >
< link rel = "stylesheet" href = "../../../_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../../_static/pygments.css" type = "text/css" / >
< link rel = "index" title = "Index" href = "../../../genindex.html" / >
< link rel = "search" title = "Search" href = "../../../search.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "../../../index.html" class = "icon icon-home" > Lorax
< / a >
< div class = "version" >
2019-07-29 22:17:38 +00:00
31.9
2019-03-27 23:44:14 +00:00
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../../../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../intro.html" > Introduction to Lorax< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../intro.html#before-lorax" > Before Lorax< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../lorax.html" > Lorax< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../livemedia-creator.html" > livemedia-creator< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../lorax-composer.html" > lorax-composer< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../composer-cli.html" > composer-cli< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../product-images.html" > Product and Updates Images< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../modules.html" > src< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "../../../index.html" > Lorax< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "../../../index.html" > Docs< / a > » < / li >
< li > < a href = "../../index.html" > Module code< / a > » < / li >
< li > < a href = "../../pylorax.html" > pylorax< / a > » < / li >
< li > pylorax.api.gitrpm< / li >
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< h1 > Source code for pylorax.api.gitrpm< / h1 > < div class = "highlight" > < pre >
< span > < / span > < span class = "c1" > # Copyright (C) 2019 Red Hat, Inc.< / span >
< span class = "c1" > #< / span >
< span class = "c1" > # This program is free software; you can redistribute it and/or modify< / span >
< span class = "c1" > # it under the terms of the GNU General Public License as published by< / span >
< span class = "c1" > # the Free Software Foundation; either version 2 of the License, or< / span >
< span class = "c1" > # (at your option) any later version.< / span >
< span class = "c1" > #< / span >
< span class = "c1" > # This program is distributed in the hope that it will be useful,< / span >
< span class = "c1" > # but WITHOUT ANY WARRANTY; without even the implied warranty of< / span >
< span class = "c1" > # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the< / span >
< span class = "c1" > # GNU General Public License for more details.< / span >
< span class = "c1" > #< / span >
< span class = "c1" > # You should have received a copy of the GNU General Public License< / span >
< span class = "c1" > # along with this program. If not, see < http://www.gnu.org/licenses/> .< / span >
< span class = "c1" > #< / span >
< span class = "sd" > " " " Clone a git repository and package it as an rpm< / span >
< span class = "sd" > This module contains functions for cloning a git repo, creating a tar archive of< / span >
< span class = "sd" > the selected commit, branch, or tag, and packaging the files into an rpm that will< / span >
< span class = "sd" > be installed by anaconda when creating the image.< / span >
< span class = "sd" > " " " < / span >
< span class = "kn" > import< / span > < span class = "nn" > logging< / span >
< span class = "n" > log< / span > < span class = "o" > =< / span > < span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > getLogger< / span > < span class = "p" > (< / span > < span class = "s2" > " lorax-composer" < / span > < span class = "p" > )< / span >
< span class = "kn" > import< / span > < span class = "nn" > os< / span >
< span class = "kn" > from< / span > < span class = "nn" > rpmfluff< / span > < span class = "k" > import< / span > < span class = "n" > SimpleRpmBuild< / span >
< span class = "kn" > import< / span > < span class = "nn" > shutil< / span >
< span class = "kn" > import< / span > < span class = "nn" > subprocess< / span >
< span class = "kn" > import< / span > < span class = "nn" > tempfile< / span >
< span class = "kn" > import< / span > < span class = "nn" > time< / span >
< span class = "kn" > from< / span > < span class = "nn" > pylorax.sysutils< / span > < span class = "k" > import< / span > < span class = "n" > joinpaths< / span >
< div class = "viewcode-block" id = "get_repo_description" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.gitrpm.get_repo_description" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > get_repo_description< / span > < span class = "p" > (< / span > < span class = "n" > gitRepo< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Return a description including the git repo and reference< / span >
< span class = "sd" > :param gitRepo: A dict with the repository details< / span >
< span class = "sd" > :type gitRepo: dict< / span >
< span class = "sd" > :returns: A string with the git repo url and reference< / span >
< span class = "sd" > :rtype: str< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > return< / span > < span class = "s2" > " Created from < / span > < span class = "si" > %s< / span > < span class = "s2" > , reference ' < / span > < span class = "si" > %s< / span > < span class = "s2" > ' , on < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "p" > (< / span > < span class = "n" > gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " repo" < / span > < span class = "p" > ],< / span > < span class = "n" > gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " ref" < / span > < span class = "p" > ],< / span > < span class = "n" > time< / span > < span class = "o" > .< / span > < span class = "n" > ctime< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "GitArchiveTarball" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.gitrpm.GitArchiveTarball" > [docs]< / a > < span class = "k" > class< / span > < span class = "nc" > GitArchiveTarball< / span > < span class = "p" > :< / span >
< span class = "sd" > " " " Create a git archive of the selected git repo and reference" " " < / span >
< span class = "k" > def< / span > < span class = "nf" > __init__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > gitRepo< / span > < span class = "p" > ):< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _gitRepo< / span > < span class = "o" > =< / span > < span class = "n" > gitRepo< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > sourceName< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " rpmname" < / span > < span class = "p" > ]< / span > < span class = "o" > +< / span > < span class = "s2" > " .tar.xz" < / span >
< div class = "viewcode-block" id = "GitArchiveTarball.write_file" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.gitrpm.GitArchiveTarball.write_file" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > write_file< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > sourcesDir< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Create the tar archive< / span >
< span class = "sd" > :param sourcesDir: Path to use for creating the archive< / span >
< span class = "sd" > :type sourcesDir: str< / span >
< span class = "sd" > This clones the git repository and creates a git archive from the specified reference.< / span >
< span class = "sd" > The result is in RPMNAME.tar.xz under the sourcesDir< / span >
< span class = "sd" > " " " < / span >
< span class = "c1" > # Clone the repository into a temporary location< / span >
< span class = "n" > cmd< / span > < span class = "o" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " git" < / span > < span class = "p" > ,< / span > < span class = "s2" > " clone" < / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " repo" < / span > < span class = "p" > ],< / span > < span class = "n" > joinpaths< / span > < span class = "p" > (< / span > < span class = "n" > sourcesDir< / span > < span class = "p" > ,< / span > < span class = "s2" > " gitrepo" < / span > < span class = "p" > )]< / span >
< span class = "n" > log< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "n" > cmd< / span > < span class = "p" > )< / span >
< span class = "k" > try< / span > < span class = "p" > :< / span >
2019-07-29 22:17:38 +00:00
< span class = "n" > subprocess< / span > < span class = "o" > .< / span > < span class = "n" > check_output< / span > < span class = "p" > (< / span > < span class = "n" > cmd< / span > < span class = "p" > ,< / span > < span class = "n" > stderr< / span > < span class = "o" > =< / span > < span class = "n" > subprocess< / span > < span class = "o" > .< / span > < span class = "n" > STDOUT< / span > < span class = "p" > )< / span >
2019-03-27 23:44:14 +00:00
< span class = "k" > except< / span > < span class = "n" > subprocess< / span > < span class = "o" > .< / span > < span class = "n" > CalledProcessError< / span > < span class = "k" > as< / span > < span class = "n" > e< / span > < span class = "p" > :< / span >
< span class = "n" > log< / span > < span class = "o" > .< / span > < span class = "n" > error< / span > < span class = "p" > (< / span > < span class = "s2" > " Failed to clone < / span > < span class = "si" > %s< / span > < span class = "s2" > : < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " repo" < / span > < span class = "p" > ],< / span > < span class = "n" > e< / span > < span class = "o" > .< / span > < span class = "n" > output< / span > < span class = "p" > )< / span >
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "s2" > " Failed to clone < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " repo" < / span > < span class = "p" > ])< / span >
< span class = "n" > oldcwd< / span > < span class = "o" > =< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > getcwd< / span > < span class = "p" > ()< / span >
< span class = "k" > try< / span > < span class = "p" > :< / span >
< span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > chdir< / span > < span class = "p" > (< / span > < span class = "n" > joinpaths< / span > < span class = "p" > (< / span > < span class = "n" > sourcesDir< / span > < span class = "p" > ,< / span > < span class = "s2" > " gitrepo" < / span > < span class = "p" > ))< / span >
< span class = "c1" > # Configure archive to create a .tar.xz< / span >
< span class = "n" > cmd< / span > < span class = "o" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " git" < / span > < span class = "p" > ,< / span > < span class = "s2" > " config" < / span > < span class = "p" > ,< / span > < span class = "s2" > " tar.tar.xz.command" < / span > < span class = "p" > ,< / span > < span class = "s2" > " xz -c" < / span > < span class = "p" > ]< / span >
< span class = "n" > log< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "n" > cmd< / span > < span class = "p" > )< / span >
< span class = "n" > subprocess< / span > < span class = "o" > .< / span > < span class = "n" > check_call< / span > < span class = "p" > (< / span > < span class = "n" > cmd< / span > < span class = "p" > )< / span >
< span class = "n" > cmd< / span > < span class = "o" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " git" < / span > < span class = "p" > ,< / span > < span class = "s2" > " archive" < / span > < span class = "p" > ,< / span > < span class = "s2" > " --prefix" < / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " rpmname" < / span > < span class = "p" > ]< / span > < span class = "o" > +< / span > < span class = "s2" > " /" < / span > < span class = "p" > ,< / span > < span class = "s2" > " -o" < / span > < span class = "p" > ,< / span > < span class = "n" > joinpaths< / span > < span class = "p" > (< / span > < span class = "n" > sourcesDir< / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > sourceName< / span > < span class = "p" > ),< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " ref" < / span > < span class = "p" > ]]< / span >
< span class = "n" > log< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "n" > cmd< / span > < span class = "p" > )< / span >
< span class = "k" > try< / span > < span class = "p" > :< / span >
2019-07-29 22:17:38 +00:00
< span class = "n" > subprocess< / span > < span class = "o" > .< / span > < span class = "n" > check_output< / span > < span class = "p" > (< / span > < span class = "n" > cmd< / span > < span class = "p" > ,< / span > < span class = "n" > stderr< / span > < span class = "o" > =< / span > < span class = "n" > subprocess< / span > < span class = "o" > .< / span > < span class = "n" > STDOUT< / span > < span class = "p" > )< / span >
2019-03-27 23:44:14 +00:00
< span class = "k" > except< / span > < span class = "n" > subprocess< / span > < span class = "o" > .< / span > < span class = "n" > CalledProcessError< / span > < span class = "k" > as< / span > < span class = "n" > e< / span > < span class = "p" > :< / span >
< span class = "n" > log< / span > < span class = "o" > .< / span > < span class = "n" > error< / span > < span class = "p" > (< / span > < span class = "s2" > " Failed to archive < / span > < span class = "si" > %s< / span > < span class = "s2" > : < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " repo" < / span > < span class = "p" > ],< / span > < span class = "n" > e< / span > < span class = "o" > .< / span > < span class = "n" > output< / span > < span class = "p" > )< / span >
2019-07-29 22:17:38 +00:00
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "s1" > ' Failed to archive < / span > < span class = "si" > %s< / span > < span class = "s1" > from ref " < / span > < span class = "si" > %s< / span > < span class = "s1" > " ' < / span > < span class = "o" > %< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " repo" < / span > < span class = "p" > ],< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " ref" < / span > < span class = "p" > ]))< / span >
2019-03-27 23:44:14 +00:00
< span class = "k" > finally< / span > < span class = "p" > :< / span >
< span class = "c1" > # Cleanup even if there was an error< / span >
< span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > chdir< / span > < span class = "p" > (< / span > < span class = "n" > oldcwd< / span > < span class = "p" > )< / span >
< span class = "n" > shutil< / span > < span class = "o" > .< / span > < span class = "n" > rmtree< / span > < span class = "p" > (< / span > < span class = "n" > joinpaths< / span > < span class = "p" > (< / span > < span class = "n" > sourcesDir< / span > < span class = "p" > ,< / span > < span class = "s2" > " gitrepo" < / span > < span class = "p" > ))< / span > < / div > < / div >
< div class = "viewcode-block" id = "GitRpmBuild" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.gitrpm.GitRpmBuild" > [docs]< / a > < span class = "k" > class< / span > < span class = "nc" > GitRpmBuild< / span > < span class = "p" > (< / span > < span class = "n" > SimpleRpmBuild< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Build an rpm containing files from a git repository" " " < / span >
< span class = "k" > def< / span > < span class = "nf" > __init__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _base_dir< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span >
< span class = "nb" > super< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "fm" > __init__< / span > < span class = "p" > (< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > )< / span >
< div class = "viewcode-block" id = "GitRpmBuild.check" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.gitrpm.GitRpmBuild.check" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > check< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "k" > raise< / span > < span class = "ne" > NotImplementedError< / span > < / div >
< div class = "viewcode-block" id = "GitRpmBuild.get_base_dir" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.gitrpm.GitRpmBuild.get_base_dir" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > get_base_dir< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Place all the files under a temporary directory + rpmbuild/< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _base_dir< / span > < span class = "p" > :< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _base_dir< / span > < span class = "o" > =< / span > < span class = "n" > tempfile< / span > < span class = "o" > .< / span > < span class = "n" > mkdtemp< / span > < span class = "p" > (< / span > < span class = "n" > prefix< / span > < span class = "o" > =< / span > < span class = "s2" > " lorax-git-rpm." < / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "n" > joinpaths< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _base_dir< / span > < span class = "p" > ,< / span > < span class = "s2" > " rpmbuild" < / span > < span class = "p" > )< / span > < / div >
< div class = "viewcode-block" id = "GitRpmBuild.cleanup_tmpdir" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.gitrpm.GitRpmBuild.cleanup_tmpdir" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > cleanup_tmpdir< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Remove the temporary directory and all of its contents< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > if< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _base_dir< / span > < span class = "p" > )< / span > < span class = "o" > < < / span > < span class = "mi" > 5< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "s2" > " Invalid base_dir: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > get_base_dir< / span > < span class = "p" > ())< / span >
< span class = "n" > shutil< / span > < span class = "o" > .< / span > < span class = "n" > rmtree< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _base_dir< / span > < span class = "p" > )< / span > < / div >
< div class = "viewcode-block" id = "GitRpmBuild.clean" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.gitrpm.GitRpmBuild.clean" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > clean< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Remove the base directory from inside the tmpdir" " " < / span >
< span class = "k" > if< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > get_base_dir< / span > < span class = "p" > ())< / span > < span class = "o" > < < / span > < span class = "mi" > 5< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "s2" > " Invalid base_dir: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > get_base_dir< / span > < span class = "p" > ())< / span >
< span class = "n" > shutil< / span > < span class = "o" > .< / span > < span class = "n" > rmtree< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > get_base_dir< / span > < span class = "p" > (),< / span > < span class = "n" > ignore_errors< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > )< / span > < / div >
< div class = "viewcode-block" id = "GitRpmBuild.add_git_tarball" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.gitrpm.GitRpmBuild.add_git_tarball" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > add_git_tarball< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > gitRepo< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Add a tar archive of a git repository to the rpm< / span >
< span class = "sd" > :param gitRepo: A dict with the repository details< / span >
< span class = "sd" > :type gitRepo: dict< / span >
< span class = "sd" > This populates the rpm with the URL of the git repository, the summary< / span >
< span class = "sd" > describing the repo, the description of the repository and reference used,< / span >
< span class = "sd" > and sets up the rpm to install the archive contents into the destination< / span >
< span class = "sd" > path.< / span >
< span class = "sd" > " " " < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > addUrl< / span > < span class = "p" > (< / span > < span class = "n" > gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " repo" < / span > < span class = "p" > ])< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > add_summary< / span > < span class = "p" > (< / span > < span class = "n" > gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " summary" < / span > < span class = "p" > ])< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > add_description< / span > < span class = "p" > (< / span > < span class = "n" > get_repo_description< / span > < span class = "p" > (< / span > < span class = "n" > gitRepo< / span > < span class = "p" > ))< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > addLicense< / span > < span class = "p" > (< / span > < span class = "s2" > " Unknown" < / span > < span class = "p" > )< / span >
< span class = "n" > sourceIndex< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > add_source< / span > < span class = "p" > (< / span > < span class = "n" > GitArchiveTarball< / span > < span class = "p" > (< / span > < span class = "n" > gitRepo< / span > < span class = "p" > ))< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > section_build< / span > < span class = "o" > +=< / span > < span class = "s2" > " tar -xvf < / span > < span class = "si" > %s< / span > < span class = "se" > \n< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > sources< / span > < span class = "p" > [< / span > < span class = "n" > sourceIndex< / span > < span class = "p" > ]< / span > < span class = "o" > .< / span > < span class = "n" > sourceName< / span >
< span class = "n" > dest< / span > < span class = "o" > =< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > path< / span > < span class = "o" > .< / span > < span class = "n" > normpath< / span > < span class = "p" > (< / span > < span class = "n" > gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " destination" < / span > < span class = "p" > ])< / span >
2019-04-17 19:12:11 +00:00
< span class = "c1" > # Prevent double slash root< / span >
< span class = "k" > if< / span > < span class = "n" > dest< / span > < span class = "o" > ==< / span > < span class = "s2" > " /" < / span > < span class = "p" > :< / span >
< span class = "n" > dest< / span > < span class = "o" > =< / span > < span class = "s2" > " " < / span >
2019-03-27 23:44:14 +00:00
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > create_parent_dirs< / span > < span class = "p" > (< / span > < span class = "n" > dest< / span > < span class = "p" > )< / span >
2019-04-17 19:12:11 +00:00
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > section_install< / span > < span class = "o" > +=< / span > < span class = "s2" > " cp -r < / span > < span class = "si" > %s< / span > < span class = "s2" > /. $RPM_BUILD_ROOT/< / span > < span class = "si" > %s< / span > < span class = "se" > \n< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "p" > (< / span > < span class = "n" > gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " rpmname" < / span > < span class = "p" > ],< / span > < span class = "n" > dest< / span > < span class = "p" > )< / span >
2019-03-27 23:44:14 +00:00
< span class = "n" > sub< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > get_subpackage< / span > < span class = "p" > (< / span > < span class = "kc" > None< / span > < span class = "p" > )< / span >
2019-04-17 19:12:11 +00:00
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > dest< / span > < span class = "p" > :< / span >
< span class = "c1" > # / is special, we don' t want to include / itself, just what' s under it< / span >
< span class = "n" > sub< / span > < span class = "o" > .< / span > < span class = "n" > section_files< / span > < span class = "o" > +=< / span > < span class = "s2" > " /*< / span > < span class = "se" > \n< / span > < span class = "s2" > " < / span >
< span class = "k" > else< / span > < span class = "p" > :< / span >
< span class = "n" > sub< / span > < span class = "o" > .< / span > < span class = "n" > section_files< / span > < span class = "o" > +=< / span > < span class = "s2" > " < / span > < span class = "si" > %s< / span > < span class = "s2" > /< / span > < span class = "se" > \n< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "n" > dest< / span > < / div > < / div >
2019-03-27 23:44:14 +00:00
< div class = "viewcode-block" id = "make_git_rpm" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.gitrpm.make_git_rpm" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > make_git_rpm< / span > < span class = "p" > (< / span > < span class = "n" > gitRepo< / span > < span class = "p" > ,< / span > < span class = "n" > dest< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Create an rpm from the specified git repo< / span >
< span class = "sd" > :param gitRepo: A dict with the repository details< / span >
< span class = "sd" > :type gitRepo: dict< / span >
< span class = "sd" > This will clone the git repository, create an archive of the selected reference,< / span >
< span class = "sd" > and build an rpm that will install the files from the repository under the destination< / span >
< span class = "sd" > directory. The gitRepo dict should have the following fields::< / span >
< span class = "sd" > rpmname: " server-config" < / span >
< span class = "sd" > rpmversion: " 1.0" < / span >
< span class = "sd" > rpmrelease: " 1" < / span >
< span class = "sd" > summary: " Setup files for server deployment" < / span >
< span class = "sd" > repo: " PATH OF GIT REPO TO CLONE" < / span >
< span class = "sd" > ref: " v1.0" < / span >
< span class = "sd" > destination: " /opt/server/" < / span >
< span class = "sd" > * rpmname: Name of the rpm to create, also used as the prefix name in the tar archive< / span >
< span class = "sd" > * rpmversion: Version of the rpm, eg. " 1.0.0" < / span >
< span class = "sd" > * rpmrelease: Release of the rpm, eg. " 1" < / span >
< span class = "sd" > * summary: Summary string for the rpm< / span >
< span class = "sd" > * repo: URL of the get repo to clone and create the archive from< / span >
< span class = "sd" > * ref: Git reference to check out. eg. origin/branch-name, git tag, or git commit hash< / span >
< span class = "sd" > * destination: Path to install the / of the git repo at when installing the rpm< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > gitRpm< / span > < span class = "o" > =< / span > < span class = "n" > GitRpmBuild< / span > < span class = "p" > (< / span > < span class = "n" > gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " rpmname" < / span > < span class = "p" > ],< / span > < span class = "n" > gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " rpmversion" < / span > < span class = "p" > ],< / span > < span class = "n" > gitRepo< / span > < span class = "p" > [< / span > < span class = "s2" > " rpmrelease" < / span > < span class = "p" > ],< / span > < span class = "p" > [< / span > < span class = "s2" > " noarch" < / span > < span class = "p" > ])< / span >
< span class = "k" > try< / span > < span class = "p" > :< / span >
< span class = "n" > gitRpm< / span > < span class = "o" > .< / span > < span class = "n" > add_git_tarball< / span > < span class = "p" > (< / span > < span class = "n" > gitRepo< / span > < span class = "p" > )< / span >
< span class = "n" > gitRpm< / span > < span class = "o" > .< / span > < span class = "n" > do_make< / span > < span class = "p" > ()< / span >
< span class = "n" > rpmfile< / span > < span class = "o" > =< / span > < span class = "n" > gitRpm< / span > < span class = "o" > .< / span > < span class = "n" > get_built_rpm< / span > < span class = "p" > (< / span > < span class = "s2" > " noarch" < / span > < span class = "p" > )< / span >
< span class = "n" > shutil< / span > < span class = "o" > .< / span > < span class = "n" > move< / span > < span class = "p" > (< / span > < span class = "n" > rpmfile< / span > < span class = "p" > ,< / span > < span class = "n" > dest< / span > < span class = "p" > )< / span >
< span class = "k" > except< / span > < span class = "ne" > Exception< / span > < span class = "k" > as< / span > < span class = "n" > e< / span > < span class = "p" > :< / span >
< span class = "n" > log< / span > < span class = "o" > .< / span > < span class = "n" > error< / span > < span class = "p" > (< / span > < span class = "s2" > " Creating git repo rpm: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > e< / span > < span class = "p" > )< / span >
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "s2" > " Creating git repo rpm: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "n" > e< / span > < span class = "p" > )< / span >
< span class = "k" > finally< / span > < span class = "p" > :< / span >
< span class = "n" > gitRpm< / span > < span class = "o" > .< / span > < span class = "n" > cleanup_tmpdir< / span > < span class = "p" > ()< / span >
< span class = "k" > return< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > path< / span > < span class = "o" > .< / span > < span class = "n" > basename< / span > < span class = "p" > (< / span > < span class = "n" > rpmfile< / span > < span class = "p" > )< / span > < / div >
< span class = "c1" > # Create the git rpms, if any, and return the path to the repo under results_dir< / span >
< div class = "viewcode-block" id = "create_gitrpm_repo" > < a class = "viewcode-back" href = "../../../pylorax.api.html#pylorax.api.gitrpm.create_gitrpm_repo" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > create_gitrpm_repo< / span > < span class = "p" > (< / span > < span class = "n" > results_dir< / span > < span class = "p" > ,< / span > < span class = "n" > recipe< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Create a dnf repository with the rpms from the recipe< / span >
< span class = "sd" > :param results_dir: Path to create the repository under< / span >
< span class = "sd" > :type results_dir: str< / span >
< span class = "sd" > :param recipe: The recipe to get the repos.git entries from< / span >
< span class = "sd" > :type recipe: Recipe< / span >
< span class = "sd" > :returns: Path to the dnf repository or " " < / span >
< span class = "sd" > :rtype: str< / span >
< span class = "sd" > This function creates a dnf repository directory at results_dir+" repo/" ,< / span >
< span class = "sd" > creates rpms for all of the repos.git entries in the recipe, runs createrepo_c< / span >
< span class = "sd" > on the dnf repository so that Anaconda can use it, and returns the path to the< / span >
< span class = "sd" > repository to the caller.< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > if< / span > < span class = "s2" > " repos" < / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "n" > recipe< / span > < span class = "ow" > or< / span > < span class = "s2" > " git" < / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "n" > recipe< / span > < span class = "p" > [< / span > < span class = "s2" > " repos" < / span > < span class = "p" > ]:< / span >
< span class = "k" > return< / span > < span class = "s2" > " " < / span >
< span class = "n" > gitrepo< / span > < span class = "o" > =< / span > < span class = "n" > joinpaths< / span > < span class = "p" > (< / span > < span class = "n" > results_dir< / span > < span class = "p" > ,< / span > < span class = "s2" > " repo/" < / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > path< / span > < span class = "o" > .< / span > < span class = "n" > exists< / span > < span class = "p" > (< / span > < span class = "n" > gitrepo< / span > < span class = "p" > ):< / span >
< span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > makedirs< / span > < span class = "p" > (< / span > < span class = "n" > gitrepo< / span > < span class = "p" > )< / span >
< span class = "k" > for< / span > < span class = "n" > r< / span > < span class = "ow" > in< / span > < span class = "n" > recipe< / span > < span class = "p" > [< / span > < span class = "s2" > " repos" < / span > < span class = "p" > ][< / span > < span class = "s2" > " git" < / span > < span class = "p" > ]:< / span >
< span class = "n" > make_git_rpm< / span > < span class = "p" > (< / span > < span class = "n" > r< / span > < span class = "p" > ,< / span > < span class = "n" > gitrepo< / span > < span class = "p" > )< / span >
< span class = "n" > cmd< / span > < span class = "o" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " createrepo_c" < / span > < span class = "p" > ,< / span > < span class = "n" > gitrepo< / span > < span class = "p" > ]< / span >
< span class = "n" > log< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "n" > cmd< / span > < span class = "p" > )< / span >
< span class = "k" > try< / span > < span class = "p" > :< / span >
2019-07-29 22:17:38 +00:00
< span class = "n" > subprocess< / span > < span class = "o" > .< / span > < span class = "n" > check_output< / span > < span class = "p" > (< / span > < span class = "n" > cmd< / span > < span class = "p" > ,< / span > < span class = "n" > stderr< / span > < span class = "o" > =< / span > < span class = "n" > subprocess< / span > < span class = "o" > .< / span > < span class = "n" > STDOUT< / span > < span class = "p" > )< / span >
2019-03-27 23:44:14 +00:00
< span class = "k" > except< / span > < span class = "n" > subprocess< / span > < span class = "o" > .< / span > < span class = "n" > CalledProcessError< / span > < span class = "k" > as< / span > < span class = "n" > e< / span > < span class = "p" > :< / span >
< span class = "n" > log< / span > < span class = "o" > .< / span > < span class = "n" > error< / span > < span class = "p" > (< / span > < span class = "s2" > " Failed to create repo at < / span > < span class = "si" > %s< / span > < span class = "s2" > : < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > gitrepo< / span > < span class = "p" > ,< / span > < span class = "n" > e< / span > < span class = "o" > .< / span > < span class = "n" > output< / span > < span class = "p" > )< / span >
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "s2" > " Failed to create repo at < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "n" > gitrepo< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "n" > gitrepo< / span > < / div >
< / pre > < / div >
< / div >
< / div >
< footer >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2018, Red Hat, Inc.
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
