Add tests for File validation

Author: smt5541

flask_parameter_validation/test/resources/aldrin_47kB.jpg

@@ -0,0 +1,4 @@
+{
+  "name": "Test JSON Document",
+  "description": "This document will be uploaded to an API route that expects image/jpeg or image/png Content-Type, with the expectation that the API will return an error."
+}

flask_parameter_validation/test/resources/hubble_mars_10kB.jpg

@@ -0,0 +1,71 @@
+import datetime
+import filecmp
+from pathlib import Path
+from typing import Type, List, Optional
+
+resources = Path(__file__).parent / 'resources'
+
+
+def test_required_file(client):
+    url = "/file/required"
+    # Test that we receive a success response if a file is provided
+    r = client.post(url, data={"v": (resources / "test.json").open("rb")})
+    assert "success" in r.json
+    assert r.json["success"]
+    # Test that we receive an error if a file is not provided
+    r = client.post(url)
+    assert "error" in r.json
+
+
+def test_optional_file(client):
+    url = "/file/optional"
+    # Test that we receive a success response if a file is provided
+    r = client.post(url, data={"v": (resources / "test.json").open("rb")})
+    assert "success" in r.json
+    assert r.json["success"]
+    assert "file_provided" in r.json
+    assert r.json["file_provided"] is True
+    # Test that we receive an error if a file is not provided
+    r = client.post(url)
+    assert "success" in r.json
+    assert r.json["success"]
+    assert "file_provided" in r.json
+    assert r.json["file_provided"] is False
+
+
+def test_file_content_types(client):
+    url = "/file/content_types"
+    # Test that we receive a success response if a file of correct Content-Type is provided
+    r = client.post(url, data={"v": (resources / "test.json").open("rb")})
+    assert "success" in r.json
+    assert r.json["success"]
+    # Test that we receive an error if a file of incorrect Content-Type is provided
+    r = client.post(url, data={"v": (resources / "hubble_mars_10kB.jpg").open("rb")})
+    assert "error" in r.json
+
+
+def test_file_min_length(client):
+    url = "/file/min_length"
+    # Test that we receive a success response if a file of correct Content-Length is provided
+    load_path = resources / "hubble_mars_10kB.jpg"
+    r = client.post(url, data={"v": load_path.open("rb")})
+    assert "success" in r.json
+    assert r.json["success"]
+    assert "save_path" in r.json
+    assert filecmp.cmp(load_path, r.json["save_path"])
+    # Test that we receive an error if a file of incorrect Content-Length is provided
+    r = client.post(url, data={"v": (resources / "test.json").open("rb")})
+    assert "error" in r.json
+
+def test_file_max_length(client):
+    url = "/file/max_length"
+    # Test that we receive a success response if a file of correct Content-Length is provided
+    load_path = resources / "hubble_mars_10kB.jpg"
+    r = client.post(url, data={"v": load_path.open("rb")})
+    assert "success" in r.json
+    assert r.json["success"]
+    assert "save_path" in r.json
+    assert filecmp.cmp(load_path, r.json["save_path"])
+    # Test that we receive an error if a file of incorrect Content-Length is provided
+    r = client.post(url, data={"v": (resources / "aldrin_47kB.jpg").open("rb")})
+    assert "error" in r.json

flask_parameter_validation/test/resources/test.json

@@ -3,6 +3,7 @@
 from flask import Flask, jsonify
 
 from flask_parameter_validation import ValidateParameters, Query, Json, Form, Route
+from flask_parameter_validation.test.testing_blueprints.file_blueprint import get_file_blueprint
 from flask_parameter_validation.test.testing_blueprints.parameter_blueprint import get_parameter_blueprint
 
 
@@ -13,5 +14,5 @@ def create_app():
     app.register_blueprint(get_parameter_blueprint(Json, "json", "json", "post"))
     app.register_blueprint(get_parameter_blueprint(Form, "form", "form", "post"))
     app.register_blueprint(get_parameter_blueprint(Route, "route", "route", "get"))
-
+    app.register_blueprint(get_file_blueprint("file"))
     return app

flask_parameter_validation/test/test_file_params.py

@@ -0,0 +1,49 @@
+import datetime
+from pathlib import Path
+from typing import Optional
+from flask import Blueprint, jsonify, request
+from werkzeug.datastructures import FileStorage
+from werkzeug.utils import secure_filename
+
+from flask_parameter_validation import ValidateParameters, File
+
+resources = Path(__file__).parent.parent / 'uploads'
+
+
+def get_file_blueprint(bp_name: str) -> Blueprint:
+    file_bp = Blueprint(bp_name, __name__, url_prefix="/file")
+
+    @file_bp.post("/required")
+    @ValidateParameters()
+    def required(v: FileStorage = File()):
+        assert type(v) is FileStorage
+        return jsonify({"success": True})
+
+    @file_bp.post("/optional")
+    @ValidateParameters()
+    def optional(v: Optional[FileStorage] = File()):
+        return jsonify({"success": True, "file_provided": v is not None})
+
+    @file_bp.post("/content_types")
+    @ValidateParameters()
+    def content_types(v: FileStorage = File(content_types=["application/json"])):
+        assert v.content_type == "application/json"
+        return jsonify({"success": True})
+
+    @file_bp.post("/min_length")
+    @ValidateParameters()
+    def min_length(v: FileStorage = File(min_length=300)):
+        save_path = resources / secure_filename(v.filename)
+        v.save(resources / secure_filename(v.filename))
+        v.close()
+        return jsonify({"success": True, "save_path": str(save_path.absolute())})
+
+    @file_bp.post("/max_length")
+    @ValidateParameters()
+    def max_length(v: FileStorage = File(max_length=10000)):
+        save_path = resources / secure_filename(v.filename)
+        v.save(resources / secure_filename(v.filename))
+        v.close()
+        return jsonify({"success": True, "save_path": str(save_path.absolute())})
+
+    return file_bp

flask_parameter_validation/test/testing_application.py

@@ -0,0 +1 @@
+*