Merge pull request #19 from stolen/add-github-ci-workflow

maxlapshin · web-flow · commit bfa5545cb91b · 2025-10-17T17:45:26.000+03:00
define tests workflow, drop obsolete deps
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,51 @@
+name: Erlang CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  common_test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        otp_ver: [27, 28, latest]
+    container:
+      image: erlang:${{ matrix.otp_ver }}
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Run tests
+      env:
+        REBAR_CONFIG: rebar.config_
+      run: rebar3 as dev ct --logdir test-logs --readable true -vv
+    - name: upload CT report
+      uses: actions/upload-artifact@v4
+      with:
+        name: ct_report_${{ matrix.otp_ver }}
+        path: test-logs/ct_run*/
+
+  common_test_legacy:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        otp_ver: [24, 25, 26]
+    container:
+      image: erlang:${{ matrix.otp_ver }}
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Run tests
+      env:
+        REBAR_CONFIG: rebar.config.pre27_
+      run: rebar3 as dev ct --logdir test-logs --readable true -vv
+    - name: upload CT report
+      uses: actions/upload-artifact@v4
+      with:
+        name: ct_report_${{ matrix.otp_ver }}
+        path: test-logs/ct_run*/
diff --git a/rebar.config.pre27_ b/rebar.config.pre27_
@@ -0,0 +1,14 @@
+% No deps by default to prevent conflicts
+{deps, [
+]}.
+
+{profiles, [
+  {dev, [
+    {deps, [
+      jsx,
+      {cowboy, "2.12.0"},
+      redbug
+    ]},
+    {ct_opts, [{ct_hooks, [cth_surefire]}]}
+  ]}
+]}.
diff --git a/rebar.config_ b/rebar.config_
@@ -5,10 +5,7 @@
 {profiles, [
   {dev, [
     {deps, [
-      jsx,
-      yamerl,
       {cowboy, "2.12.0"},
-      {lhttpc, {git, "https://github.com/erlyvideo/lhttpc.git", {branch, "master"}}},
       redbug
     ]},
     {ct_opts, [{ct_hooks, [cth_surefire]}]}
diff --git a/src/openapi_client.erl b/src/openapi_client.erl
@@ -61,13 +61,8 @@ call(#{schema := Schema, uri := URI} = State, OperationId, Args0, Opts) when is_
         #{raw_body := _} -> <<"raw_file_upload">>;
         _ -> RequestBody
       end]),
-      Timeout = proplists:get_value(timeout, Opts, 50000),
-      Result = case lhttpc:request(RequestURL, Method, RequestHeaders, RequestBody, Timeout) of
-        {ok, {{Code0,_},ResponseHeaders0,Bin0}} ->
-          {ok, Code0, [{string:to_lower(K),V} || {K,V} <- ResponseHeaders0], Bin0};
-        {error, E0} ->
-          {error, E0}
-      end,
+      HttpRequestFun = proplists:get_value(http_request_fun, Opts, fun http_request_httpc/5),
+      Result = HttpRequestFun(Method, RequestURL, RequestHeaders, RequestBody, Opts),
 
       case Result of
         {ok, Code,ResponseHeaders,Bin} when is_map_key(Code, Responses) ->
@@ -130,6 +125,31 @@ call(#{} = State, OperationId, Args, Opts) ->
   end.
 
 
+-spec http_request_httpc(
+    Method :: get | post | put | patch | delete,
+    URL :: uri_string:uri_string(),
+    Headers :: [{string(), string()}],
+    Body :: binary(),
+    Opts :: proplists:proplist()
+) ->
+  {ok, Status :: integer(), Headers :: [{NameLowercase :: string(), string()}], Body :: binary()} |
+  {error, any()}.
+
+http_request_httpc(Method, RequestURL, RequestHeaders, RequestBody, Opts) ->
+  Timeout = proplists:get_value(timeout, Opts, 50000),
+  Request = case Method of
+    get ->
+      {RequestURL, RequestHeaders};
+    _ ->
+      ContentType = proplists:get_value("Content-Type", RequestHeaders, "text/plain"),
+      {RequestURL, RequestHeaders, ContentType, RequestBody}
+  end,
+  case httpc:request(Method, Request, [{timeout, Timeout}], [{body_format, binary}]) of
+    {ok, {{_, Code0, _}, ResponseHeaders0, Bin0}} ->
+      {ok, Code0, [{string:to_lower(K), V} || {K, V} <- ResponseHeaders0], Bin0};
+    {error, E0} ->
+      {error, E0}
+  end.
 
 
 search_operation(OperationId, #{paths := Paths}) ->
diff --git a/src/openapi_schema.erl b/src/openapi_schema.erl
@@ -47,7 +47,7 @@ process(Input, #{} = Opts) ->
     (patch,Flag) when Flag == true; Flag == false -> ok;
     (extra_obj_key,Flag) when Flag == drop; Flag == error -> ok;
     (required_obj_keys,Flag) when Flag == drop; Flag == error -> ok;
-    (access_type,Flag) when Flag == read; Flag == write -> ok;
+    (access_type,Flag) when Flag == read; Flag == write; Flag == raw -> ok;
     (explain,FlagList) -> check_explain_keys(FlagList);
     (K,V) -> error({unknown_option,K,V})
   end, Opts),
@@ -88,6 +88,8 @@ prepare_type(#{oneOf := Types} = Type0) ->
   Type0#{oneOf := [prepare_type(T) || T <- Types]};
 prepare_type(#{type := <<"object">>, properties := Props} = Type0) ->
   Type0#{properties => maps:map(fun(_, T) -> prepare_type(T) end, Props)};
+prepare_type(#{type := <<"array">>, items := Items} = Type0) ->
+  Type0#{items => prepare_type(Items)};
 prepare_type(#{} = Type0) ->
   % Convert format name to atom. This matches validators syntax
   Type1 = case Type0 of
@@ -205,13 +207,15 @@ encode3(#{discriminator := #{propertyName := DKey, mapping := DMap}} = Schema, O
         try binary_to_existing_atom(DValue) catch error:badarg -> DValue end;
       #{ADKey := DValue} when is_binary(DValue) ->
         try binary_to_existing_atom(DValue) catch error:badarg -> DValue end;
-      #{} -> undefined
+      #{} -> undefined;
+      {error, _} -> Input_
     end
   end,
-  ADvalue1 = DefaultFun(Input),
+  DiscrInput = maps:with([DKey, ADKey], Input),
+  ADvalue1 = DefaultFun(DiscrInput),
   ADvalue2 = case ADvalue1 of
     undefined ->
-      Try = encode3(hd(Types), Opts#{apply_defaults => true, required_obj_keys => drop}, Input, Path),
+      Try = encode3(hd(Types), Opts#{apply_defaults => true, required_obj_keys => drop}, DiscrInput, Path),
       DefaultFun(Try);
     _ ->
       ADvalue1
@@ -222,6 +226,9 @@ encode3(#{discriminator := #{propertyName := DKey, mapping := DMap}} = Schema, O
       encode3(maps:without([discriminator], Schema), Opts, Input, Path);
     {undefined, _} ->
       {error, #{error => discriminator_missing, path => Path, propertyName => DKey}};
+    {{error, _}, _} ->
+      % this error comes from processing discriminator with first possible type, and may contain useful type error (e.g. not_string)
+      ADvalue2;
     {_, undefined} ->
       {error, #{error => discriminator_unmapped, path => Path, propertyName => DKey, value => ADvalue2}};
     {_, _} ->
@@ -282,9 +289,11 @@ encode3(#{type := <<"object">>, properties := Properties} = Schema, #{query := Q
 
       RequiredKeys = get_required_keys(Schema, Opts),
       IsReadOnly = maps:get(readOnly, Prop, false),
+      IsWriteOnly = maps:get(writeOnly, Prop, false),
       IsPrimary = maps:get('x-primary-key', Prop, false),
       IsRequired = (lists:member(FieldBin, RequiredKeys) orelse IsPrimary),
-      IsWriteAccess = maps:get(access_type, Opts, read) == write,
+      IsReadAccess = maps:get(access_type, Opts, raw) == read,
+      IsWriteAccess = maps:get(access_type, Opts, raw) == write,
 
       ApplyDefaults = maps:get(apply_defaults, Opts, false),
       EffectiveValue = case {Input, Prop} of
@@ -315,9 +324,12 @@ encode3(#{type := <<"object">>, properties := Properties} = Schema, #{query := Q
         {ok, Null} when (Null == null orelse Null == undefined) andalso
           not NullableProp andalso not Patching ->
           Obj;
-        % Silently drop read only fields with write access
+        % Silently drop readOnly fields on write
         {ok, _Value} when IsWriteAccess andalso IsReadOnly andalso (not IsRequired) ->
           Obj;
+        % Silently drop writeOnly fields on read
+        {ok, _Value} when IsReadAccess andalso IsWriteOnly andalso (not IsRequired) ->
+          Obj;
         {ok, Value} ->
           case encode3(Prop#{nullable => NullableProp}, Opts, Value, Path ++ [Field]) of
             {error, _} = E ->
@@ -450,6 +462,9 @@ encode3(#{const := Value}, #{auto_convert := Convert}, Input, Path) when is_atom
     _ -> {error, #{error => not_const2, path => Path, input => Input, value => Value}}
   end;
 
+encode3(#{const := Value}, #{}, Input, Path) ->
+  {error, #{error => not_const, path => Path, input => Input, value => Value}};
+
 encode3(#{enum := Choices, type := <<"string">>}, #{auto_convert := Convert}, Input, Path) ->
   InputValue = case Input of
     _ when is_binary(Input) -> Input;
@@ -465,6 +480,7 @@ encode3(#{enum := Choices, type := <<"string">>}, #{auto_convert := Convert}, In
 encode3(#{type := <<"string">>} = Spec, #{auto_convert := Convert} = Options, Input, Path) ->
   {Input1, InputForValidation} = case Input of
     _ when is_binary(Input) -> {Input, Input};
+    _ when is_boolean(Input) -> {{error, #{error => not_string, path => Path, input => Input}}, undefined};
     _ when is_atom(Input) andalso Convert -> {atom_to_binary(Input), atom_to_binary(Input)};
     _ when is_atom(Input) -> {Input, atom_to_binary(Input)};
     _ -> {{error, #{error => not_string, path => Path, input => Input}}, undefined}
@@ -473,11 +489,12 @@ encode3(#{type := <<"string">>} = Spec, #{auto_convert := Convert} = Options, In
     {error, _} ->
       Input1;
     _ ->
+      Length = string:length(InputForValidation),
       case Spec of
-        #{minLength := MinLength} when size(InputForValidation) < MinLength ->
-          {error, #{error => too_short, path => Path, input => Input, min_length => MinLength}};
-        #{maxLength := MaxLength} when size(InputForValidation) > MaxLength ->
-          {error, #{error => too_long, path => Path, input => Input, max_length => MaxLength}};
+        #{minLength := MinLength} when Length < MinLength ->
+          {error, #{error => too_short, path => Path, input => Input, detail => Length, min_length => MinLength}};
+        #{maxLength := MaxLength} when Length > MaxLength ->
+          {error, #{error => too_long, path => Path, input => Input, detail => Length, max_length => MaxLength}};
         #{} ->
           Format = maps:get(format, Spec, undefined),
           Validators = maps:get(validators, Options),
diff --git a/test/example-openapi.json b/test/example-openapi.json
@@ -0,0 +1,41 @@
+{
+  "openapi": "3.1.1",
+  "info": {
+    "contact": { "email": "hello@exampl.com", "name": "Test", "url": "https://example.com/" },
+    "description": "dummy desc",
+    "title": "Test API",
+    "version": "0.1.0"
+  },
+  "components": {
+    "schemas": {
+      "external_validators_simple": {
+        "type": "string",
+        "format": "no_space"
+      },
+      "external_validators_array": {
+        "type": "array",
+        "items": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "format": "no_space"
+          }
+        }
+      },
+      "external_validators_object": {
+        "type": "object",
+        "properties": {
+          "in_object": {
+            "type": "object",
+            "properties": {
+              "prop1": {
+                "type": "string",
+                "format": "no_space"
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/test/openapi_handler_SUITE.erl b/test/openapi_handler_SUITE.erl
@@ -42,8 +42,8 @@ start_http(Routes, ApiName) ->
 
 
 init_per_suite(Config) ->
+  inets:start(),
   {ok, _} = application:ensure_all_started(cowboy),
-  {ok, _} = application:ensure_all_started(lhttpc),
 
   PetstorePath = filename:join(code:lib_dir(openapi_handler),"test/redocly-petstore.json"),
   TestSchemaPath = filename:join(code:lib_dir(openapi_handler),"test/test_schema.json"),
@@ -183,9 +183,9 @@ json_body_parameters(_) ->
 broken_json(_) ->
   Port = integer_to_list(ranch:get_port(petstore_api_server)),
   JSON = "{\"key\":\"value\"]}",
-  {ok, {{400,_},Headers,Body}} = lhttpc:request("http://127.0.0.1:"++Port++"/test/yml/store/order", post,
-    [{"Content-Type", "application/json"}], JSON, 5000),
-  "application/json" = proplists:get_value("Content-Type", Headers),
+  Request = {"http://127.0.0.1:"++Port++"/test/yml/store/order", [], "application/json", JSON},
+  {ok, {{_, 400, _}, Headers, Body}} = httpc:request(post, Request, [{timeout, 5000}], [{body_format, binary}]),
+  "application/json" = proplists:get_value("content-type", Headers),
   #{<<"error">> := <<"broken_json">>} = openapi_json:decode(Body),
   ok.
 
@@ -438,18 +438,12 @@ required_keys_filter(_) ->
 
 
 select_not_filters_required_keys(_) ->
+  % p3 is 'writeOnly', so it should be dropped in results
   #{elements := [Elem1,Elem1]} = openapi_client:call(test_schema_api, selectCollectionFields,
       #{json_body => #{p1 => 1, p2 => 2, p3 => 3, p4 => 4, p5 => 5}}),
-  #{p1 := 1, p2 := 2, p3 := 3, p4 := 4, p5 :=5} = Elem1,
+  #{p1 := 1, p2 := 2, p4 := 4, p5 :=5} = Elem1,
 
-  % p1, p2 are 'readOnly' required keys
-  #{elements := [Elem2,Elem2]} = openapi_client:call(test_schema_api, selectCollectionFields,
-      #{json_body => #{p1 => 1, p2 => 2, p3 => 3, p4 => 4, p5 => 5}, select => <<"p3">>}),
-  #{p1 := 1, p2 := 2, p3 := 3} = Elem2,
-  undefined = maps:get(p4, Elem2, undefined),
-  undefined = maps:get(p5, Elem2, undefined),
-
-  % p3 is 'writeOnly' required key
+  % p1, p2 are required keys, so they are returned despite not explicitly requested
   #{elements := [Elem3,Elem3]} = openapi_client:call(test_schema_api, selectCollectionFields,
       #{json_body => #{p1 => 1, p2 => 2, p3 => 3, p4 => 4, p5 => 5}, select => <<"p4">>}),
   #{p1 := 1, p2 := 2, p4 := 4} = Elem3,
diff --git a/test/openapi_schema_SUITE.erl b/test/openapi_schema_SUITE.erl
