microsoftgraph / microsoftgraph/msgraph-sdk-php
Need Advice on mocking the sdk for unit and integration tests
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- PHP
- Sterne
- 669
- Forks
- 150
- Ø Merge
- 15 Std. 21 Min.
- Gemergte PRs (30 T.)
- 3
Beschreibung
For unit testing a class in out application that uses the sdk there isn't an easy way to mock the sdk parts see code block below.
I had a dig aorund in the source and couldnt find anything helpful in regards to this. Though I did stumble onto somthing indicating it uses the guzzle client so I was wondering if there was a way to do this:
https://docs.guzzlephp.org/en/stable/testing.html#mock-handler
with the sdk?
Or if there was any other recomended approach?
I will also need to write integration tests and dont want to be letting it call out the the MS servers so the guzzle mock hadnler or something similar would be very useful.
<?php
use Http\Promise\Promise;
use Microsoft\Graph\Generated\Chats\Item\Messages\MessagesRequestBuilder;
use Microsoft\Graph\Generated\Users\Item\Messages\Item\MessageItemRequestBuilder;
use Microsoft\Graph\Generated\Users\Item\Messages\Item\Value\ContentRequestBuilder;
use Microsoft\Graph\Generated\Users\Item\UserItemRequestBuilder;
use Microsoft\Graph\Generated\Users\UsersRequestBuilder;
use Microsoft\Graph\GraphServiceClient;
use PHPUnit\Framework\TestCase;
use Psr\Http\Message\StreamInterface;
class SomeService {
public function __construct(private GraphServiceClient $client)
{
}
public function run(): void {
$mimeEmail = $this->client->users()
->byUserId('testuser@testing.com')
->messages()
->byMessageId('SomeMessageId')
->content()
->get()
->wait();
//do something with $mimeEmail;
}
}
class SomeServiceTest extends TestCase
{
public function testComponent(): void
{
$graphServiceClient = $this->createMock(GraphServiceClient::class);
$mockUsersRequestBuilder = $this->createMock(UsersRequestBuilder::class);
$graphServiceClient->expects(self::once())
->method('users')
->willReturn($mockUsersRequestBuilder)
;
$userItemRequestBuilder = $this->createMock(UserItemRequestBuilder::class);
$mockUsersRequestBuilder->expects(self::once())
->method('byUserId')
->with($this->email)
->willReturn($userItemRequestBuilder)
;
$messagesRequestBuilder = $this->createMock(MessagesRequestBuilder::class);
$userItemRequestBuilder->expects(self::once())
->method('messages')
->willReturn($messagesRequestBuilder);
$messageItemRequestBuilder = $this->createMock(MessageItemRequestBuilder::class);
$messagesRequestBuilder->expects(self::once())
->method('byMessageId')
->with('SomeMessageId')
->willReturn($messageItemRequestBuilder)
;
$contentRequestBuilder = $this->createMock(ContentRequestBuilder::class);
$messageItemRequestBuilder->expects(self::once())
->method('content')
->willReturn($contentRequestBuilder)
;
$mimeMessagePromise = $this->createMock(Promise::class);
$contentRequestBuilder->expects(self::once())
->method('get')
->willReturn($mimeMessagePromise)
;
$stream = $this->createMock(StreamInterface::class);
$mimeMessagePromise->expects(self::once())
->method('wait')
->willReturn($stream)
;
$stream->expects(self::once())
->method('getContents')
->willReturn('Mime Contents')
;
$service = new SomeService($graphServiceClient);
$service->run();
//Do assertions
}
}
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Das Issue nennt GraphServiceClient, generierte Request-Builder, PHPUnit-Mocks und Guzzles MockHandler, enthält aber keine Repository-Dateien oder Test-Einstiegspunkte. Beginne damit, die Request-Erstellung von GraphServiceClient nachzuverfolgen und sie mit der verlinkten Guzzle-Testanleitung zu vergleichen; für den Abschluss wäre ein dokumentierter, unterstützter Mocking-Ansatz für Unit- und Integrationstests erforderlich.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- php
- Bereich
- developer-experience, testing-qa
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100