Add BDD feature tests using python-behave

Introduce behavioral tests for rdopkg patch and new-version that should from
now on be used for description of high level behavior while unit tests should
only cover individual functions.

Introduce new rdopkg.utils.distgitmagic module with shared code for sample
distgit creation and testing.

Cleanup hook leaves test dir untouched for failed tests.

Run

	behave

To get verbose colorful output.

Fixes: #123
Change-Id: I56c642796d849f7452f1abad67613c1a4d0b1563

Author: Jakub Ruzicka

features/environment.py

@@ -0,0 +1,30 @@
+# -*- coding: UTF-8 -*-
+import os
+import shutil
+
+
+def clean_tempdir(context, scenario):
+    """
+    Clean up temporary test dirs for passed tests.
+
+    Leave failed test dirs for manual inspection.
+
+    """
+    tempdir = getattr(context, 'tempdir', None)
+    if tempdir and scenario.status == 'passed':
+        shutil.rmtree(tempdir)
+        del(context.tempdir)
+
+
+def restore_cwd(context):
+    """
+    Return to original working dir or behave gets confused :-/
+    """
+    old_cwd = getattr(context, 'old_cwd', None)
+    if old_cwd:
+        os.chdir(old_cwd)
+
+
+def after_scenario(context, scenario):
+    clean_tempdir(context, scenario)
+    restore_cwd(context)

features/newversion.feature

@@ -0,0 +1,23 @@
+Feature: rdopkg new-version
+    Updating package to new version is a core feature
+
+    Scenario: rdopkg new-version --bump-only
+        Given a distgit at Version 2.0.0 and Release 3
+        When I run rdopkg new-version --bump-only -n 2.1.0
+        Then .spec file tag Version is 2.1.0
+        Then .spec file tag Release is 1%{?dist}
+        Then .spec file doesn't contain patches_base
+        Then .spec file contains new changelog entry with 1 lines
+        Then new commit was created
+
+    Scenario: rdopkg new-version with upstream patches
+        Given a distgit at Version 0.1 and Release 0.1
+        Given a patches branch with 5 patches
+        Given a new version 1.0.0 with 2 patches from patches branch
+        When I run rdopkg new-version -lntU 1.0.0
+        Then .spec file tag Version is 1.0.0
+        Then .spec file tag Release is 1%{?dist}
+        Then .spec file doesn't contain patches_base
+        Then .spec file has 3 patches defined
+        Then .spec file contains new changelog entry with 1 lines
+        Then new commit was created

features/patch.feature

@@ -0,0 +1,20 @@
+Feature: rdopkg patch
+    Updating patches from patches branch is a core feature
+
+    Scenario: rdopkg patch
+        Given a distgit
+        Given a patches branch with 5 patches
+        When I run rdopkg patch -l
+        Then .spec file has 5 patches defined
+        Then .spec file doesn't contain patches_base
+        Then .spec file contains new changelog entry with 5 lines
+        Then new commit was created
+
+    Scenario: rdopkg patch --no-bump
+        Given a distgit
+        Given a patches branch with 3 patches
+        When I run rdopkg patch --no-bump -l
+        Then .spec file has 3 patches defined
+        Then .spec file doesn't contain patches_base
+        Then .spec file doesn't contain new changelog entries
+        Then new commit was created

features/steps/distgit.py

