Need Advice on mocking the sdk for unit and integration tests
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- php
調査の方向性
このissueではGraphServiceClient、生成されたリクエストビルダー、PHPUnitのモック、GuzzleのMockHandlerが挙げられていますが、リポジトリのファイルやテストのエントリーポイントは示されていません。まずGraphServiceClientのリクエスト構築を追跡し、リンク先のGuzzleのテストガイダンスと比較してください。完了とするには、ユニットテストと統合テストの両方に対応した、文書化されたサポート対象のモック方法が必要です。
索引モデルが issue の本文から書いたものです。
説明
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
}
}
- 主要言語
- PHP
- スター
- 669
- フォーク
- 150
- 平均マージ
- 15時間 21分
- マージ済み PR(30日)
- 3
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoftgraph/msgraph-sdk-php のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
microsoftgraph/msgraph-sdk-php#1794 · コメント 2 件 ·
-
bug: metadata type:bug
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
microsoftgraph/msgraph-sdk-php#1739 · コメント 6 件 ·
-
status:waiting-for-triage type:bug
難易度 1/5 1時間未満 初心者へのやさしさ 68/100
microsoftgraph/msgraph-sdk-php#1643 · コメント 8 件 · リアクション 4 件 ·
-
status:waiting-for-triage
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
microsoftgraph/msgraph-sdk-php#1800 · リアクション 1 件 ·
-
Now オープン
難易度 5/5 1週間以上 初心者へのやさしさ 1/100
microsoftgraph/msgraph-sdk-php#1799 ·
microsoftgraph/msgraph-sdk-php の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
getgrav/grav-plugin-api#45 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
RSS-Bridge/rss-bridge#5098 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
phingofficial/phing#2025 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
silverstripe/developer-docs#911 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100