Welcome to rebase-helper

Github Actions build status Documentation build status Container image build status PyPI version Project status Code Quality

There are several steps that need to be done when rebasing a package. The goal of rebase-helper is to automate most of these steps.

How to get it running?

rebase-helper is packaged in Fedora, so you can just install it with dnf.

If you wish to use the latest codebase, consult installation instructions.

How to use it?

After installation, execute rebase-helper from a directory containing SPEC file, sources and patches (usually cloned dist-git repository):

$ ls
foo-3.1.9.tar.xz foo.spec sources

Without any arguments or configuration rebase-helper will attempt to determine the latest upstream version automatically. If that fails, or if you wish to rebase to some different version, you can specify it explicitly as an argument:

$ rebase-helper 3.1.10

or you can pass source tarball filename instead:

$ rebase-helper foo-3.1.10.tar.xz

For complete CLI reference see usage.

Alternatively, you can run rebase-helper in a container:

$ docker run -it -e PACKAGE=foo quay.io/rebasehelper/rebase-helper:latest

See container reference for more information.

What do I get from it?

rebase-helper always creates rebase-helper-results directory containing the following items:

Path Description
report.txt summary report with all important information
changes.patch diff against original files, directly applicable to dist-git repo
logs/ log files of various verbosity levels
rebased-sources/ git repository with all modified files
checkers/ reports from individual checkers that were run
old-build/ logs and results of old (original) version build
new-build/ logs and results of new (rebased) version build

How does it work?

The following steps describe a rebase process:

  • Preparation
    • rebase-helper-workspace and rebase-helper-results directories are created
    • original SPEC file is copied to rebase-helper-results/rebased-sources directory and its Version tag is modified
  • Getting sources
    • old and new source tarballs are downloaded and extracted to rebase-helper-workspace directory
    • old sources are downloaded from lookaside cache if possible
  • Downstream patches
    • new git repository is initialized and the old sources are extracted and commited
    • each downstream patch is applied and changes introduced by it are commited
    • new sources are extracted and added as a remote repository
    • git-rebase is used to rebase the commits on top of new sources
    • original patches are modified/deleted accordingly
    • resulting files are stored in rebase-helper-results/rebased-sources
    • diff against original files is saved to rebase-helper-results/changes.patch
  • Build
    • old and new source RPMs are created and built with selected build tool
    • old SRPM and RPMs can also be downloaded from Koji to speed up the rebase
  • Comparison
    • multiple checker tools are run against both sets of packages and their output is stored in rebase-helper-results/checkers directory
  • Cleanup
    • rebase-helper-workspace directory is removed

Videos

A talk about rebase-helper at DevConf.CZ 2020 given by František Nečas:

Rebasing RPM packages with rebase-helper - DevConf.CZ 2020

Another presentation, this time from DevConf.CZ 2016, by Petr Hráček and Tomáš Hozza:

Rebase-helper and Upstream Release Monitoring - DevConf.CZ 2016

User Guide

Installation

rebase-helper is packaged in Fedora, so you can just install it with dnf.

If you can’t or don’t want to use rebase-helper package, you have to install, apart from Python requirements listed in get_requirements function in setup.py, the following dependencies:

Dependency Package name (in Fedora) Notes
git git for rebasing of downstream patches
rpmbuild rpm-build for building SRPM and for rpmbuild build tool
mock mock for mock build tool, optional
koji koji for koji build tool, optional
rpmdiff rpmlint for rpmdiff checker, optional
abipkgdiff libabigail for abipkgdiff checker, optional
pkgdiff pkgdiff for pkgdiff checker, optional
csmock csmock for csmock checker, optional
licensecheck licensecheck for licensecheck checker, optional

rebase-helper is also published on PyPI.

Logging

Since version 0.18.0 rebase-helper uses standard module-level loggers.

There are also 3 loggers with a special purpose:

Logger name Purpose
rebasehelper.traceback traceback generated by unhandled exceptions
rebasehelper.summary messages forming the rebase summary
rebasehelper.report messages forming the textual rebase report (used by text output tool)

rebase-helper uses rebasehelper.logger.CustomLogger logger class which provides extra logging levels.

rebasehelper.logger.LoggerHelper class provides 3 utility methods to manage default handlers:

Examples
# use a single module and get logs from it

import logging

from rebasehelper.specfile import SpecFile

logger = logging.getLogger('rebasehelper.specfile')
logger.addHandler(logging.StreamHandler())

spec = SpecFile('test.spec')
spec.set_release_number(2)

# run a complete rebase with default log handlers

from rebasehelper.logger import LoggerHelper
from rebasehelper.config import Config
from rebasehelper.cli import CLI
from rebasehelper.application import Application

LoggerHelper.create_stream_handlers()
config = Config()
cli = CLI()
config.merge(cli)
exec_dir, res_dir = Application.setup(config)
# default file handlers are automatically created and removed by Application instance,
# unless disabled by passing create_logs=False
app = Application(config, exec_dir, res_dir)
app.run()

Rebasing in container

rebase-helper can be run in Docker container. The package to be rebased has to be specified in PACKAGE environment variable. Alternatively, you can set REPOSITORY environment variable and point it to URL of any dist-git repository. In both cases, you can reference a specific branch, tag or commit by appending it to the package name or the repository URL:

$ docker run -it -e PACKAGE=foo#branch=f26 rebasehelper/rebase-helper:latest --outputtool json

Results of the rebase will be stored in an exported volume.

Usage

DESCRIPTION

rebase-helper is a tool which helps package maintainers to rebase their packages to latest upstream versions.

It should be executed from a directory containing spec file, sources and patches (usually cloned dist-git repository).

The new version is specified by SOURCES argument, which can be either version number or filename of the new source archive. Starting with version 0.10.0, this argument can be omitted and the new version determined automatically using one of available versioneers.

OPTIONS
Positional arguments
SOURCES
version number or filename of the new source archive
Optional arguments
-h, --help
show help message and exit
--version
show rebase-helper version and exit
-v, --verbose
be more verbose
--color {always,never,auto}
colorize the output, defaults to auto
--background {dark,light,auto}
use color scheme for the given background, defaults to auto
--results-dir RESULTS_DIR
location where the rebase-helper-results directory will be created
--workspace-dir WORKSPACE_DIR
location where the rebase-helper-workspace directory will be created
--buildtool {copr,koji,mock,rpmbuild}
build tool to use, defaults to mock
--srpm-buildtool {mock,rpmbuild}
SRPM build tool to use, defaults to rpmbuild
--pkgcomparetool [{abipkgdiff,csmock,licensecheck,pkgdiff,rpmdiff,rpminspect-rpm,rpminspect-srpm,sonamecheck}]
set of tools to use for package comparison, defaults to abipkgdiff,licensecheck,pkgdiff,rpmdiff,rpminspect-rpm,rpminspect-srpm,sonamecheck if available
--outputtool {json,text}
tool to use for formatting rebase output, defaults to text
--versioneer {anitya,cpan,hackage,npmjs,pypi,rubygems}
tool to use for determining latest upstream version
--versioneer-blacklist [{anitya,cpan,hackage,npmjs,pypi,rubygems}]
prevent specified versioneers from being run
--spec-hook-blacklist [{commit-hash-updater,escape-macros,paths-to-rpm-macros,pypi-url-fix,replace-old-version,ruby-helper,typo-fix}]
prevent specified spec hooks from being run
--build-log-hook-blacklist [{files}]
prevent specified build log hooks from being run
--bugzilla-id BUG_ID
do a rebase based on Upstream Release Monitoring bugzilla
--non-interactive
do not interact with user
--favor-on-conflict {downstream,upstream,off}
favor downstream or upstream changes when conflicts appear
--not-download-sources
do not download sources
-w, --keep-workspace
do not remove workspace directory after finishing
--apply-changes
apply changes.patch after a successful rebase
--disable-inapplicable-patches
disable inapplicable patches in rebased SPEC file
--keep-comments
do not remove associated comments when removing patches from spec file
--skip-version-check
force rebase even if current version is newer than requested version
--update-sources
update “sources” file and upload new sources to lookaside cache
--skip-upload
skip uploading new sources to lookaside cache
--force-build-log-hooks
enforce running of build log hooks (even in non-interactive mode)
--builds-nowait
do not wait for remote builds to finish
--build-tasks OLD_TASK,NEW_TASK
comma-separated remote build task ids
--builder-options BUILDER_OPTIONS
enable arbitrary local builder option(s), enclose BUILDER_OPTIONS in quotes to pass more than one
--srpm-builder-options SRPM_BUILDER_OPTIONS
enable arbitrary local srpm builder option(s), enclose SRPM_BUILDER_OPTIONS in quotes to pass more than one
--lookaside-cache-preset {fedpkg,centpkg,rhpkg,rhpkg-sha512}
use specified lookaside cache configuration preset, defaults to fedpkg
--changelog-entry CHANGELOG_ENTRY
text to use as changelog entry, can contain RPM macros, which will be expanded
--no-changelog-entry
do not add a changelog entry at all
--config-file CONFIG_FILE
path to a configuration file, defaults to $XDG_CONFIG_HOME/rebase-helper.cfg
-D 'MACRO EXPR', --define 'MACRO EXPR'
define an rpm macro, can be used multiple times
--copr-project-permanent
make the created copr project permanent
--copr-project-frontpage
make the created copr project visible on the frontpage
--copr-chroots COPR_CHROOTS
comma-separated list of chroots to create copr project with
--replace-old-version-with-macro
replace old version string with %{version} instead of new version string

Writing plugins

Starting with version 0.10.0, rebase-helper is extensible through plugins.

You can implement your own build tool, checker, output tool, SPEC hook, build log hook or versioneer. All you have to do is to derive your plugin from corresponding base class, implement all necessary methods and register it using one of the following entry points:

