# Copyright 2017 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Tests for firebase_admin._http_client.""" import pytest from pytest_localserver import plugin import requests from firebase_admin import _http_client from tests import testutils # Fixture for mocking a HTTP server httpserver = plugin.httpserver _TEST_URL = 'http://firebase.test.url/' def test_http_client_default_session(): client = _http_client.HttpClient() assert client.session is not None assert client.base_url == '' recorder = _instrument(client, 'body') resp = client.request('get', _TEST_URL) assert resp.status_code == 200 assert resp.text == 'body' assert len(recorder) == 1 assert recorder[0].method == 'GET' assert recorder[0].url == _TEST_URL def test_http_client_custom_session(): session = requests.Session() client = _http_client.HttpClient(session=session) assert client.session is session assert client.base_url == '' recorder = _instrument(client, 'body') resp = client.request('get', _TEST_URL) assert resp.status_code == 200 assert resp.text == 'body' assert len(recorder) == 1 assert recorder[0].method == 'GET' assert recorder[0].url == _TEST_URL def test_base_url(): client = _http_client.HttpClient(base_url=_TEST_URL) assert client.session is not None assert client.base_url == _TEST_URL recorder = _instrument(client, 'body') resp = client.request('get', 'foo') assert resp.status_code == 200 assert resp.text == 'body' assert len(recorder) == 1 assert recorder[0].method == 'GET' assert recorder[0].url == _TEST_URL + 'foo' def test_credential(): client = _http_client.HttpClient( credential=testutils.MockGoogleCredential()) assert client.session is not None recorder = _instrument(client, 'body') resp = client.request('get', _TEST_URL) assert resp.status_code == 200 assert resp.text == 'body' assert len(recorder) == 1 assert recorder[0].method == 'GET' assert recorder[0].url == _TEST_URL assert recorder[0].headers['Authorization'] == 'Bearer mock-token' def _instrument(client, payload, status=200): recorder = [] adapter = testutils.MockAdapter(payload, status, recorder) client.session.mount(_TEST_URL, adapter) return recorder class TestHttpRetry(object): """Unit tests for the default HTTP retry configuration.""" ENTITY_ENCLOSING_METHODS = ['post', 'put', 'patch'] ALL_METHODS = ENTITY_ENCLOSING_METHODS + ['get', 'delete', 'head', 'options'] @classmethod def setup_class(cls): # Turn off exponential backoff for faster execution _http_client.DEFAULT_RETRY_CONFIG.backoff_factor = 0 @pytest.mark.parametrize('method', ALL_METHODS) def test_retry_on_503(self, httpserver, method): httpserver.serve_content({}, 503) client = _http_client.JsonHttpClient( credential=testutils.MockGoogleCredential(), base_url=httpserver.url) body = None if method in self.ENTITY_ENCLOSING_METHODS: body = {'key': 'value'} with pytest.raises(requests.exceptions.HTTPError) as excinfo: client.request(method, '/', json=body) assert excinfo.value.response.status_code == 503 assert len(httpserver.requests) == 5 @pytest.mark.parametrize('method', ALL_METHODS) def test_retry_on_500(self, httpserver, method): httpserver.serve_content({}, 500) client = _http_client.JsonHttpClient( credential=testutils.MockGoogleCredential(), base_url=httpserver.url) body = None if method in self.ENTITY_ENCLOSING_METHODS: body = {'key': 'value'} with pytest.raises(requests.exceptions.HTTPError) as excinfo: client.request(method, '/', json=body) assert excinfo.value.response.status_code == 500 assert len(httpserver.requests) == 5 def test_no_retry_on_404(self, httpserver): httpserver.serve_content({}, 404) client = _http_client.JsonHttpClient( credential=testutils.MockGoogleCredential(), base_url=httpserver.url) with pytest.raises(requests.exceptions.HTTPError) as excinfo: client.request('get', '/') assert excinfo.value.response.status_code == 404 assert len(httpserver.requests) == 1