def test_403_quota_exceeded_error(self, mocked_sleep, mocked_access_token,
mocked_request):
json = {
"error": {
"code":
403,
"message":
"Search Analytics load quota exceeded. Learn about usage limits: https://developers.google.com/webmaster-tools/v3/limits.",
"errors": [{
"message":
"Search Analytics load quota exceeded. Learn about usage limits: https://developers.google.com/webmaster-tools/v3/limits.",
"domain": "usageLimits",
"reason": "quotaExceeded"
}]
}
}
mocked_request.return_value = get_response(403, json, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.request("")
except client.GoogleQuotaExceededError as e:
self.assertEquals(
str(e), "HTTP-error-code: 403, Error: {}".format(
json["error"]["message"]))
# QuotaExceede 403 error so 2 retries
self.assertEquals(mocked_request.call_count, 2)
mocked_sleep.assert_called_with(900)
def test_404_error_in_response(self, mocked_access_token, mocked_request):
json = {
'error': {
'code':
404,
'message':
"'https://demo310799.000webhostapp1.com' is not a verified Search Console site in this account.",
'errors': [{
'message':
"'https://demo310799.000webhostapp1.com' is not a verified Search Console site in this account.",
'domain': 'global',
'reason': 'notFound',
'location': 'siteUrl',
'locationType': 'parameter'
}]
}
}
mocked_request.return_value = get_response(404, json, True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.request("")
except client.GoogleNotFoundError as e:
self.assertEquals(
str(e), "HTTP-error-code: 404, Error: {}".format(
json["error"]["message"]))
def test_error_with_empty_response(self, mocked_request):
mocked_request.return_value = get_response(400,
raise_error=True,
content='')
google_client = client.GoogleClient("", "", "", "")
with self.assertRaises(client.GoogleError):
google_client.get_access_token()
def test_200_success(self, mocked_logger, mocked_request):
json = {"access_token": "googlesearchconsole", "expires_in": 1}
mocked_request.return_value = get_response(200, json=json)
google_client = client.GoogleClient("", "", "", "")
google_client.get_access_token()
self.assertEquals(mocked_logger.call_count, 1)
def test_timeout_error__request(self, mocked_request, mocked_sleep):
# mock request and raise the 'Timeout' error
mocked_request.side_effect = requests.Timeout
config = {
"client_id": "test_client_id",
"client_secret": "test_client_secret",
"refresh_token": "test_refresh_token",
"site_urls": "www.test.com",
"start_date": "2021-01-01T00:00:00Z",
"user_agent": "test_user_agent"
}
# initialize 'GoogleClient'
cl = client.GoogleClient(
config['client_id'],
config['client_secret'],
config['refresh_token'],
config['site_urls'],
user_agent=config['user_agent'],
timeout_from_config=config.get('request_timeout'))
try:
# function call
cl.request('GET')
except requests.Timeout:
pass
# verify that we backoff for 5 times
self.assertEquals(mocked_request.call_count, 5)
def test_200_success(self, mocked_access_token, mocked_request):
json = {"key": "value", "tap": "google search console"}
mocked_request.return_value = get_response(200, json)
google_client = client.GoogleClient("", "", "", "")
response = google_client.request("")
self.assertEquals(json, response)
def test_connection_error__get_access_token(self, mocked_request,
mocked_sleep):
# mock request and raise the 'ConnectionError' error
mocked_request.side_effect = requests.ConnectionError
config = {
"client_id": "test_client_id",
"client_secret": "test_client_secret",
"refresh_token": "test_refresh_token",
"site_urls": "www.test.com",
"start_date": "2021-01-01T00:00:00Z",
"user_agent": "test_user_agent"
}
# initialize 'GoogleClient'
try:
with client.GoogleClient(
config['client_id'],
config['client_secret'],
config['refresh_token'],
config['site_urls'],
user_agent=config['user_agent'],
timeout_from_config=config.get('request_timeout')) as cl:
pass
except requests.ConnectionError:
pass
# verify that we backoff for 5 times
self.assertEquals(mocked_request.call_count, 5)
def test_sites_access_valid(self, mocked_get_token, mocked_request):
# Access token is valid and enough permission for site access
mocked_request.return_value = get_mock_http_response(
200, '{"success": {"code": 200}}')
sites = "https://example.com, https://www.example.com"
gsc_client = client_.GoogleClient('', '', '', sites, '')
gsc_client.check_sites_access()
self.assertEqual(mocked_request.call_count, 2)
def test_429_error(self, mocked_request):
mocked_request.return_value = get_response(429, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GoogleRateLimitExceeded as e:
self.assertEquals(
str(e),
"HTTP-error-code: 429, Error: Rate limit has been exceeded.")
def test_sites_invalid_creds(self, mocked_get_token, mocked_request):
# Access token is invalid for site query request
mocked_request.return_value = get_mock_http_response(
401, '{"error": {"code": 401}}')
sites = "https://example.com, https://www.example.com"
gsc_client = client_.GoogleClient('', '', '', sites, '')
with self.assertRaises(client_.GoogleUnauthorizedError):
gsc_client.check_sites_access()
self.assertEqual(mocked_request.call_count, 1)
def test_413_error(self, mocked_request):
mocked_request.return_value = get_response(413, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GoogleRequestEntityTooLargeError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 413, Error: The request is too large.")
def test_sites_access_forbidden(self, mocked_get_token, mocked_request):
# Site is not valid or not accessible for user
mocked_request.return_value = get_mock_http_response(
403, '{"error": {"code": 403}}')
sites = "https://example.com"
gsc_client = client_.GoogleClient('', '', '', sites, '')
with self.assertRaises(client_.GoogleForbiddenError):
gsc_client.check_sites_access()
self.assertEqual(mocked_request.call_count, 1)
def test_428_error(self, mocked_request):
mocked_request.return_value = get_response(428, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GooglePreconditionRequiredError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 428, Error: The request requires a precondition If-Match or If-None-Match which is not provided."
)
def test_403_error(self, mocked_request):
mocked_request.return_value = get_response(403, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GoogleForbiddenError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 403, Error: Invalid authorization credentials or permissions."
)
def test_417_error(self, mocked_request):
mocked_request.return_value = get_response(417, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GoogleExpectationFailedError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 417, Error: A client expectation cannot be met by the server."
)
def test_416_error(self, mocked_request):
mocked_request.return_value = get_response(416, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GoogleRequestedRangeNotSatisfiableError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 416, Error: The request specified a range that cannot be satisfied."
)
def test_412_error(self, mocked_request):
mocked_request.return_value = get_response(412, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GooglePreconditionFailedError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 412, Error: The condition set in the request's If-Match or If-None-Match HTTP request header was not met."
)
def test_410_error(self, mocked_request):
mocked_request.return_value = get_response(410, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GoogleGoneError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 410, Error: The requested resource is permanently unavailable."
)
def test_409_error(self, mocked_request):
mocked_request.return_value = get_response(409, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GoogleConflictError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 409, Error: The API request cannot be completed because the requested operation would conflict with an existing item."
)
def test_405_error(self, mocked_request):
mocked_request.return_value = get_response(405, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GoogleMethodNotAllowedError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 405, Error: The HTTP method associated with the request is not supported."
)
def test_404_error(self, mocked_request):
mocked_request.return_value = get_response(404, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GoogleNotFoundError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 404, Error: The requested resource does not exist."
)
def test_422_error(self, mocked_request):
mocked_request.return_value = get_response(422, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GoogleUnprocessableEntityError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 422, Error: The request was not able to process right now."
)
def test_400_error(self, mocked_access_token, mocked_request):
mocked_request.return_value = get_response(400, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.request("")
except client.GoogleBadRequestError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 400, Error: The request is missing or has bad parameters."
)
def test_402_error(self, mocked_access_token, mocked_request):
mocked_request.return_value = get_response(402, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.request("")
except client.GooglePaymentRequiredError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 402, Error: The requested operation requires more resources than the quota allows. Payment is required to complete the operation."
)
def test_sites_access_token_failed_400(self, mocked_data_request,
mocked_access_token_post_request):
# Invalid refresh token for access token request
mocked_access_token_post_request.return_value = get_mock_http_response(
400, '{"error": {"code": 400}}')
sites = "https://example.com"
gsc_client = client_.GoogleClient('', '', '', sites, '')
with self.assertRaises(client_.GoogleBadRequestError):
gsc_client.check_sites_access()
self.assertEqual(mocked_data_request.call_count, 0)
def test_401_error(self, mocked_access_token, mocked_request):
mocked_request.return_value = get_response(401, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.request("")
except client.GoogleUnauthorizedError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 401, Error: Invalid authorization credentials."
)
def test_sites_access_token_success(self, mocked_data_request,
mocked_access_token_post_request):
# Valid credentials for access token request
mocked_access_token_post_request.return_value = get_mock_http_response(
200, '{"access_token" : "abc", "expires_in" : 100}')
mocked_data_request.return_value = get_mock_http_response(
200, '{"success": {"code": 200}}')
sites = "https://example.com"
gsc_client = client_.GoogleClient('', '', '', sites, '')
gsc_client.check_sites_access()
self.assertEqual(mocked_data_request.call_count, 1)
def test_501_error(self, mocked_sleep, mocked_request):
mocked_request.return_value = get_response(501, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GoogleNotImplementedError as e:
self.assertEquals(
str(e),
"HTTP-error-code: 501, Error: Functionality does not exist.")
# on 5xx error function backoff and retries 5 times
self.assertEquals(mocked_request.call_count, 5)
def test_401_error_in_response(self, mocked_access_token, mocked_request):
json = {
'error': 'invalid_client',
'error_description': 'The OAuth client was not found.'
}
mocked_request.return_value = get_response(401, json, True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.request("")
except client.GoogleUnauthorizedError as e:
self.assertEquals(
str(e), "HTTP-error-code: 401, Error: {}".format(
json["error_description"]))
def test_503_error(self, mocked_sleep, mocked_request):
mocked_request.return_value = get_response(503, raise_error=True)
google_client = client.GoogleClient("", "", "", "")
try:
google_client.get_access_token()
except client.GoogleServiceUnavailable as e:
self.assertEquals(
str(e),
"HTTP-error-code: 503, Error: The API service is currently unavailable."
)
# on 5xx error function backoff and retries 5 times
self.assertEquals(mocked_request.call_count, 5)