Plugin type Entry point Base class
build tool rebasehelper.build_tools rebasehelper.plugins.build_tools.rpm.BuildToolBase
SRPM build tool rebasehelper.srpm_build_tools rebasehelper.plugins.build_tools.srpm.SRPMBuildToolBase
checker rebasehelper.checkers rebasehelper.plugins.checkers.BaseChecker
output tool rebasehelper.output_tools rebasehelper.plugins.output_tools.BaseOutputTool
SPEC hook rebasehelper.spec_hooks rebasehelper.plugins.spec_hooks.BaseSpecHook
build log hook rebasehelper.build_log_hooks rebasehelper.plugins.build_log_hooks.BaseBuildLogHook
versioneer rebasehelper.versioneers rebasehelper.plugins.versioneers.BaseVersioneer
Example
my_spec_hook/__init__.py
from rebasehelper.plugins.spec_hooks import BaseSpecHook


class MySpecHook(BaseSpecHook):

    NAME = 'MySpecHook'

    @classmethod
    def get_name(cls):
        return cls.NAME

    @classmethod
    def run(cls, spec_file, rebase_spec_file):
        """
        This method is called after original SPEC file is processed

        :param spec_file: SpecFile object representing original SPEC file
        :param rebase_spec_file: SpecFile object representing rebased SPEC file
        """
        rebase_spec_file.spec_content.section('%package').insert(0, '# processed by {}\n'.format(cls.NAME))
        rebase_spec_file.save()
setup.py
from setuptools import setup


setup(
    name='MySpecHook',
    version='0.1',
    description='Custom SPEC hook for rebase-helper',
    author='John Doe',
    install_requires=['rebasehelper>=0.10.0'],
    packages=['my_spec_hook'],
    entry_points={
        'rebasehelper.spec_hooks': ['my_spec_hook = my_spec_hook:MySpecHook']
    }
)

API

Helpers

Bugzilla helper module
class rebasehelper.helpers.bugzilla_helper.BugzillaHelper[source]

Class for working with Upstream Release Monitoring on bugzilla.

BUGZILLA_REST_API_URL = 'https://bugzilla.redhat.com/rest'
DIST_GIT_REPO_URL = 'https://src.fedoraproject.org/rpms'
UPSTREAM_RELEASE_MONITORING_USERNAME = 'upstream-release-monitoring'
classmethod clone_repository(component: str, bugzilla_id: str) → str[source]

Clones remote dist-git repository of a component.

Parameters:
  • component – Package to clone.
  • bugzilla_id – ID of the bugzilla.
Returns:

Path to the cloned repository.
Raises:
  • RebaseHelperError – If the directory, that the repository
  • is supposed to be cloned into, exists.
classmethod get_bugzilla_component(bugzilla_id: str) → str[source]

Gets a component of the bugzilla.

Parameters:

bugzilla_id – ID of the bugzilla.
Returns:

Component of the bugzilla.
Raises:
  • RebaseHelperError – If no such bugzilla exists or if the bugzilla
  • was not created by Upstream Release Monitoring.
classmethod get_version_from_comments(bugzilla_id: str) → Optional[str][source]

Gets version from bugzilla comments.

Parameters:bugzilla_id – ID of the bugzilla.
Returns:Version specified by Upstream Release Monitoring in comments or None, if no version could be found.
Raises:RebaseHelperError – If no such bugzilla exists.
classmethod prepare_rebase_repository(bugzilla_id: str) → Tuple[str, str][source]

Clones a repository based on Upstream Release Monitoring bugzilla.

Parameters:

bugzilla_id – ID of the bugzilla.
Returns:

Path of the cloned repository and version to rebase to.
Raises:
  • RebaseHelperError – If there was an error while obtaining
  • data from bugzilla or if there was a problem while cloning
  • the repository.
Console helper module
class rebasehelper.helpers.console_helper.ConsoleHelper[source]

Class for interacting with the command line.

class Capturer(stdout=False, stderr=False)[source]

ContextManager for capturing stdout/stderr

static color_is_light(rgb, bit_width)[source]

Determines whether a color is light or dark.

Parameters:
  • rgb (tuple) – RGB tuple.
  • bit_width – Number of bits defining the RGB.
Returns:

Whether a color is light or dark.
Return type:

bool
classmethod cprint(message, fg=None, bg=None, style=None)[source]

Prints colored output if possible.

Parameters:
  • message (str) – String to be printed out.
  • fg (str) – Foreground color.
  • bg (str) – Background color.
  • style (str) – Style to be applied to the printed message. Possible styles: bold, faint, italic, underline, blink, blink2, negative, concealed, crossed. Some styles may not be supported by every terminal, e.g. ‘blink’. Multiple styles should be connected with a ‘+’, e.g. ‘bold+italic’.
static detect_background()[source]

Detects terminal background color and decides whether it is light or dark.

Returns:Whether to use dark or light color scheme.
Return type:str
static exchange_control_sequence(query, timeout=0.05)[source]

Captures a response of a control sequence from STDIN.

Parameters:
  • query (str) – Control sequence.
  • timeout (int, float) – Time given to the terminal to react.
Returns:

Response of the terminal.
Return type:

str
static parse_rgb_device_specification(specification)[source]

Parses RGB device specification.

Parameters:specification (str) – RGB device specification.
Returns:If the specification follows correct format, the first element is RGB tuple and the second is bit width of the RGB. Otherwise, both elements are None.
Return type:tuple
classmethod should_use_colors(conf)[source]

Determines whether ANSI colors should be used for CLI output.

Parameters:conf (rebasehelper.config.Config) – Configuration object with arguments from the command line.
Returns:Whether colors should be used.
Return type:bool
use_colors = False
Copr helper module
class rebasehelper.helpers.copr_helper.CoprHelper[source]
DELETE_PROJECT_AFTER = 60
classmethod build(client, project, srpm)[source]
classmethod create_project(client, project, chroots, description, instructions, permanent=False, hide=True)[source]
classmethod download_build(client, build_id, destination)[source]
classmethod get_build_status(client, build_id)[source]
classmethod get_build_url(client, build_id)[source]
classmethod get_client()[source]
classmethod watch_build(client, build_id)[source]
Download helper module
class rebasehelper.helpers.download_helper.DownloadHelper[source]

Class for downloading files and performing HTTP requests.

static download_file(url, destination_path, blocksize=8192)[source]

Downloads a file from HTTP, HTTPS or FTP URL.

Parameters:
  • url (str) – URL to be downloaded.
  • destination_path (str) – Path to where the downloaded file will be stored.
  • blocksize (int) – Block size in bytes.
static progress(download_total, downloaded, start_time, show_size=True)[source]

Prints current progress and estimated remaining time of a download to the standard output.

Parameters:
  • download_total (int) – Total download size in bytes.
  • downloaded (int) – Size of the already downloaded portion of a file in bytes.
  • start_time (float) – Time when the download started in seconds since epoch.
  • show_size (bool) – Whether to show the number of downloaded bytes.
static request(url, **kwargs)[source]

Performs an HTTP request or an FTP RETR command.

Parameters:
  • url (str) – HTTP, HTTPS or FTP URL.
  • **kwargs – Keyword arguments to be passed to requests.session.get().
Returns:

Response object.
Return type:

requests.Response
Git helper module
class rebasehelper.helpers.git_helper.GitHelper[source]

Class which operates with git repositories

GIT_USER_EMAIL = 'rebase-helper@localhost.local'
GIT_USER_NAME = 'rebase-helper'
classmethod get_email()[source]
classmethod get_user()[source]
classmethod run_mergetool(repo)[source]
Input helper module
class rebasehelper.helpers.input_helper.InputHelper[source]

Class for command line interaction with the user.

classmethod get_message(message, default_yes=True, any_input=False)[source]

Prompts a user with yes/no message and gets the response.

Parameters:
  • message (str) – Prompt string.
  • default_yes (bool) – If the default value should be YES.
  • any_input (bool) – Whether to return default value regardless of input.
Returns:

True or False, based on user’s input.
Return type:

bool
static strtobool(message)[source]

Converts a user message to a corresponding truth value.

This method is a replacement for deprecated strtobool from distutils, its behaviour remains the same.

Parameters:message (str) – Message to evaluate.
Returns:
True on ‘y’, ‘yes’, ‘t’, ‘true’, ‘on’ and ‘1’.
False on ‘n’, ‘no’, ‘f’, ‘false’, ‘off’ and ‘0’.
Return type:bool
Raises:ValueError – On any other value.
Koji Helper module
class rebasehelper.helpers.koji_helper.KojiHelper[source]
classmethod create_session(login=False, profile='koji')[source]

Creates new Koji session and immediately logs in to a Koji hub.

Parameters:
  • login (bool) – Whether to perform a login.
  • profile (str) – Koji profile to use.
Returns:

Newly created session instance.
Return type:

koji.ClientSession
Raises:

RebaseHelperError – If login failed.
classmethod display_task_results(tasks)[source]

Prints states of Koji tasks.

Parameters:tasks (list) – List of koji.TaskWatcher instances.
classmethod download_build(session, build_id, destination, arches)[source]

Downloads RPMs and logs of a Koji build.

Parameters:
  • session (koji.ClientSession) – Active Koji session instance.
  • build_id (str) – Koji build ID.
  • destination (str) – Path where to download files to.
  • arches (list) – List of architectures to be downloaded.
Returns:

List of downloaded RPMs and list of downloaded logs.
Return type:

tuple
Raises:

DownloadError – If download failed.
classmethod download_task_results(session, tasklist, destination)[source]

Downloads packages and logs of finished Koji tasks.

Parameters:
  • session (koji.ClientSession) – Active Koji session instance.
  • tasklist (list) – List of task IDs.
  • destination (str) – Path where to download files to.
Returns:

List of downloaded RPMs and list of downloaded logs.
Return type:

tuple
Raises:

DownloadError – If download failed.
functional = False
classmethod get_build(session, package, version)[source]

Looks up Koji build of a specific version of a package.

Parameters:
  • session (koji.ClientSession) – Active Koji session instance.
  • package (str) – Package name.
  • version (str) – Package version.
