Skip to content

Commit 5ef65b2

Browse files
yndu13yndu13
committed
feat: support inner credentials client for RAM role arn
1 parent 11db11a commit 5ef65b2

File tree

8 files changed

+152
-70
lines changed

8 files changed

+152
-70
lines changed

‎.phpunit.result.cache‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"version":1,"defects":{"AlibabaCloud\\Client\\Tests\\Unit\\Credentials\\Providers\\RamRoleArnProviderTest::testAccessKeyIdEmpty":3,"AlibabaCloud\\Client\\Tests\\Unit\\Credentials\\RamRoleArnCredentialTest::testClient":3},"times":{"AlibabaCloud\\Client\\Tests\\Unit\\Credentials\\Providers\\RamRoleArnProviderTest::testAccessKeyIdEmpty":0.009,"AlibabaCloud\\Client\\Tests\\Unit\\Credentials\\Providers\\RamRoleArnProviderTest::testAccessKeyIdFormat":0,"AlibabaCloud\\Client\\Tests\\Unit\\Credentials\\Providers\\RamRoleArnProviderTest::testAccessKeySecretEmpty":0,"AlibabaCloud\\Client\\Tests\\Unit\\Credentials\\Providers\\RamRoleArnProviderTest::testAccessKeySecretFormat":0,"AlibabaCloud\\Client\\Tests\\Unit\\Credentials\\Providers\\RamRoleArnProviderTest::testGet":0.077,"AlibabaCloud\\Client\\Tests\\Unit\\Credentials\\Providers\\RamRoleArnProviderTest::testGetInCache":0.001,"AlibabaCloud\\Client\\Tests\\Unit\\Credentials\\Providers\\RamRoleArnProviderTest::testNoCredentials":0.002,"AlibabaCloud\\Client\\Tests\\Unit\\Credentials\\Providers\\RamRoleArnProviderTest::testOk":0,"AlibabaCloud\\Client\\Tests\\Unit\\Credentials\\RamRoleArnCredentialTest::testConstruct":0.004,"AlibabaCloud\\Client\\Tests\\Unit\\Credentials\\RamRoleArnCredentialTest::testClient":0.005}}

‎src/Clients/Client.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class Client
3232
/**
3333
* @var CredentialsInterface|AccessKeyCredential|BearerTokenCredential|StsCredential|EcsRamRoleCredential|RamRoleArnCredential|RsaKeyPairCredential
3434
*/
35-
private $credential;
35+
protected $credential;
3636

3737
/**
3838
* @var SignatureInterface

‎src/Clients/RamRoleArnClient.php‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,17 @@ public function __construct($accessKeyId, $accessKeySecret, $roleArn, $roleSessi
3030
new ShaHmac1Signature()
3131
);
3232
}
33+
34+
/**
35+
* @param string $clientName
36+
*
37+
* @return $this
38+
* @throws ClientException
39+
*/
40+
public function withCredentialClient($clientName)
41+
{
42+
$this->credential = $this->credential->withClient($clientName);
43+
44+
return $this;
45+
}
3346
}

‎src/Credentials/Providers/RamRoleArnProvider.php‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
use AlibabaCloud\Client\Exception\ClientException;
1111
use AlibabaCloud\Client\Exception\ServerException;
1212
use AlibabaCloud\Client\Credentials\Requests\AssumeRole;
13+
use AlibabaCloud\Client\Filter\CredentialFilter;
1314

1415
/**
1516
* Class RamRoleArnProvider
@@ -68,11 +69,15 @@ private function request($timeout, $connectTimeout)
6869
{
6970
$clientName = __CLASS__ . \uniqid('ak', true);
7071
$credential = $this->client->getCredential();
71-
72-
AlibabaCloud::accessKeyClient(
73-
$credential->getAccessKeyId(),
74-
$credential->getAccessKeySecret()
75-
)->name($clientName);
72+
if (!is_null($credential->getClient())) {
73+
$clientName = $credential->getClient();
74+
} else {
75+
CredentialFilter::AccessKey($credential->getAccessKeyId(), $credential->getAccessKeySecret());
76+
AlibabaCloud::accessKeyClient(
77+
$credential->getAccessKeyId(),
78+
$credential->getAccessKeySecret()
79+
)->name($clientName);
80+
}
7681

7782
return (new AssumeRole($credential))
7883
->client($clientName)

‎src/Credentials/RamRoleArnCredential.php‎

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
namespace AlibabaCloud\Client\Credentials;
44

5-
use AlibabaCloud\Client\Filter\CredentialFilter;
5+
use AlibabaCloud\Client\AlibabaCloud;
66
use AlibabaCloud\Client\Exception\ClientException;
77

88
/**
@@ -13,6 +13,11 @@
1313
class RamRoleArnCredential implements CredentialsInterface
1414
{
1515

16+
/**
17+
* @var string
18+
*/
19+
private $client;
20+
1621
/**
1722
* @var string
1823
*/
@@ -51,15 +56,26 @@ class RamRoleArnCredential implements CredentialsInterface
5156
*/
5257
public function __construct($accessKeyId, $accessKeySecret, $roleArn, $roleSessionName, $policy = '')
5358
{
54-
CredentialFilter::AccessKey($accessKeyId, $accessKeySecret);
55-
5659
$this->accessKeyId = $accessKeyId;
5760
$this->accessKeySecret = $accessKeySecret;
5861
$this->roleArn = $roleArn;
5962
$this->roleSessionName = $roleSessionName;
6063
$this->policy = $policy;
6164
}
6265

