This package provides a very basic, convenient, and unified wrapper for Microsoft Azure DevOps.
To install the client you need to require the package using composer:
$ composer require testmonitor/devops-client
Use composer's autoload:
require __DIR__.'/../vendor/autoload.php';
You're all set up now!
This client only supports oAuth authentication. You'll need an Azure DevOps application to proceed. If you haven't done so, please read up with the Azure DevOps authentication docs on how to create an application.
When your DevOps application is up and running, start with the oAuth authorization:
$oauth = [
'clientId' => '12345',
'clientSecret' => 'abcdef',
'redirectUrl' => 'https://redirect.myapp.com/',
];
$devops = new \TestMonitor\DevOps\Client($oauth);
header('Location: ' . $devops->authorizationUrl());
exit();
This will redirect the user to a page asking confirmation for your app getting access to Azure DevOps. Make sure your redirectUrl points back to your app. This URL should point to the following code:
$oauth = [
'clientId' => '12345',
'clientSecret' => 'abcdef',
'redirectUrl' => 'https://redirect.myapp.com/',
];
$devops = new \TestMonitor\DevOps\Client($oauth);
$token = $devops->fetchToken($_REQUEST['code']);
When everything went ok, you should have an access token (available through Token object). It will be valid for one hour. After that, you'll have to refresh the token to regain access:
$oauth = ['clientId' => '12345', 'clientSecret' => 'abcdef', 'redirectUrl' => 'https://redirect.myapp.com/'];
$token = new \TestMonitor\DevOps\AccessToken('eyJ0...', '0/34ccc...', 1574601877); // the token you got last time
$organization = 'MyOrg';
$devops = new \TestMonitor\DevOps\Client($oauth, $organization, $token);
if ($token->expired()) {
$newToken = $devops->refreshToken();
}
The new token will be valid again for the next hour.
Get a list of Azure DevOps accounts:
$accounts = $devops->accounts();
Or creating a work item, for example (using a work item type 'Bug' and example project with id 12345):
$workItem = $devops->createWorkItem(new \TestMonitor\DevOps\Resources\WorkItem([
'title' => 'Summary of the item',
'description' => 'Some description',
'workItemType' => 'Bug',
'stepsToReproduce' => 'Repro steps',
]), '12345');
The package contains integration tests. You can run them using PHPUnit.
$ vendor/bin/phpunit
Refer to CHANGELOG for more information.
Refer to CONTRIBUTING for contributing details.
- Thijs Kok - Lead developer - ThijsKok
- Stephan Grootveld - Developer - Stefanius
- Frank Keulen - Developer - FrankIsGek
- Muriel Nooder - Developer - ThaNoodle
The MIT License (MIT). Refer to the License for more information.