Returns:

Found latest package version and Koji build ID.
Return type:

tuple
classmethod get_latest_build(session, package)[source]

Looks up latest Koji build of a package.

Parameters:
  • session (koji.ClientSession) – Active Koji session instance.
  • package (str) – Package name.
Returns:

Found latest package version and Koji build ID.
Return type:

tuple
classmethod get_old_build_info(package_name, package_version)[source]

Gets old build info from Koji.

Parameters:
  • package_name (str) – Package name from specfile.
  • package_version (str) – Package version from specfile.
Returns:

Koji build id, package version.
Return type:

tuple
classmethod get_task_url(session, task_id)[source]
classmethod upload_srpm(session, srpm)[source]

Uploads SRPM to a Koji hub.

Parameters:
  • session (koji.ClientSession) – Active Koji session instance.
  • srpm (str) – Valid path to SRPM.
Returns:

Remote path to the uploaded SRPM.
Return type:

str
Raises:

RebaseHelperError – If upload failed.
classmethod watch_koji_tasks(session, tasklist)[source]

Waits for Koji tasks to finish and prints their states.

Parameters:
  • session (koji.ClientSession) – Active Koji session instance.
  • tasklist (list) – List of task IDs.
Returns:

Dictionary mapping task IDs to their states or None if interrupted.
Return type:

dict
Lookaside cache helper module
class rebasehelper.helpers.lookaside_cache_helper.LookasideCacheHelper[source]

Class for downloading files from Fedora/RHEL lookaside cache

classmethod download(tool, basepath, package, target_dir=None)[source]
rpkg_config_dir = '/etc/rpkg'
classmethod update_sources(tool, basepath, package, old_sources, new_sources, upload=True, source_dir='')[source]
Macro helper module
class rebasehelper.helpers.macro_helper.MacroHelper[source]

Class for working with RPM macros

MACROS_WHITELIST = ['_bindir', '_datadir', '_includedir', '_infodir', '_initdir', '_libdir', '_libexecdir', '_localstatedir', '_mandir', '_sbindir', '_sharedstatedir', '_sysconfdir', 'python2_sitelib', 'python3_sitelib']
static dump()[source]

Gets list of all defined macros.

Returns:All defined macros.
Return type:list
static expand(s, default=None, suppress_errors=False)[source]
classmethod expand_macros(macros)[source]

Expands values of multiple macros.

Parameters:macros (list) – List of macros to be expanded, macros are represented as dicts.
Returns:List of macros with expanded values.
Return type:list
static filter(macros, **kwargs)[source]

Finds all macros satisfying certain conditions.

Parameters:
  • macros (list) – Macros to be filtered.
  • **kwargs – Filters to be used.
Returns:

Macros satisfying the conditions.
Return type:

list
classmethod purge_macro(macro: str) → None[source]
static substitute_path_with_macros(path, macros)[source]

Substitutes parts of a path with macros.

Parameters:
  • path (str) – Path to be changed.
  • macros (list) – Macros which can be used as a substitution.
Returns:

Path expressed using macros.
Return type:

str
Path helper module
class rebasehelper.helpers.path_helper.PathHelper[source]

Class for performing path related tasks.

static file_available(filename)[source]

Checks if the given file exists.

Parameters:filename (str) – Path to the file.
Returns:Whether the file exists.
Return type:bool
static find_all_files(top_path, pattern)[source]

Recursively searches for all files matching the given pattern.

Parameters:
  • top_path (str) – Directory where to start the search.
  • pattern (str) – Filename pattern.
Returns:

List containing absolute paths to all found files.
Return type:

list
static find_all_files_current_dir(top_path, pattern)[source]

Searches for all files that match the given pattern inside a directory.

Parameters:
  • top_path (str) – Directory where to start the search.
  • pattern (str) – Filename pattern.
Returns:

List containing absolute paths to all found files.
Return type:

list
static find_first_dir_with_file(top_path, pattern)[source]

Recursively searches for a directory containing a file that matches the given pattern.

Parameters:
  • top_path (str) – Directory where to start the search.
  • pattern (str) – Filename pattern.
Returns:

Full path to the directory containing the first occurence of the searched file. None if there is no file matching the pattern.
Return type:

str
static find_first_file(top_path, pattern, recursion_level=None)[source]

Recursively searches for a file that matches the given pattern.

Parameters:
  • top_path (str) – Directory where to start the search.
  • pattern (str) – Filename pattern.
  • recursion_level (int) – How deep in the directory tree the search can go.
Returns:

Path to the file matching the pattern or None if there is no file matching the pattern.
Return type:

str
static get_temp_dir()[source]

Creates a new temporary directory.

Returns:Path to the created directory.
Return type:str
Process helper module
class rebasehelper.helpers.process_helper.ProcessHelper[source]

Class for executing subprocesses.

DEV_NULL = '/dev/null'
static run_subprocess(cmd, input_file=None, output_file=None, ignore_stderr=False)[source]

Runs the specified command in a subprocess.

Parameters:
  • cmd (iterable) – A sequence of program arguments.
  • input_file (str, typing.BytesIO) – File to read the input from.
  • output_file (str, typing.BytesIO) – File to write the output of the command to.
  • ignore_stderr (bool) – Whether to ignore stderr output.
Returns:

Exit code of the subprocess.
Return type:

int
static run_subprocess_cwd(cmd, cwd=None, input_file=None, output_file=None, ignore_stderr=False, shell=False)[source]

Runs the specified command in a subprocess in a different working directory.

Parameters:
  • cmd (iterable) – A sequence of program arguments.
  • cwd (str) – Working directory for the command.
  • input_file (str, typing.BytesIO) – File to read the input from.
  • output_file (str, typing.BytesIO) – File to write the output of the command to.
  • ignore_stderr (bool) – Whether to ignore stderr output.
  • shell (bool) – Whether to run the command in a shell.
Returns:

Exit code of the subprocess.
Return type:

int
static run_subprocess_cwd_env(cmd, cwd=None, env=None, input_file=None, output_file=None, ignore_stderr=False, shell=False)[source]

Runs the specified command in a subprocess in a different working directory with a redefined environment.

Parameters:
  • cmd (iterable) – A sequence of program arguments.
  • cwd (str) – Working directory for the command.
  • env (dict) – Environment variables for the new process.
  • input_file (str, typing.BytesIO) – File to read the input from.
  • output_file (str, typing.BytesIO) – File to write the output of the command to.
  • ignore_stderr (bool) – Whether to ignore stderr output.
  • shell (bool) – Whether to run the command in a shell.
Returns:

Exit code of the subprocess.
Return type:

int
static run_subprocess_env(cmd, env=None, input_file=None, output_file=None, ignore_stderr=False, shell=False)[source]

Runs the specified command in a subprocess with a redefined environment.

Parameters:
  • cmd (iterable) – A sequence of program arguments.
  • env (dict) – Environment variables for the new process.
  • input_file (str, typing.BytesIO) – File to read the input from.
  • output_file (str, typing.BytesIO) – File to write the output of the command to.
  • ignore_stderr (bool) – Whether to ignore stderr output.
  • shell (bool) – Whether to run the command in a shell.
Returns:

Exit code of the subprocess.
Return type:

int
RPM helper module
class rebasehelper.helpers.rpm_helper.RpmHeader(hdr: <sphinx.ext.autodoc.importer._MockObject object at 0x7f1d737b3150>)[source]
class rebasehelper.helpers.rpm_helper.RpmHelper[source]

Class for working with RPM database and packages.

ARCHES = []
static all_packages_installed(pkg_names=None)[source]

Checks if all specified packages are installed.

Parameters:pkg_names (list) – List of package names to check.
Returns:True if all packages are installed, False otherwise.
Return type:bool
static get_arches()[source]

Gets list of all known architectures

static get_header_from_rpm(rpm_name)[source]

Gets an RPM header from the given RPM package.

Parameters:rpm_name (str) – Path to the package.
Returns:Header object obtained from the package.
Return type:RpmHeader
classmethod get_rpm_spec(path: str, sourcedir: str, predefined_macros: Dict[str, str]) → <sphinx.ext.autodoc.importer._MockObject object at 0x7f1d737b3910>[source]
static install_build_dependencies(spec_path=None, assume_yes=False)[source]

Installs build dependencies of a package using dnf.

Parameters:
  • spec_path (str) – Absolute path to the SPEC file.
  • assume_yes (bool) – Whether to automatically answer ‘yes’ to all questions.
Returns:

Exit code of the subprocess run.
Return type:

int
static is_package_installed(pkg_name=None)[source]

Checks whether a package is installed.

Parameters:pkg_name (str) – Name of the package.
Returns:Whether the package is installed.
Return type:bool
classmethod parse_spec(path, flags=None)[source]
classmethod split_nevra(s)[source]

Splits string into name, epoch, version, release and arch components

Plugins

Build Log Hooks package
class rebasehelper.plugins.build_log_hooks.BaseBuildLogHook[source]

Base class for a build log hook.

CATEGORIES = []
classmethod format(data)[source]

Formats build log hook output to a readable text form.

classmethod merge_two_results(old, new)[source]
classmethod run(spec_file, rebase_spec_file, results_dir, **kwargs)[source]

Runs the build log hook.

Parameters:
Returns:

The first element is a dict containing changes, the second is a bool whether the build process should be restarted.
Return type:

tuple
class rebasehelper.plugins.build_log_hooks.BuildLogHookCollection(entrypoint: str, manager: PluginManager)[source]
run(spec_file, rebase_spec_file, non_interactive, force_build_log_hooks, **kwargs)[source]

Runs all non-blacklisted build log hooks.

Parameters:
  • spec_file (rebasehelper.specfile.SpecFile) – Original SpecFile object.
  • rebase_spec_file (rebasehelper.specfile.SpecFile) – Rebased SpecFile object.
  • non_interactive (bool) – Whether rebase-helper is in non-interactive mode.
  • force_build_log_hooks (bool) – Whether to run the hooks even in non-interactive mode.
  • kwargs (dict) – Keyword arguments from instance of Application.
