334 - updated endpoint paths validation to be more clear

Author: mmacai

lib/rig_api/v1/apis_test.exs

@@ -367,10 +367,7 @@ defmodule RigApi.V1.APIsTest do
                "invalid-config/" => [
                  %{"id" => "must be string"},
                  %{"id" => "must have a length of at least 1"},
-                 %{"path" => "must be string"},
-                 %{"path" => "must have a length of at least 1"},
-                 %{"path_regex" => "must be string"},
-                 %{"path_regex" => "must have a length of at least 1"},
+                 %{"path, path_regex" => "Either path or path_regex must be set"},
                  %{"method" => "must be string"},
                  %{"method" => "must have a length of at least 1"}
                ]

lib/rig_api/v2/apis_test.exs

@@ -367,10 +367,7 @@ defmodule RigApi.V2.APIsTest do
                "invalid-config/" => [
                  %{"id" => "must be string"},
                  %{"id" => "must have a length of at least 1"},
-                 %{"path" => "must be string"},
-                 %{"path" => "must have a length of at least 1"},
-                 %{"path_regex" => "must be string"},
-                 %{"path_regex" => "must have a length of at least 1"},
+                 %{"path, path_regex" => "Either path or path_regex must be set"},
                  %{"method" => "must be string"},
                  %{"method" => "must have a length of at least 1"}
                ]

lib/rig_api/v3/apis_test.exs

@@ -367,10 +367,7 @@ defmodule RigApi.V3.APIsTest do
                "invalid-config/" => [
                  %{"id" => "must be string"},
                  %{"id" => "must have a length of at least 1"},
-                 %{"path" => "must be string"},
-                 %{"path" => "must have a length of at least 1"},
-                 %{"path_regex" => "must be string"},
-                 %{"path_regex" => "must have a length of at least 1"},
+                 %{"path, path_regex" => "Either path or path_regex must be set"},
                  %{"method" => "must be string"},
                  %{"method" => "must have a length of at least 1"}
                ]

lib/rig_inbound_gateway/api_proxy/validations.ex

@@ -12,6 +12,9 @@ defmodule RigInboundGateway.ApiProxy.Validations do
 
   require Logger
 
+  @endpoint_paths ["path", "path_regex"]
+  @endpoint_paths_error_key "path, path_regex"
+
   @type error_t :: [{:error, String.t() | atom, atom, String.t()}]
   @type error_list_t :: [{String.t(), error_t()}]
   @type error_map_t :: %{String.t() => [%{(String.t() | atom) => String.t()}]}
@@ -90,10 +93,23 @@ defmodule RigInboundGateway.ApiProxy.Validations do
 
   @spec validate_endpoint_path(Api.endpoint()) :: error_list_t()
   def validate_endpoint_path(endpoint) do
-    errors = validate_string(endpoint, "path") ++ validate_string(endpoint, "path_regex")
-
-    # each option can produce 2 errors, so 4 in total, therefore 2 is the min value for number of errors
-    with_any_error(errors, 2)
+    present_paths =
+      @endpoint_paths
+      |> Enum.filter(fn key -> Map.has_key?(endpoint, key) end)
+
+    case present_paths do
+      [] ->
+        [{:error, @endpoint_paths_error_key, :by, "Either path or path_regex must be set"}]
+
+      [path] ->
+        validate_string(endpoint, path)
+
+      _ ->
+        [
+          {:error, @endpoint_paths_error_key, :by,
+           "You can't set path and path_regex at the same time"}
+        ]
+    end
   end
 
   # ---

test/rig_inbound_gateway/rig/proxy_test.exs

@@ -154,7 +154,68 @@ defmodule RigInboundGateway.ProxyTest do
 
       test_proxy_exit(
         ctx,
-        "[{\"invalid-config/\", [{:error, \"id\", :by, \"must be string\"}, {:error, \"id\", :length, \"must have a length of at least 1\"}, {:error, \"path\", :by, \"must be string\"}, {:error, \"path\", :length, \"must have a length of at least 1\"}, {:error, \"path_regex\", :by, \"must be string\"}, {:error, \"path_regex\", :length, \"must have a length of at least 1\"}, {:error, \"method\", :by, \"must be string\"}, {:error, \"method\", :length, \"must have a length of at least 1\"}]}]"
+        "[{\"invalid-config/\", [{:error, \"id\", :by, \"must be string\"}, {:error, \"id\", :length, \"must have a length of at least 1\"}, {:error, \"path, path_regex\", :by, \"Either path or path_regex must be set\"}, {:error, \"method\", :by, \"must be string\"}, {:error, \"method\", :length, \"must have a length of at least 1\"}]}]"
+      )
+
+      ProxyConfig.restore()
+    end
+
+    test "should exit the process when 'endpoint' has 'path' and 'path_regex' set at the same time",
+         ctx do
+      endpoints = [
+        %{
+          "id" => @invalid_config_id <> "1",
+          "method" => "GET",
+          "path" => "/",
+          "path_regex" => "/"
+        }
+      ]
+
+      ProxyConfig.set_proxy_config(@invalid_config_id, endpoints)
+
+      test_proxy_exit(
+        ctx,
+        "[{\"invalid-config/invalid-config1\", [{:error, \"path, path_regex\", :by, \"You can't set path and path_regex at the same time\"}]}]"
+      )
+
+      ProxyConfig.restore()
+    end
+
+    test "should exit the process when 'path' is set, but incorrect",
+         ctx do
+      endpoints = [
+        %{
+          "id" => @invalid_config_id <> "1",
+          "method" => "GET",
+          "path" => ""
+        }
+      ]
+
+      ProxyConfig.set_proxy_config(@invalid_config_id, endpoints)
+
+      test_proxy_exit(
+        ctx,
+        "[{\"invalid-config/invalid-config1\", [{:error, \"path\", :length, \"must have a length of at least 1\"}]}]"
+      )
+
+      ProxyConfig.restore()
+    end
+
+    test "should exit the process when 'path_regex' is set, but incorrect",
+         ctx do
+      endpoints = [
+        %{
+          "id" => @invalid_config_id <> "1",
+          "method" => "GET",
+          "path_regex" => ""
+        }
+      ]
+
+      ProxyConfig.set_proxy_config(@invalid_config_id, endpoints)
+
+      test_proxy_exit(
+        ctx,
+        "[{\"invalid-config/invalid-config1\", [{:error, \"path_regex\", :length, \"must have a length of at least 1\"}]}]"
       )
 
       ProxyConfig.restore()