Skip to content

Commit 9ff3199

Browse files
vimishorvimishor
committed
Merged in leadz/bitbucket-api/build_status_api (pull request #27)
Issue #38 : Adds support for the build status API
2 parents 36ae85a + 506d5b4 commit 9ff3199

File tree

3 files changed

+198
-0
lines changed

3 files changed

+198
-0
lines changed

‎docs/examples/repositories/commits/build-statuses.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: default
3+
permalink: /examples/repositories/commits/build-statuses.html
4+
title: Build Statuses
5+
---
6+
7+
# Build Statuses
8+
9+
Manages build statuses on a commit.
10+
11+
### Prepare:
12+
13+
```php
14+
$buildStatuses = new Bitbucket\API\Repositories\Commits\BuildStatuses();
15+
$buildStatuses->setCredentials( new Bitbucket\API\Authentication\Basic($user, $password) );
16+
```
17+
18+
### Get the build status for a commit: (API 2.0)
19+
20+
```php
21+
$buildStatuses->get($account, $repository, $revision, $key);
22+
```
23+
24+
### Adds a build status to a commit: (API 2.0)
25+
26+
```php
27+
$buildStatuses->create($account, $repository, $revision, array(
28+
'state' => 'FAILED',
29+
'key'=> 'JENKINS-PROJECT-X',
30+
'name'=> 'Build #1',
31+
'url'=> 'https://example.com/path/to/build/info',
32+
'description'=> 'Changes by John Doe'
33+
));
34+
```
35+
36+
### Updates the build status for a commit: (API 2.0)
37+
38+
```php
39+
$buildStatuses->update($account, $repository, $revision, $key, array(
40+
'state' => 'SUCCESSFUL',
41+
'name'=> 'Build #2',
42+
'url'=> 'https://example.com/path/to/build/info',
43+
'description'=> 'Changes by John Doe'
44+
));
45+
```
46+
47+
----
48+
49+
#### Related:
50+
* [Authentication]({{ site.url }}/examples/authentication.html)
51+
* [BB Wiki](https://confluence.atlassian.com/bitbucket/buildstatus-resource-779295267.html)

‎lib/Bitbucket/API/Repositories/Commits/BuildStatuses.php‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
<?php
2+
3+
/**
4+
* This file is part of the bitbucket-api package.
5+
*
6+
* (c) Alexandru G. <alex@gentle.ro>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Bitbucket\API\Repositories\Commits;
13+
14+
use Bitbucket\API\Api;
15+
use Buzz\Message\MessageInterface;
16+
17+
/**
18+
* @author Brice M. <brice.mancone@gmail.com>
19+
*/
20+
class BuildStatuses extends Api
21+
{
22+
/**
23+
* Returns the status for specific build associated with a commit.
24+
*
25+
* @access public
26+
* @param string $account The team or individual account owning the repository.
27+
* @param string $repository The repository identifier.
28+
* @param string $revision A SHA1 value for the commit.
29+
* @param string $key The key that distinguishes the build status from others.
30+
* @return MessageInterface
31+
*
32+
* @see https://confluence.atlassian.com/bitbucket/buildstatus-resource-779295267.html
33+
*/
34+
public function get($account, $repository, $revision, $key)
35+
{
36+
return $this->getClient()->setApiVersion('2.0')->get(
37+
sprintf('repositories/%s/%s/commit/%s/statuses/build/%s', $account, $repository, $revision, $key)
38+
);
39+
}
40+
41+
/**
42+
* Adds a build status to a commit.
43+
* If the build is already associated with the commit, a POST also updates the status.
44+
*
45+
* @access public
46+
* @param string $account The team or individual account owning the repository.
47+
* @param string $repository The repository identifier.
48+
* @param string $revision A SHA1 value for the commit.
49+
* @param array $params The status.
50+
* @return MessageInterface
51+
*
52+
* @see https://confluence.atlassian.com/bitbucket/buildstatus-resource-779295267.html
53+
*/
54+
public function create($account, $repository, $revision, $params)
55+
{
56+
return $this->getClient()->setApiVersion('2.0')->post(
57+
sprintf('repositories/%s/%s/commit/%s/statuses/build', $account, $repository, $revision),
58+
json_encode($params),
59+
array('Content-Type' => 'application/json')
60+
);
61+
}
62+
63+
/**
64+
* Updates the build status for a commit.
65+
*
66+
* @access public
67+
* @param string $account The team or individual account owning the repository.
68+
* @param string $repository The repository identifier.
69+
* @param string $revision A SHA1 value for the commit.
70+
* @param string $key The key that distinguishes the build status from others.
71+
* @param array $params The status.
72+
* @return MessageInterface
73+
*
74+
* @see https://confluence.atlassian.com/bitbucket/buildstatus-resource-779295267.html
75+
*/
76+
public function update($account, $repository, $revision, $key, $params)
77+
{
78+
return $this->getClient()->setApiVersion('2.0')->put(
79+
sprintf('repositories/%s/%s/commit/%s/statuses/build/%s', $account, $repository, $revision, $key),
80+
json_encode($params),
81+
array('Content-Type' => 'application/json')
82+
);
83+
}
84+
}

‎test/Bitbucket/Tests/API/Repositories/Commits/BuildStatusesTest.php‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<?php
2+
3+
namespace Bitbucket\Tests\API\Repositories\Commits\Statuses;
4+
5+
use Bitbucket\Tests\API as Tests;
6+
use Bitbucket\API;
7+
8+
class BuildStatusesTest extends Tests\TestCase
9+
{
10+
public function testGet()
11+
{
12+
$endpoint = 'repositories/gentle/eof/commit/SHA1/statuses/build/KEY';
13+
$expectedResult = $this->fakeResponse(array('dummy'));
14+
15+
$client = $this->getHttpClientMock();
16+
$client->expects($this->once())
17+
->method('get')
18+
->with($endpoint)
19+
->will($this->returnValue($expectedResult));
20+
21+
/** @var \Bitbucket\API\Repositories\Commits\BuildStatuses $buildStatus */
22+
$buildStatus = $this->getClassMock('Bitbucket\API\Repositories\Commits\BuildStatuses', $client);
23+
$actual = $buildStatus->get('gentle', 'eof', 'SHA1', 'KEY');
24+
25+
$this->assertEquals($expectedResult, $actual);
26+
}
27+
28+
public function testCreate()
29+
{
30+
$endpoint = 'repositories/gentle/eof/commit/SHA1/statuses/build';
31+
$params = json_encode(array(
32+
'state' => 'SUCCESSFUL'
33+
));
34+
35+
$client = $this->getHttpClientMock();
36+
$client->expects($this->once())
37+
->method('post')
38+
->with($endpoint);
39+
40+
/** @var \Bitbucket\API\Repositories\Commits\BuildStatuses $buildStatus */
41+
$buildStatus = $this->getClassMock('Bitbucket\API\Repositories\Commits\BuildStatuses', $client);
42+
43+
$buildStatus->create('gentle', 'eof', 'SHA1', $params);
44+
}
45+
46+
public function testUpdate()
47+
{
48+
$endpoint = 'repositories/gentle/eof/commit/SHA1/statuses/build/KEY';
49+
$params = json_encode(array(
50+
'state' => 'SUCCESSFUL'
51+
));
52+
53+
$client = $this->getHttpClientMock();
54+
$client->expects($this->once())
55+
->method('put')
56+
->with($endpoint);
57+
58+
/** @var \Bitbucket\API\Repositories\Commits\BuildStatuses $buildStatus */
59+
$buildStatus = $this->getClassMock('Bitbucket\API\Repositories\Commits\BuildStatuses', $client);
60+
61+
$buildStatus->update('gentle', 'eof', 'SHA1', 'KEY', $params);
62+
}
63+
}

0 commit comments

Comments
 (0)