Merge pull request #70 from geoadmin/develop

New Release v2.1.0 - #minor

.pylintrc

@@ -521,6 +521,6 @@ min-public-methods=2
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "BaseException, Exception".
-overgeneral-exceptions=BaseException,
-                       Exception,
-                       StandardError
+overgeneral-exceptions=builtins.BaseException,
+                       builtins.Exception,
+                       builtins.StandardError

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.9-slim-buster
+FROM python:3.11-slim-buster
 RUN groupadd -r geoadmin && useradd -u 1000 -r -s /bin/false -g geoadmin geoadmin
 
 

LICENSE.md

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, swisstopo
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Pipfile

@@ -6,15 +6,15 @@ name = "pypi"
 
 [packages]
 PyYAML = ">=5.4"
-gevent = "~=20.9.0"
-gunicorn = "~=19.9.0"
-Flask = "~=2.1.1"
-logging-utilities = "~=3.0"
+gevent = "~=22.10.2"
+gunicorn = "~=20.1.0"
+Flask = "~=2.3.2"
+logging-utilities = "~=4.0.0"
 defusedxml = "~=0.7.1"
-boto3 = "~=1.17.60"
-botocore = "~=1.20.98"
+boto3 = "~=1.26.158"
+botocore = "~=1.29.158"
 moto = {extras = [ "s3",], version = "*"}
-python-dotenv = "~=0.17.0"
+python-dotenv = "~=1.0.0"
 
 [dev-packages]
 yapf = "*"
@@ -23,4 +23,4 @@ pylint = "*"
 pylint-flask = "*"
 
 [requires]
-python_version = "3.9"
+python_version = "3.11"

README.md

@@ -44,7 +44,7 @@ See also [Git Flow - Versioning](https://github.com/geoadmin/doc-guidelines/blob
 
 ### Make Dependencies
 
-The **Make** targets assume you have **python3.7**, **pipenv**, **bash**, **curl**, **tar**, **docker** and **docker-compose** installed.
+The **Make** targets assume you have **python3.11**, **pipenv**, **bash**, **curl**, **tar**, **docker** and **docker-compose** installed.
 
 ### Setting up to work
 
@@ -131,7 +131,7 @@ Here some curl examples
 
 ```bash
 # post a kml
-curl -X POST http://localhost:5000/api/kml/admin -F kml="@./tests/samples/valid-kml.xml; type=application/vnd.google-earth.kml+xml" -H "Origin: map.geo.admin.ch"
+curl -X POST http://localhost:5000/api/kml/admin -F kml="@./tests/samples/valid-kml.xml; type=application/vnd.google-earth.kml+xml" -F author="test" -H "Origin: map.geo.admin.ch"
 
 # get the kml metadata
 curl http://localhost:5000/api/kml/admin/${KML_ID} -H "Origin: map.geo.admin.ch"

tests/unit_tests/base.py

@@ -100,11 +100,11 @@ def prepare_kml_payload(
         with open(f'./tests/samples/{kml_file}', 'rb') as file:
             kml_data = file.read()
     if admin_id and kml_data:
-        data = dict(admin_id=admin_id, kml=(io.BytesIO(kml_data), 'kml.xml', content_type))
+        data = {'admin_id': admin_id, 'kml': (io.BytesIO(kml_data), 'kml.xml', content_type)}
     elif kml_data:
-        data = dict(kml=(io.BytesIO(kml_data), 'kml.xml', content_type))
+        data = {'kml': (io.BytesIO(kml_data), 'kml.xml', content_type)}
     elif admin_id:
-        data = dict(admin_id=admin_id)
+        data = {'admin_id': admin_id}
     else:
         raise ValueError('No admin_id and no kml_string given')
 

tests/unit_tests/test_routes.py

@@ -525,7 +525,7 @@ def test_kml_delete(self):
         response = self.app.delete(
             url_for('delete_kml', kml_id=id_to_delete),
             content_type='multipart/form-data',
-            data=dict(admin_id=self.sample_kml['admin_id']),
+            data={'admin_id': self.sample_kml['admin_id']},
             headers=self.origin_headers["allowed"]
         )
         self.assertEqual(response.status_code, 200)
@@ -562,7 +562,7 @@ def test_kml_delete_non_allowed_origin(self):
 
         response = self.app.delete(
             url_for('delete_kml', kml_id=id_to_delete),
-            data=dict(admin_id=self.sample_kml['admin_id']),
+            data={'admin_id': self.sample_kml['admin_id']},
             content_type='multipart/form-data',
             headers=self.origin_headers["bad"]
         )
@@ -577,7 +577,7 @@ def test_kml_delete_non_allowed_admin_id(self):
         response = self.app.delete(
             url_for('delete_kml', kml_id=id_to_delete),
             content_type='multipart/form-data',
-            data=dict(admin_id='invalid-id'),
+            data={'admin_id': 'invalid-id'},
             headers=self.origin_headers["allowed"]
         )
         self.assertEqual(response.status_code, 403)
@@ -604,7 +604,7 @@ def test_kml_delete_wrong_content_type(self):
         response = self.app.delete(
             url_for('delete_kml', kml_id=id_to_delete),
             content_type='application/json',
-            data=dict(admin_id=self.sample_kml['admin_id']),
+            data={'admin_id': self.sample_kml['admin_id']},
             headers=self.origin_headers["allowed"]
         )
         self.assertEqual(response.status_code, 415)

update_to_latest.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+# This script updates the Pipfile automatically. It will update all version strings of type
+# "~=x.x.x" to their respective latest version. Version strings of dependencies that use other
+# version specifiers (like "*") will be left untouched. All dependencies will be updated
+# (with "pipenv update") in the process.
+# A regex can be optionally specified as first argument. In this case, only the version strings
+# of packages matching the regex will be updated. (e.g. update_to_latest.sh 'django.*')
+# This script is meant as a helper only. Use git to revert unwanted changes made by this script.
+
+cd "$(dirname "$0")" || exit
+#If an argument was passed to the script, it will be used as a regular expression
+#Else we will simply match any package name
+regexp=${1:-'\S+'}
+line_regexp="^($regexp) = \"~=[0-9\\.]+\"(.*)$"
+
+#Generate an array of all packages that need to be updated and switch their version to "*"
+packages_to_modify=( $(cat Pipfile | sed -En "s/$line_regexp/\1/ip") )
+echo "The script will try to update the following packages: ${packages_to_modify[*]}"
+read -p "Do you want to contnue? [Y|N] " -n 1 -r
+echo
+[[ ! $REPLY =~ ^[Yy]$ ]] && exit
+sed -Ei "s/$line_regexp/\1 = \"*\"\2/i" Pipfile
+
+# Update the packages to the latest version
+pipenv update --dev
+
+# Set the current version in the Pipfile (only for the packages that were updated)
+updateVersions=""
+while read -r name version ; do
+    if [[ " ${packages_to_modify[*]} " == *" $name "*  ]] ; then
+        updateVersions+="/^$name =/s/\"\\*\"/$version/"
+        updateVersions+=$'\n'
+    fi
+done < <(pipenv run pip freeze | sed -E 's/==([0-9\.]+\w*)/ "~=\1"/')
+sed -Ei -f <(echo "$updateVersions") Pipfile