@@ -0,0 +1,79 @@
+from behave import *
+import os
+
+from rdopkg.utils import distgitmagic
+from rdopkg.utils import specfile
+from rdopkg.utils.distgitmagic import git, run
+
+
+@given('a distgit at Version {version} and Release {release}')
+def step_impl(context, version, release):
+    name = 'foo-bar'
+    context.execute_steps(u'Given a temporary directory')
+    context.distgitdir = distgitmagic.create_sample_distgit(
+        name, version=version, release=release)
+    os.chdir(context.distgitdir)
+    # collect .spec state to compare against after actions
+    spec = specfile.Spec()
+    context.old_changelog_entry = spec.get_last_changelog_entry()
+    context.old_commit = git.current_commit()
+
+
+@given('a distgit')
+def step_impl(context):
+    context.execute_steps(u'Given a distgit at Version 1.2.3 and Release 2')
+
+
+@given('a patches branch with {n:n} patches')
+def step_impl(context, n):
+    distgitmagic.create_sample_patches_branch(n)
+
+
+@given('a new version {version} with {n:n} patches from patches branch')
+def step_impl(context, version, n):
+    distgitmagic.create_sample_upstream_new_version(version, 9, n)
+
+
+@given('a new version {version}')
+def step_impl(context, version):
+    context.execute_steps(
+        u'Given a new version %s with 0 patches from patches branch' %
+        version)
+
+
+@then('.spec file tag {tag} is {value}')
+def step_impl(context, tag, value):
+    spec = specfile.Spec()
+    assert spec.get_tag(tag) == value
+
+
+@then('.spec file contains new changelog entry with {n:n} lines')
+def step_impl(context, n):
+    spec = specfile.Spec()
+    entry = spec.get_last_changelog_entry()
+    assert len(entry[1]) == n
+    assert entry != context.old_changelog_entry
+
+
+@then('.spec file doesn\'t contain new changelog entries')
+def step_impl(context):
+    entry = specfile.Spec().get_last_changelog_entry()
+    assert entry == context.old_changelog_entry
+
+
+@then('.spec file has {n:n} patches defined')
+def step_impl(context, n):
+    spec = specfile.Spec()
+    assert spec.get_n_patches() == n
+
+
+@then('.spec file doesn\'t contain patches_base')
+def step_impl(context):
+    spec = specfile.Spec()
+    assert spec.get_patches_base() == (None, 0)
+
+
+@then('new commit was created')
+def step_impl(context):
+    new_commit = git.current_commit()
+    assert new_commit != context.old_commit

features/steps/utils.py

@@ -0,0 +1,19 @@
+from behave import *
+import os
+import tempfile
+
+from rdopkg.utils.distgitmagic import run
+
+
+@when('I run rdopkg {args}')
+def step_impl(context, args):
+    # proper argument parsing might be needed
+    cmd = ['rdopkg'] + args.split(' ')
+    run(*cmd)
+
+
+@given('a temporary directory')
+def step_impl(context):
+    context.tempdir = tempfile.mkdtemp(prefix='rdopkg-test-')
+    context.old_cwd = os.getcwd()
+    os.chdir(context.tempdir)

rdopkg/utils/distgitmagic.py

