Beautify Errors (#177)

* Beautify errors

* Beautify errors

* Beautify errors

* Beautify errors

Author: branyip

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 =======
 
+# 1.9.3 (2023-06-27)
+- Beautified error messages
+
 # 1.9.2 (2023-06-21)
 - Use Bionic dist instead of Xenial for Travis build
 

mapbox_tilesets/__init__.py

@@ -1,3 +1,3 @@
 """mapbox_tilesets package"""
 
-__version__ = "1.9.0"
+__version__ = "1.9.3"

mapbox_tilesets/errors.py

@@ -1,7 +1,8 @@
 """Error handling for the tilesets CLI"""
+from click import ClickException
 
 
-class TilesetsError(Exception):
+class TilesetsError(ClickException):
     """Base Tilesets error
     Deriving errors from this base isolates module development
     problems from Python usage problems.

mapbox_tilesets/utils.py

@@ -4,7 +4,8 @@
 
 import numpy as np
 
-from jsonschema import validate
+from click import ClickException
+from jsonschema import validate, ValidationError
 from requests import Session
 
 import mapbox_tilesets
@@ -126,7 +127,10 @@ def validate_geojson(index, feature):
             },
         },
     }
-    validate(instance=feature, schema=schema)
+    try:
+        validate(instance=feature, schema=schema)
+    except ValidationError as e:
+        raise ClickException(e)
     geojson_validate(index, feature)
 
 

tests/test_cli_delete.py

@@ -5,7 +5,6 @@
 from unittest import mock
 
 from mapbox_tilesets.scripts.cli import delete
-from mapbox_tilesets.errors import TilesetsError
 
 
 class MockResponse:
@@ -82,4 +81,4 @@ def test_cli_delete_fail(mock_request_delete):
         "https://api.mapbox.com/tilesets/v1/test.id?access_token=pk.eyJ1IjoidGVzdC11c2VyIn0K"
     )
     assert result.exit_code == 1
-    assert isinstance(result.exception, TilesetsError)
+    assert isinstance(result.exception, SystemExit)

tests/test_cli_estimate_area.py

@@ -1,6 +1,7 @@
 from click.testing import CliRunner
 
 from mapbox_tilesets.scripts.cli import estimate_area
+from utils import clean_runner_output
 
 
 # rainy day scenarios
@@ -11,7 +12,7 @@ def test_cli_estimate_area_features_from_invalid_stdin_geojson():
         estimate_area, ["--precision", "10m"], input="invalidGeoJson input"
     )
     assert invalidated_result.exit_code == 1
-    assert str(invalidated_result.exception) == message
+    assert clean_runner_output(invalidated_result.output) == message
 
 
 def test_cli_estimate_area_features_from_invalid_geojson_content():
@@ -21,7 +22,7 @@ def test_cli_estimate_area_features_from_invalid_geojson_content():
         estimate_area,
         ["tests/fixtures/invalid-geojson.ldgeojson", "--precision", "1m"],
     )
-    assert message in str(invalidated_result.exception)
+    assert message in str(invalidated_result.output)
     assert invalidated_result.exit_code == 1
 
 
@@ -32,7 +33,7 @@ def test_cli_estimate_area_features_from_nonexistent_geojson_file():
         estimate_area,
         ["tests/fixtures/nonexistent-geojson.ldgeojson", "--precision", "1m"],
     )
-    assert str(invalidated_result.exception) == message
+    assert clean_runner_output(invalidated_result.output) == message
     assert invalidated_result.exit_code == 1
 
 
@@ -64,7 +65,7 @@ def test_cli_estimate_area_1cm_precision_without_flag():
         ["tests/fixtures/valid.ldgeojson", "-p", "1cm"],
     )
     assert invalidated_result.exit_code == 1
-    assert str(invalidated_result.exception) == message
+    assert clean_runner_output(invalidated_result.output) == message
 
 
 def test_cli_estimate_area_invalid_1cm_precision_flag():
@@ -75,7 +76,7 @@ def test_cli_estimate_area_invalid_1cm_precision_flag():
         ["tests/fixtures/valid.ldgeojson", "-p", "1m", "--force-1cm"],
     )
     assert invalidated_result.exit_code == 1
-    assert str(invalidated_result.exception) == message
+    assert clean_runner_output(invalidated_result.output) == message
 
 
 # sunny day scenarios

tests/test_cli_sources.py

@@ -14,6 +14,7 @@
     validate_source,
     list_sources,
 )
+from utils import clean_runner_output
 
 
 @pytest.mark.usefixtures("token_environ")
@@ -73,7 +74,7 @@ def test_cli_add_source_wrong_username(
     assert validated_result.exit_code == 1
 
     assert (
-        str(validated_result.exception)
+        clean_runner_output(validated_result.output)
         == "Token username wrong-user does not match username test-user-wrong"
     )
 
@@ -91,7 +92,7 @@ def test_cli_add_source_no_token():
     assert unauthenticated_result.exit_code == 1
 
     assert (
-        str(unauthenticated_result.exception)
+        clean_runner_output(unauthenticated_result.output)
         == """No access token provided. Please set the MAPBOX_ACCESS_TOKEN environment variable or use the --token flag."""
     )
 
@@ -116,7 +117,7 @@ def test_cli_add_source_no_validation(mock_request_post, MockResponse):
     assert no_validation_result.exit_code == 1
 
     assert (
-        no_validation_result.exception.message
+        clean_runner_output(no_validation_result.output)
         == '{"message": "Invalid file format. Only GeoJSON features are allowed."}'
     )
 
@@ -254,7 +255,7 @@ def side_effect(fields):
     assert validated_result.exit_code == 1
 
     assert (
-        str(validated_result.exception)
+        clean_runner_output(validated_result.output)
         == "Error in feature number 0: Each linear ring must end where it started"
     )
 

tests/test_cli_status.py

@@ -5,7 +5,7 @@
 from unittest import mock
 
 from mapbox_tilesets.scripts.cli import status
-from mapbox_tilesets.errors import TilesetsError
+from utils import clean_runner_output
 
 
 @pytest.mark.usefixtures("token_environ")
@@ -63,5 +63,5 @@ def test_cli_status_error(mock_request_get, MockResponse):
         "https://api.mapbox.com/tilesets/v1/test.id/jobs?limit=1&access_token=pk.eyJ1IjoidGVzdC11c2VyIn0K"
     )
     assert result.exit_code == 1
-    assert isinstance(result.exception, TilesetsError)
-    assert result.exception.message == '{"message": "test.id has no jobs."}'
+    assert isinstance(result.exception, SystemExit)
+    assert clean_runner_output(result.output) == '{"message": "test.id has no jobs."}'

tests/test_cli_tilejson.py

@@ -3,7 +3,7 @@
 from unittest import mock
 from click.testing import CliRunner
 from mapbox_tilesets.scripts.cli import tilejson
-from mapbox_tilesets.errors import TilesetsError, TilesetNameError
+from utils import clean_runner_output
 
 
 class MockResponse:
@@ -94,7 +94,7 @@ def test_cli_tilejson_error(mock_request_get, MockResponse):
         "https://api.mapbox.com/v4/test.id,test.another.json?access_token=pk.eyJ1IjoidGVzdC11c2VyIn0K"
     )
     assert result.exit_code == 1
-    assert isinstance(result.exception, TilesetsError)
+    assert isinstance(result.exception, SystemExit)
 
 
 @pytest.mark.usefixtures("token_environ")
@@ -104,5 +104,5 @@ def test_cli_tilejson_invalid_tileset_id():
     # sends expected request
     result = runner.invoke(tilejson, ["invalid@@id"])
     assert result.exit_code == 1
-    assert isinstance(result.exception, TilesetNameError)
-    assert "invalid@@id" in str(result.exception)
+    assert isinstance(result.exception, SystemExit)
+    assert clean_runner_output(result.output) == "Invalid Tileset ID"

tests/test_cli_view_recipe.py

@@ -5,6 +5,7 @@
 from unittest import mock
 
 from mapbox_tilesets.scripts.cli import view_recipe
+from utils import clean_runner_output
 
 
 @pytest.mark.usefixtures("token_environ")
@@ -50,5 +51,4 @@ def test_cli_view_recipe_raises(mock_request_get, MockResponse):
         "https://api.mapbox.com/tilesets/v1/test.id/recipe?access_token=pk.eyJ1IjoidGVzdC11c2VyIn0K"
     )
     assert result.exit_code == 1
-
-    assert result.exception.message == '"not found"'
+    assert clean_runner_output(result.output) == '"not found"'