-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update documentation: Datamodels, architecture and endpoints (#181)
* Update SurveyAnswer to move to ModelForm * Update SurveyAnswer to move to ModelForm * Fix test import * Updated datamodels documentation * Updated datamodels documentation * Update architechture and endpoint documentation
- Loading branch information
1 parent
13b401d
commit 773b96c
Showing
6 changed files
with
221 additions
and
42 deletions.
There are no files selected for viewing
30 changes: 30 additions & 0 deletions
30
...ute_rangers_api/migrations/0010_alter_surveyresponse_transit_improvement_open_and_more.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # Generated by Django 5.0.4 on 2024-05-22 22:13 | ||
|
|
||
| import django.core.validators | ||
| from django.db import migrations, models | ||
|
|
||
|
|
||
| class Migration(migrations.Migration): | ||
|
|
||
| dependencies = [ | ||
| ("route_rangers_api", "0009_changing_survey"), | ||
| ] | ||
|
|
||
| operations = [ | ||
| migrations.AlterField( | ||
| model_name="surveyresponse", | ||
| name="transit_improvement_open", | ||
| field=models.CharField(max_length=128, null=True), | ||
| ), | ||
| migrations.AlterField( | ||
| model_name="surveyresponse", | ||
| name="trip_time", | ||
| field=models.PositiveIntegerField( | ||
| null=True, | ||
| validators=[ | ||
| django.core.validators.MinValueValidator(1), | ||
| django.core.validators.MaxValueValidator(240), | ||
| ], | ||
| ), | ||
| ), | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| import os | ||
| import sys | ||
| import pytest | ||
| from unittest.mock import patch, mock_open | ||
| from app.scripts.ingest_census_data import ( | ||
| valid_command_line_arg, | ||
| get_census_data, | ||
| store_census_data, | ||
| city_fips, | ||
| ) | ||
|
|
||
|
|
||
| @pytest.fixture | ||
| def supported_cities(): | ||
| return list(city_fips.keys()) | ||
|
|
||
|
|
||
| ######################################################################################## | ||
| # COMMAND LINE TESTS | ||
| ######################################################################################## | ||
|
|
||
|
|
||
| def test_valid_command_line_arg_correct_input(monkeypatch, supported_cities): | ||
| monkeypatch.setattr("sys.argv", ["extract_census_data.py", "portland"]) | ||
| assert valid_command_line_arg(supported_cities) == "portland" | ||
|
|
||
|
|
||
| def test_valid_command_line_arg_incorrect_input(monkeypatch, supported_cities): | ||
| monkeypatch.setattr("sys.argv", ["extract_census_data.py", "miami"]) | ||
| with pytest.raises(SystemExit) as excinfo: | ||
| valid_command_line_arg(supported_cities) | ||
| assert "Unsupported city. Available options: nyc, chicago, portland" == str( | ||
| excinfo.value | ||
| ) | ||
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| "argv", [(["extract_census_data.py"]), (["extract_census_data.py", "nyc", "miami"])] | ||
| ) | ||
| def test_valid_command_line_arg_incorrect_number_inputs( | ||
| monkeypatch, supported_cities, argv | ||
| ): | ||
| monkeypatch.setattr("sys.argv", argv) | ||
| with pytest.raises(SystemExit) as excinfo: | ||
| valid_command_line_arg(supported_cities) | ||
| assert "Retype command as 'python3 extract_census_data.py <city_name>'" == str( | ||
| excinfo.value | ||
| ) | ||
|
|
||
|
|
||
| ######################################################################################## | ||
| # DATA SCRAPING TESTS | ||
| ######################################################################################## | ||
|
|
||
|
|
||
| @patch("requests.get") | ||
| def test_get_census_data_successful_api_call(mock_get): | ||
| mock_data = [ | ||
| ["state_code", "county_code", "B01001_001E", "block_group"], | ||
| ["36", "061", "1000", "1"], | ||
| ["36", "047", "2000", "2"], | ||
| ] | ||
| mock_get.return_value.status_code = 200 | ||
| mock_get.return_value.json.return_value = mock_data | ||
|
|
||
| expected = [ | ||
| { | ||
| "state_code": "36", | ||
| "county_code": "061", | ||
| "B01001_001E": "1000", | ||
| "block_group": "1", | ||
| }, | ||
| { | ||
| "state_code": "36", | ||
| "county_code": "047", | ||
| "B01001_001E": "2000", | ||
| "block_group": "2", | ||
| }, | ||
| ] | ||
| actual = get_census_data({"B01001_001E": "total_population"}, "36", "061") | ||
| assert actual == expected | ||
|
|
||
|
|
||
| @pytest.mark.parametrize("status_code", [400, 401, 404, 429, 500, 503]) | ||
| @patch("requests.get") | ||
| def test_get_census_data_api_failure(mock_get, status_code): | ||
| mock_get.return_value.status_code = status_code | ||
| mock_get.return_value.json.return_value = {"error": "Something went wrong"} | ||
| assert get_census_data({"B01001_001E": "total_population"}, "36", "061") == [] | ||
|
|
||
|
|
||
| ######################################################################################## | ||
| # DATA STORING TESTS | ||
| ######################################################################################## | ||
|
|
||
|
|
||
| @pytest.fixture | ||
| def mock_env(monkeypatch): | ||
| monkeypatch.setattr(os, "getcwd", lambda: "/fake/dir") | ||
| monkeypatch.setattr(sys, "argv", ["script.py", "nyc"]) | ||
|
|
||
|
|
||
| def test_store_census_data_with_valid_data(mock_env): | ||
| """ | ||
| Test | ||
| """ | ||
| with patch("builtins.open", mock_open(read_data="data"), create=True) as mock_file: | ||
| data = [ | ||
| { | ||
| "state_code": "36", | ||
| "county_code": "061", | ||
| "total_population": "1000", | ||
| "block_group": "1", | ||
| }, | ||
| { | ||
| "state_code": "36", | ||
| "county_code": "047", | ||
| "total_population": "2000", | ||
| "block_group": "2", | ||
| }, | ||
| ] | ||
| store_census_data(data, "nyc") | ||
| mock_file.assert_called_once_with("/fake/dir/nyc_data.csv", "w", newline="") | ||
| handle = mock_file() | ||
| assert handle.write.call_count > 2 | ||
|
|
||
|
|
||
| def test_store_census_data_with_invalid_data(mock_env): | ||
| """ | ||
| Test | ||
| """ | ||
| invalid_data = [ | ||
| { | ||
| "state_code": "36", | ||
| }, | ||
| { | ||
| "county_code": "047", | ||
| }, | ||
| ] | ||
| with patch("builtins.open", mock_open(read_data="data"), create=True) as mock_file: | ||
| store_census_data(invalid_data, "nyc") | ||
| mock_file.assert_called_once_with("/fake/dir/nyc_data.csv", "w", newline="") | ||
| handle = mock_file() | ||
| assert handle.write.call_count == 3 |