ClientTraitTest.php 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666
  1. <?php
  2. namespace AlibabaCloud\Client\Tests\Unit\Traits;
  3. use AlibabaCloud\Client\SDK;
  4. use PHPUnit\Framework\TestCase;
  5. use AlibabaCloud\Client\AlibabaCloud;
  6. use AlibabaCloud\Client\Credentials\StsCredential;
  7. use AlibabaCloud\Client\Exception\ClientException;
  8. use AlibabaCloud\Client\Signature\ShaHmac1Signature;
  9. use AlibabaCloud\Client\Credentials\AccessKeyCredential;
  10. use AlibabaCloud\Client\Credentials\EcsRamRoleCredential;
  11. use AlibabaCloud\Client\Credentials\RamRoleArnCredential;
  12. use AlibabaCloud\Client\Credentials\RsaKeyPairCredential;
  13. use AlibabaCloud\Client\Credentials\BearerTokenCredential;
  14. use AlibabaCloud\Client\Signature\ShaHmac256WithRsaSignature;
  15. use AlibabaCloud\Client\Tests\Unit\Credentials\Ini\VirtualAccessKeyCredential;
  16. use AlibabaCloud\Client\Tests\Unit\Credentials\Ini\VirtualRsaKeyPairCredential;
  17. /**
  18. * Class ClientTraitTest
  19. *
  20. * @package AlibabaCloud\Client\Tests\Unit\Client\Traits
  21. *
  22. * @coversDefaultClass \AlibabaCloud\Client\Traits\ClientTrait
  23. */
  24. class ClientTraitTest extends TestCase
  25. {
  26. /**
  27. * @before
  28. */
  29. public function initialize()
  30. {
  31. parent::setUp();
  32. self::$regionId = 'cn-hangzhou';
  33. self::$accessKeyId = \getenv('ACCESS_KEY_ID');
  34. self::$accessKeySecret = \getenv('ACCESS_KEY_SECRET');
  35. self::$roleName = 'EcsRamRoleTest';
  36. self::$roleArn = 'acs:ram::1483445870618637:role/test';
  37. self::$roleSessionName = 'role_session_name';
  38. self::$bearerToken = 'BEARER_TOKEN';
  39. }
  40. /**
  41. * @var string
  42. */
  43. private static $accessKeyId;
  44. /**
  45. * @var string
  46. */
  47. private static $accessKeySecret;
  48. /**
  49. * @var string
  50. */
  51. private static $regionId;
  52. /**
  53. * @var string
  54. */
  55. private static $roleName;
  56. /**
  57. * @var string
  58. */
  59. private static $roleArn;
  60. /**
  61. * @var string
  62. */
  63. private static $roleSessionName;
  64. /**
  65. * @var string
  66. */
  67. private static $bearerToken;
  68. /**
  69. * @throws ClientException
  70. */
  71. public function testGetDefaultClient()
  72. {
  73. $this->expectException(ClientException::class);
  74. $this->expectExceptionMessage("Client 'default' not found");
  75. AlibabaCloud::flush();
  76. AlibabaCloud::getDefaultClient();
  77. }
  78. /**
  79. * @throws ClientException
  80. */
  81. public function testClient()
  82. {
  83. AlibabaCloud::client(
  84. new AccessKeyCredential('foo', 'bar'),
  85. new ShaHmac256WithRsaSignature()
  86. )->name('client');
  87. self::assertInstanceOf(ShaHmac256WithRsaSignature::class, AlibabaCloud::get('client')->getSignature());
  88. }
  89. /**
  90. * @throws ClientException
  91. */
  92. public function testAccessKeyClient()
  93. {
  94. AlibabaCloud::accessKeyClient(self::$accessKeyId, self::$accessKeyId)->asDefaultClient();
  95. $credential = AlibabaCloud::getDefaultClient()->getCredential();
  96. self::assertInstanceOf(AccessKeyCredential::class, $credential);
  97. self::assertEquals(self::$accessKeyId, $credential->getAccessKeyId());
  98. }
  99. /**
  100. * @throws ClientException
  101. */
  102. public function testAccessKeyClientWithAccessKeyIdEmpty()
  103. {
  104. $this->expectException(ClientException::class);
  105. $this->expectExceptionMessage("AccessKey ID cannot be empty");
  106. AlibabaCloud::accessKeyClient(
  107. '',
  108. self::$accessKeySecret
  109. )->asDefaultClient();
  110. }
  111. /**
  112. * @throws ClientException
  113. */
  114. public function testAccessKeyClientWithAccessKeyIdFormat()
  115. {
  116. $this->expectException(ClientException::class);
  117. $this->expectExceptionMessage("AccessKey ID format is invalid");
  118. AlibabaCloud::accessKeyClient(
  119. null,
  120. self::$accessKeySecret
  121. )->asDefaultClient();
  122. }
  123. /**
  124. * @throws ClientException
  125. */
  126. public function testAccessKeyClientWithAccessKeySecretEmpty()
  127. {
  128. $this->expectException(ClientException::class);
  129. $this->expectExceptionMessage("AccessKey Secret cannot be empty");
  130. AlibabaCloud::accessKeyClient(
  131. self::$accessKeyId,
  132. ''
  133. )->asDefaultClient();
  134. }
  135. /**
  136. * @throws ClientException
  137. */
  138. public function testAccessKeyClientWithAccessKeySecretFormat()
  139. {
  140. $this->expectException(ClientException::class);
  141. $this->expectExceptionMessage("AccessKey Secret format is invalid");
  142. AlibabaCloud::accessKeyClient(
  143. self::$accessKeyId,
  144. null
  145. )->asDefaultClient();
  146. }
  147. /**
  148. * @throws ClientException
  149. */
  150. public function testRamRoleArnClient()
  151. {
  152. AlibabaCloud::ramRoleArnClient(
  153. self::$accessKeyId,
  154. self::$accessKeySecret,
  155. self::$roleArn,
  156. self::$roleSessionName
  157. )->asDefaultClient();
  158. $credential = AlibabaCloud::getDefaultClient()->getCredential();
  159. self::assertInstanceOf(RamRoleArnCredential::class, $credential);
  160. self::assertEquals(self::$accessKeyId, $credential->getAccessKeyId());
  161. self::assertEquals(self::$accessKeySecret, $credential->getAccessKeySecret());
  162. self::assertEquals(self::$roleArn, $credential->getRoleArn());
  163. self::assertEquals(self::$roleSessionName, $credential->getRoleSessionName());
  164. }
  165. /**
  166. * @throws ClientException
  167. */
  168. public function testRamRoleArnClientWithAccessKeyIdEmpty()
  169. {
  170. $this->expectException(ClientException::class);
  171. $this->expectExceptionMessage("AccessKey ID cannot be empty");
  172. AlibabaCloud::ramRoleArnClient(
  173. '',
  174. self::$accessKeySecret,
  175. self::$roleArn,
  176. self::$roleSessionName
  177. )->asDefaultClient();
  178. }
  179. /**
  180. * @throws ClientException
  181. */
  182. public function testRamRoleArnClientWithAccessKeyIdFormat()
  183. {
  184. $this->expectException(ClientException::class);
  185. $this->expectExceptionMessage("AccessKey ID must be a string");
  186. AlibabaCloud::ramRoleArnClient(
  187. null,
  188. self::$accessKeySecret,
  189. self::$roleArn,
  190. self::$roleSessionName
  191. )->asDefaultClient();
  192. }
  193. /**
  194. * @throws ClientException
  195. */
  196. public function testRamRoleArnClientWithAccessKeySecretEmpty()
  197. {
  198. $this->expectException(ClientException::class);
  199. $this->expectExceptionMessage("AccessKey Secret cannot be empty");
  200. AlibabaCloud::ramRoleArnClient(
  201. self::$accessKeyId,
  202. '',
  203. self::$roleArn,
  204. self::$roleSessionName
  205. )->asDefaultClient();
  206. }
  207. /**
  208. * @throws ClientException
  209. */
  210. public function testRamRoleArnClientWithAccessKeySecretFormat()
  211. {
  212. $this->expectException(ClientException::class);
  213. $this->expectExceptionMessage("AccessKey Secret must be a string");
  214. AlibabaCloud::ramRoleArnClient(
  215. self::$accessKeyId,
  216. null,
  217. self::$roleArn,
  218. self::$roleSessionName
  219. )->asDefaultClient();
  220. }
  221. /**
  222. * @throws ClientException
  223. */
  224. public function testEcsRamRoleClient()
  225. {
  226. AlibabaCloud::ecsRamRoleClient(self::$roleName)->asDefaultClient();
  227. $credential = AlibabaCloud::getDefaultClient()->getCredential();
  228. self::assertInstanceOf(EcsRamRoleCredential::class, $credential);
  229. self::assertEquals(self::$roleName, $credential->getRoleName());
  230. }
  231. /**
  232. * @throws ClientException
  233. */
  234. public function testEcsRamRoleClientEmpty()
  235. {
  236. $this->expectException(ClientException::class);
  237. $this->expectExceptionMessage("Role Name cannot be empty");
  238. AlibabaCloud::ecsRamRoleClient('')->asDefaultClient();
  239. }
  240. /**
  241. * @throws ClientException
  242. */
  243. public function testEcsRamRoleClientFormat()
  244. {
  245. $this->expectException(ClientException::class);
  246. $this->expectExceptionMessage("Role Name must be a string");
  247. AlibabaCloud::ecsRamRoleClient(null)->asDefaultClient();
  248. }
  249. /**
  250. * @throws ClientException
  251. */
  252. public function testBearerTokenClient()
  253. {
  254. AlibabaCloud::bearerTokenClient(self::$bearerToken)->asDefaultClient();
  255. $credential = AlibabaCloud::getDefaultClient()->getCredential();
  256. self::assertInstanceOf(BearerTokenCredential::class, $credential);
  257. self::assertEquals('', $credential->getAccessKeyId());
  258. self::assertEquals('', $credential->getAccessKeySecret());
  259. self::assertEquals(self::$bearerToken, $credential->getBearerToken());
  260. }
  261. /**
  262. * @throws ClientException
  263. */
  264. public function testBearerTokenClientEmpty()
  265. {
  266. $this->expectException(ClientException::class);
  267. $this->expectExceptionMessage("Bearer Token cannot be empty");
  268. AlibabaCloud::bearerTokenClient('')->asDefaultClient();
  269. }
  270. /**
  271. * @throws ClientException
  272. */
  273. public function testBearerTokenClientFormat()
  274. {
  275. $this->expectException(ClientException::class);
  276. $this->expectExceptionMessage("Bearer Token must be a string");
  277. AlibabaCloud::bearerTokenClient(null)->asDefaultClient();
  278. }
  279. /**
  280. * @throws ClientException
  281. */
  282. public function testStsClient()
  283. {
  284. AlibabaCloud::stsClient('key', 'secret', 'token')->name('sts');
  285. self::assertInstanceOf(StsCredential::class, AlibabaCloud::get('sts')->getCredential());
  286. }
  287. /**
  288. * @throws ClientException
  289. */
  290. public function testStsClientWithPublicKeyIdEmpty()
  291. {
  292. $this->expectException(ClientException::class);
  293. $this->expectExceptionMessage("AccessKey ID cannot be empty");
  294. AlibabaCloud::stsClient('', 'secret')
  295. ->name('sts');
  296. }
  297. /**
  298. * @throws ClientException
  299. */
  300. public function testStsClientWithPublicKeyIdFormat()
  301. {
  302. $this->expectException(ClientException::class);
  303. $this->expectExceptionMessage("AccessKey ID must be a string");
  304. AlibabaCloud::stsClient(null, 'secret')
  305. ->name('sts');
  306. }
  307. /**
  308. * @throws ClientException
  309. */
  310. public function testStsClientWithPrivateKeyFileEmpty()
  311. {
  312. $this->expectException(ClientException::class);
  313. $this->expectExceptionMessage("AccessKey Secret cannot be empty");
  314. AlibabaCloud::stsClient('key', '')
  315. ->name('sts');
  316. }
  317. /**
  318. * @throws ClientException
  319. */
  320. public function testStsClientWithPrivateKeyFileFormat()
  321. {
  322. $this->expectException(ClientException::class);
  323. $this->expectExceptionMessage("AccessKey Secret must be a string");
  324. AlibabaCloud::stsClient('key', null)
  325. ->name('sts');
  326. }
  327. /**
  328. * @throws ClientException
  329. */
  330. public function testRsaKeyPairClient()
  331. {
  332. AlibabaCloud::rsaKeyPairClient('key', VirtualAccessKeyCredential::ok())
  333. ->name('rsa');
  334. self::assertInstanceOf(
  335. RsaKeyPairCredential::class,
  336. AlibabaCloud::get('rsa')->getCredential()
  337. );
  338. }
  339. /**
  340. * @throws ClientException
  341. */
  342. public function testRsaKeyPairClientWithPublicKeyIdEmpty()
  343. {
  344. $this->expectException(ClientException::class);
  345. $this->expectExceptionMessage("Public Key ID cannot be empty");
  346. AlibabaCloud::rsaKeyPairClient('', 'privateKeyFile')
  347. ->name('rsa');
  348. }
  349. /**
  350. * @throws ClientException
  351. */
  352. public function testRsaKeyPairClientWithPublicKeyIdFormat()
  353. {
  354. $this->expectException(ClientException::class);
  355. $this->expectExceptionMessage("Public Key ID must be a string");
  356. AlibabaCloud::rsaKeyPairClient(null, 'privateKeyFile')
  357. ->name('rsa');
  358. }
  359. /**
  360. * @throws ClientException
  361. */
  362. public function testRsaKeyPairClientWithPrivateKeyFileEmpty()
  363. {
  364. $this->expectException(ClientException::class);
  365. $this->expectExceptionMessage("Private Key File cannot be empty");
  366. AlibabaCloud::rsaKeyPairClient('publicKeyId', '')
  367. ->name('rsa');
  368. }
  369. /**
  370. * @throws ClientException
  371. */
  372. public function testRsaKeyPairClientWithPrivateKeyFileFormat()
  373. {
  374. $this->expectException(ClientException::class);
  375. $this->expectExceptionMessage("Private Key File must be a string");
  376. AlibabaCloud::rsaKeyPairClient('publicKeyId', null)
  377. ->name('rsa');
  378. }
  379. /**
  380. * @throws ClientException
  381. */
  382. public function testGet()
  383. {
  384. // setup
  385. $accessKeyId = uniqid('', true);
  386. $accessKeySecret = uniqid('', true);
  387. AlibabaCloud::accessKeyClient($accessKeyId, $accessKeySecret)->name('client1');
  388. static::assertEquals(
  389. $accessKeyId,
  390. AlibabaCloud::get('client1')->getCredential()->getAccessKeyId()
  391. );
  392. try {
  393. AlibabaCloud::get('None')->getCredential()->getAccessKeyId();
  394. } catch (ClientException $e) {
  395. static::assertEquals(SDK::CLIENT_NOT_FOUND, $e->getErrorCode());
  396. }
  397. }
  398. /**
  399. * @throws ClientException
  400. */
  401. public function testIsDebug()
  402. {
  403. $accessKeyId = uniqid('', true);
  404. $accessKeySecret = uniqid('', true);
  405. AlibabaCloud::accessKeyClient($accessKeyId, $accessKeySecret)->name('client1');
  406. AlibabaCloud::get('client1')->debug(true);
  407. self::assertTrue(AlibabaCloud::get('client1')->isDebug());
  408. }
  409. /**
  410. * @throws ClientException
  411. */
  412. public function testGetSignature()
  413. {
  414. $accessKeyId = uniqid('', true);
  415. $accessKeySecret = uniqid('', true);
  416. AlibabaCloud::accessKeyClient($accessKeyId, $accessKeySecret)->name('client1');
  417. static::assertInstanceOf(ShaHmac1Signature::class, AlibabaCloud::get('client1')->getSignature());
  418. }
  419. /**
  420. * @throws ClientException
  421. */
  422. public function testDel()
  423. {
  424. // Setup
  425. $clientName = 'test';
  426. $accessKeyId = uniqid('', true);
  427. $accessKeySecret = uniqid('', true);
  428. // Test
  429. AlibabaCloud::accessKeyClient($accessKeyId, $accessKeySecret)->name($clientName);
  430. static::assertEquals(true, AlibabaCloud::has($clientName));
  431. AlibabaCloud::del($clientName);
  432. static::assertEquals(false, AlibabaCloud::has($clientName));
  433. }
  434. /**
  435. * @throws ClientException
  436. */
  437. public function testAll()
  438. {
  439. $accessKeyId = uniqid('', true);
  440. $accessKeySecret = uniqid('', true);
  441. AlibabaCloud::accessKeyClient($accessKeyId, $accessKeySecret)->name('client1');
  442. AlibabaCloud::accessKeyClient($accessKeyId, $accessKeySecret)->name('client2');
  443. AlibabaCloud::accessKeyClient($accessKeyId, $accessKeySecret)->name('client3');
  444. static::assertArrayHasKey('client3', AlibabaCloud::all());
  445. }
  446. /**
  447. * @throws ClientException
  448. */
  449. public function testLoadWithFiles()
  450. {
  451. AlibabaCloud::load(
  452. VirtualRsaKeyPairCredential::ok(),
  453. VirtualAccessKeyCredential::ok()
  454. );
  455. static::assertNotNull(AlibabaCloud::all());
  456. }
  457. /**
  458. * @throws ClientException
  459. */
  460. public function testLoad()
  461. {
  462. AlibabaCloud::load();
  463. static::assertNotNull(AlibabaCloud::all());
  464. }
  465. /**
  466. *
  467. * @throws ClientException
  468. */
  469. public function testDelEmpty()
  470. {
  471. $this->expectException(ClientException::class);
  472. $this->expectExceptionMessage("Client Name cannot be empty");
  473. AlibabaCloud::del('');
  474. }
  475. /**
  476. *
  477. * @throws ClientException
  478. */
  479. public function testDelFormat()
  480. {
  481. $this->expectException(ClientException::class);
  482. $this->expectExceptionMessage("Client Name must be a string");
  483. AlibabaCloud::del(null);
  484. }
  485. /**
  486. *
  487. * @throws ClientException
  488. */
  489. public function testHasEmpty()
  490. {
  491. $this->expectException(ClientException::class);
  492. $this->expectExceptionMessage("Client Name cannot be empty");
  493. AlibabaCloud::has('');
  494. }
  495. /**
  496. *
  497. * @throws ClientException
  498. */
  499. public function testHasFormat()
  500. {
  501. $this->expectException(ClientException::class);
  502. $this->expectExceptionMessage("Client Name must be a string");
  503. AlibabaCloud::has(null);
  504. }
  505. /**
  506. *
  507. * @throws ClientException
  508. */
  509. public function testSetEmpty()
  510. {
  511. $this->expectException(ClientException::class);
  512. $this->expectExceptionMessage("Client Name cannot be empty");
  513. AlibabaCloud::set('', AlibabaCloud::bearerTokenClient('token'));
  514. }
  515. /**
  516. *
  517. * @throws ClientException
  518. */
  519. public function testSetFormat()
  520. {
  521. $this->expectException(ClientException::class);
  522. $this->expectExceptionMessage("Client Name must be a string");
  523. AlibabaCloud::set(null, AlibabaCloud::bearerTokenClient('token'));
  524. }
  525. /**
  526. * @throws ClientException
  527. */
  528. public function testSet()
  529. {
  530. $name = uniqid('', true);
  531. AlibabaCloud::set($name, AlibabaCloud::bearerTokenClient('token'));
  532. self::assertTrue(AlibabaCloud::has($name));
  533. AlibabaCloud::del($name);
  534. }
  535. /**
  536. *
  537. * @throws ClientException
  538. */
  539. public function testGetEmpty()
  540. {
  541. $this->expectException(ClientException::class);
  542. $this->expectExceptionMessage("Client Name cannot be empty");
  543. AlibabaCloud::get('');
  544. }
  545. /**
  546. *
  547. * @throws ClientException
  548. */
  549. public function testGetFormat()
  550. {
  551. $this->expectException(ClientException::class);
  552. $this->expectExceptionMessage("Client Name must be a string");
  553. AlibabaCloud::get(null);
  554. }
  555. /**
  556. *
  557. * @throws ClientException
  558. */
  559. public function testGetNotFound()
  560. {
  561. $this->expectException(ClientException::class);
  562. $this->expectExceptionMessage("Client 'notFound' not found");
  563. AlibabaCloud::get('notFound');
  564. }
  565. }