Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ v3 APIs:
* [Organization](organization.md)
* [Members](organization/members.md)
* [Teams](organization/teams.md)
* [Self hosted runners](organization/actions/self_hosted_runners.md)
* [Secrets](organization/actions/secrets.md)
* [Variables](organization/actions/variables.md)
* [Projects](project/projects.md)
Expand Down
51 changes: 51 additions & 0 deletions doc/organization/actions/self_hosted_runners.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
## Organization / Actions / Self Hosted Runners API
[Back to the "Organization API"](../../organization.md) | [Back to the navigation](../../README.md)

# List self-hosted runners for an Organization

https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#list-self-hosted-runners-for-an-organization

```php
$runners = $client->api('organization')->runners()->all('KnpLabs');
```

# Get a self-hosted runner for an Organization

https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#get-a-self-hosted-runner-for-an-organization

```php
$runner = $client->api('organization')->runners()->show('KnpLabs', $runnerId);
```

# Delete a self-hosted runner from an Organization

https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#delete-a-self-hosted-runner-from-an-organization

```php
$client->api('organization')->runners()->remove('KnpLabs', $runnerId);
```

# List runner applications for an Organization

https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#list-runner-applications-for-an-organization

```php
$applications = $client->api('organization')->selfHostedRunners()->applications('KnpLabs');
```

# List of all runners with Pagination

```php
$api = $github->api('organization')->runners();
$paginator = new Github\ResultPager($github);
$parameters = array('KnpLabs');
$runners = $paginator->fetchAll($api, 'all', $parameters);

do {
foreach ($runners['runners'] as $runner) {
// code
}
$runners = $paginator->fetchNext();
}
while($paginator->hasNext());
```
9 changes: 9 additions & 0 deletions lib/Github/Api/Organization.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace Github\Api;

use Github\Api\Organization\Actions\Secrets;
use Github\Api\Organization\Actions\SelfHostedRunners;
use Github\Api\Organization\Actions\Variables;
use Github\Api\Organization\Hooks;
use Github\Api\Organization\Members;
Expand Down Expand Up @@ -140,4 +141,12 @@ public function issues($organization, array $params = [], $page = 1)
{
return $this->get('/orgs/'.rawurlencode($organization).'/issues', array_merge(['page' => $page], $params));
}

/**
* @return SelfHostedRunners
*/
public function runners(): SelfHostedRunners
{
return new SelfHostedRunners($this->getClient());
}
}
59 changes: 59 additions & 0 deletions lib/Github/Api/Organization/Actions/SelfHostedRunners.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<?php

namespace Github\Api\Organization\Actions;

use Github\Api\AbstractApi;

class SelfHostedRunners extends AbstractApi
{
/**
* @link https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#list-self-hosted-runners-for-an-organization
*
* @param string $organization
* @param array $parameters
*
* @return array|string
*/
public function all(string $organization, array $parameters = [])
{
return $this->get('/orgs/'.rawurlencode($organization).'/actions/runners', $parameters);
}

/**
* @link https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#get-a-self-hosted-runner-for-an-organization
*
* @param string $organization
* @param int $runnerId
*
* @return array|string
*/
public function show(string $organization, int $runnerId)
{
return $this->get('/orgs/'.rawurlencode($organization).'/actions/runners/'.$runnerId);
}

/**
* @link https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#delete-a-self-hosted-runner-from-an-organization
*
* @param string $organization
* @param int $runnerId
*
* @return array|string
*/
public function remove(string $organization, int $runnerId)
{
return $this->delete('/orgs/'.rawurlencode($organization).'/actions/runners/'.$runnerId);
}

/**
* @link https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#list-runner-applications-for-an-organization
*
* @param string $organization
*
* @return array|string
*/
public function applications(string $organization)
{
return $this->get('/orgs/'.rawurlencode($organization).'/actions/runners/downloads');
}
}
115 changes: 115 additions & 0 deletions test/Github/Tests/Api/Organization/Actions/SelfHostedRunnersTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
<?php

namespace Github\Tests\Api\Organization\Actions;

use Github\Api\Organization\Actions\SelfHostedRunners;
use Github\Tests\Api\TestCase;
use PHPUnit\Framework\MockObject\MockObject;

class SelfHostedRunnersTest extends TestCase
{
/**
* @test
*/
public function shouldGetSelfHostedRunners()
{
$expectedArray = [
[
'id' => 1,
'name' => 'MBP',
'os' => 'macos',
'status' => 'online',
],
[
'id' => 2,
'name' => 'iMac',
'os' => 'macos',
'status' => 'offline',
],
];

/** @var SelfHostedRunners|MockObject $api */
$api = $this->getApiMock();

$api
->expects($this->once())
->method('get')
->with('/orgs/KnpLabs/actions/runners')
->will($this->returnValue($expectedArray));

$this->assertEquals($expectedArray, $api->all('KnpLabs'));
}

/**
* @test
*/
public function shouldGetSelfHostedRunner()
{
$expectedArray = [
'id' => 1,
'name' => 'MBP',
'os' => 'macos',
'status' => 'online',
];

/** @var SelfHostedRunners|MockObject $api */
$api = $this->getApiMock();

$api
->expects($this->once())
->method('get')
->with('/orgs/KnpLabs/actions/runners/1')
->will($this->returnValue($expectedArray));

$this->assertEquals($expectedArray, $api->show('KnpLabs', 1));
}

/**
* @test
*/
public function shouldRemoveSelfHostedRunner()
{
$expectedValue = 'response';

/** @var SelfHostedRunners|MockObject $api */
$api = $this->getApiMock();

$api
->expects($this->once())
->method('delete')
->with('/orgs/KnpLabs/actions/runners/1')
->will($this->returnValue($expectedValue));

$this->assertEquals($expectedValue, $api->remove('KnpLabs', 1));
}

/**
* @test
*/
public function shouldGetSelfHostedRunnerApps()
{
$expectedArray = [
['os' => 'osx', 'architecture' => 'x64', 'download_url' => 'download_url', 'filename' => 'filename'],
['os' => 'linux', 'architecture' => 'x64', 'download_url' => 'download_url', 'filename' => 'filename'],
['os' => 'linux', 'architecture' => 'arm', 'download_url' => 'download_url', 'filename' => 'filename'],
['os' => 'win', 'architecture' => 'x64', 'download_url' => 'download_url', 'filename' => 'filename'],
['os' => 'linux', 'architecture' => 'arm64', 'download_url' => 'download_url', 'filename' => 'filename'],
];

/** @var SelfHostedRunners|MockObject $api */
$api = $this->getApiMock();

$api
->expects($this->once())
->method('get')
->with('/orgs/KnpLabs/actions/runners/downloads')
->will($this->returnValue($expectedArray));

$this->assertEquals($expectedArray, $api->applications('KnpLabs'));
}

protected function getApiClass()
{
return SelfHostedRunners::class;
}
}
10 changes: 10 additions & 0 deletions test/Github/Tests/Api/OrganizationTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,16 @@ public function shouldGetTeamsApiObject()
$this->assertInstanceOf(\Github\Api\Organization\Teams::class, $api->teams());
}

/**
* @test
*/
public function shouldGetSelfHostedRunnersApiObject()
{
$api = $this->getApiMock();

$this->assertInstanceOf(\Github\Api\Organization\Actions\SelfHostedRunners::class, $api->runners());
}

/**
* @test
*/
Expand Down