def test_gazettes_endpoint_should_fail_with_invalid_until_value(self):
configure_api_app(self.create_mock_gazette_interface(),
MockSuggestionService())
client = TestClient(app)
response = client.get("/gazettes/4205902",
params={"until": "foo-bar-2222"})
self.assertEqual(response.status_code, 422)
def test_cities_should_return_data_returned_by_gazettes_interface(self):
configure_api_app(
self.create_mock_gazette_interface(cities_info=[
{
"territory_id": "1234",
"territory_name": "piraporia",
"state_code": "SC",
"publication_urls": ["https://querido-diario.org.br"],
"level": "1",
}
]),
MockSuggestionService(),
)
client = TestClient(app)
response = client.get("/cities", params={"city_name": "pirapo"})
self.assertEqual(response.status_code, 200)
self.assertEqual(
response.json(),
{
"cities":
[{
"territory_id": "1234",
"territory_name": "piraporia",
"state_code": "SC",
"publication_urls": ["https://querido-diario.org.br"],
"level": "1",
}]
},
)
def test_configure_api_should_failed_with_invalid_root_path(self):
configure_api_app(
MockGazetteAccessInterface(),
MockSuggestionService(),
MockCompaniesAccessInterface(),
api_root_path=1,
)
def test_cities_endpoint_should_accept_request_without_partial_city_name(
self):
configure_api_app(self.create_mock_gazette_interface(),
MockSuggestionService())
client = TestClient(app)
response = client.get("/cities", params={"city_name": "pirapo"})
self.assertEqual(response.status_code, 200)
def test_api_without_edition_and_extra_field(self):
today = date.today()
yesterday = today - timedelta(days=1)
interface = self.create_mock_gazette_interface((
2,
[
{
"territory_id": "4205902",
"date": today,
"url": "https://queridodiario.ok.org.br/",
"territory_name": "My city",
"state_code": "My state",
"is_extra_edition": False,
"edition": "12.3442",
"highlight_texts": ["test"],
},
{
"territory_id": "4205902",
"date": yesterday,
"url": "https://queridodiario.ok.org.br/",
"territory_name": "My city",
"state_code": "My state",
"highlight_texts": ["test"],
},
],
))
configure_api_app(interface, MockSuggestionService())
client = TestClient(app)
response = client.get("/gazettes/4205902")
interface.get_gazettes.assert_called_once()
self.assertEqual(interface.get_gazettes.call_args.args[0].territory_id,
"4205902")
self.assertEqual(response.status_code, 200)
self.assertEqual(
response.json(),
{
"total_gazettes":
2,
"gazettes": [
{
"territory_id": "4205902",
"date": today.strftime("%Y-%m-%d"),
"url": "https://queridodiario.ok.org.br/",
"territory_name": "My city",
"state_code": "My state",
"is_extra_edition": False,
"edition": "12.3442",
"highlight_texts": ["test"],
},
{
"territory_id": "4205902",
"date": yesterday.strftime("%Y-%m-%d"),
"url": "https://queridodiario.ok.org.br/",
"territory_name": "My city",
"state_code": "My state",
"highlight_texts": ["test"],
},
],
},
)
def test_city_endpoint_should_return_city_info_returned_by_gazettes_interface(self):
configure_api_app(
self.create_mock_gazette_interface(
city_info={
"territory_id": "1234",
"territory_name": "piraporia",
"state_code": "SC",
"publication_urls": ["https://querido-diario.org.br"],
"level": "1",
}
),
MockSuggestionService(),
MockCompaniesAccessInterface(),
)
client = TestClient(app)
response = client.get("/cities/1234")
self.assertEqual(
response.json(),
{
"city": {
"territory_id": "1234",
"territory_name": "piraporia",
"state_code": "SC",
"publication_urls": ["https://querido-diario.org.br"],
"level": "1",
}
},
)
def test_configure_api_root_path(self):
configure_api_app(
MockGazetteAccessInterface(),
MockSuggestionService(),
api_root_path="/api/v1",
)
self.assertEqual("/api/v1", app.root_path)
def test_gazettes_without_territory_endpoint__should_fail_with_invalid_since_value(
self, ):
configure_api_app(self.create_mock_gazette_interface(),
MockSuggestionService())
client = TestClient(app)
response = client.get("/gazettes", params={"since": "foo-bar-2222"})
self.assertEqual(response.status_code, 422)
def test_get_gazettes_without_territory_id_should_forward_gazettes_filters_to_interface_object(
self,
):
interface = self.create_mock_gazette_interface()
configure_api_app(
interface, MockSuggestionService(), MockCompaniesAccessInterface()
)
client = TestClient(app)
response = client.get(
"/gazettes",
params={
"since": date.today().strftime("%Y-%m-%d"),
"until": date.today().strftime("%Y-%m-%d"),
"offset": 10,
"size": 100,
},
)
self.assertEqual(response.status_code, 200)
interface.get_gazettes.assert_called_once()
self.assertIsNone(interface.get_gazettes.call_args.args[0].territory_id)
self.assertEqual(
interface.get_gazettes.call_args.args[0].since, date.today(),
)
self.assertEqual(interface.get_gazettes.call_args.args[0].until, date.today())
self.assertEqual(interface.get_gazettes.call_args.args[0].offset, 10)
self.assertEqual(interface.get_gazettes.call_args.args[0].size, 100)
def test_get_gazettes_should_request_gazettes_to_interface_object(self):
interface = self.create_mock_gazette_interface()
configure_api_app(interface, MockSuggestionService())
client = TestClient(app)
response = client.get("/gazettes/4205902")
self.assertEqual(response.status_code, 200)
interface.get_gazettes.assert_called_once()
def test_gazettes_endpoint_should_accept_query_until_date(self):
configure_api_app(self.create_mock_gazette_interface(),
MockSuggestionService())
client = TestClient(app)
response = client.get(
"/gazettes/4205902",
params={"until": date.today().strftime("%Y-%m-%d")})
self.assertEqual(response.status_code, 200)
def test_city_endpoint_should_return_404_with_city_id_not_found(self):
configure_api_app(
self.create_mock_gazette_interface(),
MockSuggestionService(),
)
client = TestClient(app)
response = client.get("/cities/1234")
self.assertEqual(response.status_code, 404)
def test_cities_should_request_data_from_gazette_interface(self):
interface = self.create_mock_gazette_interface()
configure_api_app(
interface, MockSuggestionService(), MockCompaniesAccessInterface()
)
client = TestClient(app)
response = client.get("/cities", params={"city_name": "pirapo"})
interface.get_cities.assert_called_once()
def setUp(self):
self.suggestion_service = MockSuggestionService()
configure_api_app(
MockGazetteAccessInterface(),
self.suggestion_service,
MockCompaniesAccessInterface(),
)
self.client = TestClient(app)
def test_api_should_fail_when_try_to_set_any_object_as_suggestions_service_interface(
self,
):
with self.assertRaises(Exception):
configure_api_app(
MockGazetteAccessInterface(),
MagicMock(),
MockCompaniesAccessInterface(),
)
def test_cities_endpoint_should_reject_request_without_partial_city_name(self):
configure_api_app(
self.create_mock_gazette_interface(),
MockSuggestionService(),
MockCompaniesAccessInterface(),
)
client = TestClient(app)
response = client.get("/cities")
self.assertNotEqual(response.status_code, 200)
def test_cities_should_return_some_city_info(self):
configure_api_app(self.create_mock_gazette_interface(),
MockSuggestionService())
client = TestClient(app)
response = client.get("/cities", params={"city_name": "pirapo"})
self.assertEqual(response.status_code, 200)
self.assertEqual(
response.json(),
{"cities": []},
)
def test_api_should_forward_the_result_offset(self):
interface = self.create_mock_gazette_interface()
configure_api_app(
interface, MockSuggestionService(), MockCompaniesAccessInterface()
)
client = TestClient(app)
response = client.get("/gazettes", params={"offset": 0,},)
self.assertEqual(response.status_code, 200)
interface.get_gazettes.assert_called_once()
self.assertEqual(interface.get_gazettes.call_args.args[0].offset, 0)
def test_gazettes_endpoint_should_accept_query_keywords_date(self):
configure_api_app(self.create_mock_gazette_interface(),
MockSuggestionService())
client = TestClient(app)
response = client.get("/gazettes/4205902",
params={"keywords": ["keyword1"
"keyword2"]})
self.assertEqual(response.status_code, 200)
response = client.get("/gazettes/4205902", params={"keywords": []})
self.assertEqual(response.status_code, 200)
def test_gazettes_without_territory_endpoint__should_accept_query_since_date(self):
configure_api_app(
self.create_mock_gazette_interface(),
MockSuggestionService(),
MockCompaniesAccessInterface(),
)
client = TestClient(app)
response = client.get(
"/gazettes", params={"since": date.today().strftime("%Y-%m-%d")}
)
self.assertEqual(response.status_code, 200)
def test_gazettes_endpoint_should_accept_territory_id_in_the_path(self):
interface = self.create_mock_gazette_interface()
configure_api_app(interface, MockSuggestionService())
client = TestClient(app)
response = client.get("/gazettes/4205902")
self.assertEqual(response.status_code, 200)
self.assertEqual("4205902",
interface.get_gazettes.call_args.args[0].territory_id)
self.assertIsNone(interface.get_gazettes.call_args.args[0].since)
self.assertIsNone(interface.get_gazettes.call_args.args[0].until)
self.assertIsNone(interface.get_gazettes.call_args.args[0].keywords)
self.assertIsNotNone(interface.get_gazettes.call_args.args[0].offset)
self.assertIsNotNone(interface.get_gazettes.call_args.args[0].size)
def test_gazettes_endpoint_should_accept_query_querystring_date(self):
configure_api_app(
self.create_mock_gazette_interface(),
MockSuggestionService(),
MockCompaniesAccessInterface(),
)
client = TestClient(app)
response = client.get(
"/gazettes/4205902", params={"querystring": "keyword1 keyword2"}
)
self.assertEqual(response.status_code, 200)
response = client.get("/gazettes/4205902", params={"querystring": []})
self.assertEqual(response.status_code, 200)
def test_get_gazettes_without_territory_id_should_be_fine(self):
interface = self.create_mock_gazette_interface()
configure_api_app(
interface, MockSuggestionService(), MockCompaniesAccessInterface()
)
client = TestClient(app)
response = client.get("/gazettes/")
self.assertEqual(response.status_code, 200)
self.assertIsNone(interface.get_gazettes.call_args.args[0].territory_id)
self.assertIsNone(interface.get_gazettes.call_args.args[0].since)
self.assertIsNone(interface.get_gazettes.call_args.args[0].until)
self.assertIsNone(interface.get_gazettes.call_args.args[0].querystring)
self.assertIsNotNone(interface.get_gazettes.call_args.args[0].offset)
self.assertIsNotNone(interface.get_gazettes.call_args.args[0].size)
def test_city_endpoint_should_accept_request_with_city_id(self):
configure_api_app(
self.create_mock_gazette_interface(
city_info={
"territory_id": "1234",
"territory_name": "piraporia",
"state_code": "SC",
"publication_urls": ["https://querido-diario.org.br"],
"level": "1",
}),
MockSuggestionService(),
)
client = TestClient(app)
response = client.get("/cities/1234")
self.assertEqual(response.status_code, 200)
def test_get_gazettes_should_forwards_keywords_to_interface_object(self):
interface = self.create_mock_gazette_interface()
configure_api_app(interface, MockSuggestionService())
client = TestClient(app)
response = client.get("/gazettes/4205902",
params={"keywords": ["keyword1", 1, True]})
interface.get_gazettes.assert_called_once()
self.assertEqual(interface.get_gazettes.call_args.args[0].keywords,
["keyword1", "1", "True"])
interface = self.create_mock_gazette_interface()
configure_api_app(interface, MockSuggestionService())
response = client.get("/gazettes/4205902", params={"keywords": []})
interface.get_gazettes.assert_called_once()
self.assertIsNone(interface.get_gazettes.call_args.args[0].keywords)
def test_city_endpoint_should_request_data_from_gazette_interface(self):
interface = self.create_mock_gazette_interface(
city_info={
"territory_id": "1234",
"territory_name": "piraporia",
"state_code": "SC",
"publication_urls": ["https://querido-diario.org.br"],
"level": "1",
}
)
configure_api_app(
interface, MockSuggestionService(), MockCompaniesAccessInterface(),
)
client = TestClient(app)
response = client.get("/cities/1234")
interface.get_city.assert_called_once()
def test_get_gazettes_should_return_empty_list_when_no_gazettes_is_found(self):
today = date.today()
interface = self.create_mock_gazette_interface()
configure_api_app(
interface, MockSuggestionService(), MockCompaniesAccessInterface()
)
client = TestClient(app)
response = client.get("/gazettes/4205902")
interface.get_gazettes.assert_called_once()
self.assertEqual(
interface.get_gazettes.call_args.args[0].territory_id, "4205902"
)
self.assertEqual(response.status_code, 200)
self.assertEqual(
response.json(), {"total_gazettes": 0, "gazettes": []},
)
def test_get_gazettes_should_return_json_with_items(self):
today = date.today()
interface = self.create_mock_gazette_interface(
(
1,
[
{
"territory_id": "4205902",
"date": today,
"url": "https://queridodiario.ok.org.br/",
"territory_name": "My city",
"state_code": "My state",
"is_extra_edition": False,
"edition": "12.3442",
"highlight_texts": ["test"],
}
],
)
)
configure_api_app(
interface, MockSuggestionService(), MockCompaniesAccessInterface()
)
client = TestClient(app)
response = client.get("/gazettes/4205902")
interface.get_gazettes.assert_called_once()
self.assertEqual(
interface.get_gazettes.call_args.args[0].territory_id, "4205902"
)
self.assertEqual(response.status_code, 200)
self.assertEqual(
response.json(),
{
"total_gazettes": 1,
"gazettes": [
{
"territory_id": "4205902",
"date": today.strftime("%Y-%m-%d"),
"url": "https://queridodiario.ok.org.br/",
"territory_name": "My city",
"state_code": "My state",
"is_extra_edition": False,
"edition": "12.3442",
"highlight_texts": ["test"],
}
],
},
)
def test_gazettes_endpoint_should_fail_with_invalid_pagination_data(self):
configure_api_app(
self.create_mock_gazette_interface(),
MockSuggestionService(),
MockCompaniesAccessInterface(),
)
client = TestClient(app)
response = client.get(
"/gazettes/4205902", params={"offset": "asfasdasd", "size": "10"}
)
self.assertEqual(response.status_code, 422)
response = client.get(
"/gazettes/4205902", params={"offset": "10", "size": "ssddsfds"}
)
self.assertEqual(response.status_code, 422)
response = client.get(
"/gazettes/4205902", params={"offset": "x", "size": "asdasdas"}
)
self.assertEqual(response.status_code, 422)
def test_get_gazettes_should_forward_querystring_to_interface_object(self):
interface = self.create_mock_gazette_interface()
configure_api_app(
interface, MockSuggestionService(), MockCompaniesAccessInterface()
)
client = TestClient(app)
response = client.get(
"/gazettes/4205902", params={"querystring": "keyword1 1 True"}
)
interface.get_gazettes.assert_called_once()
self.assertEqual(
interface.get_gazettes.call_args.args[0].querystring, "keyword1 1 True"
)
interface = self.create_mock_gazette_interface()
configure_api_app(
interface, MockSuggestionService(), MockCompaniesAccessInterface()
)
response = client.get("/gazettes/4205902", params={"querystring": None})
interface.get_gazettes.assert_called_once()
self.assertIsNone(interface.get_gazettes.call_args.args[0].querystring)
interface = self.create_mock_gazette_interface()
configure_api_app(
interface, MockSuggestionService(), MockCompaniesAccessInterface()
)
response = client.get("/gazettes/4205902", params={"querystring": ""})
interface.get_gazettes.assert_called_once()
self.assertEqual(interface.get_gazettes.call_args.args[0].querystring, "")