66+
/**
67+
* @param string $clientName
68+
*
69+
* @return $this
70+
* @throws ClientException
71+
*/
72+
public function withClient($clientName)
73+
{
74+
$this->client = $clientName;
75+
76+
return $this;
77+
}
78+
6379
/**
6480
* @return string
6581
*/
@@ -76,6 +92,14 @@ public function getAccessKeySecret()
7692
return $this->accessKeySecret;
7793
}
7894

95+
/**
96+
* @return string
97+
*/
98+
public function getClient()
99+
{
100+
return $this->client;
101+
}
102+
79103
/**
80104
* @return string
81105
*/
@@ -105,6 +129,12 @@ public function getPolicy()
105129
*/
106130
public function __toString()
107131
{
108-
return "$this->accessKeyId#$this->accessKeySecret#$this->roleArn#$this->roleSessionName";
132+
$accessKeyId = $this->accessKeyId;
133+
$accessKeySecret = $this->accessKeySecret;
134+
if (!is_null($this->client)) {
135+
$accessKeyId = AlibabaCloud::get($this->client)->getCredential()->getAccessKeyId();
136+
$accessKeySecret = AlibabaCloud::get($this->client)->getCredential()->getAccessKeySecret();
137+
}
138+
return "$accessKeyId#$accessKeySecret#$this->client#$this->roleArn#$this->roleSessionName";
109139
}
110140
}

‎tests/Unit/Credentials/Providers/ProviderTest.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ public function key()
7878
],
7979
[
8080
new RamRoleArnClient('foo', 'bar', 'arn', 'name'),
81-
'foo#bar#arn#name',
81+
'foo#bar##arn#name',
8282
],
8383
[
8484
new RsaKeyPairClient('foo', VirtualRsaKeyPairCredential::ok()),

‎tests/Unit/Credentials/Providers/RamRoleArnProviderTest.php‎

Lines changed: 72 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,78 @@ protected function finalize()
3131
AlibabaCloud::cancelMock();
3232
}
3333

34+
/**
35+
* @throws ClientException
36+
*/
37+
public function testAccessKeyIdEmpty()
38+
{
39+
$this->expectException(ClientException::class);
40+
$this->expectExceptionMessage('AccessKey ID cannot be empty');
41+
// Setup
42+
$client = new RamRoleArnClient(
43+
'',
44+
'access_key_secret',
45+
'role_arn',
46+
'role_session_name'
47+
);
48+
$provider = new RamRoleArnProvider($client);
49+
$provider->get();
50+
}
51+
52+
/**
53+
* @throws ClientException
54+
*/
55+
public function testAccessKeyIdFormat()
56+
{
57+
$this->expectException(ClientException::class);
58+
$this->expectExceptionMessage('AccessKey ID must be a string');
59+
// Setup
60+
$client = new RamRoleArnClient(
61+
null,
62+
'access_key_secret',
63+
'role_arn',
64+
'role_session_name'
65+
);
66+
$provider = new RamRoleArnProvider($client);
67+
$provider->get();
68+
}
69+
70+
/**
71+
* @throws ClientException
72+
*/
73+
public function testAccessKeySecretEmpty()
74+
{
75+
$this->expectException(ClientException::class);
76+
$this->expectExceptionMessage('AccessKey Secret cannot be empty');
77+
// Setup
78+
$client = new RamRoleArnClient(
79+
'access_key_id',
80+
'',
81+
'role_arn',
82+
'role_session_name'
83+
);
84+
$provider = new RamRoleArnProvider($client);
85+
$provider->get();
86+
}
87+
88+
/**
89+
* @throws ClientException
90+
*/
91+
public function testAccessKeySecretFormat()
92+
{
93+
$this->expectException(ClientException::class);
94+
$this->expectExceptionMessage('AccessKey Secret must be a string');
95+
// Setup
96+
$client = new RamRoleArnClient(
97+
'access_key_id',
98+
null,
99+
'role_arn',
100+
'role_session_name'
101+
);
102+
$provider = new RamRoleArnProvider($client);
103+
$provider->get();
104+
}
105+
34106
/**
35107
* @throws ClientException
36108
*/
@@ -54,7 +126,6 @@ public function testGet()
54126
} catch (ServerException $e) {
55127
self::assertEquals('InvalidAccessKeyId.NotFound', $e->getErrorCode());
56128
}
57-
58129
}
59130

