Skip to content

refactor openapi & swagger tests a bit #802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
opqdonut merged 2 commits into from
Sep 18, 2026
Merged

refactor openapi & swagger tests a bit #802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5a8fb5
test: golf sort-spec-parameters
opqdonut Sep 18, 2026
8d6d453
test: more systematic normalization in reitit.swagger-test
opqdonut Sep 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 5 additions & 14 deletions test/cljc/reitit/openapi_test.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,20 +44,11 @@
(if-not (:paths spec)
spec
(update spec :paths
(fn [paths]
(reduce-kv
(fn [ps path methods]
(assoc ps path
(reduce-kv
(fn [ms method op]
(assoc ms method
(cond-> op
(contains? op :parameters)
(update :parameters sorted-parameters))))
methods
methods)))
paths
paths)))))
update-vals (fn [path]
(update-vals path (fn [method]
(if-not (:parameters method)
method
(update method :parameters sorted-parameters))))))))

(def app
(ring/ring-handler
Expand Down
184 changes: 86 additions & 98 deletions test/cljc/reitit/swagger_test.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,40 +15,30 @@
[spec-tools.data-spec :as ds]
[malli.core :as mc]))

(defn- normalize
"Normalize swagger parameter arrays by converting to json and back.
Handles differences like :q vs \"q\"."
[data]
(-> data
j/write-value-as-string
(j/read-value j/keyword-keys-object-mapper)))

(defn- sorted-parameters
"Swagger parameter arrays are unordered. Sort for `=` so tests do not
depend on Clojure map seq order."
[params]
(when params
(vec (sort-by (juxt :in #(str (:name %))) params))))

(defn- normalize
"Normalize swagger parameter arrays by converting to json and back, then
sorting. Handles differences like :q vs \"q\" and map seq order."
[data]
(-> data
j/write-value-as-string
(j/read-value j/keyword-keys-object-mapper)
sorted-parameters))

(defn- sort-spec-parameters [spec]
(if-not (:paths spec)
spec
(update spec :paths
(fn [paths]
(reduce-kv
(fn [ps path methods]
(assoc ps path
(reduce-kv
(fn [ms method op]
(assoc ms method
(cond-> op
(contains? op :parameters)
(update :parameters sorted-parameters))))
methods
methods)))
paths
paths)))))
update-vals (fn [path]
(update-vals path (fn [method]
(if-not (:parameters method)
method
(update method :parameters sorted-parameters))))))))

(def malli-registry
(merge
Expand Down Expand Up @@ -183,8 +173,8 @@
:query-params {:x "2", :y "1"}})))))

