Merge ~nacc/git-ubuntu:importer-test-messages into git-ubuntu:master

[Nish Aravamudan]

Make jenkins happy

[Andreas Hasenack (ahasenack)]

+1

review: Approve

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:79f54b6cd37029f646de8621d56acad5db869198
https://jenkins.ubuntu.com/server/job/git-ubuntu-ci/392/
Executed test runs:
    SUCCESS: VM Setup
    SUCCESS: Build
    SUCCESS: Unit Tests
    SUCCESS: Integration Tests
    IN_PROGRESS: Declarative: Post Actions

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/git-ubuntu-ci/392/rebuild

review: Approve (continuous-integration)

diff --git a/gitubuntu/importer.py b/gitubuntu/importer.py
index 42ab520..78fc3dc 100644
--- a/gitubuntu/importer.py
+++ b/gitubuntu/importer.py
@@ -467,6 +467,52 @@ def get_changelog_for_commit(
         changelog_entry_found = True
     return changelog_entry
 
+def get_import_commit_msg(
+    repo,
+    spi,
+    namespace,
+    tree_hash,
+    changelog_parent_commit,
+    upload_parent_commit,
+    unapplied_parent_commit,
+):
+    if unapplied_parent_commit:
+        import_type = 'patches-applied'
+        target_head_name = spi.applied_head_name(namespace)
+    else:
+        import_type = 'patches-unapplied'
+        target_head_name = spi.head_name(namespace)
+
+    # Do not show importer/ namespace to user
+    _, _, pretty_head_name = target_head_name.partition('%s/' % namespace)
+    changelog_entry = get_changelog_for_commit(
+        repo,
+        tree_hash,
+        changelog_parent_commit
+    )
+
+    msg = (
+        b'Import %s version %b to %b\n\nImported using git-ubuntu import.' % (
+            import_type.encode(),
+            spi.version.encode(),
+            pretty_head_name.encode(),
+        )
+    )
+
+    if any([changelog_parent_commit, upload_parent_commit, unapplied_parent_commit]):
+        msg += b'\n'
+
+    if changelog_parent_commit is not None:
+        msg += b'\nChangelog parent: %b' % changelog_parent_commit.encode()
+    if upload_parent_commit is not None:
+        msg += b'\nUpload parent: %b' % upload_parent_commit.encode()
+    if unapplied_parent_commit is not None:
+        msg += b'\nUnapplied parent: %b' % unapplied_parent_commit.encode()
+
+    msg += b'%b' % changelog_entry
+
+    return msg
+
 def _commit_import(
     repo,
     spi,
@@ -514,9 +560,6 @@ def _commit_import(
         tree_hash,
         changelog_parent_commit
     )
-    msg = (b'Import %s version %b to %b\n\nImported using git-ubuntu import.' %
-           (import_type.encode(), spi.version.encode(), pretty_head_name.encode())
-          )
 
     parents = []
 
@@ -526,26 +569,27 @@ def _commit_import(
         target_head_name in repo.local_branch_names:
         # No parents and not creating a new branch
         tag = orphan_tag(spi.version, namespace)
-    else:
-        msg += b'\n'
 
     if changelog_parent_commit is not None:
         parents.append(changelog_parent_commit)
-        msg += b'\nChangelog parent: %b' % changelog_parent_commit.encode()
     if upload_parent_commit is not None:
         parents.append(upload_parent_commit)
-        msg += b'\nUpload parent: %b' % upload_parent_commit.encode()
     if unapplied_parent_commit is not None:
         parents.append(unapplied_parent_commit)
-        msg += b'\nUnapplied parent: %b' % unapplied_parent_commit.encode()
-
-    msg += b'%b' % changelog_entry
 
     commit_hash = repo.commit_tree_hash(
         tree_hash,
         parents,
-        msg,
-        environment_spi=spi
+        get_import_commit_msg(
+            repo=repo,
+            spi=spi,
+            namespace=namespace,
+            tree_hash=tree_hash,
+            changelog_parent_commit=changelog_parent_commit,
+            upload_parent_commit=upload_parent_commit,
+            unapplied_parent_commit=unapplied_parent_commit,
+        ),
+        environment_spi=spi,
     )
 
     repo.update_head_to_commit(target_head_name, commit_hash)
@@ -1080,6 +1124,10 @@ def update_devel_branches(
                 repo.update_head_to_commit(ref, commit)
 
 
+def get_import_tag_msg():
+    return 'git-ubuntu import v%s' % VERSION
+
+
 # imports a package based upon source package information
 def import_unapplied_spi(
     repo,
@@ -1172,7 +1220,6 @@ def import_unapplied_spi(
 
     unapplied_changelog_parent_commit = None
     upload_parent_commit = None
-    unapplied_parent_commit = None
 
     if spi.version in parent_overrides:
         logging.debug(
diff --git a/gitubuntu/test_importer.py b/gitubuntu/test_importer.py
index 5ce59da..7fd5f45 100644
--- a/gitubuntu/test_importer.py
+++ b/gitubuntu/test_importer.py
@@ -1,9 +1,19 @@
-from unittest.mock import sentinel
+from unittest.mock import (
+    Mock,
+    patch,
+    sentinel,
+)
 
 import pytest
 
+
+import gitubuntu.repo_builder as repo_builder
+import gitubuntu.source_builder as source_builder
+
 import gitubuntu.importer as target
 
+from gitubuntu.test_git_repository import pygit2, repo
+
 
 @pytest.mark.parametrize('head_versions,expected', [
     (
@@ -47,3 +57,94 @@ def test_devel_branch_updates(head_versions, expected):
         ['yakkety', 'xenial', 'trusty'],
     )
     assert set(result) == set(expected.items())
+
+
+@patch('gitubuntu.importer.VERSION', '1.0')
+def test_get_import_tag_msg():
+    assert target.get_import_tag_msg() == 'git-ubuntu import v1.0'
+
+
[e-mail](
+    'head_name_value, changelog_parent_commit, upload_parent_commit, unapplied_parent_commit, expected',
+    [
+        (
+            'importer/ubuntu/trusty',
+            None,
+            None,
+            None,
+            b'Import patches-unapplied version 1-1 to ubuntu/trusty\n\nImported using git-ubuntu import.',
+        ),
+        (
+            'importer/ubuntu/trusty',
+            '123456',
+            None,
+            None,
+            b'Import patches-unapplied version 1-1 to ubuntu/trusty\n\nImported using git-ubuntu import.\n\nChangelog parent: 123456',
+        ),
+        (
+            'importer/ubuntu/trusty',
+            None,
+            '123456',
+            None,
+            b'Import patches-unapplied version 1-1 to ubuntu/trusty\n\nImported using git-ubuntu import.\n\nUpload parent: 123456',
+        ),
+        (
+            'importer/ubuntu/trusty',
+            None,
+            None,
+            '123456',
+            b'Import patches-applied version 1-1 to ubuntu/trusty\n\nImported using git-ubuntu import.\n\nUnapplied parent: 123456',
+        ),
+        (
+            'importer/ubuntu/trusty',
+            '123456',
+            '789123',
+            '456789',
+            b'Import patches-applied version 1-1 to ubuntu/trusty\n\nImported using git-ubuntu import.\n\nChangelog parent: 123456\nUpload parent: 789123\nUnapplied parent: 456789'
+        ),
+    ],
+)
+def test_get_import_commit_msg(
+    repo,
+    head_name_value,
+    changelog_parent_commit,
+    upload_parent_commit,
+    unapplied_parent_commit,
+    expected,
+):
+    target.get_changelog_for_commit = Mock()
+    target.get_changelog_for_commit.return_value = b''
+
+    publish_spec = source_builder.SourceSpec(
+        version='1-1',
+        native=False,
+    )
+    publish_source = source_builder.Source(publish_spec)
+
+    publish_oid = repo_builder.SourceTree(publish_source).write(repo.raw_repo)
+    publish_tree_hash = str(
+        repo.raw_repo.get(publish_oid).peel(pygit2.Tree).id
+    )
+
+    with publish_source as dsc_path:
+        spi = Mock()
+        spi.dsc_pathname = dsc_path
+        spi.distribution.name = 'Ubuntu'
+        spi.version = publish_spec.version
+        # avoid automatic parenting for head_name to make the assertion later
+        # easier
+        head_name = Mock(name='head_name')
+        head_name.return_value = head_name_value
+        spi.head_name = head_name
+        spi.applied_head_name = head_name
+        spi.date_published = '1970-01-01T00:00:00Z'
+
+        assert target.get_import_commit_msg(
+            repo,
+            spi,
+            'importer',
+            publish_tree_hash,
+            changelog_parent_commit,
+            upload_parent_commit,
+            unapplied_parent_commit,
+        ) == expected