Returns:

Whether build log hooks made some changes to the SPEC file.
Return type:

bool
Build Tools package
class rebasehelper.plugins.build_tools.BuildTemporaryEnvironment(sources, patches, spec, results_dir)[source]

Class representing temporary environment.

TEMPDIR_RESULTS = 'TEMPDIR_RESULTS'
TEMPDIR_SOURCES = 'TEMPDIR_SOURCES'
TEMPDIR_SPEC = 'TEMPDIR_SPEC'
TEMPDIR_SPECS = 'TEMPDIR_SPECS'
class rebasehelper.plugins.build_tools.MockTemporaryEnvironment(sources, patches, spec, results_dir)[source]

Class representing temporary environment for MockBuildTool.

class rebasehelper.plugins.build_tools.RpmbuildTemporaryEnvironment(sources, patches, spec, results_dir)[source]

Class representing temporary environment for RpmbuildBuildTool.

TEMPDIR_BUILD = 'TEMPDIR_BUILD'
TEMPDIR_BUILDROOT = 'TEMPDIR_BUILDROOT'
TEMPDIR_RPMBUILD = 'TEMPDIR_RPMBUILD'
TEMPDIR_RPMS = 'TEMPDIR_RPMS'
TEMPDIR_SRPMS = 'TEMPDIR_SRPMS'
rebasehelper.plugins.build_tools.check_mock_privileges() → bool[source]
rebasehelper.plugins.build_tools.get_mock_logfile_path(ret, results_dir, tmp_path=None)[source]

Get path to logfile containing the error message

Parameters:
  • ret – return code from mock
  • results_dir – directory where logs will be stored
  • tmp_path – temporary directory where logs are during build
Returns:
Checkers package
class rebasehelper.plugins.checkers.BaseChecker[source]

Base class of package checkers.

DEFAULT

If True, the checker is run by default.

Type:bool
CATEGORY

Category which determines when the checker is run.

Type:CheckerCategory
results_dir

Path where the results are stored.

Type:str
CATEGORY = None
DEFAULT = False
classmethod format(data)[source]

Formats checker output to a readable text form.

classmethod get_category()[source]
classmethod get_checker_output_dir_short()[source]

Return short version of checker output directory

classmethod get_important_changes(checker_output)[source]

Each checker has an opportunity to highlight some of its output. This function is optional, as not all checkers provide output with critical information.

Parameters:checker_output (dict) – Dictionary with output from the given checker.
Returns:List of strings to be output to CLI as warning messages.
Return type:list
classmethod get_underlined_title(text, separator='=')[source]
classmethod is_available()[source]
classmethod prepare_results_dir()[source]

Creates checker’s results dir.

Removes the existing results dir if it exists to avoid collisions.

results_dir = None
classmethod run_check(results_dir, **kwargs)[source]

Perform the check itself and return results.

class rebasehelper.plugins.checkers.CheckerCategory[source]

An enumeration.

RPM = 3
SOURCE = 1
SRPM = 2
class rebasehelper.plugins.checkers.CheckerCollection(entrypoint: str, manager: PluginManager)[source]

Class representing the process of running various checkers on final packages.

get_default_plugins(return_one: bool = False) → Union[str, List[str], None][source]
get_supported_plugins() → List[str][source]
run(results_dir: str, checker_name: str, **kwargs) → Optional[Dict[str, Any]][source]

Runs a particular checker and returns the results.

Parameters:
  • results_dir – Path to a directory in which the checker should store the results.
  • checker_name – Name of the checker to be run.
Raises:

NotImplementedError – If a checker with the given name doesn’t exist.
Returns:

Results of the checker.
Output Tools package
class rebasehelper.plugins.output_tools.BaseOutputTool[source]

Base class for an output tool

DEFAULT = False
EXTENSION = ''
classmethod get_report_path(app)[source]
classmethod prepend_results_dir_name(app, *path_members)[source]

Prepends a path with path to rebase-helper-results.

Takes directory changes (such as cd into cloned repo with –bugzilla-id) into account.

Parameters:
  • app – Application instance.
  • path_members – Path members to prepend the results dir to.
Returns:

Prepended path.
classmethod print_cli_summary(app)[source]

Outputs a summary of a rebase-helper run.

Parameters:app – Application instance.
classmethod print_important_checkers_output()[source]

Iterates over all checkers output to highlight important checkers warning

classmethod print_patches_cli()[source]

Outputs info about patches

classmethod print_patches_section_cli(logger_method, patch_type)[source]

Outputs information about one of the patch types.

Parameters:
  • logger_method – Method to use for logging
  • patch_type – A key to use for filtering patch dictionary obtained from results_store.
classmethod print_report_file_path(app)[source]

Outputs path to the report file

classmethod run(logs, app)[source]
class rebasehelper.plugins.output_tools.OutputToolCollection(entrypoint: str, manager: PluginManager)[source]

Class representing the process of running various output tools.

run(tool, logs=None, app=None)[source]

Runs specified output tool.

Parameters:
Plugin Collection module
class rebasehelper.plugins.plugin_collection.PluginCollection(entrypoint: str, manager: PluginManager)[source]
get_all_plugins() → List[str][source]
get_default_plugins(return_one: bool = False) → Union[str, List[str], None][source]
get_options() → List[Union[Dict[str, Any], List[Dict[str, Any]]]][source]

Gets options of all plugins of one type.

Returns:List of plugins’ options.
Return type:list
get_plugin(tool: str) → Optional[Type[rebasehelper.plugins.plugin.Plugin]][source]
get_supported_plugins() → List[str][source]
Plugin Manager module
class rebasehelper.plugins.plugin_manager.PluginManager[source]
COLLECTIONS = [<class 'rebasehelper.plugins.build_log_hooks.BuildLogHookCollection'>, <class 'rebasehelper.plugins.build_tools.rpm.BuildToolCollection'>, <class 'rebasehelper.plugins.build_tools.srpm.SRPMBuildToolCollection'>, <class 'rebasehelper.plugins.checkers.CheckerCollection'>, <class 'rebasehelper.plugins.output_tools.OutputToolCollection'>, <class 'rebasehelper.plugins.spec_hooks.SpecHookCollection'>, <class 'rebasehelper.plugins.versioneers.VersioneerCollection'>]
get_options() → List[Union[Dict[str, Any], List[Dict[str, Any]]]][source]

Gets options of all plugins.

Returns:List of plugins’ options.
Return type:list
RPM Build Tools package
class rebasehelper.plugins.build_tools.rpm.BuildToolBase[source]

Build tool base class.

DEFAULT

If True, the build tool is default tool.

Type:bool
ACCEPTS_OPTIONS

If True, the build tool accepts additional options passed via –builder-options.

Type:bool
CREATES_TASKS

If True, the build tool creates remote tasks.

Type:bool
ACCEPTS_OPTIONS = False
CREATES_TASKS = False
DEFAULT = False
classmethod build(spec, results_dir, srpm, **kwargs)[source]

Build binaries from the sources.

Keyword arguments: spec – path to a SPEC file sources – list with absolute paths to SOURCES patches – list with absolute paths to PATCHES results_dir – path to DIR where results should be stored

Returns: dict with: ‘srpm’ -> absolute path to SRPM ‘rpm’ -> list of absolute paths to RPMs ‘logs’ -> list of absolute paths to logs

static get_builder_options(**kwargs)[source]
classmethod get_detached_task(task_id, results_dir)[source]

Gets packages and logs for specified task

Parameters:
  • task_id – detached task id
  • results_dir – path to DIR where results should be stored
Returns:

tuple with: list of absolute paths to RPMs list of absolute paths to logs
classmethod get_task_info(build_dict)[source]

Gets information about detached remote task

Parameters:build_dict – build data
Returns:task info
classmethod prepare(spec, conf)[source]

Prepare for building.

Parameters:spec – spec file object
classmethod wait_for_task(build_dict, task_id, results_dir)[source]

Waits until specified task is finished

Parameters:
  • build_dict – build data
  • results_dir – path to DIR where results should be stored
Returns:

tuple with: list of absolute paths to RPMs list of absolute paths to logs
class rebasehelper.plugins.build_tools.rpm.BuildToolCollection(entrypoint: str, manager: PluginManager)[source]

Collection of RPM build tools.

SPEC Hooks package
class rebasehelper.plugins.spec_hooks.BaseSpecHook[source]

Base class for a spec hook

CATEGORIES = []
classmethod run(spec_file, rebase_spec_file, **kwargs)[source]

Runs a spec hook.

Parameters:
  • spec_file – Original spec file object
  • rebase_spec_file – Rebased spec file object
  • kwargs – Keyword arguments from Application instance
class rebasehelper.plugins.spec_hooks.SpecHookCollection(entrypoint: str, manager: PluginManager)[source]

Class representing the process of running various spec file hooks.

run(spec_file, rebase_spec_file, **kwargs)[source]

Runs all non-blacklisted spec hooks.

Parameters:
SRPM Build Tools package
class rebasehelper.plugins.build_tools.srpm.SRPMBuildToolBase[source]

SRPM build tool base class.

DEFAULT

If True, the build tool is default tool.

Type:bool
DEFAULT = False
classmethod build(spec, results_dir, **kwargs)[source]

Build SRPM with chosen SRPM Build Tool

Parameters:
  • spec – SpecFile object
  • results_dir – absolute path to DIR where results should be stored
Returns:

absolute path to SRPM, list with absolute paths to logs
static get_srpm_builder_options(**kwargs)[source]
class rebasehelper.plugins.build_tools.srpm.SRPMBuildToolCollection(entrypoint: str, manager: PluginManager)[source]

Collection of SRPM build tools.

Versioneers package
class rebasehelper.plugins.versioneers.BaseVersioneer[source]

Base class for a versioneer

CATEGORIES = []
classmethod run(package_name)[source]

Runs a versioneer.

