add version info

api/api.go

@@ -18,6 +18,7 @@ const (
 	activeConnectionsPath = "/api/v1/sftp_connection"
 	quotaScanPath         = "/api/v1/quota_scan"
 	userPath              = "/api/v1/user"
+	versionPath           = "/api/v1/version"
 )
 
 var (

api/api_test.go

@@ -35,6 +35,7 @@ const (
 	userPath              = "/api/v1/user"
 	activeConnectionsPath = "/api/v1/sftp_connection"
 	quotaScanPath         = "/api/v1/quota_scan"
+	versionPath           = "/api/v1/version"
 )
 
 var (
@@ -393,6 +394,17 @@ func TestStartQuotaScan(t *testing.T) {
 	}
 }
 
+func TestGetVersion(t *testing.T) {
+	_, _, err := api.GetVersion(http.StatusOK)
+	if err != nil {
+		t.Errorf("unable to get sftp version: %v", err)
+	}
+	_, _, err = api.GetVersion(http.StatusInternalServerError)
+	if err == nil {
+		t.Errorf("get version request must succeed, we requested to check a wrong status code")
+	}
+}
+
 func TestGetSFTPConnections(t *testing.T) {
 	_, _, err := api.GetSFTPConnections(http.StatusOK)
 	if err != nil {
@@ -668,6 +680,12 @@ func TestStartQuotaScanNonExistentUserMock(t *testing.T) {
 	checkResponseCode(t, http.StatusBadRequest, rr.Code)
 }
 
+func TestGetVersionMock(t *testing.T) {
+	req, _ := http.NewRequest(http.MethodGet, versionPath, nil)
+	rr := executeRequest(req)
+	checkResponseCode(t, http.StatusOK, rr.Code)
+}
+
 func TestGetSFTPConnectionsMock(t *testing.T) {
 	req, _ := http.NewRequest(http.MethodGet, activeConnectionsPath, nil)
 	rr := executeRequest(req)

api/api_utils.go

@@ -242,6 +242,24 @@ func CloseSFTPConnection(connectionID string, expectedStatusCode int) ([]byte, e
 	return body, err
 }
 
+// GetVersion returns version details
+func GetVersion(expectedStatusCode int) (utils.VersionInfo, []byte, error) {
+	var version utils.VersionInfo
+	var body []byte
+	resp, err := getHTTPClient().Get(buildURLRelativeToBase(versionPath))
+	if err != nil {
+		return version, body, err
+	}
+	defer resp.Body.Close()
+	err = checkResponse(resp.StatusCode, expectedStatusCode)
+	if err == nil && expectedStatusCode == http.StatusOK {
+		err = render.DecodeJSON(resp.Body, &version)
+	} else {
+		body, _ = getResponseBody(resp)
+	}
+	return version, body, err
+}
+
 func checkResponse(actual int, expected int) error {
 	if expected != actual {
 		return fmt.Errorf("wrong status code: got %v want %v", actual, expected)

api/internal_test.go

@@ -205,5 +205,9 @@ func TestApiCallToNotListeningServer(t *testing.T) {
 	if err == nil {
 		t.Errorf("request to an inactive URL must fail")
 	}
+	_, _, err = GetVersion(http.StatusOK)
+	if err == nil {
+		t.Errorf("request to an inactive URL must fail")
+	}
 	SetBaseURL(oldBaseURL)
 }

api/router.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/drakkan/sftpgo/logger"
 	"github.com/drakkan/sftpgo/sftpd"
+	"github.com/drakkan/sftpgo/utils"
 	"github.com/go-chi/chi"
 	"github.com/go-chi/chi/middleware"
 	"github.com/go-chi/render"
@@ -30,6 +31,10 @@ func initializeRouter() {
 		sendAPIResponse(w, r, nil, "Method not allowed", http.StatusMethodNotAllowed)
 	}))
 
+	router.Get(versionPath, func(w http.ResponseWriter, r *http.Request) {
+		render.JSON(w, r, utils.GetAppVersion())
+	})
+
 	router.Get(activeConnectionsPath, func(w http.ResponseWriter, r *http.Request) {
 		render.JSON(w, r, sftpd.GetConnectionsStats())
 	})

api/schema/openapi.yaml

@@ -7,6 +7,21 @@ info:
 servers:
 - url: /api/v1
 paths:
+  /version:
+    get:
+      tags:
+      - version
+      summary: Get version details
+      operationId: get_version
+      responses:
+        200:
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref : '#/components/schemas/VersionInfo'
   /sftp_connection:
     get:
       tags:
@@ -654,3 +669,13 @@ components:
           type: string
           nullable: true
           description: error description if any
+    VersionInfo:
+      type: object
+      properties:
+        version:
+          type: string
+        build_date:
+          type: string
+        commit_hash:
+          type: string
+