message formatter

Author: kszucs

.github/workflows/comment_bot.yml

@@ -44,10 +44,12 @@ jobs:
       - run: |
           pip install -e arrow/dev/archery
       - name: Handle GH event
+        env:
+          ARROW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CROSSBOW_GITHUB_TOKEN: ${{ secrets.CROSSBOW_GITHUB_TOKEN }}
         run: |
           archery trigger-bot \
             --event-name ${{ github.event_name }} \
-            --event-payload ${{ github.event_path }} \
-            --arrow-token ${{ secrets.GITHUB_TOKEN }}
+            --event-payload ${{ github.event_path }}
 
 

dev/archery/archery/bot.py

@@ -130,7 +130,10 @@ def __init__(self, crossbow_repo):
 
     def render(self, job):
         url = 'https://github.com/{repo}/branches/all?query={branch}'
-        msg = f'Submitted crossbow builds: [{{repo}} @ {{branch}}]({url})\n'
+        sha = job['target']['head']
+
+        msg = f'Revision: {sha}\n\n'
+        msg += f'Submitted crossbow builds: [{{repo}} @ {{branch}}]({url})\n'
         msg += '\n|Task|Status|\n|----|------|'
 
         tasks = sorted(job['tasks'].items(), key=operator.itemgetter(0))
@@ -233,15 +236,12 @@ def ursabot(ctx):
 
 
 @ursabot.group()
-@click.option('--arrow', '-a', default='apache/arrow',
-              help='Arrow repository on github to use')
 @click.option('--crossbow', '-c', default='ursa-labs/crossbow',
               help='Crossbow repository on github to use')
 @click.pass_obj
-def crossbow(obj, arrow, crossbow):
+def crossbow(obj, crossbow):
     """Trigger crossbow builds for this pull request"""
-    # obj['arrow_repo'] = 'https://github.com/{}'.format(arrow)
-    obj['crossbow_repo'] = 'https://github.com/{}'.format(crossbow)
+    obj['crossbow_repo'] = crossbow
 
 
 @crossbow.command()