@@ -0,0 +1,133 @@
+import os
+from rdopkg import helpers
+import rdopkg.utils.cmd
+from rdopkg.utils import specfile
+
+
+SAMPLE_SPEC = u"""
+Name:             {name}
+Epoch:            1
+Version:          {version}
+Release:          {release}%{{?dist}}
+Summary:          Amazing {name} package
+
+Group:            Development/Languages
+License:          ASL 2.0
+URL:              http://pypi.python.org/pypi/%{{name}}
+Source0:          http://pypi.python.org/lul/%{{name}}/%{{name}}-%{{version}}.tar.gz
+
+BuildArch:        noarch
+BuildRequires:    python-setuptools
+BuildRequires:    python2-devel
+
+Requires:         python-argparse
+Requires:         python-iso8601
+Requires:         python-prettytable
+
+%description
+{name} is incredibly interesting and useful to all beings in universe.
+
+It's pretty good stuff for a testing package that doesn't even exist.
+
+%prep
+%setup -q
+
+%build
+%{{__python}} setup.py build
+
+%install
+%{{__python}} setup.py install -O1 --skip-build --root %{{buildroot}}
+
+%files
+%doc README.rst
+%{{_bindir}}/{name}
+
+%changelog
+* Mon Apr 23 2017 Jakub Ruzicka <jruzicka@redhat.com> {version}-{release}
+- Update to upstream {version}
+- Introduce new bugs (rhbz#123456)
+
+* Tue Mar 23 2016 Jakub Ruzicka <jruzicka@redhat.com> 1.2.2-1
+- Update to upstream 1.2.2
+
+* Tue Jun 23 2015 Jakub Ruzicka <jruzicka@redhat.com> 1.1.1-1
+- Update to upstream 1.1.1
+- Lorem Ipsum
+- Dolor sit Amet
+"""  # noqa
+
+
+# silent run() by default
+def run(*args, **kwargs):
+    kwargs['log_cmd'] = False
+    return rdopkg.utils.cmd.run(*args, **kwargs)
+
+
+class SilentGit(rdopkg.utils.cmd.Git):
+    def __call__(self, *args, **kwargs):
+        if kwargs.get('log_cmd', None) is None:
+            kwargs['log_cmd'] = False
+        return super(SilentGit, self).__call__(*args, **kwargs)
+
+
+# silent git() by default
+git = SilentGit()
+
+
+def do_patch(fn, content, msg):
+    f = open(fn, 'a')
+    f.write(content)
+    f.close()
+    git('add', fn)
+    git('commit', '-m', msg)
+
+
+def add_n_patches(n, patch_name='Test Patch %d',
+                  branch='master-patches'):
+    if branch:
+        old_branch = rdopkg.utils.cmd.git.current_branch()
+        git('checkout', branch)
+    for i in range(1, n + 1):
+        pn = patch_name % i
+        do_patch(pn, pn + '\n', pn)
+    if branch:
+        git('checkout', old_branch)
+
+
+def create_sample_distgit(name, version='1.2.3', release='1', path=None):
+    if not path:
+        path = name
+    assert not os.path.exists(path)
+    os.makedirs(path)
+    with helpers.cdir(path):
+        txt = SAMPLE_SPEC.format(name=name, version=version, release=release)
+        spec = specfile.Spec(fn='%s.spec' % name, txt=txt)
+        spec.set_tag('Name', name)
+        spec.save()
+        git('init',)
+        git('add', '.')
+        git('commit', '-m', 'Initial import', isolated=True)
+    return os.path.abspath(path)
+
+
+def create_sample_patches_branch(n):
+    version = specfile.Spec().get_tag('Version')
+    branch = rdopkg.utils.cmd.git.current_branch()
+    git('tag', version, fatal=False, log_fail=False)
+    git('branch', '%s-patches' % branch)
+    add_n_patches(n, patch_name="Original Patch %d")
+
+
+def create_sample_upstream_new_version(
+        new_version, n_patches, n_from_patches_branch):
+    branch = rdopkg.utils.cmd.git.current_branch()
+    old_version = specfile.Spec().get_tag('Version')
+    git('checkout', '-b', 'upstream', old_version)
+    add_n_patches(n_patches,
+                  patch_name='Upstream Commit %d',
+                  branch=None)
+    for i in range(n_from_patches_branch):
+        # emulate upstream patches that were backported
+        git('cherry-pick', 'master-patches' + i * '~')
+    git('tag', new_version)
+    git('checkout', branch)

run_tests.sh

@@ -3,8 +3,9 @@ set -exuo pipefail
 
 # avoid possible pytest errors due to precompiled files
 export PYTHONDONTWRITEBYTECODE=1
-find . | grep -E "(__pycache__|\.pyc|\.pyo$)" | xargs rm -rf || true
+find . | grep -E "(__pycache__|\.pyc|\.pyo)$" | xargs rm -rf || true
 
 PYTHONPATH=. py.test $@
+PYTHONPATH=. behave --format=progress
 python -m pycodestyle
 ./tests/test_findpkg_integration.sh

test-requirements.txt

@@ -1,3 +1,3 @@
-pep8
-pytest
+behave
 pycodestyle
+pytest