jenkins-bot has submitted this change and it was merged.
Change subject: Add some more output to give the user better feedback
......................................................................
Add some more output to give the user better feedback
* Output version number of script being run
* Positive feedback if no errors are found
* Link to guidelines if errors are found
And update tests accordingly.
Change-Id: I692e5fce58f7ac16445e7dabb36a855a585690b6
---
M commit_message_validator/__init__.py
M commit_message_validator/tests/data/check_message_errors.out
M commit_message_validator/tests/data/check_message_ok.out
M commit_message_validator/tests/test_commit-message-validator.py
4 files changed, 16 insertions(+), 3 deletions(-)
Approvals:
Legoktm: Looks good to me, approved
jenkins-bot: Verified
diff --git a/commit_message_validator/__init__.py
b/commit_message_validator/__init__.py
index bc0ba0a..88b3e5f 100755
--- a/commit_message_validator/__init__.py
+++ b/commit_message_validator/__init__.py
@@ -159,10 +159,16 @@
errors.append(
"Line %d: Unexpected line after Change-Id" % last_lineno)
+ print('commit-message-validator v%s' % __version__)
if errors:
+ print('The following errors were found:')
for e in errors:
print(e)
+ print('Please review
<https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines>'
+ ' and update your commit message accordingly')
return 1
+ else:
+ print('Commit message is formatted properly! Keep up the good work!')
return 0
diff --git a/commit_message_validator/tests/data/check_message_errors.out
b/commit_message_validator/tests/data/check_message_errors.out
index a90a91c..2a8b345 100644
--- a/commit_message_validator/tests/data/check_message_errors.out
+++ b/commit_message_validator/tests/data/check_message_errors.out
@@ -1,3 +1,5 @@
+commit-message-validator v%version%
+The following errors were found:
Line 1: First line should be <=80 characters
Line 2: Second line should be empty
Line 3: Line should be <=100 characters
@@ -19,3 +21,4 @@
Line 14: The phabricator task ID must use uppercase T
Line 15: Extra Change-Id found, next at 16
Line 17: Unexpected line after Change-Id
+Please review
<https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines> and update
your commit message accordingly
diff --git a/commit_message_validator/tests/data/check_message_ok.out
b/commit_message_validator/tests/data/check_message_ok.out
index e69de29..76dfe33 100644
--- a/commit_message_validator/tests/data/check_message_ok.out
+++ b/commit_message_validator/tests/data/check_message_ok.out
@@ -0,0 +1,2 @@
+commit-message-validator v%version%
+Commit message is formatted properly! Keep up the good work!
diff --git a/commit_message_validator/tests/test_commit-message-validator.py
b/commit_message_validator/tests/test_commit-message-validator.py
index a9cd253..079f194 100644
--- a/commit_message_validator/tests/test_commit-message-validator.py
+++ b/commit_message_validator/tests/test_commit-message-validator.py
@@ -24,7 +24,7 @@
"""
def __new__(cls, name, bases, dct):
- def create_test_method(msg, expected):
+ def create_test_method(msg, expected, expected_exit_code):
def test(self):
saved_stdout = sys.stdout
try:
@@ -32,7 +32,7 @@
sys.stdout = out
exit_code = cmv.check_message(msg.splitlines())
self.assertEqual(expected, out.getvalue())
- self.assertEqual(exit_code, 1 if expected else 0)
+ self.assertEqual(exit_code, expected_exit_code)
finally:
sys.stdout = saved_stdout
return test
@@ -43,10 +43,12 @@
test, _, extension = fn.rpartition('.')
fn = os.path.join(base_path, test)
if extension == 'msg' and os.path.isfile(fn + '.out'):
+ exit_code = 0 if fn.endswith('ok') else 1
with open(fn + '.msg') as msg:
with open(fn + '.out') as out:
+ out_text = out.read().replace('%version%',
cmv.__version__)
dct['test_' + test] = create_test_method(
- msg.read(), out.read())
+ msg.read(), out_text, exit_code)
return super(MetaValidator, cls).__new__(cls, name, bases, dct)
--
To view, visit https://gerrit.wikimedia.org/r/303750
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I692e5fce58f7ac16445e7dabb36a855a585690b6
Gerrit-PatchSet: 1
Gerrit-Project: integration/commit-message-validator
Gerrit-Branch: master
Gerrit-Owner: Legoktm <legoktm.wikipe...@gmail.com>
Gerrit-Reviewer: Hashar <has...@free.fr>
Gerrit-Reviewer: Legoktm <legoktm.wikipe...@gmail.com>
Gerrit-Reviewer: Paladox <thomasmulhall...@yahoo.com>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
