AS1024
/
Kanboard-Prod
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve automatic action to create comments based on commit messages

This commit is contained in:
Frederic Guillot 2015-06-20 20:55:50 -04:00
parent 7b947ebdbd
commit 98fd34bfe3
9 changed files with 139 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
app/Action/ActionCommentCreationTest.php
View File

@ -11,6 +11,59 @@ use Integration\GithubWebhook;
class ActionCommentCreationTest extends Base
{
public function testWithoutRequiredParams()
{
$action = new Action\CommentCreation($this->container, 1, GithubWebhook::EVENT_ISSUE_COMMENT);
// We create a task in the first column
$tc = new TaskCreation($this->container);
$p = new Project($this->container);
$c = new Comment($this->container);
$this->assertEquals(1, $p->create(array('name' => 'test')));
$this->assertEquals(1, $tc->create(array('title' => 'test', 'project_id' => 1, 'column_id' => 1)));
// We create an event to move the task to the 2nd column
$event = array(
'project_id' => 1,
'task_id' => 1,
'user_id' => 1,
);
// Our event should be executed
$this->assertTrue($action->execute(new GenericEvent($event)));
$comment = $c->getById(1);
$this->assertEmpty($comment);
}
public function testWithCommitMessage()
{
$action = new Action\CommentCreation($this->container, 1, GithubWebhook::EVENT_ISSUE_COMMENT);
// We create a task in the first column
$tc = new TaskCreation($this->container);
$p = new Project($this->container);
$c = new Comment($this->container);
$this->assertEquals(1, $p->create(array('name' => 'test')));
$this->assertEquals(1, $tc->create(array('title' => 'test', 'project_id' => 1, 'column_id' => 1)));
// We create an event to move the task to the 2nd column
$event = array(
'project_id' => 1,
'task_id' => 1,
'commit_comment' => 'plop',
);
// Our event should be executed
$this->assertTrue($action->execute(new GenericEvent($event)));
$comment = $c->getById(1);
$this->assertNotEmpty($comment);
$this->assertEquals(1, $comment['task_id']);
$this->assertEquals(0, $comment['user_id']);
$this->assertEquals('plop', $comment['comment']);
}
public function testWithUser()
{
$action = new Action\CommentCreation($this->container, 1, GithubWebhook::EVENT_ISSUE_COMMENT);

13
app/Action/CommentCreation.php
View File

@ -2,7 +2,9 @@
namespace Action;
use Integration\BitbucketWebhook;
use Integration\GithubWebhook;
use Integration\GitlabWebhook;
/**
* Create automatically a comment from a webhook
@ -22,6 +24,9 @@ class CommentCreation extends Base
{
return array(
GithubWebhook::EVENT_ISSUE_COMMENT,
GithubWebhook::EVENT_COMMIT,
BitbucketWebhook::EVENT_COMMIT,
GitlabWebhook::EVENT_COMMIT,
);
}
@ -45,8 +50,6 @@ class CommentCreation extends Base
public function getEventRequiredParameters()
{
return array(
'comment',
'user_id',
'task_id',
);
}
@ -62,9 +65,9 @@ class CommentCreation extends Base
{
return (bool) $this->comment->create(array(
'reference' => isset($data['reference']) ? $data['reference'] : '',
'comment' => $data['comment'],
'comment' => empty($data['comment']) ? $data['commit_comment'] : $data['comment'],
'task_id' => $data['task_id'],
'user_id' => $data['user_id'],
'user_id' => empty($data['user_id']) ? 0 : $data['user_id'],
));
}
@ -77,6 +80,6 @@ class CommentCreation extends Base
*/
public function hasRequiredCondition(array $data)
{
return true;
return ! empty($data['comment']) || ! empty($data['commit_comment']);
}
}

26
app/Integration/BitbucketWebhook.php
View File

@ -2,7 +2,7 @@
namespace Integration;
use Event\TaskEvent;
use Event\GenericEvent;
use Model\Task;
/**
@ -72,7 +72,7 @@ class BitbucketWebhook extends \Core\Base
{
$task_id = $this->task->getTaskIdFromText($commit['message']);
if (! $task_id) {
if (empty($task_id)) {
return false;
}
@ -82,16 +82,20 @@ class BitbucketWebhook extends \Core\Base
return false;
}
if ($task['is_active'] == Task::STATUS_OPEN && $task['project_id'] == $this->project_id) {
$this->container['dispatcher']->dispatch(
self::EVENT_COMMIT,
new TaskEvent(array('task_id' => $task_id) + $task)
);
return true;
if ($task['project_id'] != $this->project_id) {
return false;
}
return false;
$this->container['dispatcher']->dispatch(
self::EVENT_COMMIT,
new GenericEvent(array(
'task_id' => $task_id,
'commit_message' => $commit['message'],
'commit_url' => '',
'commit_comment' => $commit['message']."\n\n".t('Commit made by @%s on Bitbucket', $commit['author'])
) + $task)
);
return true;
}
}

17
app/Integration/GithubWebhook.php
View File

@ -90,12 +90,19 @@ class GithubWebhook extends \Core\Base
continue;
}
if ($task['project_id'] == $this->project_id) {
$this->container['dispatcher']->dispatch(
self::EVENT_COMMIT,
new GenericEvent(array('task_id' => $task_id) + $task)
);
if ($task['project_id'] != $this->project_id) {
continue;
}
$this->container['dispatcher']->dispatch(
self::EVENT_COMMIT,
new GenericEvent(array(
'task_id' => $task_id,
'commit_message' => $commit['message'],
'commit_url' => $commit['url'],
'commit_comment' => $commit['message']."\n\n[".t('Commit made by @%s on Github', $commit['author']['username']).']('.$commit['url'].')'
) + $task)
);
}
return true;

25
app/Integration/GitlabWebhook.php
View File

@ -3,7 +3,6 @@
namespace Integration;
use Event\GenericEvent;
use Event\TaskEvent;
use Model\Task;
/**
@ -116,7 +115,7 @@ class GitlabWebhook extends \Core\Base
{
$task_id = $this->task->getTaskIdFromText($commit['message']);
if (! $task_id) {
if (empty($task_id)) {
return false;
}
@ -126,17 +125,21 @@ class GitlabWebhook extends \Core\Base
return false;
}
if ($task['is_active'] == Task::STATUS_OPEN && $task['project_id'] == $this->project_id) {
$this->container['dispatcher']->dispatch(
self::EVENT_COMMIT,
new TaskEvent(array('task_id' => $task_id) + $task)
);
return true;
if ($task['project_id'] != $this->project_id) {
return false;
}
return false;
$this->container['dispatcher']->dispatch(
self::EVENT_COMMIT,
new GenericEvent(array(
'task_id' => $task_id,
'commit_message' => $commit['message'],
'commit_url' => $commit['url'],
'commit_comment' => $commit['message']."\n\n[".t('Commit made by @%s on Gitlab', $commit['author']['name']).']('.$commit['url'].')'
) + $task)
);
return true;
}
/**

5
app/Template/board/comments.php
View File

@ -1,7 +1,10 @@
<section>
<?php foreach ($comments as $comment): ?>
<p class="comment-title">
<span class="comment-username"><?= $this->e($comment['name'] ?: $comment['username']) ?></span> @ <span class="comment-date"><?= dt('%b %e, %Y, %k:%M %p', $comment['date']) ?></span>
<?php if (! empty($comment['username'])): ?>
<span class="comment-username"><?= $this->e($comment['name'] ?: $comment['username']) ?></span> @
<?php endif ?>
<span class="comment-date"><?= dt('%b %e, %Y, %k:%M %p', $comment['date_creation']) ?></span>
</p>
<div class="comment-inner">

19
tests/units/BitbucketWebhookTest.php
View File

@ -21,7 +21,7 @@ class BitbucketWebhookTest extends Base
$this->assertEquals(1, $p->create(array('name' => 'test')));
$g->setProjectId(1);
$this->container['dispatcher']->addListener(BitbucketWebhook::EVENT_COMMIT, function() {});
$this->container['dispatcher']->addListener(BitbucketWebhook::EVENT_COMMIT, array($this, 'onCommit'));
$event = json_decode($this->post_payload, true);
@ -29,15 +29,15 @@ class BitbucketWebhookTest extends Base
$this->assertFalse($g->handleCommit($event['commits'][0]));
// Create task with the wrong id
$this->assertEquals(1, $tc->create(array('title' => 'test', 'project_id' => 1)));
$this->assertEquals(1, $tc->create(array('title' => 'test1', 'project_id' => 1)));
$this->assertFalse($g->handleCommit($event['commits'][1]));
// Create task with the right id
$this->assertEquals(2, $tc->create(array('title' => 'test', 'project_id' => 1)));
$this->assertEquals(2, $tc->create(array('title' => 'test2', 'project_id' => 1)));
$this->assertTrue($g->handleCommit($event['commits'][1]));
$called = $this->container['dispatcher']->getCalledListeners();
$this->assertArrayHasKey(BitbucketWebhook::EVENT_COMMIT.'.closure', $called);
$this->assertArrayHasKey(BitbucketWebhook::EVENT_COMMIT.'.BitbucketWebhookTest::onCommit', $called);
}
public function testParsePayload()
@ -62,4 +62,15 @@ class BitbucketWebhookTest extends Base
$called = $this->container['dispatcher']->getCalledListeners();
$this->assertArrayHasKey(BitbucketWebhook::EVENT_COMMIT.'.closure', $called);
}
public function onCommit($event)
{
$data = $event->getAll();
$this->assertEquals(1, $data['project_id']);
$this->assertEquals(2, $data['task_id']);
$this->assertEquals('test2', $data['title']);
$this->assertEquals("Fix #2\n\n\nCommit made by @Frederic Guillot on Bitbucket", $data['commit_comment']);
$this->assertEquals("Fix #2\n", $data['commit_message']);
$this->assertEquals('', $data['commit_url']);
}
}

3
tests/units/GithubWebhookTest.php
View File

@ -451,5 +451,8 @@ class GithubWebhookTest extends Base
$this->assertEquals(1, $data['project_id']);
$this->assertEquals(1, $data['task_id']);
$this->assertEquals('boo', $data['title']);
$this->assertEquals("Update README to fix #1\n\n[Commit made by @fguillot on Github](https://github.com/kanboardapp/webhook/commit/98dee3e49ee7aa66ffec1f761af93da5ffd711f6)", $data['commit_comment']);
$this->assertEquals('Update README to fix #1', $data['commit_message']);
$this->assertEquals('https://github.com/kanboardapp/webhook/commit/98dee3e49ee7aa66ffec1f761af93da5ffd711f6', $data['commit_url']);
}
}

19
tests/units/GitlabWebhookTest.php
View File

@ -33,7 +33,7 @@ class GitlabWebhookTest extends Base
$this->assertEquals(1, $p->create(array('name' => 'test')));
$g->setProjectId(1);
$this->container['dispatcher']->addListener(GitlabWebhook::EVENT_COMMIT, function() {});
$this->container['dispatcher']->addListener(GitlabWebhook::EVENT_COMMIT, array($this, 'onCommit'));
$event = json_decode($this->push_payload, true);
@ -41,15 +41,15 @@ class GitlabWebhookTest extends Base
$this->assertFalse($g->handleCommit($event['commits'][0]));
// Create task with the wrong id
$this->assertEquals(1, $tc->create(array('title' => 'test', 'project_id' => 1)));
$this->assertEquals(1, $tc->create(array('title' => 'test1', 'project_id' => 1)));
$this->assertFalse($g->handleCommit($event['commits'][0]));
// Create task with the right id
$this->assertEquals(2, $tc->create(array('title' => 'test', 'project_id' => 1)));
$this->assertEquals(2, $tc->create(array('title' => 'test2', 'project_id' => 1)));
$this->assertTrue($g->handleCommit($event['commits'][0]));
$called = $this->container['dispatcher']->getCalledListeners();
$this->assertArrayHasKey(GitlabWebhook::EVENT_COMMIT.'.closure', $called);
$this->assertArrayHasKey(GitlabWebhook::EVENT_COMMIT.'.GitlabWebhookTest::onCommit', $called);
}
public function testHandleIssueOpened()
@ -116,4 +116,15 @@ class GitlabWebhookTest extends Base
$this->assertEquals(1, $data['task_id']);
$this->assertEquals(103361, $data['reference']);
}
public function onCommit($event)
{
$data = $event->getAll();
$this->assertEquals(1, $data['project_id']);
$this->assertEquals(2, $data['task_id']);
$this->assertEquals('test2', $data['title']);
$this->assertEquals("Fix bug #2\n\n\n[Commit made by @Frédéric Guillot on Gitlab](https://gitlab.com/minicoders/kanboard/commit/b3caaee62ad27dc31497946065ac18299784aee4)", $data['commit_comment']);
$this->assertEquals("Fix bug #2\n", $data['commit_message']);
$this->assertEquals('https://gitlab.com/minicoders/kanboard/commit/b3caaee62ad27dc31497946065ac18299784aee4', $data['commit_url']);
}
}