Parameters:package_name – Name of a package
Returns:Latest upstream version of a package
class rebasehelper.plugins.versioneers.VersioneerCollection(entrypoint: str, manager: PluginManager)[source]
run(versioneer, package_name, category, versioneer_blacklist=None)[source]

Runs the specified versioneer or all versioneers subsequently until one of them succeeds.

Parameters:
  • versioneer (str) – Name of a versioneer.
  • package_name (str) – Name of a package.
  • category (str) – Package category.
  • versioneer_blacklist (list) – List of versioneers that will be skipped.
Returns:

Latest upstream version of a package.
Return type:

str

Application module

class rebasehelper.application.Application(cli_conf: rebasehelper.config.Config, start_dir: str, execution_dir: str, results_dir: str, create_logs: bool = True)[source]
apply_changes()[source]
build_binary_packages()[source]

Function calls build class for building packages

build_source_packages()[source]
static extract_archive(archive_path, destination)[source]

Extracts given archive into the destination and handle all exceptions.

Parameters:
  • archive_path – path to the archive to be extracted
  • destination – path to a destination, where the archive should be extracted to
Returns:
static extract_sources(archive_path, destination)[source]

Function extracts a given Archive and returns a full dirname to sources

generate_patch()[source]

Generates patch to the results_dir containing all needed changes for the rebased package version

get_new_build_logs()[source]
patch_sources(sources)[source]
prepare_next_run(results_dir)[source]
prepare_sources()[source]

Function prepares a sources.

Returns:
print_summary(exception=None)[source]

Save rebase-helper result and print the summary using output tools. :param exception: Error message from rebase-helper :return:

print_task_info(builder)[source]
run()[source]
run_package_checkers(results_dir, **kwargs)[source]

Runs checkers on packages and stores results in a given directory.

Parameters:
  • results_dir (str) – Path to directory in which to store the results.
  • category (str) – checker type(SOURCE/SRPM/RPM)
Returns:

None
static setup(cli_conf)[source]

Archive module

class rebasehelper.archive.Archive(filename)[source]

Class representing an archive with sources

extract_archive(path)[source]

Extracts the archive into the given path

Parameters:path – Path where to extract the archive to.
classmethod get_supported_archives()[source]
class rebasehelper.archive.ArchiveTypeBase[source]

Base class for various archive types

EXTENSION = ''
classmethod extract(archive, filename, path)[source]

Extracts the archive into the given path

Parameters:path – Path where to extract the archive to.
Returns:
classmethod match(filename)[source]

Checks if the filename matches the archive type. If yes, returns True, otherwise returns False.

classmethod open(filename)[source]

Opens archive with the given filename and returns the proper archive type object.

class rebasehelper.archive.Bz2ArchiveType[source]
EXTENSION = '.bz2'
class rebasehelper.archive.CrateArchiveType[source]
EXTENSION = '.crate'
class rebasehelper.archive.GemArchiveType[source]
EXTENSION = '.gem'
class GemArchive(filename)[source]
close()[source]
extract(path)[source]
classmethod extract(archive, filename, path)[source]

Extracts the archive into the given path

Parameters:path – Path where to extract the archive to.
Returns:
classmethod open(filename)[source]

Opens archive with the given filename and returns the proper archive type object.

class rebasehelper.archive.TarArchiveType[source]
EXTENSION = '.tar'
class rebasehelper.archive.TarBz2ArchiveType[source]
EXTENSION = '.tar.bz2'
classmethod extract(archive, filename, path)[source]

Extracts the archive into the given path

Parameters:path – Path where to extract the archive to.
Returns:
classmethod open(filename)[source]

Opens archive with the given filename and returns the proper archive type object.

class rebasehelper.archive.TarGzArchiveType[source]
EXTENSION = '.tar.gz'
classmethod extract(archive, filename, path)[source]

Extracts the archive into the given path

Parameters:path – Path where to extract the archive to.
Returns:
classmethod open(filename)[source]

Opens archive with the given filename and returns the proper archive type object.

class rebasehelper.archive.TarXzArchiveType[source]
EXTENSION = '.tar.xz'
classmethod extract(archive, filename, path)[source]

Extracts the archive into the given path

Parameters:path – Path where to extract the archive to.
Returns:
classmethod open(filename)[source]

Opens archive with the given filename and returns the proper archive type object.

class rebasehelper.archive.TgzArchiveType[source]
EXTENSION = '.tgz'
class rebasehelper.archive.ZipArchiveType[source]
EXTENSION = '.zip'
classmethod extract(archive, filename, path)[source]

Extracts the archive into the given path

Parameters:path – Path where to extract the archive to.
Returns:
classmethod match(filename)[source]

Checks if the filename matches the archive type. If yes, returns True, otherwise returns False.

classmethod open(filename)[source]

Opens archive with the given filename and returns the proper archive type object.

rebasehelper.archive.register_archive_type(archive)[source]

CLI module

class rebasehelper.cli.CLI(args=None)[source]

Class for processing data from commandline

static build_parser(available_choices_only=False)[source]
class rebasehelper.cli.CliHelper[source]
classmethod convert_macros_to_dict(macros_list: List[str]) → Dict[str, str][source]

Converts macros from CLI to a dictionary.

Parameters:macros_list – List of macros in the format ‘MACRO EXPRESSION’.
Returns:The converted macros, MACRO are keys, EXPRESSION are values.
Raises:RebaseHelperError if the macros don’t follow the correct format.
classmethod run()[source]

Exception module

exception rebasehelper.exceptions.BinaryPackageBuildError(*args, **kwargs)[source]

Error indicating failure during the build of binary package.

exception rebasehelper.exceptions.CheckerNotFoundError[source]

Error indicating not being able to find checker binary.

exception rebasehelper.exceptions.DownloadError[source]

Exception indicating that download of a file failed.

exception rebasehelper.exceptions.LookasideCacheError[source]

Exception indicating a problem in accessing lookaside cache.

exception rebasehelper.exceptions.ParseError[source]
exception rebasehelper.exceptions.RebaseHelperError(*args, **kwargs)[source]

Class representing Error raised inside rebase-helper after intentionally catching some expected and well known exception/error.

exception rebasehelper.exceptions.SourcePackageBuildError(*args, **kwargs)[source]

Error indicating failure during the build of source package

Logger module

class rebasehelper.logger.ColorizingStreamHandler(stream=None)[source]
colors = {'dark': {10: {'bg': 'default', 'fg': 'brightblack', 'style': None}, 11: {'bg': 'default', 'fg': 'red', 'style': None}, 12: {'bg': 'default', 'fg': 'brightblack', 'style': None}, 20: {'bg': 'default', 'fg': 'default', 'style': None}, 25: {'bg': 'default', 'fg': 'green', 'style': None}, 26: {'bg': 'default', 'fg': 'yellow', 'style': None}, 27: {'bg': 'default', 'fg': 'red', 'style': None}, 30: {'bg': 'default', 'fg': 'yellow', 'style': None}, 40: {'bg': 'default', 'fg': 'red', 'style': 'bold'}, 50: {'bg': 'red', 'fg': 'white', 'style': 'bold'}}, 'light': {10: {'bg': 'default', 'fg': 'brightblack', 'style': None}, 11: {'bg': 'default', 'fg': 'red', 'style': None}, 12: {'bg': 'default', 'fg': 'brightblack', 'style': None}, 20: {'bg': 'default', 'fg': 'default', 'style': None}, 25: {'bg': 'default', 'fg': 'green', 'style': None}, 26: {'bg': 'default', 'fg': 'blue', 'style': None}, 27: {'bg': 'default', 'fg': 'red', 'style': None}, 30: {'bg': 'default', 'fg': 'blue', 'style': None}, 40: {'bg': 'default', 'fg': 'red', 'style': 'bold'}, 50: {'bg': 'red', 'fg': 'white', 'style': 'bold'}}}
emit(record)[source]

Emit a record.

If a formatter is specified, it is used to format the record. The record is then written to the stream with a trailing newline. If exception information is present, it is formatted using traceback.print_exception and appended to the stream. If the stream has an ‘encoding’ attribute, it is used to determine how to do the output to the stream.

set_terminal_background(background)[source]
terminal_background = 'dark'
class rebasehelper.logger.CustomLogger(name, level=0)[source]
HEADING = 26
IMPORTANT = 27
SUCCESS = 25
TRACE = 11
VERBOSE = 12
class rebasehelper.logger.LoggerHelper[source]

Helper class for setting up a logger.

static add_file_handler(logger: logging.Logger, path: str, formatter: Optional[logging.Formatter] = None, level: Optional[int] = None) → Optional[logging.FileHandler][source]

Adds file handler to the given logger.

Parameters:
  • logger – Logger object to add the handler to.
  • path – Path to a log file.
  • formatter – Formatter object used to format logged messages.
  • level – Severity threshold.
Returns:

Created file handler instance or None if creation failed.
static add_stream_handler(logger: logging.Logger, level: Optional[int] = None, formatter: Optional[logging.Formatter] = None) → rebasehelper.logger.ColorizingStreamHandler[source]

Adds stream handler to the given logger.

Parameters:
  • logger – Logger object to add the handler to.
  • level – Severity threshold.
  • formatter – Formatter object used to format logged messages.
Returns:

Created stream handler instance.
classmethod create_file_handlers(results_dir: str) → List[logging.FileHandler][source]

Creates rebase-helper file handlers.

Parameters:results_dir – Path to rebase-helper-results directory.
Returns:List of created file handler instances.
classmethod create_stream_handlers() → Tuple[rebasehelper.logger.ColorizingStreamHandler, rebasehelper.logger.ColorizingStreamHandler][source]
memory_handler = None
classmethod remove_file_handlers(handlers: List[logging.FileHandler]) → None[source]

Removes rebase-helper file handlers.

Parameters:handlers – List of file handlers to remove.
classmethod remove_memory_handler() → None[source]
classmethod setup_memory_handler() → None[source]
class rebasehelper.logger.MemoryHandler[source]

