update validations (#2)

update validations, and add tests for them

Author: tanmaykm

README.md

@@ -54,6 +54,7 @@ Following validations are incorporated into models:
 - minimum length: must be a string value of length greater than or equal to a specified value
 - maximum item count: must be a list value with number of items less than or equal to a specified value
 - minimum item count: must be a list value with number of items greater than or equal to a specified value
+- pattern: must match the specified regex pattern
 - enum: value must be from a list of allowed values
 
 Validations are imposed in the constructor and `setproperty!` methods of models.

src/val.jl

@@ -19,6 +19,9 @@ function val_unique_items(val::Vector, is_unique)
     is_unique || return true
     return length(Set(val)) == length(val)
 end
+function val_pattern(val::AbstractString, pattern::Regex)
+    return !isnothing(match(pattern, val))
+end
 
 const MSG_INVALID_API_PARAM = Dict{Symbol,Function}([
     :maximum => (val,excl)->string("must be a value less than ", excl ? "or equal to " : "", val),
@@ -28,7 +31,10 @@ const MSG_INVALID_API_PARAM = Dict{Symbol,Function}([
     :maxItems => (val)->string("number of items must be less than or equal to ", val),
     :minItems => (val)->string("number of items must be greater than or equal to ", val),
     :uniqueItems => (val)->string("items must be unique"),
-    :enum => (lst)->string("value is not from the allowed values", lst),
+    :maxProperties => (val)->string("number of properties must be less than or equal to ", val),
+    :minProperties => (val)->string("number of properties must be greater than or equal to ", val),
+    :enum => (lst)->string("value is not from the allowed values ", lst),
+    :pattern => (val)->string("value does not match required pattern"),
 ])
 
 const VAL_API_PARAM = Dict{Symbol,Function}([
@@ -39,8 +45,9 @@ const VAL_API_PARAM = Dict{Symbol,Function}([
     :maxItems => val_max_length,
     :minItems => val_min_length,
     :uniqueItems => val_unique_items,
-    :maxProterties => val_max_length,
-    :minProterties => val_min_length,
+    :maxProperties => val_max_length,
+    :minProperties => val_min_length,
+    :pattern => val_pattern,
     :enum => val_enum,
 ])
 

test/client/runtests.jl

@@ -13,6 +13,9 @@ function runtests()
         @testset "Utils" begin
             test_longpoll_exception_check()
         end
+        @testset "Validations" begin
+            test_validations()
+        end
         @testset "Petstore" begin
             if get(ENV, "RUNNER_OS", "") == "Linux"
                 @testset "V3" begin

test/client/utilstests.jl

@@ -30,3 +30,52 @@ function test_longpoll_exception_check()
     @test OpenAPI.Clients.is_longpoll_timeout(CompositeException([openapiex1, as_taskfailedexception(openapiex2)]))
     @test OpenAPI.Clients.is_longpoll_timeout(CompositeException([openapiex1, as_taskfailedexception(openapiex1)])) == false
 end
+
+function test_validations()
+    # maximum
+    @test_throws OpenAPI.ValidationException OpenAPI.validate_param("test_param", "test_model", :maximum, 11, 10, true)
+    @test_throws OpenAPI.ValidationException OpenAPI.validate_param("test_param", "test_model", :maximum, 11, 10, false)
+    @test_throws OpenAPI.ValidationException OpenAPI.validate_param("test_param", "test_model", :maximum, 10, 10, true)
+    @test OpenAPI.validate_param("test_param", "test_model", :maximum, 10, 10, false) === nothing
+    @test OpenAPI.validate_param("test_param", "test_model", :maximum, 1, 10, false) === nothing
+
+    # minimum
+    @test_throws OpenAPI.ValidationException OpenAPI.validate_param("test_param", "test_model", :minimum, 10, 11, true)
+    @test_throws OpenAPI.ValidationException OpenAPI.validate_param("test_param", "test_model", :minimum, 10, 11, false)
+    @test_throws OpenAPI.ValidationException OpenAPI.validate_param("test_param", "test_model", :minimum, 10, 10, true)
+    @test OpenAPI.validate_param("test_param", "test_model", :minimum, 10, 10, false) === nothing
+    @test OpenAPI.validate_param("test_param", "test_model", :minimum, 10, 1, false) === nothing
+
+    # maxLength, maxItems, maxProperties
+    for test in (:maxLength, :maxItems, :maxProperties)
+        for items in (1:10, Dict(zip(1:10, 1:10)), [1:10...])
+            @test OpenAPI.validate_param("test_param", "test_model", test, items, 10) === nothing
+        end
+        for items in (1:2, Dict(zip(1:2, 1:2)), [1:2...])
+            @test OpenAPI.validate_param("test_param", "test_model", test, items, 10) === nothing
+        end
+    end
+
+    # minLength, minItems, minProperties
+    for test in (:minLength, :minItems, :minProperties)
+        for items in (1:10, Dict(zip(1:10, 1:10)), [1:10...])
+            @test OpenAPI.validate_param("test_param", "test_model", test, items, 10) === nothing
+            @test OpenAPI.validate_param("test_param", "test_model", test, items, 1) === nothing
+        end
+    end
+
+    # unique
+    @test OpenAPI.validate_param("test_param", "test_model", :uniqueItems, [1, 2, 3], true) === nothing
+    @test OpenAPI.validate_param("test_param", "test_model", :uniqueItems, [1, 2, 2], false) === nothing
+    @test_throws OpenAPI.ValidationException OpenAPI.validate_param("test_param", "test_model", :uniqueItems, [1, 2, 2], true)
+
+    # pattern
+    @test OpenAPI.validate_param("test_param", "test_model", :pattern, "test", r"[a-z]+") === nothing
+    @test_throws OpenAPI.ValidationException OpenAPI.validate_param("test_param", "test_model", :pattern, "test", r"[0-9]+")
+
+    # enum
+    @test OpenAPI.validate_param("test_param", "test_model", :enum, [:a, :b, :b], [:a, :b, :c]) === nothing
+    @test_throws OpenAPI.ValidationException OpenAPI.validate_param("test_param", "test_model", :enum, [:a, :b, :c, :d], [:a, :b, :c])
+    
+    return nothing
+end