Merge branch 'main' into bump/deps-2024-07

Author: rafaeldelboni

resources/config.edn

@@ -10,10 +10,10 @@
             :host #or [#env DB_HOST "localhost"]
             :port #or [#env DB_PORT 5432]}
 
- :db-docs {:dir "target"
-           :url "https://github.com/clj-codes/docs.extractor/releases/download"
-           :version "v0.3.4"
-           :file-name "docs-db.zip"}
+ :db-docs {:dir #or [#env DB_DOCS_DIR "target"]
+           :url #or [#env DB_DOCS_URL "https://github.com/clj-codes/docs.extractor/releases/download"]
+           :version #or [#env DB_DOCS_VERSION "v0.3.4"]
+           :file-name #or [#env DB_DOCS_FILE_NAME "docs-db.zip"]}
 
  :github {:client {:id #or [#env GH_CLIENT_ID "app-client-id"]
                    :secret #or [#env GH_CLIENT_SECRET "app-client-secret"]}}

src/codes/clj/docs/backend/ports/http_in/ops.clj

@@ -0,0 +1,5 @@
+(ns codes.clj.docs.backend.ports.http-in.ops)
+
+(defn health
+  [_]
+  {:status 200 :body "OK"})

src/codes/clj/docs/backend/routes.clj

@@ -1,6 +1,7 @@
 (ns codes.clj.docs.backend.routes
   (:require [codes.clj.docs.backend.interceptors :as backend.interceptors]
             [codes.clj.docs.backend.ports.http-in.document :as ports.http-in.document]
+            [codes.clj.docs.backend.ports.http-in.ops :as ports.http-in.ops]
             [codes.clj.docs.backend.ports.http-in.social :as ports.http-in.social]
             [codes.clj.docs.backend.schemas.wire.in.social :as schemas.wire.in.social]
             [codes.clj.docs.backend.schemas.wire.out.document :as schemas.wire.out.document]
@@ -15,6 +16,15 @@
                             :description "codes.clj.docs.backend"}}
            :handler (swagger/create-swagger-handler)}}]
 
+   ["/ops"
+    {:swagger {:tags ["ops"]}}
+
+    ["/health"
+     {:get {:summary "health check"
+            :responses {200 {:body :string}
+                        500 {:body :string}}
+            :handler ports.http-in.ops/health}}]]
+
    ["/api"
 
     ["/login"

test/integration/codes/clj/docs/backend/ops_test.clj

@@ -0,0 +1,20 @@
+(ns integration.codes.clj.docs.backend.ops-test
+  (:require [clojure.test :refer [use-fixtures]]
+            [integration.codes.clj.docs.backend.util :as util]
+            [parenthesin.helpers.malli :as helpers.malli]
+            [parenthesin.helpers.state-flow.server.pedestal :as state-flow.server]
+            [state-flow.api :refer [defflow flow]]
+            [state-flow.assertions.matcher-combinators :refer [match?]]))
+
+(use-fixtures :once helpers.malli/with-intrumentation)
+
+(defflow
+  flow-integration-ops-test
+  {:init util/start-system!
+   :cleanup util/stop-system!
+   :fail-fast? true}
+  (flow "should interact with system"
+    (flow "health check"
+      (match? {:status 200 :body "OK"}
+              (state-flow.server/request! {:method :get
+                                           :uri    "/ops/health"})))))