Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SCM commit message #4877

Merged
merged 6 commits into from
Apr 29, 2019
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions conans/client/tools/scm.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,14 @@ def get_commit(self):

get_revision = get_commit

def get_commit_message(self):
self.check_repo()
try:
message = self.run("log -1 --format=%s%n%b")
return message.strip()
jgsogo marked this conversation as resolved.
Show resolved Hide resolved
except Exception:
return None

def is_pristine(self):
self.check_repo()
status = self.run("status --porcelain").strip()
Expand Down Expand Up @@ -353,6 +361,10 @@ def is_pristine(self):
def get_revision(self):
return self._show_item('revision')

def get_revision_message(self):
output = self.run("log -r COMMITTED").splitlines()
return output[3] if len(output) > 2 else None

def get_repo_root(self):
return self._show_item('wc-root')

Expand Down
36 changes: 36 additions & 0 deletions conans/test/unittests/util/tools_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -1595,6 +1595,21 @@ def build(self):
client.run("create . user/channel", assert_error=True)
self.assertIn("specify a branch to checkout", client.out)

def git_commit_message_test(self):
client = TestClient()
git_repo = temp_folder()
client.runner("git init .", cwd=git_repo)
client.runner('git config user.email "you@example.com"', cwd=git_repo)
client.runner('git config user.name "Your Name"', cwd=git_repo)
client.runner("git checkout -b dev", cwd=git_repo)
git = Git(git_repo)
self.assertIsNone(git.get_commit_message())
save(os.path.join(git_repo, "test"), "contents")
client.runner("git add test", cwd=git_repo)
client.runner('git commit -m "first commit"', cwd=git_repo)
self.assertEqual("dev", git.get_branch())
self.assertEqual("first commit", git.get_commit_message())


class GitToolsTests(unittest.TestCase):

Expand Down Expand Up @@ -1678,6 +1693,21 @@ def test_revision_number(self):
rev2 = int(svn.get_revision())
self.assertEqual(rev2, rev + 1)

def svn_revision_message_test(self):
tmp_folder = self.gimme_tmp()
svn = SVN(folder=tmp_folder)
svn.checkout(url=self.repo_url)
self.assertIsNone(svn.get_revision_message())

new_file = os.path.join(tmp_folder, "new_file")
with open(new_file, "w") as f:
f.write("content")

svn.run('add new_file')
svn.run('commit -m "add to file"')
svn.run('update')
self.assertEqual("add to file", svn.get_revision_message())

def test_repo_url(self):
svn = SVN(folder=self.gimme_tmp())
svn.checkout(url=self.repo_url)
Expand Down Expand Up @@ -2076,6 +2106,7 @@ def setUp(self):
self.svn.run('commit -m "add external"')
self.svn.update()
self.assertTrue(self.svn.is_pristine())
self.assertEqual("add external", self.svn.get_revision_message())

self.svn_subrepo = SVN(folder=os.path.join(self.svn.folder, 'subrepo'))
self.assertTrue(self.svn_subrepo.is_pristine())
Expand All @@ -2092,10 +2123,14 @@ def test_commit_external(self):
self.svn_subrepo.run('commit -m "up external"')
self.assertFalse(self.svn_subrepo.is_pristine())
self.assertFalse(self.svn.is_pristine())
self.assertEqual("add external", self.svn.get_revision_message())

self.svn_subrepo.update()
self.assertTrue(self.svn_subrepo.is_pristine())
self.assertFalse(self.svn.is_pristine())
self.assertEqual("add external", self.svn.get_revision_message())
output = self.svn_subrepo.get_revision_message()
self.assertEqual("up external", output)

def test_untracked_external(self):
with open(os.path.join(self.svn.folder, "subrepo", "other_file"), "w") as f:
Expand Down Expand Up @@ -2124,6 +2159,7 @@ def test_ignored_external(self):
self.svn.run('commit -m "change property"')
self.svn.update()
self.assertTrue(self.svn.is_pristine())
self.assertEqual("change property", self.svn.get_revision_message())


@attr("slow")
Expand Down