BufferingHandler with infinite capacity

replay_into(target: logging.Handler) → None[source]
shouldFlush(record: logging.LogRecord) → bool[source]

Should the handler flush its buffer?

Returns true if the buffer is up to capacity. This method can be overridden to implement custom flushing strategies.

Patcher module

class rebasehelper.patcher.Patcher[source]

Class for git command used for patching old and new sources

classmethod apply_old_patches(source_dir)[source]

Function applies a patch to a old/new sources

classmethod apply_patch(repo, patch_object)[source]

Function applies patches to old sources It tries apply patch with am command and if it fails then with command –apply

static decorate_patch_name(patch_name)[source]
classmethod extract_patch_name(message)[source]
classmethod init_git(directory)[source]

Function initialize old and new Git repository

classmethod insert_patch_name(message, patch_name)[source]
new_repo = None
new_sources = None
non_interactive = False
old_repo = None
old_sources = None
output_data = None
classmethod patch(old_dir, new_dir, rest_sources, patches, **kwargs)[source]

The function can be used for patching one directory against another

patches = []
classmethod strip_patch_name(diff, patch_name)[source]

Spec content module

class rebasehelper.spec_content.SpecContent(content: str)[source]

Class representing content of a SPEC file.

DISALLOW_INLINE_COMMENTS = ['%package', '%patchlist', '%sourcelist', '%description', '%files', '%changelog']
SECTION_HEADERS = ['%package', '%prep', '%generate_buildrequires', '%build', '%install', '%check', '%clean', '%preun', '%postun', '%pretrans', '%posttrans', '%pre', '%post', '%files', '%changelog', '%description', '%triggerpostun', '%triggerprein', '%triggerun', '%triggerin', '%trigger', '%verifyscript', '%sepolicy', '%filetriggerin', '%filetrigger', '%filetriggerun', '%filetriggerpostun', '%transfiletriggerin', '%transfiletrigger', '%transfiletriggerun', '%transfiletriggerpostun', '%end', '%patchlist', '%sourcelist']
classmethod get_comment_span(line: str, section: str) → Tuple[int, int][source]

Gets span of a comment depending on the section.

Parameters:
  • line – Line to find the comment in.
  • section – Section the line is in.
Returns:

Span of the comment. If no comment is found, both tuple elements are equal to the length of the line for convenient use in a slice.
replace_section(name: str, content: List[str]) → bool[source]

Replaces content of a section.

In case there are multiple sections with the same name, the first one is replaced.

Parameters:
  • name – Section name.
  • content – Section content as a list of lines.
Returns:

False if section was not found else True.
section(name: str) → Optional[List[str]][source]

Gets content of a section.

In case there are multiple sections with the same name, the first one is returned.

Parameters:name – Section name.
Returns:Section content as a list of lines.

Specfile module

class rebasehelper.specfile.PackageCategory[source]

An enumeration.

R = re.compile('^R-')
haskell = re.compile('^ghc-')
nodejs = re.compile('^nodejs-')
perl = re.compile('^perl-')
php = re.compile('^php-')
python = re.compile('^python[23]?-')
ruby = re.compile('^rubygem-')
rust = re.compile('^rust-')
class rebasehelper.specfile.PatchList[source]
class rebasehelper.specfile.PatchObject(path, index, strip)[source]

Class represents set of information about patches

get_patch_name()[source]
class rebasehelper.specfile.SpecFile(path: str, sources_location: str = '', predefined_macros: Optional[Dict[str, str]] = None, lookaside_cache_preset: str = 'fedpkg', keep_comments: bool = False)[source]

Class representing a SPEC file. Be aware that using SpecFile modifies RPM macros in global context.

copy(new_path)[source]

Creates a copy of the current object and copies the SPEC file to a new location.

Parameters:new_path (str) – Path to copy the new SPEC file to.
Returns:The created SpecFile instance.
Return type:SpecFile
download_remote_sources()[source]

Method that iterates over all sources and downloads ones, which contain URL instead of just a file.

Returns:None
static extract_version_from_archive_name(archive_path: str, main_source: str) → str[source]

Extracts version string from source archive name.

Parameters:
  • archive_path – Path to the main sources archive.
  • main_source – Value of Source0 tag.
Returns:

Extracted version string.
Raises:

RebaseHelperError in case version can’t be determined.
find_archive_target_in_prep(archive)[source]

Tries to find a command that is used to extract the specified archive and attempts to determine target path from it. ‘tar’ and ‘unzip’ commands are supported so far.

Parameters:archive – Path to archive
Returns:Target path relative to builddir or None if not determined
get_NVR() → str[source]
get_applied_patches()[source]

Method returns list of all applied patches.

Returns:list of PatchObject
get_archive()[source]

Method returns the basename of first Source in SPEC file a.k.a. Source0

Returns:basename of first Source in SPEC file
Return type:str
get_main_files_section()[source]

Finds the exact name of the main %files section.

Returns:Name of the main files section.
Return type:str
get_main_source() → str[source]

Provide the main source, returns empty string if there are no sources

get_new_log(changelog_entry)[source]

Constructs a new changelog entry.

Parameters:changelog_entry (str) – Message to use in the entry.
Returns:List of lines of the new entry.
Return type:list
get_not_used_patches()[source]

Method returns list of all unpplied patches.

Returns:list of PatchObject
get_patches()[source]

Method returns list of all applied and not applied patches

Returns:list of PatchObject
get_prep_section()[source]

Function returns whole prep section

get_raw_tag_value(tag_name: str, section: Union[str, int, None] = None) → Optional[str][source]
get_release() → str[source]

Returns release string without %dist

get_setup_dirname()[source]

Get dirname from %setup or %autosetup macro arguments

Returns:dirname
get_sources() → List[str][source]

Gets a list of local sources.

static get_subpackage_name(files_section)[source]

Gets subpackage name based on the %files section.

get_version() → str[source]
is_test_suite_enabled()[source]

Returns whether test suite is enabled during the build time

Returns:True if enabled or False if not
parse_release() → Tuple[bool, int, Optional[str]][source]

Parses release string.

Returns:Tuple of is_prerelease, release_number and extra_version.
Raises:RebaseHelperError in case release string is not valid.
process_patch_macros(comment_out: Optional[List[int]] = None, remove: Optional[List[int]] = None, annotate: Optional[List[int]] = None, note: Optional[str] = None) → None[source]

Processes %patch macros in %prep section.

Parameters:
  • comment_out – List of patch numbers to comment out.
  • remove – List of patch numbers to remove.
  • annotate – List of patch numbers to annotate.
  • note – Message to annotate patches with.
reload()[source]

Reloads the whole Spec file.

save() → None[source]

Saves changes made to SpecContent and updates the internal state.

set_extra_version(extra_version: Optional[str], version_changed: bool) → None[source]

Updates SPEC file with the specified extra version.

Parameters:
  • extra_version – Extra version string or None.
  • version_changed – Whether version (the value of Version tag) changed.
set_raw_tag_value(tag_name: str, value: str, section: Union[str, int, None] = None) → None[source]
set_release(release: str, preserve_macros: bool = True) → None[source]
set_release_number(release: str) → None[source]
set_tag(*args, **kwargs)[source]
set_version(version: str, preserve_macros: bool = True) → None[source]
static split_version_string(version_string: str, current_version: str) → Tuple[str, Optional[str]][source]

Splits version string into version and extra version.

Parameters:
  • version_string – Complete version string.
  • current_version – Current version (the value of Version tag).
Returns:

Tuple of version and extra_version.
Raises:

RebaseHelperError in case passed version string is not valid.
tag(name: str, section: Union[str, int, None] = None) → Optional[rebasehelper.tags.Tag][source]

Returns the first non-unique tag.

update() → None[source]
update_changelog(*args, **kwargs)[source]
update_paths_to_sources_and_patches(*args, **kwargs)[source]
update_setup_dirname(*args, **kwargs)[source]
write_updated_patches(*args, **kwargs)[source]
rebasehelper.specfile.get_rebase_name(dir_name, name)[source]

Function returns a name in results directory

Parameters:
  • dir_name –
  • name –
Returns:

full path to results dir with name
rebasehelper.specfile.saves(func)[source]

Decorator for saving the SpecFile after a method is run.

Tags module

class rebasehelper.tags.Tag(section_index: int, section_name: str, line: int, name: str, value_span: Tuple[int, int], valid: bool, index: Optional[int] = None)[source]
class rebasehelper.tags.Tags(raw_content: rebasehelper.spec_content.SpecContent, parsed_content: rebasehelper.spec_content.SpecContent)[source]
filter(section_index: Optional[int] = None, section_name: Optional[str] = None, name: Optional[str] = None, valid: Optional[bool] = True) → Iterator[rebasehelper.tags.Tag][source]

Filters tags based on section, name or validity. Defaults to all valid tags in all sections.

Parameters:
  • section_index – If specified, includes tags only from section of this index.
  • section_name – If specified, includes tags only from sections of this name.
  • name – If specified, includes tags matching this name. Wildcards are supported.
  • valid – If specified, includes tags of this validity.
Returns:

Iterator of matching Tag objects.

Temporary environment module

class rebasehelper.temporary_environment.TemporaryEnvironment(exit_callback=None)[source]

Class representing a temporary environment (directory) that can be used as a workspace.

Works as a context manager.

TEMPDIR = 'TEMPDIR'
env()[source]

Gets a copy of _env dictionary.

Returns:Copy of _env dictionary.
Return type:dict
path()[source]

Gets the path to the temporary environment.

Returns:Absolute path to the temporary environment.
Return type:str

Change Log

[Unreleased]

[0.26.0] - 2021-09-27

Added
  • Added support for SPEC files with no Source tags
Fixed
  • Fixed traceback on setting original locale
  • rpmdiff is now called with long options to workaround a bug in argument parsing
