Merge pull request #165 from mapbox/validate-source-id

validate source-id when uploading

Author: Pshrawani

.pre-commit-config.yaml

@@ -2,7 +2,7 @@ repos:
     -
         repo: 'https://github.com/ambv/black'
         # 18.6b1
-        rev: 20.8b1
+        rev: 22.3.0
         hooks:
             - id: black
               args: ['--safe']

.travis.yml

@@ -3,6 +3,7 @@ python:
   - '3.6'
   - '3.7'
 install:
+  - pip install -U setuptools importlib-metadata
   - pip install -r requirements.txt -e .[test]
 script:
   - python --version

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 =======
 
+# 1.7.4 (2022-07-13)
+- validates source id for correct syntax when `upload-source` command to resolve `Connection reset by peer error`
+
 # 1.7.3 (2022-03-14)
  - Loads `supermercado` on request because binaries for arm64 MacOS and Windows are not easily available.
  - Hide deprecated `add-source` command from command list.

mapbox_tilesets/__init__.py

@@ -1,3 +1,3 @@
 """mapbox_tilesets package"""
 
-__version__ = "1.7.3"
+__version__ = "1.7.4"

mapbox_tilesets/scripts/cli.py

@@ -6,6 +6,7 @@
 import click
 import cligj
 import base64
+import re
 from requests_toolbelt import MultipartEncoder, MultipartEncoderMonitor
 
 import mapbox_tilesets
@@ -509,9 +510,18 @@ def validate_source(features):
     click.echo("✔ valid")
 
 
+def validate_source_id(ctx, param, value):
+    if re.match("^[a-zA-Z0-9-_]{1,32}$", value):
+        return value
+    else:
+        raise click.BadParameter(
+            'Tileset Source ID is invalid. Must be no more than 32 characters and only include "-", "_", and alphanumeric characters.'
+        )
+
+
 @cli.command("upload-source")
 @click.argument("username", required=True, type=str)
-@click.argument("id", required=True, type=str)
+@click.argument("id", required=True, callback=validate_source_id, type=str)
 @cligj.features_in_arg
 @click.option("--no-validation", is_flag=True, help="Bypass source file validation")
 @click.option("--quiet", is_flag=True, help="Don't show progress bar")

mapbox_tilesets/utils.py

@@ -157,7 +157,7 @@ def _tile2lng(tile_x, zoom):
     -------
         longitude
     """
-    return ((tile_x / 2 ** zoom) * 360.0) - 180.0
+    return ((tile_x / 2**zoom) * 360.0) - 180.0
 
 
 def _tile2lat(tile_y, zoom):
@@ -174,7 +174,7 @@ def _tile2lat(tile_y, zoom):
     -------
         latitude
     """
-    n = np.pi - 2 * np.pi * tile_y / 2 ** zoom
+    n = np.pi - 2 * np.pi * tile_y / 2**zoom
     return (180.0 / np.pi) * np.arctan(0.5 * (np.exp(n) - np.exp(-n)))
 
 
@@ -198,7 +198,7 @@ def _calculate_tile_area(tile):
     bottom = np.deg2rad(_tile2lat(tile[:, 1] + 1, tile[:, 2]))
     return (
         (np.pi / np.deg2rad(180))
-        * EARTH_RADIUS ** 2
+        * EARTH_RADIUS**2
         * np.abs(np.sin(top) - np.sin(bottom))
         * np.abs(left - right)
     )

requirements.txt

@@ -1,6 +1,6 @@
 boto3==1.9.99
-Click==7.1.2
-cligj==0.5.0
+Click==8.0.2
+cligj==0.7.2
 numpy==1.19.5
 requests==2.21.0
 requests-toolbelt==0.9.1

setup.py

