[#375] Switch to mocks for Functional StatusReportTest (#389)

* [#375] Switch to mocks for Functional StatusReportTest

* [#375] Switch to mocks for Functional StatusReportTest.

Co-authored-by: Arlina Espinoza <[email protected]>

Author: shadcn

tests/modules/apigee_mock_api_client/README.md

@@ -116,3 +116,9 @@ For convenience, helper methods have been added to `ApigeeMockApiClientHelperTra
 
 See [ApigeeMockApiClientHelperTrait](tests/src/Traits/ApigeeMockApiClientHelperTrait.php) for a full list of helper
 methods and documentation on usage.
+
+Notes:
+
+- This module is not currently compatible with `apigee_edge_test` or `apigee_edge_debug`, as they decorate the
+SDK connector client, and this module replaces one of the arguments (injected services). Refactored tests should not
+enable those modules.

tests/modules/apigee_mock_api_client/tests/response-templates/access-token.json.twig

@@ -0,0 +1,8 @@
+{
+  "access_token": "yeJhbGciOiJSUzI1NiJ9.eyJqdGkiOiIxNWE0ZDlmNS0xNWEyLTQ3NzYtYjg1My0zZTMxZDBjMmI5MGYiLCJzdWIiOiJmMjgzZGZlOC1mMDJhLTRkNmEtYWMyZC0zMGI1ZDQ5ZGZmNjEiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwic2NpbS5tZSIsIm9wZW5pZCIsInBhc3N3b3JkLndyaXRlIiwiYXBwcm92YWxzLm1lIiwic2NpbS5pZHMucmVhZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZjI4M2RmZTgtZjAyYS00ZDZhLWFjMmQtMzBiNWQ0OWRmZjYxIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJhcmxpbmEuZXNwaW5vemFAZ21haWwuY29tIiwiZW1haWwiOiJhcmxpbmEuZXNwaW5vemFAZ21haWwuY29tIiwiYXV0aF90aW1lIjoxNTg1Nzc2MTgxLCJhbCI6MCwicmV2X3NpZyI6Ijg5ZWU3YzFlIiwiaWF0IjoxNTg1Nzc2MTgxLCJleHAiOjE1ODU4MTkzODEsImlzcyI6Imh0dHBzOi8vbG9naW4uYXBpZ2VlLmNvbSIsInppZCI6InVhYSIsImF1ZCI6WyJlZGdlY2xpIiwic2NpbS5lbWFpbHMiLCJzY2ltIiwib3BlbmlkIiwicGFzc3dvcmQiLCJhcHByb3ZhbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.pynAmrhmFqDs8u2Oo65zZ4n7GyxumzboizgHQ0dQW4JnuHTh6sJ6wOkPhKGV-W05YoNB3z4OfkNNxAEVAmVgZHz1_lddaau52CVLFulw0vIrYExpENN17SsG8kqB0dC58OhgxAfs9Z7DrQBgOlhKOVBMIrFuEV-w8agfZyVFPioRQhJ3yNaLaK2zuwxYFWZIHOsFLaxvuKJKFp-dfMbp-zaMFhbGcOxDsxcfDDtAodP7NEHcgYmIqzJ-tZJFTALRSUXaaBQn6rUwIuCN8bumJAbKs3QrkmsGL4raXn9c5CQBwuzAa4doYK8Kr5CHHLgUKoSpDfarqZzL9WFDLCrhdf",
+  "token_type": "bearer",
+  "refresh_token": "yeJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI1M2Y1ODFiYy00ZThhLTQyZDktYjJmNi1jZTk3OGVlOWExYTYtciIsInN1YiI6ImYyODNkZmU4LWYwMmEtNGQ2YS1hYzJkLTMwYjVkNDlkZmY2MSIsInNjb3BlIjpbInNjaW0uZW1haWxzLnJlYWQiLCJzY2ltLm1lIiwib3BlbmlkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLmlkcy5yZWFkIiwib2F1dGguYXBwcm92YWxzIl0sImlhdCI6MTU4NTc3NjE4MSwiZXhwIjoxNTg4MzY4MTgxLCJjaWQiOiJlZGdlY2xpIiwiY2xpZW50X2lkIjoiZWRnZWNsaSIsImlzcyI6Imh0dHBzOi8vbG9naW4uYXBpZ2VlLmNvbSIsInppZCI6InVhYSIsImdyYW50X3R5cGUiOiJwYXNzd29yZCIsInVzZXJfbmFtZSI6ImFybGluYS5lc3Bpbm96YUBnbWFpbC5jb20iLCJvcmlnaW4iOiJ1c2VyZ3JpZCIsInVzZXJfaWQiOiJmMjgzZGZlOC1mMDJhLTRkNmEtYWMyZC0zMGI1ZDQ5ZGZmNjEiLCJhbCI6MCwicmV2X3NpZyI6Ijg5ZWU3YzFlIiwiYXVkIjpbImVkZ2VjbGkiLCJzY2ltLmVtYWlscyIsInNjaW0iLCJvcGVuaWQiLCJwYXNzd29yZCIsImFwcHJvdmFscyIsInNjaW0uaWRzIiwib2F1dGgiXX0.Jee1t2nIM8tuBPsJ41fGrIYzXnU0KLncI7oQsUbu3xirRjcvkTHq_K4jSOTAWxmj1L_URfgAWhZ9If8VWMm3ERPxGZdjb_P32xYL_wfIMK3SqNQlBMsg9dUFFM2O-i2PuciJ9IvZnPCWCM3nr5t202TYFrq5VueQOeZ_WW-R2wl_uxh4kFBjf3fD0Q_4Oy5kmDvZSMQRYWPJFIRAUEHCTpHWIuuWoRp4dLrzM2n6c75Bk0jR4Kr6WDOj03AAvllCn_-UT6JXsrfBEI8QP-qfboq0_ZqdT17rtwjFc9CvoZUHeIYjp_BOTNDFBuSpqv8qwGmTQOmMAVfjyzEpI_7M7x",
+  "expires_in": 43199,
+  "scope": "scim.emails.read scim.me openid password.write approvals.me scim.ids.read oauth.approvals",
+  "jti": "17a4d9f5-15a2-4776-b853-3e31d0c2b90i"
+}

tests/src/Functional/StatusReportTest.php

@@ -41,14 +41,22 @@ class StatusReportTest extends ApigeeEdgeFunctionalTestBase {
 
   const CANNOT_CONNECT_LONG = 'Cannot connect to Apigee Edge server. You have either given wrong credential details or the Apigee Edge server is unreachable. Visit the Apigee Edge general settings page to get more information.';
 
+  /**
+   * {@inheritdoc}
+   */
+  protected static $mock_api_client_ready = TRUE;
+
   /**
    * Tests invalid credentials.
    */
   public function testInvalidCredentials() {
+    $orgName = $this->sdkConnector->getOrganization();
+
     $this->drupalLogin($this->rootUser);
     $status_report_path = Url::fromRoute('system.status');
 
     // Ensure that pre-defined credentials are correctly set.
+    $this->stack->queueMockResponse(['org' => ['org_name' => $orgName]]);
     $this->drupalGet($status_report_path);
     $this->assertSession()->pageTextNotContains(self::CANNOT_CONNECT_SHORT);
 
@@ -82,6 +90,7 @@ public function testInvalidCredentials() {
     $key->save();
     $this->setKey('private_file');
 
+    $this->stack->queueMockResponse(['org' => ['org_name' => $orgName]]);
     $this->drupalGet($status_report_path);
     $this->assertSession()->pageTextNotContains(self::CANNOT_CONNECT_SHORT);
 
@@ -95,6 +104,7 @@ public function testInvalidCredentials() {
     ]));
     $key->save();
 
+    $this->stack->queueMockResponse(['get_not_found' => ['status_code' => 401]]);
     $this->drupalGet($status_report_path);
     $this->assertSession()->pageTextContains(self::CANNOT_CONNECT_LONG);
 
@@ -117,6 +127,8 @@ public function testInvalidCredentials() {
 
     $this->setKey('private_file_oauth');
 
+    $this->stack->queueMockResponse('access_token');
+    $this->stack->queueMockResponse(['org' => ['org_name' => $orgName]]);
     $this->drupalGet($status_report_path);
     $this->assertSession()->pageTextNotContains(self::CANNOT_CONNECT_SHORT);
 
@@ -130,6 +142,7 @@ public function testInvalidCredentials() {
     ]));
     $key->save();
 
+    $this->stack->queueMockResponse('get_not_found');
     $this->drupalGet($status_report_path);
     $this->assertSession()->pageTextContains(self::CANNOT_CONNECT_LONG);