diff options
Diffstat (limited to 'test/support')
| -rw-r--r-- | test/support/api_spec_helpers.ex | 57 | ||||
| -rw-r--r-- | test/support/conn_case.ex | 54 | 
2 files changed, 111 insertions, 0 deletions
| diff --git a/test/support/api_spec_helpers.ex b/test/support/api_spec_helpers.ex new file mode 100644 index 000000000..80c69c788 --- /dev/null +++ b/test/support/api_spec_helpers.ex @@ -0,0 +1,57 @@ +# Pleroma: A lightweight social networking server +# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/> +# SPDX-License-Identifier: AGPL-3.0-only + +defmodule Pleroma.Tests.ApiSpecHelpers do +  @moduledoc """ +  OpenAPI spec test helpers +  """ + +  import ExUnit.Assertions + +  alias OpenApiSpex.Cast.Error +  alias OpenApiSpex.Reference +  alias OpenApiSpex.Schema + +  def assert_schema(value, schema) do +    api_spec = Pleroma.Web.ApiSpec.spec() + +    case OpenApiSpex.cast_value(value, schema, api_spec) do +      {:ok, data} -> +        data + +      {:error, errors} -> +        errors = +          Enum.map(errors, fn error -> +            message = Error.message(error) +            path = Error.path_to_string(error) +            "#{message} at #{path}" +          end) + +        flunk( +          "Value does not conform to schema #{schema.title}: #{Enum.join(errors, "\n")}\n#{ +            inspect(value) +          }" +        ) +    end +  end + +  def resolve_schema(%Schema{} = schema), do: schema + +  def resolve_schema(%Reference{} = ref) do +    schemas = Pleroma.Web.ApiSpec.spec().components.schemas +    Reference.resolve_schema(ref, schemas) +  end + +  def api_operations do +    paths = Pleroma.Web.ApiSpec.spec().paths + +    Enum.flat_map(paths, fn {_, path_item} -> +      path_item +      |> Map.take([:delete, :get, :head, :options, :patch, :post, :put, :trace]) +      |> Map.values() +      |> Enum.reject(&is_nil/1) +      |> Enum.uniq() +    end) +  end +end diff --git a/test/support/conn_case.ex b/test/support/conn_case.ex index 064874201..fa30a0c41 100644 --- a/test/support/conn_case.ex +++ b/test/support/conn_case.ex @@ -51,6 +51,60 @@ defmodule Pleroma.Web.ConnCase do          %{user: user, token: token, conn: conn}        end +      defp request_content_type(%{conn: conn}) do +        conn = put_req_header(conn, "content-type", "multipart/form-data") +        [conn: conn] +      end + +      defp json_response_and_validate_schema( +             %{ +               private: %{ +                 open_api_spex: %{operation_id: op_id, operation_lookup: lookup, spec: spec} +               } +             } = conn, +             status +           ) do +        content_type = +          conn +          |> Plug.Conn.get_resp_header("content-type") +          |> List.first() +          |> String.split(";") +          |> List.first() + +        status = Plug.Conn.Status.code(status) + +        unless lookup[op_id].responses[status] do +          err = "Response schema not found for #{conn.status} #{conn.method} #{conn.request_path}" +          flunk(err) +        end + +        schema = lookup[op_id].responses[status].content[content_type].schema +        json = json_response(conn, status) + +        case OpenApiSpex.cast_value(json, schema, spec) do +          {:ok, _data} -> +            json + +          {:error, errors} -> +            errors = +              Enum.map(errors, fn error -> +                message = OpenApiSpex.Cast.Error.message(error) +                path = OpenApiSpex.Cast.Error.path_to_string(error) +                "#{message} at #{path}" +              end) + +            flunk( +              "Response does not conform to schema of #{op_id} operation: #{ +                Enum.join(errors, "\n") +              }\n#{inspect(json)}" +            ) +        end +      end + +      defp json_response_and_validate_schema(conn, _status) do +        flunk("Response schema not found for #{conn.method} #{conn.request_path} #{conn.status}") +      end +        defp ensure_federating_or_authenticated(conn, url, user) do          initial_setting = Config.get([:instance, :federating])          on_exit(fn -> Config.put([:instance, :federating], initial_setting) end) | 