@@ -16,19 +16,19 @@ def read(fname):
 setup(
     name="mapbox-tilesets",
     version=__version__,
-    description=u"CLI for interacting with and preparing data for the Tilesets API",
+    description="CLI for interacting with and preparing data for the Tilesets API",
     long_description=long_description,
     long_description_content_type="text/markdown",
     classifiers=[],
     keywords="",
-    author=u"Mapbox",
+    author="Mapbox",
     author_email="[email protected]",
     url="https://github.com/mapbox/tilesets-cli",
     license="BSD-2",
     packages=find_packages(exclude=["ez_setup", "examples", "tests"]),
     install_requires=[
         "boto3",
-        "click~=7.1.2",
+        "click~=8.0.2",
         "cligj",
         "numpy",
         "requests",
@@ -48,7 +48,7 @@ def read(fname):
             "pytest==4.6.11",
             "pytest-cov",
             "pre-commit",
-            "black==20.8b1",
+            "black==22.3.0",
             "pep8",
             "supermercado~=0.2.0",
             "toml==0.10.2",

tests/test_cli_create.py

@@ -140,7 +140,7 @@ def test_cli_create_private_invalid(mock_request_post, MockResponse):
     )
     assert result.exit_code == 2
     assert (
-        "Invalid value for '--privacy' / '-p': invalid choice: invalid-privacy-value. (choose from public, private)"
+        "Error: Invalid value for '--privacy' / '-p': 'invalid-privacy-value' is not one of 'public', 'private'."
         in result.output
     )
 

tests/test_cli_sources.py

@@ -1,6 +1,7 @@
 from click.testing import CliRunner
 import json
 import os
+import click
 from unittest import mock
 
 import pytest
@@ -42,10 +43,9 @@ def side_effect(fields):
         add_source, ["test-user", "hello-world", "tests/fixtures/valid.ldgeojson"]
     )
     assert validated_result.exit_code == 0
-
     assert (
         validated_result.output
-        == """{"id": "mapbox://tileset-source/test-user/hello-world"}\n"""
+        == """upload progress\n{"id": "mapbox://tileset-source/test-user/hello-world"}\n"""
     )
 
 
@@ -149,10 +149,9 @@ def side_effect(fields):
         ["test-user", "hello-world", "tests/fixtures/valid.ldgeojson", "--replace"],
     )
     assert validated_result.exit_code == 0
-
     assert (
         validated_result.output
-        == """{"id": "mapbox://tileset-source/test-user/hello-world"}\n"""
+        == """upload progress\n{"id": "mapbox://tileset-source/test-user/hello-world"}\n"""
     )
 
 
@@ -187,8 +186,53 @@ def side_effect(fields):
 
     assert (
         validated_result.output
-        == """{"id": "mapbox://tileset-source/test-user/hello-world"}\n"""
+        == """upload progress\n{"id": "mapbox://tileset-source/test-user/hello-world"}\n"""
+    )
+
+
+@pytest.mark.usefixtures("token_environ")
+@mock.patch("mapbox_tilesets.scripts.cli.MultipartEncoder")
+@mock.patch("mapbox_tilesets.scripts.cli.MultipartEncoderMonitor")
+@mock.patch("requests.Session.post")
+def test_cli_upload_source(
+    mock_request_post,
+    mock_multipart_encoder_monitor,
+    mock_multipart_encoder,
+    MockResponse,
+    MockMultipartEncoding,
+):
+    okay_response = {"id": "mapbox://tileset-source/test-user/populated-places-source"}
+    mock_request_post.return_value = MockResponse(okay_response, status_code=200)
+
+    expected_json = b'{"type":"Feature","geometry":{"type":"Point","coordinates":[125.6,10.1]},"properties":{"name":"Dinagat Islands"}}\n'
+
+    def side_effect(fields):
+        assert fields["file"][1].read() == expected_json
+        return MockMultipartEncoding()
+
+    mock_multipart_encoder.side_effect = side_effect
+
+    runner = CliRunner()
+    validated_result = runner.invoke(
+        upload_source,
+        ["test-user", "populated-places-source", "tests/fixtures/valid.ldgeojson"],
+    )
+    assert validated_result.exit_code == 0
+    assert (
+        validated_result.output
+        == """upload progress\n{"id": "mapbox://tileset-source/test-user/populated-places-source"}\n"""
+    )
+
+
+@pytest.mark.usefixtures("token_environ")
+def validate_source_id(self):
+    self.assertRaises(
+        click.BadParameter,
+        value="mapbox://tileset-source/test-user/hello-world",
+        param=None,
+        ctx=None,
     )
+    self.assertEqual("hello-world", value="hello-world", param=None, ctx=None)
 
 
 @pytest.mark.usefixtures("token_environ")