Changed
  • Employed Github Actions for CI and PyPI deployment
  • Character encoding is now explicitly specified everywhere, to conform with PEP597
  • Made copr project creation more robust

[0.25.0] - 2021-07-13

Added
  • Added lookaside cache preset for centpkg
Fixed
  • Started using C locale for updating %changelog section
  • Fixed documentation builds with Sphinx 4
  • Fixed macro value detection in SpecFile.set_tag()
  • Fixed licensecheck availability test
Changed
  • Moved from using deprecated --old-chroot mock option to --isolation simple
  • Migrated from Travis CI to Github Actions
  • Moved away from soon-to-be-deprecated distutils

[0.24.0] - 2021-02-02

Added
  • Added --lookaside-cache-preset option to enable using different lookaside cache configuration presets
  • Added --no-changelog-entry option to prevent rebase-helper from generating an entry in %changelog section
  • Added --keep-comments option to disable removing comments
Fixed
  • Fixed removing accompanying comments alongside patches
  • Fixed broken --get-old-build-from-koji option
Changed
  • Switched to new format of Fedora lookaside cache URLs
  • Limited koji builds to x86_64 (it’s a waste of resources until rebase-helper fully supports other architectures)
  • Suppressed harmless errors produced by rpm when expanding and deleting macros
  • Paths in patches are now sanitized before applying with git apply, to allow dealing with unusual patch formats
  • SpecFile._process_patches() method has been replaced with a public SpecFile.process_patch_macros() method

[0.23.1] - 2020-09-30

Fixed
  • Fixed uploads to Fedora lookaside cache and improved error handling
  • A build is no longer retried as a result of checker failure
Changed
  • SpecFile.set_version() and SpecFile.set_release() now allow disabling of preserving macros
  • rpminspect checker now uses rpminspect-fedora

[0.23.0] - 2020-08-28

Added
  • Added rpminspect checker
Fixed
  • rebase-helper is now able to deal with existing git repository in extracted upstream sources
  • Prevented git commands executed in the background from launching an interactive editor and effectively rendering rebase-helper unusable
  • Outputs of checkers are now removed before subsequent runs
  • Tilde is now recognized as extra version separator
  • make test-podman has been updated to work with the latest podman
Changed
  • Checker outputs are now ordered by type in the text report
  • Excessive blank lines are now removed from the SPEC file when removing patches
  • Sources and patches are now automatically renamed, if necessary
  • abipkgdiff now falls back to comparing without debuginfo in case it is unable to read it from the provided debuginfo packages

[0.22.0] - 2020-03-31

Added
  • Added more type hints, including all public API methods
Fixed
  • SpecFile.reload() no longer pointlessly calls SpecFile._read_spec_content()
  • Deleted files are now skipped when detecting unresolved conflicts during git rebase
  • Fixed detection of Koji log file containing build failure
  • Adapted to changes in git 2.26.0
  • Fixed unhandled exception during upload to lookaside cache
Changed
  • Removed no longer necessary workarounds from Fedora base images
  • Simplified packit configuration
  • Options --pkgcomparetool, --versioneer-blacklist, --spec-hook-blacklist and --build-log-hook-blacklist can now be specified without an argument to indicate none of the tools/hooks should be run

[0.21.0] - 2020-02-21

Added
  • Added public API tests for Tags class
  • Added support for %patchlist and %sourcelist
  • Added support for automatic Source/Patch numbering
Fixed
  • commit-hash-updater SPEC hook now handles empty release name
  • sources is now ignored if it’s not a regular file
  • Fixed summary and report paths when using --bugzila-id or --results-dir
  • Fixed and extended detection of ABI changes reported by abipkgdiff
  • Removed deprecated encoding parameter in json.load() for Python 3.9
  • Fixed processing of remote patches
  • Fixed handling of intermediate macros in SpecFile.set_tag()
Changed
  • All RPM macros are now reset when SpecFile object is destroyed
  • Renamed docker directory to containers and Dockerfiles to Containerfiles
  • Switched from Docker Hub to quay.io for automatic image building
  • Improved and cleaned up SpecFile tests
  • replace-old-version SPEC hook can now replace also extraversion

[0.20.0] - 2019-12-06

Added
  • Introduced Tags class unifying and simplifying access to SPEC tags
  • Added proper support for crate and gem archives
  • Added --bugzilla-id option to perform a rebase based on Upstream Release Monitoring bugzilla
  • Added -D/--define option to define macros
  • Added tests for public API
Fixed
  • Fixed --build-tasks option
  • Fixed detecting unresolved conflicts in non-UTF-8 files
  • Prevented loss of messages logged before logging file handlers are created
  • rebase-helper now skips unparseable lines in %prep instead of tracebacking on them
  • Fixed parsing SPEC files with -h in %prep
  • Fixed processing SPEC files with zero-padded indexed tags and %patch macros
Changed
  • Completely reworked dealing with extraversions
  • Improved SpecFile.set_tag() to minimize changes made to the SPEC file

[0.19.0] - 2019-09-26

Added
  • Added --workspace-dir option to allow specifying custom workspace directory
  • Added sonamecheck checker for detecting SONAME changes
  • Added --copr-project-permanent, --copr-project-frontpage and --copr-chroots options
Fixed
  • Strings like “1” are no longer replaced with macros in %prep
  • SPEC files without Source0 tag are now handled correctly
  • Fixed copr build tool, switched to V3 API
  • Avoided parsing SPEC without properly setting %{_sourcedir} macro first
Changed
  • Introduced RpmHeader class for more convenient access to package header attributes
  • Modification of Patch tags now preserves whitespace to minimize differences in SPEC
  • Moved Bash completion script from /etc/bash_completion.d to /usr/share/bash-completion/completions
Removed
  • Removed non-working --patch-only, --build-only and --comparepkgs-only options
  • Temporarily removed --continue option
  • Removed no longer used python3-six build dependency
  • Removed copr workaround in favor of making copr build tool unavailable in case it’s not working

[0.18.0] - 2019-08-21

Added
  • Added workaround for missing mock group in Fedora Rawhide
Fixed
  • Moved setup dependencies from install_requires to setup_requires
Changed
Removed
  • Removed unused Application methods and attributes
  • Removed unused testing files

[0.17.2] - 2019-08-09

Added
Fixed
  • Added exception handling to PyPI release webhook endpoint
  • Fixed TestCLI.test_cli_unit() test
  • Updated MANIFEST.in to include all necessary files
Changed
  • Improved tests for Application class
  • SpecFile.update_changelog() now creates %changelog section if it doesn’t exist
  • rebase-helper now uses setuptools-scm to determine version from git
  • setup.py sdist now supports overriding distribution base name with --base-name option

[0.17.1] - 2019-08-01

Fixed
  • Fixed PyPI release webhook endpoint
Changed
  • Removed direct dependencies preventing PyPI release

[0.17.0] - 2019-07-31

Added
  • Added possibility for plugins to specify their own arguments
  • Added basic type hints and enabled mypy linter
  • Added rust package category
  • replace-old-version SPEC hook can now replace old version with %{version} macro
  • replace-old-version SPEC hook can now replace also parts of version in Sources and Patches
Fixed
  • Fixed broken ansicolors dependency
  • Fixed printing of output of unavaiable checkers
  • Fixed determining unmatched quotation in %prep section
  • Made files build log hook handle conditions and macros in %files section
  • files build log hook now adds man pages in a way that follows Fedora Packaging Guidelines
  • files build log hook now ignores debuginfo files
  • Fixed issues with polluted global macro namespace when parsing multiple different SPEC files
  • Fixed handling of remote downstream patches (URLs)
  • Fixed parsing of patch strip options in %prep
  • Fixed wrapping of extra long lines in the usage documentation
  • Sources from lookaside cache are now downloaded to a proper location
Changed
  • Restructured the code layout of plugins
  • Refactored parts of SpecFile class
  • Disabled removing of “unused” patches
  • mock is now automatically run with superuser privileges if necessary
  • Local builder is now used if --get-old-build-from-koji is specified and the build can’t be downloaded from Koji
  • checkers (even the default ones) are now skipped if they are not available
  • Sources are now copied to destination if they cannot be extracted
  • Reimplemented downloading Koji builds
  • Updated documentation
Removed
  • Removed Python 2 support

[0.16.3] - 2019-05-03

Fixed
  • Fixed handling of SPEC files with conditionalized sections
  • Fixed replace-old-version SPEC hook not to update version in %changelog and local sources
  • Fixed capturing RPM error output during SPEC parsing
  • Fixed handling of absolute %license and %doc paths in files build log hook
  • Fixed logging of SRPM and RPM build errors
Changed
  • Updated packit configuration for packit 0.2.0
  • Adapted to upcoming change in RPM python API
  • Made SpecFile class more suitable for external use

[0.16.2] - 2019-03-07

Added
  • Added support for packit
  • Added SPEC hook for replacing old version string
Fixed
  • Fixed documentation building by mocking requests-gssapi
  • Fixed TestOutputTool for checkers
Changed
  • Build log hooks are now run only if build of new binary packages fails
  • It is now possible to use --get-old-build-from-koji option without FAS

[0.16.1] - 2019-02-28

Fixed
  • Made GitPatchTool auto-skip empty commits caused by new rebase implementation in git 2.20
  • Fixed TestGitHelper to work on real systems with existing git configuration

[0.16.0] - 2019-02-27

Added
  • Added category for R packages
  • Added make test-podman as an alternative to make test-docker
  • Added --skip-upload option (to be used in conjunction with --update-sources)
  • Added check that all sources for the new version are present
  • Added SPEC hook for escaping macros in comments
Changed
  • --get-old-build-from-koji now tries to get specific version build (as opposed to the latest one)
  • Implemented parsing of multiline macros and shell expansions in SPEC files
  • rebase-helper can now handle multiline enquoted strings in %prep section
  • Refactored GitPatchTool to make the rebase process more robust and to preserve as much of the original downstream patches as possible
  • git mergetool is now run again if there are some unresolved conflicts left
  • Associated comments are now removed along with patches