60131
/**
@@ -91,7 +162,6 @@ public function testGetInCache()
91162

92163
// Assert
93164
self::assertInstanceOf(StsCredential::class, $actual);
94-
95165
}
96166

97167
/**
@@ -108,7 +178,6 @@ public function testNoCredentials()
108178

109179
$provider = new RamRoleArnProvider($client);
110180
$provider->get();
111-
112181
}
113182

114183
/**
@@ -140,7 +209,5 @@ public function testOk()
140209
$provider = new RamRoleArnProvider($client);
141210
$credential = $provider->get();
142211
self::assertInstanceOf(StsCredential::class, $credential);
143-
144212
}
145-
146213
}

‎tests/Unit/Credentials/RamRoleArnCredentialTest.php‎

Lines changed: 20 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
namespace AlibabaCloud\Client\Tests\Unit\Credentials;
44

55
use PHPUnit\Framework\TestCase;
6+
use AlibabaCloud\Client\AlibabaCloud;
67
use AlibabaCloud\Client\Exception\ClientException;
78
use AlibabaCloud\Client\Credentials\RamRoleArnCredential;
89

@@ -38,76 +39,41 @@ public function testConstruct()
3839
$this->assertEquals($sessionName, $credential->getRoleSessionName());
3940
$this->assertEquals($policy, $credential->getPolicy());
4041
$this->assertEquals(
41-
"$accessKeyId#$accessKeySecret#$arn#$sessionName",
42+
"$accessKeyId#$accessKeySecret##$arn#$sessionName",
4243
(string)$credential
4344
);
4445
}
4546

4647
/**
4748
* @throws ClientException
4849
*/
49-
public function testAccessKeyIdEmpty()
50+
public function testClient()
5051
{
51-
$this->expectException(ClientException::class);
52-
$this->expectExceptionMessage('AccessKey ID cannot be empty');
5352
// Setup
54-
$accessKeyId = '';
53+
$accessKeyId = 'access_key_id';
5554
$accessKeySecret = 'access_key_secret';
5655
$arn = 'role_arn';
5756
$sessionName = 'role_session_name';
57+
$policy = '';
5858

59-
// Test
60-
new RamRoleArnCredential($accessKeyId, $accessKeySecret, $arn, $sessionName);
61-
}
62-
63-
/**
64-
* @throws ClientException
65-
*/
66-
public function testAccessKeyIdFormat()
67-
{
68-
$this->expectException(ClientException::class);
69-
$this->expectExceptionMessage('AccessKey ID must be a string');
70-
// Setup
71-
$accessKeyId = null;
72-
$accessKeySecret = 'access_key_secret';
73-
$arn = 'role_arn';
74-
$sessionName = 'role_session_name';
59+
AlibabaCloud::accessKeyClient(
60+
$accessKeyId,
61+
$accessKeySecret
62+
)->name('clientName');
7563

7664
// Test
77-
new RamRoleArnCredential($accessKeyId, $accessKeySecret, $arn, $sessionName);
78-
}
79-
80-
/**
81-
* @throws ClientException
82-
*/
83-
public function testAccessKeySecretEmpty()
84-
{
85-
$this->expectException(ClientException::class);
86-
$this->expectExceptionMessage('AccessKey Secret cannot be empty');
87-
// Setup
88-
$accessKeyId = 'access_key_id';
89-
$accessKeySecret = '';
90-
$arn = 'role_arn';
91-
$sessionName = 'role_session_name';
65+
$credential = (new RamRoleArnCredential(null, null, $arn, $sessionName))->withClient('clientName');
9266

93-
// Test
94-
new RamRoleArnCredential($accessKeyId, $accessKeySecret, $arn, $sessionName);
67+
// Assert
68+
$this->assertNull($credential->getAccessKeyId());
69+
$this->assertNull($credential->getAccessKeySecret());
70+
$this->assertEquals($arn, $credential->getRoleArn());
71+
$this->assertEquals($sessionName, $credential->getRoleSessionName());
72+
$this->assertEquals($policy, $credential->getPolicy());
73+
$this->assertEquals(
74+
"$accessKeyId#$accessKeySecret#clientName#$arn#$sessionName",
75+
(string)$credential
76+
);
9577
}
9678

97-
/**
98-
* @throws ClientException
99-
*/
100-
public function testAccessKeySecretFormat()
101-
{
102-
$this->expectException(ClientException::class);
103-
$this->expectExceptionMessage('AccessKey Secret must be a string');
104-
// Setup
105-
$accessKeyId = 'access_key_id';
106-
$accessKeySecret = null;
107-
$arn = 'role_arn';
108-
$sessionName = 'role_session_name';
109-
110-
// Test
111-
new RamRoleArnCredential($accessKeyId, $accessKeySecret, $arn, $sessionName);
112-
}
11379
}

0 commit comments

Comments
 (0)