Merge pull request #205 from nrccua-bradb/add_slack_message_prefix

Add message prefix support

Author: LaserPhaser

pytest_slack/plugin.py

@@ -44,6 +44,14 @@ def pytest_addoption(parser):
         help='Set the reporter name'
     )
 
+    group.addoption(
+        '--slack_message_prefix',
+        action='store',
+        dest='slack_message_prefix',
+        default=None,
+        help='Set a prefix to come before the test result counts.'
+    )
+
     group.addoption(
         '--slack_timeout',
         action='store',
@@ -106,6 +114,7 @@ def pytest_terminal_summary(terminalreporter, exitstatus, config):
     slack_hook = config.option.slack_hook
     channel = config.option.slack_channel
     ssl_verify = config.option.ssl_verify
+    message_prefix = config.option.slack_message_prefix
 
     slack_username = config.option.slack_username if config.option.slack_username else 'Regression testing results'
 
@@ -122,6 +131,8 @@ def pytest_terminal_summary(terminalreporter, exitstatus, config):
         passed, failed, skipped, error, xfailed, xpassed)
     if report_link:
         final_results = '<%s|%s>' % (report_link, final_results)
+    if message_prefix:
+        final_results = '%s: %s' % (message_prefix, final_results)
 
     results_pattern = {
         "color": color,

tests/test_plugin.py

@@ -107,6 +107,45 @@ def test_pass():
         assert emoji == slack_hook_icon_emoji
 
 
+@pytest.mark.parametrize('expected_prefix,report_link', [
+    ("Test Prefix", None),
+    ("Test Prefix", "http://report_link.com")
+])
+def test_pytest_slack_message_prefix(testdir, expected_prefix, report_link):
+    """Make sure that message prefix works."""
+
+    testdir.makepyfile(
+        """
+        import pytest
+        def test_pass():
+            assert 1 == 1
+        """
+    )
+
+    slack_hook_host = 'http://test.com/any_hash'
+    slack_hook_channel = 'test'
+    run_args = [
+        '--slack_channel', slack_hook_channel,
+        '--slack_hook', slack_hook_host,
+        '--slack_message_prefix', expected_prefix
+    ]
+    if report_link:
+        run_args.extend(['--slack_report_link', report_link])
+
+    expected_text = 'Passed=1 Failed=0 Skipped=0 Error=0 XFailed=0 XPassed=0'
+    if report_link:
+        expected_text = '<%s|%s>' % (report_link, expected_text)
+    expected_text = '%s: %s' % (expected_prefix, expected_text)
+
+    with mock.patch('requests.post') as mock_post:
+        testdir.runpytest(*run_args)
+
+        called_data = json.loads(mock_post.call_args[1]['data'])
+        text = called_data['attachments'][0]['text']
+
+        assert text == expected_text
+
+
 @pytest.mark.parametrize('test_input,expected_emoji', [
     ('1 == 1', ':sunny:'),
     ('2 == 1', ':rain_cloud:'),