@@ -256,19 +256,19 @@ def submit(obj, task, group, dry_run):
 
     See groups defined in arrow/dev/tasks/tests.yml
     """
-    args = ['--output-file', 'result.yaml']
+    args = []
     for g in group:
         args.extend(['-g', g])
     for t in task:
         args.append(t)
 
     # clone crossbow
     git = Git()
-    git.clone(obj['crossbow_repo'], 'crossbow')
+    git.clone('https://github.com/{}'.format(obj['crossbow_repo']), 'crossbow')
 
     # submit the crossbow tasks
     xbow = Crossbow('arrow/dev/tasks/crossbow.py')
-    xbow.run('submit', *args)
+    xbow.run('--output-file', 'result.yaml', 'submit', *args)
 
     # parse the result yml describing the submitted job
     yaml = YAML()
@@ -280,6 +280,4 @@ def submit(obj, task, group, dry_run):
     response = formatter.render(job)
 
     # send the response
-    obj['pull'].create_issue_comment(response)
-
-
+    obj['pull'].create_issue_comment(response)

dev/archery/archery/tests/fixtures/crossbow-success-message.md

@@ -1,5 +1,3 @@
-[Builder1 (#{build_id})]({build_url}) builder {status}
-
 Revision: {revision}
 
 Submitted crossbow builds: [{repo} @ {branch}](https://github.com/{repo}/branches/all?query={branch})

dev/archery/archery/tests/test_bot.py

@@ -3,11 +3,15 @@
 from unittest.mock import Mock
 
 import pytest
+import textwrap
 import responses as rsps
 import click
 from click.testing import CliRunner
+from ruamel.yaml import YAML
 
-from archery.bot import CommentBot, CommandError, group
+from archery.bot import (
+    CommentBot, CommandError, CrossbowCommentFormatter, group
+)
 
 
 @pytest.fixture
@@ -17,9 +21,15 @@ def responses():
 
 
 def load_fixture(name):
-    path = Path(__file__).parent / 'fixtures' / '{}.json'.format(name)
+    path = Path(__file__).parent / 'fixtures' / name
     with path.open('r') as fp:
-        return json.load(fp)
+        if name.endswith('.json'):
+            return json.load(fp)
+        elif name.endswith('.yaml'):
+            yaml = YAML()
+            return yaml.load(fp)
+        else:
+            return fp.read()
 
 
 def github_url(path):
@@ -60,13 +70,28 @@ def test_click_based_commands():
     assert custom_handler('extra', extra='data') == {'extra': 'data'}
 
 
+def test_crossbow_comment_formatter():
+    job = load_fixture('crossbow-job.yaml')
+    msg = load_fixture('crossbow-success-message.md')
+
+    formatter = CrossbowCommentFormatter(crossbow_repo='ursa-labs/crossbow')
+    response = formatter.render(job)
+    expected = msg.format(
+        repo='ursa-labs/crossbow',
+        branch='ursabot-1',
+        revision='f766a1d615dd1b7ee706d05102e579195951a61c',
+        status='has been succeeded.'
+    )
+    assert response == textwrap.dedent(expected).strip()
+
+
 @pytest.mark.parametrize('fixture_name', [
     # the bot is not mentiond, nothing to do
-    'event-issue-comment-not-mentioning-ursabot',
+    'event-issue-comment-not-mentioning-ursabot.json',
     # don't respond to itself, it prevents recursive comment storms!
-    'event-issue-comment-by-ursabot',
+    'event-issue-comment-by-ursabot.json',
     # non-authorized user sent the comment, do not respond
-    'event-issue-comment-by-non-authorized-user',
+    'event-issue-comment-by-non-authorized-user.json',
 ])
 def test_noop_events(fixture_name):
     payload = load_fixture(fixture_name)
@@ -82,7 +107,7 @@ def test_issue_comment_without_pull_request(responses):
     responses.add(
         responses.GET,
         github_url('/repositories/169101701/issues/19'),
-        json=load_fixture('issue-19'),
+        json=load_fixture('issue-19.json'),
         status=200
     )
     responses.add(
@@ -100,7 +125,7 @@ def test_issue_comment_without_pull_request(responses):
     def handler(command, **kwargs):
         pass
 
-    payload = load_fixture('event-issue-comment-without-pull-request')
+    payload = load_fixture('event-issue-comment-without-pull-request.json')
     bot = CommentBot(name='ursabot', token='', handler=handler)
     bot.handle('issue_comment', payload)
 
@@ -114,19 +139,19 @@ def test_respond_with_usage(responses):
     responses.add(
         responses.GET,
         github_url('/repositories/169101701/issues/26'),
-        json=load_fixture('issue-26'),
+        json=load_fixture('issue-26.json'),
         status=200
     )
     responses.add(
         responses.GET,
         github_url('/repos/ursa-labs/ursabot/pulls/26'),
-        json=load_fixture('pull-request-26'),
+        json=load_fixture('pull-request-26.json'),
         status=200
     )
     responses.add(
         responses.GET,
         github_url('/repos/ursa-labs/ursabot/issues/comments/480243811'),
-        json=load_fixture('issue-comment-480243811')
+        json=load_fixture('issue-comment-480243811.json')
     )
     responses.add(
         responses.POST,
@@ -137,7 +162,7 @@ def test_respond_with_usage(responses):
     def handler(command, **kwargs):
         raise CommandError('test-usage')
 
-    payload = load_fixture('event-issue-comment-with-empty-command')
+    payload = load_fixture('event-issue-comment-with-empty-command.json')
     bot = CommentBot(name='ursabot', token='', handler=handler)
     bot.handle('issue_comment', payload)
 
@@ -153,19 +178,19 @@ def test_issue_comment_with_commands(responses, command, reaction):
     responses.add(
         responses.GET,
         github_url('/repositories/169101701/issues/26'),
-        json=load_fixture('issue-26'),
+        json=load_fixture('issue-26.json'),
         status=200
     )
     responses.add(
         responses.GET,
         github_url('/repos/ursa-labs/ursabot/pulls/26'),
-        json=load_fixture('pull-request-26'),
+        json=load_fixture('pull-request-26.json'),
         status=200
     )
     responses.add(
         responses.GET,
         github_url('/repos/ursa-labs/ursabot/issues/comments/480248726'),
-        json=load_fixture('issue-comment-480248726')
+        json=load_fixture('issue-comment-480248726.json')
     )
     responses.add(
         responses.POST,
@@ -181,7 +206,7 @@ def handler(command, **kwargs):
         else:
             raise ValueError('Only `build` command is supported.')
 
-    payload = load_fixture('event-issue-comment-build-command')
+    payload = load_fixture('event-issue-comment-build-command.json')
     payload["comment"]["body"] = command
 
     bot = CommentBot(name='ursabot', token='', handler=handler)