(testing "swagger-spec"
(let [spec (:body (app {:request-method :get
:uri "/api/swagger.json"}))
(let [spec (sort-spec-parameters (:body (app {:request-method :get
:uri "/api/swagger.json"})))
expected {:x-id #{::math}
:swagger "2.0"
:info {:title "my-api"}
Expand All @@ -204,20 +194,20 @@
:options {:parameters []
:summary "options"
:responses {200 {:description "200"}}}
:get {:parameters [{:in "query"
:name "x"
:get {:parameters [{:in "path"
:name "z"
:description ""
:required true
:type "integer"
:format "int64"}
{:in "query"
:name "y"
:name "x"
:description ""
:required true
:type "integer"
:format "int64"}
{:in "path"
:name "z"
{:in "query"
:name "y"
:description ""
:required true
:type "integer"
Expand Down Expand Up @@ -255,20 +245,20 @@
:description "kosh"}
500 {:description "fail"}}
:summary "plus with body"}}
"/api/malli/plus/{z}" {:get {:parameters [{:in "query"
:name :x
"/api/malli/plus/{z}" {:get {:parameters [{:in "path"
:name :z
:description ""
:required true
:type "integer"
:format "int64"}
{:in "query"
:name :y
:name :x
:description ""
:required true
:type "integer"
:format "int64"}
{:in "path"
:name :z
{:in "query"
:name :y
:description ""
:required true
:type "integer"
Expand Down Expand Up @@ -323,7 +313,13 @@
:description ""}
500 {:description "fail"}}
:summary "plus put with definitions"}}
"/api/schema/plus/{z}" {:get {:parameters [{:description ""
"/api/schema/plus/{z}" {:get {:parameters [{:in "path"
:name "z"
:description ""
:type "integer"
:required true
:format "int32"}
{:description ""
:format "int32"
:in "query"
:name "x"
Expand All @@ -334,13 +330,7 @@
:in "query"
:name "y"
:required true
:type "integer"}
{:in "path"
:name "z"
:description ""
:type "integer"
:required true
:format "int32"}]
:type "integer"}]
:responses {200 {:description ""
:schema {:additionalProperties false
:properties {"total" {:format "int32"
Expand Down Expand Up @@ -375,14 +365,14 @@
:description "kosh"}
500 {:description "fail"}}
:summary "plus with body"}}}}]
(is (= (sort-spec-parameters expected) (sort-spec-parameters spec)))
(is (= expected spec))

(testing "ring-async swagger-spec"
(let [response* (atom nil)
respond (partial reset! response*)]
(app {:request-method :get
:uri "/api/swagger.json"} respond (fn [_] (is false)))
(is (= (sort-spec-parameters expected)
(is (= expected
(sort-spec-parameters (:body @response*)))))))))

(defn spec-paths [app uri]
Expand Down Expand Up @@ -522,20 +512,19 @@
spec (-> {:request-method :get
:uri "/swagger.json"}
app
:body)]
(is (= (normalize
[{:description ""
:in "formData"
:name "file"
:required true
:type "file"}
{:description ""
:in "formData"
:name "more"
:required true
:type "string"}])
(normalize
(get-in spec [:paths "/upload" :post :parameters]))))))))
:body
sort-spec-parameters)]
(is (= [{:description ""
:in "formData"
:name "file"
:required true
:type "file"}
{:description ""
:in "formData"
:name "more"
:required true
:type "string"}]
(normalize (get-in spec [:paths "/upload" :post :parameters]))))))))

(def X :int)
(def Y :int)
Expand All @@ -560,43 +549,42 @@
["/swagger.json"
{:get {:no-doc true
:handler (swagger/create-swagger-handler)}}]]))
spec (:body (app {:request-method :get, :uri "/swagger.json"}))]
(is (= (sort-spec-parameters
{:definitions {"reitit.swagger-test.Plus" {:properties {:x {:$ref "#/definitions/reitit.swagger-test.X"},
:y {:$ref "#/definitions/reitit.swagger-test.Y"}},
:required [:x :y],
:type "object"},
"reitit.swagger-test.X" {:format "int64",
:type "integer"},
"reitit.swagger-test.Y" {:format "int64",
:type "integer"},
"reitit.swagger-test.Result" {:type "object",
:properties {:result {:type "integer", :format "int64"}},
:required [:result]}},
:paths {"/post" {:post {:parameters [{:description "",
:in "body",
:name "body",
:required true,
:schema {:$ref "#/definitions/reitit.swagger-test.Plus"}}]
:responses {200 {:description ""
:schema {:$ref "#/definitions/reitit.swagger-test.Result"}}}}}
"/get" {:get {:parameters [{:in "query"
:name :x
:description ""
:type "integer"
:required true
:format "int64"}
{:in "query"
:name :y
:description ""
:type "integer"
:required true
:format "int64"}]
:responses {200 {:description ""
:schema {:$ref "#/definitions/reitit.swagger-test.Result"}}}}}}
:swagger "2.0",
:x-id #{:reitit.swagger/default}})
(sort-spec-parameters spec)))))
spec (sort-spec-parameters (:body (app {:request-method :get, :uri "/swagger.json"})))]
(is (= {:definitions {"reitit.swagger-test.Plus" {:properties {:x {:$ref "#/definitions/reitit.swagger-test.X"},
:y {:$ref "#/definitions/reitit.swagger-test.Y"}},
:required [:x :y],
:type "object"},
"reitit.swagger-test.X" {:format "int64",
:type "integer"},
"reitit.swagger-test.Y" {:format "int64",
:type "integer"},
"reitit.swagger-test.Result" {:type "object",
:properties {:result {:type "integer", :format "int64"}},
:required [:result]}},
:paths {"/post" {:post {:parameters [{:description "",
:in "body",
:name "body",
:required true,
:schema {:$ref "#/definitions/reitit.swagger-test.Plus"}}]
:responses {200 {:description ""
:schema {:$ref "#/definitions/reitit.swagger-test.Result"}}}}}
"/get" {:get {:parameters [{:in "query"
:name :x
:description ""
:type "integer"
:required true
:format "int64"}
{:in "query"
:name :y
:description ""
:type "integer"
:required true
:format "int64"}]
:responses {200 {:description ""
:schema {:$ref "#/definitions/reitit.swagger-test.Result"}}}}}}
:swagger "2.0",
:x-id #{:reitit.swagger/default}}
spec))))

(deftest swagger-schema-tests
(testing "s/Any"
Expand All @@ -611,7 +599,7 @@
:responses {200 {:body {:bar s/Any}}}
:handler identity}}]]
{:data {:coercion schema/coercion}}))
spec (:body (app {:request-method :get :uri "/swagger.json"}))]
spec (sort-spec-parameters (:body (app {:request-method :get :uri "/swagger.json"})))]
(is (= {200 {:schema {:type "object",
:properties {"bar" {}},
:additionalProperties false,
Expand All @@ -633,4 +621,4 @@
:type "string",
:required true,
:allowEmptyValue true}]
(sort-by :in (get-in spec [:paths "/post" :post :parameters])))))))
(get-in spec [:paths "/post" :post :parameters]))))))
Loading