Fixed
  • Fixed populating list of logs on build failures
  • Added missing abort after failed git am
  • Fixed processing SPEC files without %prep section
  • Fixed several issues in ruby-helper SPEC hook
  • Fixed unwanted expansion of %autosetup macro
  • Fixed automatic rebulding based on build log hooks result
  • Fixed removal of %doc and %license files in subpackages
Removed
  • Removed requests-kerberos support and switched to requests-gssapi exclusively

[0.15.0] - 2018-12-21

Added
  • Implemented build log hooks and added files hook to detect and fix missing/unpackaged files
Changed
  • Refactored and simplified all plugins
Fixed
  • Fixed not listing all argument choices while generating documentation
  • Fixed error in parsing rpmdiff output
  • Fixed insertion of extra blank lines to a SPEC file after removing patches
Removed
  • Removed unneeded packages from base Docker image

[0.14.0] - 2018-10-04

Added
  • Added PathsToRPMMacros SPEC hook for transforming paths in %files section
  • Added --favor-on-conflict option to prefer upstream or downstream changes with conflicting patches
Changed
  • Extended PyPIURLFix SPEC hook to incorporate the new https://pypi.org website
  • Made processing of patches in a SPEC file more robust
  • Rewritten functional test to use an artificial package designed to check most aspects of the rebase process
  • pylint is now run with Python 3 only, as Python 2 variant is no longer supported
  • Code refactoring, simplified SpecFile class
  • Checkers are no longer required for rebase-helper to run, only available checkers are used
Fixed
  • Fixed bug in licensecheck checker when used with json output tool
  • Fixed SPEC hook tests
  • Fixed strangely acting lookaside cache upload progressbar
  • Fixed downloading of SRPMs with --get-old-build-from-koji
  • Fixed building usage documentation

[0.13.2] - 2018-05-18

Added
  • Added licensecheck checker for detecting license changes
  • Added another not-so-verbose verbosity level
Changed
  • Refactored utils module
Fixed
  • Fixed abipkgdiff detecting changes in only one object file
  • Fixed uploads to lookaside cache
  • Fixed broken consequent build retries

[0.13.1] - 2018-04-19

Added
  • Added --apply-changes option to apply changes.patch after successful rebase
  • Implemented .gitignore update with --update-sources
Changed
  • Extended README.md
  • Cleaned up constants
Fixed
  • Fixed crash after failed rebase when no checkers were run

[0.13.0] - 2018-03-29

Added
  • Added possibility to make changes to specfile between build retries
  • Added CommitHashUpdater SPEC hook
  • Added hackage versioneer
  • Added support for uncompressed tar archives
  • Created integration environment for test suite to isolate it from the internet
  • Added --update-sources option to update sources file and upload new sources to lookaside cache
Changed
  • Switched to requests library for downloads
  • Made error messages from Koji builds more useful
  • Reworked handling of downstream patches
  • Changed package build process to build first SRPMs and then RPMs
  • Divided checkers into categories running at different phases of rebase
  • Koji build tool refactored to be better adjustable and extensible
  • Colorized rebase-helper output and enhanced log messages
  • Significatly improved rebase summary and report
Fixed
  • Fixed TestConsoleHelper.test_get_message() test
  • Fixed bug in rpmdiff output analysis
  • Fixed some code styling errors and a large number of issues found by static analysis

[0.12.0] - 2017-12-19

Added
  • Added npmjs and cpan versioneers
  • Added possibility to specify custom py.test arguments
  • Added possibility to customize changelog entry
  • Added version check to abort rebase if requested version is not newer than current
  • Added separate tox tasks for linting
  • Implemented rpmbuild and mock SRPM build tools
  • Added possibility to configure rebase-helper with configuration file
  • Added possibility to blacklist certain SPEC hooks or versioneers
  • Created rebasehelper/rebase-helper Docker Hub repository
Changed
  • Made several speed optimizations in the test suite
  • Tests requiring superuser privileges are now automatically skipped if necessary
  • Simplified build analysis and made related log messages more useful
Fixed
  • Fixed documentation builds on readthedocs.org broken by rpm distribution requirement
  • Fixed reading username and e-mail from git configuration
  • Added missing dependencies to Dockerfile
  • Fixed processing of custom builder options
  • Added workarounds for RPM bugs related to %sources and %patches
  • Fixed several unhandled exceptions
  • Fixed parsing tarball filename containing certain characters

[0.11.0] - 2017-10-04

Added
  • Added rpm-py-installer to install rpm-python from pip
  • Implemented detection of package category (python, perl, ruby, nodejs, php)
  • Added RubyGems versioneer
  • Added RubyHelper SPEC hook for getting additional sources based on instructions in SPEC file comments
Changed
  • Value of Version and Release tags is now preserved if there are any macros that can be modified instead
  • Versioneers and SPEC hooks are now run only for matching package categories
  • Bash completion is now generated from source code, so it is always up-to-date
Fixed
  • Prevented unwanted modifications of %prep section
  • Fixed unexpected removal of rpms and build logs after last build retry
  • Added files are no longer listed as removed in rpmdiff report

[0.10.1] - 2017-08-30

Added
  • Added --version argument
Changed
  • Anitya versioneer now primarily searches for projects using Fedora mapping
  • Python dependencies moved from requirements.txt to setup.py
Fixed
  • Made CustomManPagesBuilder work with Sphinx >= 1.6
  • %prep section parser is now able to handle backslash-split lines

[0.10.0] - 2017-08-25

Added
  • Implemented extensible SPEC hooks and versioneers
  • Added PyPI SPEC hook for automatic fixing of Source URL of Python packages
  • Added Anitya and PyPI versioneers for determining latest upstream version of a package
  • Added possibility to download old version build of a package from Koji
  • Added support for test suite to be run in Docker containers
  • Implemented functional tests for automatic testing of whole rebase process
  • Diff against original source files is now generated as changes.patch
Changed
  • Introduced plugin system for extending build tools, checkers and output tools
  • Updated for Koji 1.13 which finally brings Python 3 support
  • Improved output information and reports
  • Added colorized output
  • Improved project documentation
Fixed
  • Pre-configured git username and e-mail address is now used if available
  • Fixed several issues in rpmdiff and especially abipkgdiff checkers
  • Fixed several test suite related issues

[0.9.0] - 2017-01-05

Added
  • Old sources are now downloaded from Fedora lookaside cache
  • Auto-generated and improved CLI documentation and man page
  • Added support for downloading files of unknown size
Changed
  • SpecFile class preparation for pre-download hooks
  • Code cleanup and refactorization
Fixed
  • Fixed regexp for getting release number from SPEC
  • Fixed functionality of --results-dir option
  • Several upstream monitoring fixes
  • Fixed issues caused by Fedora Flag Day

[0.8.0] - 2016-07-31

Added
  • Added support for JSON output format
  • Added support for copr build tool
  • Added support for passing arbitrary extra arguments to local builders (mock, rpmbuild) with --builder-options.
  • Added new option --build-retries allows the user to specify number of build retries (by default 2)
  • Added support for csmock check tool
Changed
  • Renamed fedpkg build tool to koji to make it more clear
  • Downloading of files is now done only using standard Python library and not using PyCURL
Fixed
  • Many bug fixes and code clean up

[0.7.3] - 2016-04-08

Added
  • Added rpm.addMacro
Fixed
  • Handled exceptions raised during parsing of SPEC files
  • Fixed unapplied patches mixing with deleted ones

[0.7.2] - 2016-03-15

Added
  • Added information about scratch builds
Fixed
  • Added check if file exists and is empty for the-new-hotness
  • Patches are applied in case --builds-nowait option is used

[0.7.1] - 2016-02-22

Added
  • Two new command line options used by upstream monitoring
Fixed
  • fedpkg reimplementation

[0.7.0] - 2016-01-13

Changed
  • Several improvements
Fixed
  • pkgdiff is now smarter
  • Included tar.bz2 into list of supported formats
  • Added support for noarch package in case of fedpkg build
  • Checker should return None if there is no debug package
Removed
  • Removed a bunch of debug stuff

[0.6.2] - 2015-11-09

Fixed
  • Logs are being saved to their own directory
  • Prep script is moved into workspace directory
  • No more traceback in case koji module is not present
  • Each checker creates its own log file
  • rebase-helper informs if it failed or not
  • Report on script is smarter

[0.6.1] - 2015-10-30

Added
  • upstream-monitoring.py - used by upstream monitoring service
  • rebase-helper-fedmsg.py - testing Python script

[0.6.0] - 2015-07-31

Added
  • Parts of %prep section related to patching are executed
  • Support for abipkgdiff
Fixed
  • Several fixes
  • Replaced yum with dnf

[0.5.0] - 2015-05-22

Added
  • Added support for building packages via fedpkg (or koji)
  • Added summary report for better overview
  • continue option implemented for git rebase
  • Added several tests
  • Added class for operating with Git repositories
Changed
  • git rebase is used instead of patch command
Fixed
  • Fixed several decoding issues
  • Several PEP8 and W1202 fixes
Removed
  • DiffHelper class is not needed

[0.4.0] - 2014-12-05

Added
  • Handling of extra versions like b1, rc1, etc.
  • Added build log analyzer to detect unpackaged files or other issues
  • Added Bash completion
Changed
  • Improved version extraction from archive name
  • rebase-helper output is looged to rebase-helper-results directory
  • SpecFile class rewritten

[0.3.1] - 2014-07-25

Added
  • New build class
  • --build-only option
  • Installation of build dependencies in case of rpmbuild tool
  • More tests
  • RebaseHelperError class for catching exceptions
Fixed
  • Several fixes

[0.3.0]

Added
  • pkgdiff tool for comparing RPM packages
  • Tests for Archive class and SPEC file

[0.2.0]

Added
  • diff_helper for comparing two tarballs
  • Applying patches to tarballs
  • patch_helper

[0.1.0]

Added
  • Initial classes
  • CLI interface