Files
max-bot-api-client-php/tests/ApiTest.php
T

1358 lines
46 KiB
PHP

<?php
declare(strict_types=1);
namespace BushlanovDev\MaxMessengerBot\Tests;
use BushlanovDev\MaxMessengerBot\Api;
use BushlanovDev\MaxMessengerBot\Client;
use BushlanovDev\MaxMessengerBot\ClientApiInterface;
use BushlanovDev\MaxMessengerBot\Enums\AttachmentType;
use BushlanovDev\MaxMessengerBot\Enums\ButtonType;
use BushlanovDev\MaxMessengerBot\Enums\MessageFormat;
use BushlanovDev\MaxMessengerBot\Enums\SenderAction;
use BushlanovDev\MaxMessengerBot\Enums\UpdateType;
use BushlanovDev\MaxMessengerBot\Enums\UploadType;
use BushlanovDev\MaxMessengerBot\Exceptions\SerializationException;
use BushlanovDev\MaxMessengerBot\ModelFactory;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Buttons\CallbackButton;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Payloads\ContactAttachmentRequestPayload;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Payloads\InlineKeyboardAttachmentRequestPayload;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Payloads\LocationAttachmentRequestPayload;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Payloads\PhotoAttachmentRequestPayload;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Payloads\PhotoToken;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Payloads\ShareAttachmentRequestPayload;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Payloads\StickerAttachmentRequestPayload;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Payloads\UploadedInfoAttachmentRequestPayload;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\AudioAttachmentRequest;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\ContactAttachmentRequest;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\FileAttachmentRequest;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\InlineKeyboardAttachmentRequest;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\LocationAttachmentRequest;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\PhotoAttachmentRequest;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\ShareAttachmentRequest;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\StickerAttachmentRequest;
use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\VideoAttachmentRequest;
use BushlanovDev\MaxMessengerBot\Models\BotInfo;
use BushlanovDev\MaxMessengerBot\Models\Chat;
use BushlanovDev\MaxMessengerBot\Models\ChatList;
use BushlanovDev\MaxMessengerBot\Models\Message;
use BushlanovDev\MaxMessengerBot\Models\MessageBody;
use BushlanovDev\MaxMessengerBot\Models\Recipient;
use BushlanovDev\MaxMessengerBot\Models\Result;
use BushlanovDev\MaxMessengerBot\Models\Sender;
use BushlanovDev\MaxMessengerBot\Models\Subscription;
use BushlanovDev\MaxMessengerBot\Models\UpdateList;
use BushlanovDev\MaxMessengerBot\Models\Updates\AbstractUpdate;
use BushlanovDev\MaxMessengerBot\Models\Updates\BotStartedUpdate;
use BushlanovDev\MaxMessengerBot\Models\Updates\MessageCreatedUpdate;
use BushlanovDev\MaxMessengerBot\Models\UploadEndpoint;
use BushlanovDev\MaxMessengerBot\Models\User;
use BushlanovDev\MaxMessengerBot\WebhookHandler;
use GuzzleHttp\Psr7\ServerRequest;
use InvalidArgumentException;
use LogicException;
use org\bovigo\vfs\vfsStream;
use phpmock\phpunit\PHPMock;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\PreserveGlobalState;
use PHPUnit\Framework\Attributes\RunInSeparateProcess;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\Attributes\UsesClass;
use PHPUnit\Framework\MockObject\Exception;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use ReflectionClass;
use RuntimeException;
#[CoversClass(Api::class)]
#[UsesClass(Result::class)]
#[UsesClass(Client::class)]
#[UsesClass(BotInfo::class)]
#[UsesClass(Subscription::class)]
#[UsesClass(Message::class)]
#[UsesClass(MessageBody::class)]
#[UsesClass(Recipient::class)]
#[UsesClass(Sender::class)]
#[UsesClass(CallbackButton::class)]
#[UsesClass(InlineKeyboardAttachmentRequestPayload::class)]
#[UsesClass(InlineKeyboardAttachmentRequest::class)]
#[UsesClass(PhotoToken::class)]
#[UsesClass(PhotoAttachmentRequest::class)]
#[UsesClass(PhotoAttachmentRequestPayload::class)]
#[UsesClass(UploadEndpoint::class)]
#[UsesClass(Chat::class)]
#[UsesClass(UpdateList::class)]
#[UsesClass(WebhookHandler::class)]
#[UsesClass(User::class)]
#[UsesClass(AbstractUpdate::class)]
#[UsesClass(BotStartedUpdate::class)]
#[UsesClass(MessageCreatedUpdate::class)]
#[UsesClass(UploadedInfoAttachmentRequestPayload::class)]
#[UsesClass(VideoAttachmentRequest::class)]
#[UsesClass(AudioAttachmentRequest::class)]
#[UsesClass(FileAttachmentRequest::class)]
#[UsesClass(StickerAttachmentRequest::class)]
#[UsesClass(StickerAttachmentRequestPayload::class)]
#[UsesClass(ContactAttachmentRequest::class)]
#[UsesClass(ContactAttachmentRequestPayload::class)]
#[UsesClass(LocationAttachmentRequest::class)]
#[UsesClass(LocationAttachmentRequestPayload::class)]
#[UsesClass(ShareAttachmentRequest::class)]
#[UsesClass(ShareAttachmentRequestPayload::class)]
#[UsesClass(ChatList::class)]
final class ApiTest extends TestCase
{
use PHPMock;
private MockObject&ClientApiInterface $clientMock;
private MockObject&ModelFactory $modelFactoryMock;
private Api $api;
/**
* @throws Exception
*/
protected function setUp(): void
{
parent::setUp();
$this->clientMock = $this->createMock(ClientApiInterface::class);
$this->modelFactoryMock = $this->createMock(ModelFactory::class);
$this->api = new Api('fake-token', $this->clientMock, $this->modelFactoryMock);
}
#[Test]
public function constructorCanCreateDefaultDependencies(): void
{
$api = new Api('some-token');
$reflection = new ReflectionClass($api);
$clientProp = $reflection->getProperty('client');
$this->assertInstanceOf(ClientApiInterface::class, $clientProp->getValue($api));
$factoryProp = $reflection->getProperty('modelFactory');
$this->assertInstanceOf(ModelFactory::class, $factoryProp->getValue($api));
}
#[Test]
public function getBotInfoCallsClientAndFactoryCorrectly(): void
{
$rawResponseData = ['user_id' => 123, 'first_name' => 'ApiTestBot'];
$botInfo = new BotInfo(
123,
'ApiTestBot',
null, null, true, 0, null, null, null, null,
);
$this->clientMock
->expects($this->once())
->method('request')
->with('GET', '/me')
->willReturn($rawResponseData);
$this->modelFactoryMock
->expects($this->once())
->method('createBotInfo')
->with($rawResponseData)
->willReturn($botInfo);
$result = $this->api->getBotInfo();
$this->assertSame($botInfo, $result);
}
#[Test]
public function testSubscribeCallsClientAndFactoryCorrectly(): void
{
$rawResponseData = [
'subscriptions' => [
[
'url' => 'https://example.com/webhook',
'time' => 1678886400000,
'update_types' => ['message_created'],
'version' => '0.0.1',
],
],
];
$subscription = new Subscription(
'https://example.com/webhook',
1678886400000,
[UpdateType::MessageCreated],
'0.0.1',
);
$this->clientMock
->expects($this->once())
->method('request')
->with('GET', '/subscriptions')
->willReturn($rawResponseData);
$this->modelFactoryMock
->expects($this->once())
->method('createSubscriptions')
->with($rawResponseData)
->willReturn([$subscription]);
$result = $this->api->getSubscriptions();
$this->assertIsArray($result);
$this->assertCount(1, $result);
$this->assertInstanceOf(Subscription::class, $result[0]);
$this->assertSame(UpdateType::MessageCreated, $result[0]->updateTypes[0]);
}
#[Test]
public function subscribeCallsClientWithAllParameters(): void
{
$url = 'https://example.com/webhook';
$secret = 'secure';
$updateTypes = [UpdateType::MessageCreated, UpdateType::BotStarted];
$updateTypesAsStrings = array_map(fn($type) => $type->value, $updateTypes);
$expectedBody = [
'url' => $url,
'secret' => $secret,
'update_types' => $updateTypesAsStrings,
];
$rawClientResponse = ['success' => true];
$expectedResultObject = new Result(true, null);
$this->clientMock
->expects($this->once())
->method('request')
->with('POST', '/subscriptions', [], $expectedBody)
->willReturn($rawClientResponse);
$this->modelFactoryMock
->expects($this->once())
->method('createResult')
->with($rawClientResponse)
->willReturn($expectedResultObject);
$result = $this->api->subscribe($url, $secret, $updateTypes);
$this->assertSame($expectedResultObject, $result);
}
#[Test]
public function subscribeHandlesOptionalParametersAsNull(): void
{
$url = 'https://example.com/webhook';
$expectedBody = [
'url' => $url,
'secret' => null,
'update_types' => null,
];
$rawClientResponse = ['success' => true];
$expectedResultObject = new Result(true, null);
$this->clientMock
->expects($this->once())
->method('request')
->with('POST', '/subscriptions', [], $expectedBody)
->willReturn($rawClientResponse);
$this->modelFactoryMock
->expects($this->once())
->method('createResult')
->with($rawClientResponse)
->willReturn($expectedResultObject);
$result = $this->api->subscribe($url);
$this->assertSame($expectedResultObject, $result);
}
#[Test]
public function unsubscribeCallsClientWithCorrectParameters(): void
{
$url = 'https://example.com/webhook';
$expectedQueryParams = ['url' => $url];
$rawClientResponse = ['success' => true];
$expectedResultObject = new Result(true, null);
$this->clientMock
->expects($this->once())
->method('request')
->with('DELETE', '/subscriptions', $expectedQueryParams, [])
->willReturn($rawClientResponse);
$this->modelFactoryMock
->expects($this->once())
->method('createResult')
->with($rawClientResponse)
->willReturn($expectedResultObject);
$result = $this->api->unsubscribe($url);
$this->assertSame($expectedResultObject, $result);
}
#[Test]
public function sendMessageBuildsCorrectRequestForAllParameters(): void
{
$chatId = 123456;
$text = 'Hello, **world**!';
$format = MessageFormat::Markdown;
$notify = false;
$disableLinkPreview = true;
$expectedQuery = [
'chat_id' => $chatId,
'disable_link_preview' => $disableLinkPreview,
];
$expectedBody = [
'text' => $text,
'format' => $format->value,
'notify' => $notify,
];
$apiResponse = [
'message' => [
'timestamp' => time(),
'body' => ['mid' => 'mid.456.xyz', 'seq' => 101, 'text' => $text],
'recipient' => ['chat_type' => 'dialog', 'user_id' => 123, 'chat_id' => null],
'sender' => [
'user_id' => 123,
'first_name' => 'John',
'last_name' => 'Doe',
'username' => 'johndoe',
'is_bot' => false,
'last_activity_time' => 1678886400000,
],
'url' => 'https://max.ru/message/123',
],
];
$expectedMessageObject = Message::fromArray($apiResponse['message']);
$this->clientMock
->expects($this->once())
->method('request')
->with('POST', '/messages', $expectedQuery, $expectedBody)
->willReturn($apiResponse);
$this->modelFactoryMock
->expects($this->once())
->method('createMessage')
->with($apiResponse['message'])
->willReturn($expectedMessageObject);
$result = $this->api->sendMessage(
null,
$chatId,
$text,
null,
$format,
null,
$notify,
$disableLinkPreview,
);
$this->assertSame($expectedMessageObject, $result);
}
#[Test]
public function sendMessageWithAttachmentsBuildsCorrectRequest(): void
{
$chatId = 123456;
$text = 'Test message with a keyboard';
$disableLinkPreview = true;
$button = new CallbackButton('Press Me', 'payload_123');
$keyboard = new InlineKeyboardAttachmentRequest([[$button]]);
$expectedAttachmentsJson = [
[
'type' => AttachmentType::InlineKeyboard->value,
'payload' => [
'buttons' => [
[
[
'type' => ButtonType::Callback->value,
'text' => 'Press Me',
'payload' => 'payload_123',
'intent' => null,
]
]
]
]
]
];
$expectedBody = [
'text' => $text,
'attachments' => $expectedAttachmentsJson,
'notify' => true,
];
$expectedQuery = ['chat_id' => $chatId, 'disable_link_preview' => $disableLinkPreview];
$apiResponse = [
'message' => [
'timestamp' => time(),
'body' => ['mid' => 'mid.test.123', 'seq' => 1, 'text' => $text],
'recipient' => ['chat_type' => 'dialog', 'user_id' => 123, 'chat_id' => null],
]
];
$expectedMessageObject = Message::fromArray($apiResponse['message']);
$this->clientMock
->expects($this->once())
->method('request')
->with(
'POST',
'/messages',
$expectedQuery,
$expectedBody,
)
->willReturn($apiResponse);
$this->modelFactoryMock
->expects($this->once())
->method('createMessage')
->with($apiResponse['message'])
->willReturn($expectedMessageObject);
$result = $this->api->sendMessage(
chatId: $chatId,
text: $text,
attachments: [$keyboard],
disableLinkPreview: $disableLinkPreview,
);
$this->assertSame($expectedMessageObject, $result);
}
#[Test]
public function uploadAttachmentSuccessfullyUploadsImageAndReturnsAttachment(): void
{
$filePath = tempnam(sys_get_temp_dir(), 'test_upload_');
file_put_contents($filePath, 'fake-image-content');
$uploadType = UploadType::Image;
$uploadUrl = 'https://upload.server/gohere';
$uploadToken = 'FINAL_TOKEN_123';
$getUploadUrlResponse = ['url' => $uploadUrl];
$uploadResponse = ['token' => $uploadToken];
$expectedEndpoint = new UploadEndpoint($uploadUrl);
$expectedAttachment = PhotoAttachmentRequest::fromToken($uploadToken);
$this->clientMock
->expects($this->once())
->method('request')
->with('POST', '/uploads', ['type' => $uploadType->value])
->willReturn($getUploadUrlResponse);
$this->modelFactoryMock
->expects($this->once())
->method('createUploadEndpoint')
->with($getUploadUrlResponse)
->willReturn($expectedEndpoint);
$this->clientMock
->expects($this->once())
->method('upload')
->with($uploadUrl, $this->isResource(), basename($filePath))
->willReturn($uploadResponse);
$result = $this->api->uploadAttachment($uploadType, $filePath);
$this->assertEquals($expectedAttachment, $result);
unlink($filePath);
}
#[Test]
public function uploadAttachmentForMultiplePhotosReturnsCorrectAttachment(): void
{
$filePath = tempnam(sys_get_temp_dir(), 'test_');
file_put_contents($filePath, 'content');
$getUploadUrlResponse = ['url' => 'http://upload.server'];
$expectedEndpoint = new UploadEndpoint('http://upload.server');
$uploadResponse = ['token' => 'token'];
$expectedAttachment = PhotoAttachmentRequest::fromToken('token');
$this->clientMock->method('request')->willReturn($getUploadUrlResponse);
$this->modelFactoryMock->method('createUploadEndpoint')->willReturn($expectedEndpoint);
$this->clientMock->method('upload')->willReturn($uploadResponse);
$result = $this->api->uploadAttachment(UploadType::Image, $filePath);
$this->assertEquals($expectedAttachment, $result);
unlink($filePath);
}
#[Test]
public function uploadAttachmentThrowsExceptionForNonExistentFile(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessageMatches('/File not found or not readable/');
$this->api->uploadAttachment(UploadType::Image, '/path/to/non/existent/file.jpg');
}
#[Test]
public function getChatCallsClientAndFactoryCorrectly(): void
{
$chatId = 100123456789;
$rawResponseData = [
'chat_id' => $chatId,
'type' => 'chat',
'status' => 'active',
'last_event_time' => 1678886400000,
'participants_count' => 50,
'is_public' => false,
'title' => 'Test Chat Title',
'icon' => null,
'owner_id' => null,
'link' => null,
'description' => null,
'dialog_with_user' => null,
'messages_count' => null,
'chat_message_id' => null,
'pinned_message' => null,
];
$expectedChatObject = Chat::fromArray($rawResponseData);
$this->clientMock
->expects($this->once())
->method('request')
->with('GET', '/chats/' . $chatId)
->willReturn($rawResponseData);
$this->modelFactoryMock
->expects($this->once())
->method('createChat')
->with($rawResponseData)
->willReturn($expectedChatObject);
$result = $this->api->getChat($chatId);
$this->assertSame($expectedChatObject, $result);
}
#[Test]
public function getUpdatesCallsClientWithCorrectParameters(): void
{
$limit = 50;
$timeout = 60;
$marker = 12345;
$types = [UpdateType::MessageCreated, UpdateType::BotStarted];
$expectedQuery = [
'limit' => $limit,
'timeout' => $timeout,
'marker' => $marker,
'types' => 'message_created,bot_started',
];
$rawResponse = ['updates' => [], 'marker' => $marker + 1];
$expectedUpdateList = new UpdateList([], $marker + 1);
$this->clientMock
->expects($this->once())
->method('request')
->with('GET', '/updates', $expectedQuery)
->willReturn($rawResponse);
$this->modelFactoryMock
->expects($this->once())
->method('createUpdateList')
->with($rawResponse)
->willReturn($expectedUpdateList);
$result = $this->api->getUpdates($limit, $timeout, $marker, $types);
$this->assertSame($expectedUpdateList, $result);
}
#[Test]
public function getUpdatesHandlesNullParameters(): void
{
$this->clientMock
->expects($this->once())
->method('request')
->with('GET', '/updates', [])
->willReturn(['updates' => [], 'marker' => null]);
$this->modelFactoryMock
->method('createUpdateList')
->willReturn(new UpdateList([], null));
$this->api->getUpdates();
}
#[Test]
public function createWebhookHandlerReturnsInstanceWithProvidedSecret(): void
{
$secret = 'my-test-secret-key';
$webhookHandler = $this->api->createWebhookHandler($secret);
$this->assertInstanceOf(WebhookHandler::class, $webhookHandler);
$reflection = new ReflectionClass($webhookHandler);
$apiProperty = $reflection->getProperty('api');
$this->assertSame($this->api, $apiProperty->getValue($webhookHandler));
$factoryProperty = $reflection->getProperty('modelFactory');
$this->assertSame($this->modelFactoryMock, $factoryProperty->getValue($webhookHandler));
$secretProperty = $reflection->getProperty('secret');
$this->assertSame($secret, $secretProperty->getValue($webhookHandler));
}
#[Test]
public function getWebhookUpdateCreatesHandlerAndReturnsUpdate(): void
{
$api = new Api('fake-token', $this->clientMock, $this->modelFactoryMock);
$payload = '{"update_type":"bot_started","timestamp":123,"chat_id":1,"user":{"user_id":1,"first_name":"Test","is_bot":false,"last_activity_time":123}}';
$request = new ServerRequest('POST', '/webhook', [], $payload);
$expectedUpdate = new BotStartedUpdate(
123,
1,
new User(1, 'Test', null, null, false, 123, null, null, null),
null,
null,
);
$this->modelFactoryMock
->expects($this->once())
->method('createUpdate')
->with(json_decode($payload, true))
->willReturn($expectedUpdate);
$result = $api->getWebhookUpdate(null, $request);
$this->assertSame($expectedUpdate, $result);
}
#[Test]
public function handleWebhooksDispatchesCorrectHandler(): void
{
$api = new Api('fake-token', $this->clientMock, $this->modelFactoryMock);
$secret = 'my-secret';
$payload = '{"update_type":"message_created","timestamp":123,"message":{"timestamp":1,"body":{"mid":"m1","seq":1},"recipient":{"chat_type":"dialog"}}}';
$request = new \GuzzleHttp\Psr7\ServerRequest(
'POST',
'/webhook',
['X-Max-Bot-Api-Secret' => $secret],
$payload,
);
$expectedUpdate = new MessageCreatedUpdate(
123,
Message::fromArray(
['timestamp' => 1, 'body' => ['mid' => 'm1', 'seq' => 1], 'recipient' => ['chat_type' => 'dialog']]
),
null,
);
$this->modelFactoryMock
->expects($this->once())
->method('createUpdate')
->with(json_decode($payload, true))
->willReturn($expectedUpdate);
$messageHandlerCallCount = 0;
$messageHandlerCapturedUpdate = null;
$messageHandler = function (MessageCreatedUpdate $update, Api $receivedApi) use (
&$messageHandlerCallCount,
&$messageHandlerCapturedUpdate,
) {
$messageHandlerCallCount++;
$messageHandlerCapturedUpdate = $update;
};
$botStartedHandlerCallCount = 0;
$botStartedHandler = function () use (&$botStartedHandlerCallCount) {
$botStartedHandlerCallCount++;
};
$handlers = [
UpdateType::MessageCreated->value => $messageHandler,
UpdateType::BotStarted->value => $botStartedHandler,
];
$api->handleWebhooks($handlers, $secret, $request);
$this->assertSame(1, $messageHandlerCallCount, 'MessageCreated handler should be called once.');
$this->assertSame(0, $botStartedHandlerCallCount, 'BotStarted handler should not be called.');
$this->assertSame($expectedUpdate, $messageHandlerCapturedUpdate);
}
#[Test]
public function processUpdatesBatchDispatchesHandlersAndUpdatesMarker(): void
{
$messageUpdate = new MessageCreatedUpdate(
1,
Message::fromArray(
['timestamp' => 1, 'body' => ['mid' => 'm1', 'seq' => 1], 'recipient' => ['chat_type' => 'dialog']]
),
null,
);
$botStartedUpdate = new BotStartedUpdate(
2, 123,
User::fromArray(['user_id' => 1, 'first_name' => 'Test', 'is_bot' => false, 'last_activity_time' => 1]),
null,
null,
);
$messageHandlerCallCount = 0;
$botStartedHandlerCallCount = 0;
$handlers = [
UpdateType::MessageCreated->value => function () use (&$messageHandlerCallCount) {
$messageHandlerCallCount++;
},
UpdateType::BotStarted->value => function () use (&$botStartedHandlerCallCount) {
$botStartedHandlerCallCount++;
},
];
$apiMock = $this->getMockBuilder(Api::class)
->setConstructorArgs(['fake-token', $this->clientMock, $this->modelFactoryMock])
->onlyMethods(['getUpdates'])
->getMock();
$apiMock->expects($this->once())
->method('getUpdates')
->willReturn(new UpdateList([$messageUpdate, $botStartedUpdate], 12345));
$marker = null;
$apiMock->processUpdatesBatch($handlers, 90, $marker);
$this->assertSame(1, $messageHandlerCallCount, 'MessageCreated handler should have been called once.');
$this->assertSame(1, $botStartedHandlerCallCount, 'BotStarted handler should have been called once.');
$this->assertSame(12345, $marker, 'Marker should have been updated to the new value.');
}
/**
* @var int Counter for processUpdatesBatch method calls.
*/
private int $processUpdatesBatchCallCount = 0;
/**
* @throws \Throwable We catch a base \Error, so we need to declare it here.
*/
#[Test]
public function handleUpdatesLoopContinuesAfterException(): void
{
$this->processUpdatesBatchCallCount = 0;
$handlers = [UpdateType::MessageCreated->value => fn() => null];
$apiMock = $this->getMockBuilder(Api::class)
->setConstructorArgs(['fake-token', $this->clientMock, $this->modelFactoryMock])
->onlyMethods(['processUpdatesBatch'])
->getMock();
$apiMock->expects($this->any())
->method('processUpdatesBatch')
->willReturnCallback(function () {
switch ($this->processUpdatesBatchCallCount++) {
case 0:
return;
case 1:
throw new \BushlanovDev\MaxMessengerBot\Exceptions\NetworkException("Simulated network error");
default:
throw new \Error("LoopBreak");
}
});
$this->expectOutputRegex('/Network error: Simulated network error/');
try {
$apiMock->handleUpdates($handlers);
} catch (\Error $e) {
$this->assertSame('LoopBreak', $e->getMessage());
$this->assertSame(
3,
$this->processUpdatesBatchCallCount,
'processUpdatesBatch should have been called 3 times.',
);
}
}
#[Test]
#[RunInSeparateProcess]
#[PreserveGlobalState(false)]
public function constructorThrowsExceptionWhenGuzzleIsMissing(): void
{
$this->expectException(LogicException::class);
$this->expectExceptionMessageMatches('/"guzzlehttp\/guzzle" is not found/');
$classExistsMock = $this->getFunctionMock('BushlanovDev\MaxMessengerBot', 'class_exists');
$classExistsMock->expects($this->once())
->with(\GuzzleHttp\Client::class)
->willReturn(false);
new Api('some-token');
}
#[Test]
public function handleUpdatesLoopCatchesGenericExceptionAndContinues(): void
{
$this->processUpdatesBatchCallCount = 0;
$handlers = [UpdateType::MessageCreated->value => fn() => null];
$apiMock = $this->getMockBuilder(Api::class)
->setConstructorArgs(['fake-token', $this->clientMock, $this->modelFactoryMock])
->onlyMethods(['processUpdatesBatch'])
->getMock();
$apiMock->expects($this->any())
->method('processUpdatesBatch')
->willReturnCallback(function () {
switch ($this->processUpdatesBatchCallCount++) {
case 0:
return;
case 1:
throw new \BushlanovDev\MaxMessengerBot\Exceptions\SerializationException(
"Simulated JSON error"
);
default:
throw new \Error("LoopBreak");
}
});
$this->expectOutputRegex('/An error occurred: Simulated JSON error/');
try {
$apiMock->handleUpdates($handlers);
} catch (\Error $e) {
$this->assertSame('LoopBreak', $e->getMessage());
$this->assertSame(
3,
$this->processUpdatesBatchCallCount,
'processUpdatesBatch should have been called 3 times, indicating the loop continued after the exception.',
);
}
}
#[Test]
public function uploadAttachmentThrowsRuntimeExceptionWhenPathIsADirectory(): void
{
$root = vfsStream::setup('root');
$directory = vfsStream::newDirectory('my_dir')->at($root);
$this->expectException(RuntimeException::class);
$this->expectExceptionMessageMatches('/Could not open file for reading/');
$this->api->uploadAttachment(UploadType::File, $directory->url());
}
#[Test]
public function uploadAttachmentThrowsSerializationExceptionForInvalidUploadResponse(): void
{
$filePath = tempnam(sys_get_temp_dir(), 'test_upload_');
file_put_contents($filePath, 'content');
$uploadType = UploadType::Image;
$uploadUrl = 'https://upload.server/path';
$getUploadUrlResponse = ['url' => $uploadUrl];
$expectedEndpoint = new UploadEndpoint($uploadUrl);
$invalidUploadResponse = ['status' => 'error', 'message' => 'Upload failed'];
$this->clientMock
->expects($this->once())
->method('request')
->with('POST', '/uploads', ['type' => $uploadType->value])
->willReturn($getUploadUrlResponse);
$this->modelFactoryMock
->expects($this->once())
->method('createUploadEndpoint')
->with($getUploadUrlResponse)
->willReturn($expectedEndpoint);
$this->clientMock
->expects($this->once())
->method('upload')
->with($uploadUrl, $this->isResource(), basename($filePath))
->willReturn($invalidUploadResponse);
$this->expectException(SerializationException::class);
$this->expectExceptionMessage('Could not find "token" in upload server response.');
try {
$this->api->uploadAttachment($uploadType, $filePath);
} finally {
unlink($filePath);
}
}
#[Test]
public function uploadAttachmentSuccessfullyUploadsVideoAndReturnsAttachment(): void
{
$filePath = tempnam(sys_get_temp_dir(), 'test_video_');
file_put_contents($filePath, 'fake-video-content');
$uploadType = UploadType::Video;
$uploadUrl = 'https://upload.server/video_path';
$uploadToken = 'VIDEO_TOKEN_XYZ';
$getUploadUrlResponse = ['url' => $uploadUrl];
$uploadResponse = ['token' => $uploadToken];
$expectedEndpoint = new UploadEndpoint($uploadUrl);
$expectedAttachment = new VideoAttachmentRequest($uploadToken);
$this->clientMock
->expects($this->once())
->method('request')
->with('POST', '/uploads', ['type' => $uploadType->value])
->willReturn($getUploadUrlResponse);
$this->modelFactoryMock
->expects($this->once())
->method('createUploadEndpoint')
->with($getUploadUrlResponse)
->willReturn($expectedEndpoint);
$this->clientMock
->expects($this->once())
->method('upload')
->with($uploadUrl, $this->isResource(), basename($filePath))
->willReturn($uploadResponse);
$result = $this->api->uploadAttachment($uploadType, $filePath);
$this->assertEquals($expectedAttachment, $result);
unlink($filePath);
}
#[Test]
public function uploadAttachmentSuccessfullyUploadsAudioAndReturnsAttachment(): void
{
$filePath = tempnam(sys_get_temp_dir(), 'test_audio_');
file_put_contents($filePath, 'fake-audio-content');
$uploadType = UploadType::Audio;
$uploadUrl = 'https://upload.server/audio_path';
$uploadToken = 'AUDIO_TOKEN_ABC';
$getUploadUrlResponse = ['url' => $uploadUrl];
$uploadResponse = ['token' => $uploadToken];
$expectedEndpoint = new UploadEndpoint($uploadUrl);
$expectedAttachment = new AudioAttachmentRequest($uploadToken);
$this->clientMock
->expects($this->once())
->method('request')
->with('POST', '/uploads', ['type' => $uploadType->value])
->willReturn($getUploadUrlResponse);
$this->modelFactoryMock
->expects($this->once())
->method('createUploadEndpoint')
->with($getUploadUrlResponse)
->willReturn($expectedEndpoint);
$this->clientMock
->expects($this->once())
->method('upload')
->with($uploadUrl, $this->isResource(), basename($filePath))
->willReturn($uploadResponse);
$result = $this->api->uploadAttachment($uploadType, $filePath);
$this->assertEquals($expectedAttachment, $result);
unlink($filePath);
}
#[Test]
public function uploadAttachmentSuccessfullyUploadsFileAndReturnsAttachment(): void
{
$filePath = tempnam(sys_get_temp_dir(), 'test_file_');
file_put_contents($filePath, 'fake-file-content');
$uploadType = UploadType::File;
$uploadUrl = 'https://upload.server/file_path';
$uploadToken = 'FILE_TOKEN_QWERTY';
$getUploadUrlResponse = ['url' => $uploadUrl];
$uploadResponse = ['token' => $uploadToken];
$expectedEndpoint = new UploadEndpoint($uploadUrl);
$expectedAttachment = new FileAttachmentRequest($uploadToken);
$this->clientMock
->expects($this->once())
->method('request')
->with('POST', '/uploads', ['type' => $uploadType->value])
->willReturn($getUploadUrlResponse);
$this->modelFactoryMock
->expects($this->once())
->method('createUploadEndpoint')
->with($getUploadUrlResponse)
->willReturn($expectedEndpoint);
$this->clientMock
->expects($this->once())
->method('upload')
->with($uploadUrl, $this->isResource(), basename($filePath))
->willReturn($uploadResponse);
$result = $this->api->uploadAttachment($uploadType, $filePath);
$this->assertEquals($expectedAttachment, $result);
unlink($filePath);
}
#[Test]
public function sendMessageWithStickerAttachmentBuildsCorrectRequest(): void
{
$chatId = 12345;
$stickerCode = 'sticker_id_ok';
$stickerRequest = new StickerAttachmentRequest($stickerCode);
$expectedBody = [
'attachments' => [
[
'type' => 'sticker',
'payload' => [
'code' => $stickerCode,
],
],
],
'notify' => true,
];
$expectedQuery = ['chat_id' => $chatId, 'disable_link_preview' => false];
$apiResponse = [
'message' => [
'timestamp' => time(),
'body' => ['mid' => 'mid.sticker.1', 'seq' => 10],
'recipient' => ['chat_type' => 'dialog', 'user_id' => $chatId],
]
];
$expectedMessageObject = Message::fromArray($apiResponse['message']);
$this->clientMock->expects($this->once())
->method('request')
->with('POST', '/messages', $expectedQuery, $expectedBody)
->willReturn($apiResponse);
$this->modelFactoryMock->expects($this->once())
->method('createMessage')
->with($apiResponse['message'])
->willReturn($expectedMessageObject);
$result = $this->api->sendMessage(chatId: $chatId, attachments: [$stickerRequest]);
$this->assertSame($expectedMessageObject, $result);
}
#[Test]
public function sendMessageWithContactAttachmentBuildsCorrectRequest(): void
{
$chatId = 12345;
$contactRequest = new ContactAttachmentRequest(name: 'Service Desk', vcfPhone: '555-1234');
$expectedBody = [
'attachments' => [
[
'type' => 'contact',
'payload' => [
'name' => 'Service Desk',
'contact_id' => null,
'vcf_info' => null,
'vcf_phone' => '555-1234',
],
],
],
'notify' => true,
];
$expectedQuery = ['chat_id' => $chatId, 'disable_link_preview' => false];
$apiResponse = [
'message' => [
'timestamp' => time(),
'body' => ['mid' => 'mid.contact.1', 'seq' => 11],
'recipient' => ['chat_type' => 'dialog', 'user_id' => $chatId],
]
];
$expectedMessageObject = Message::fromArray($apiResponse['message']);
$this->clientMock->expects($this->once())
->method('request')
->with('POST', '/messages', $expectedQuery, $expectedBody)
->willReturn($apiResponse);
$this->modelFactoryMock->expects($this->once())
->method('createMessage')
->with($apiResponse['message'])
->willReturn($expectedMessageObject);
$result = $this->api->sendMessage(chatId: $chatId, attachments: [$contactRequest]);
$this->assertSame($expectedMessageObject, $result);
}
#[Test]
public function sendMessageWithLocationAttachmentBuildsCorrectRequest(): void
{
$chatId = 12345;
$latitude = 59.9343;
$longitude = 30.3351;
$locationRequest = new LocationAttachmentRequest($latitude, $longitude);
$expectedBody = [
'attachments' => [
[
'type' => 'location',
'payload' => [
'latitude' => $latitude,
'longitude' => $longitude,
],
],
],
'notify' => true,
];
$expectedQuery = ['chat_id' => $chatId, 'disable_link_preview' => false];
$apiResponse = [
'message' => [
'timestamp' => time(),
'body' => ['mid' => 'mid.location.1', 'seq' => 12],
'recipient' => ['chat_type' => 'dialog', 'user_id' => $chatId],
]
];
$expectedMessageObject = Message::fromArray($apiResponse['message']);
$this->clientMock->expects($this->once())
->method('request')
->with('POST', '/messages', $expectedQuery, $expectedBody)
->willReturn($apiResponse);
$this->modelFactoryMock->expects($this->once())
->method('createMessage')
->with($apiResponse['message'])
->willReturn($expectedMessageObject);
$result = $this->api->sendMessage(chatId: $chatId, attachments: [$locationRequest]);
$this->assertSame($expectedMessageObject, $result);
}
#[Test]
public function sendMessageWithShareAttachmentBuildsCorrectRequest(): void
{
$chatId = 12345;
$url = 'https://dev.max.ru';
$shareRequest = ShareAttachmentRequest::fromUrl($url);
$expectedBody = [
'attachments' => [
[
'type' => 'share',
'payload' => [
'url' => $url,
'token' => null,
],
],
],
'notify' => true,
];
$expectedQuery = ['chat_id' => $chatId, 'disable_link_preview' => false];
$apiResponse = [
'message' => [
'timestamp' => time(),
'body' => ['mid' => 'mid.share.1', 'seq' => 13],
'recipient' => ['chat_type' => 'dialog', 'user_id' => $chatId],
]
];
$expectedMessageObject = Message::fromArray($apiResponse['message']);
$this->clientMock->expects($this->once())
->method('request')
->with('POST', '/messages', $expectedQuery, $expectedBody)
->willReturn($apiResponse);
$this->modelFactoryMock->expects($this->once())
->method('createMessage')
->with($apiResponse['message'])
->willReturn($expectedMessageObject);
$result = $this->api->sendMessage(chatId: $chatId, attachments: [$shareRequest]);
$this->assertSame($expectedMessageObject, $result);
}
#[Test]
public function getChatsPassesAllParametersToClient(): void
{
$count = 30;
$marker = 12345;
$expectedQuery = ['count' => $count, 'marker' => $marker];
$rawResponse = ['chats' => [], 'marker' => 54321];
$expectedChatList = new ChatList([], 54321);
$this->clientMock->expects($this->once())
->method('request')
->with('GET', '/chats', $expectedQuery)
->willReturn($rawResponse);
$this->modelFactoryMock->expects($this->once())
->method('createChatList')
->with($rawResponse)
->willReturn($expectedChatList);
$result = $this->api->getChats($count, $marker);
$this->assertSame($expectedChatList, $result);
}
#[Test]
public function getChatsHandlesNullParametersCorrectly(): void
{
$expectedQuery = [];
$rawResponse = ['chats' => [], 'marker' => null];
$expectedChatList = new ChatList([], null);
$this->clientMock->expects($this->once())
->method('request')
->with('GET', '/chats', $expectedQuery)
->willReturn($rawResponse);
$this->modelFactoryMock->expects($this->once())
->method('createChatList')
->with($rawResponse)
->willReturn($expectedChatList);
$result = $this->api->getChats(null, null);
$this->assertSame($expectedChatList, $result);
}
#[Test]
public function getChatByLinkCallsClientAndFactoryCorrectly(): void
{
$chatLink = '@test_channel';
$rawResponseData = [
'chat_id' => 987,
'type' => 'channel',
'status' => 'active',
'last_event_time' => 1,
'participants_count' => 100,
'is_public' => true,
'title' => 'Test Channel',
];
$expectedChatObject = Chat::fromArray($rawResponseData);
$this->clientMock
->expects($this->once())
->method('request')
->with('GET', '/chats/' . $chatLink)
->willReturn($rawResponseData);
$this->modelFactoryMock
->expects($this->once())
->method('createChat')
->with($rawResponseData)
->willReturn($expectedChatObject);
$result = $this->api->getChatByLink($chatLink);
$this->assertSame($expectedChatObject, $result);
}
#[Test]
public function getChatByLinkHandlesLinkWithoutAtSymbol(): void
{
$chatLink = 'test_channel_no_at';
$rawResponseData = [
'chat_id' => 987,
'type' => 'channel',
'status' => 'active',
'last_event_time' => 1,
'participants_count' => 100,
'is_public' => true,
'title' => 'Test Channel',
];
$expectedChatObject = Chat::fromArray($rawResponseData);
$this->clientMock->method('request')->willReturn($rawResponseData);
$this->modelFactoryMock->method('createChat')->willReturn($expectedChatObject);
$this->api->getChatByLink($chatLink);
$this->expectNotToPerformAssertions();
}
#[Test]
public function deleteChatCallsClientAndFactoryCorrectly(): void
{
$chatId = 123456789;
$rawResponseData = ['success' => true, 'message' => null];
$expectedResultObject = new Result(true, null);
$this->clientMock
->expects($this->once())
->method('request')
->with(self::equalTo('DELETE'), self::equalTo('/chats/' . $chatId))
->willReturn($rawResponseData);
$this->modelFactoryMock
->expects($this->once())
->method('createResult')
->with($rawResponseData)
->willReturn($expectedResultObject);
$result = $this->api->deleteChat($chatId);
$this->assertSame($expectedResultObject, $result);
$this->assertTrue($result->success);
}
#[Test]
public function sendActionCallsClientCorrectly(): void
{
$chatId = 12345;
$action = SenderAction::TypingOn;
$uri = '/chats/' . $chatId . '/actions';
$expectedBody = ['action' => 'typing_on'];
$rawResponse = ['success' => true];
$expectedResult = new Result(true, null);
$this->clientMock
->expects($this->once())
->method('request')
->with(self::equalTo('POST'), self::equalTo($uri), self::equalTo([]), self::equalTo($expectedBody))
->willReturn($rawResponse);
$this->modelFactoryMock
->expects($this->once())
->method('createResult')
->with($rawResponse)
->willReturn($expectedResult);
$result = $this->api->sendAction($chatId, $action);
$this->assertSame($expectedResult, $result);
}
}