Merge pull request #295 from bstasyszyn/292

feat: Add REST endpoint for Sidetree version

pkg/peer/config/service.go

@@ -153,6 +153,8 @@ func (c *sidetreeService) LoadSidetreeHandlers(mspID, peerID string) ([]sidetree
 			return nil, err
 		}
 
+		cfg.Version = kv.ComponentVersion
+
 		handlers = append(handlers, cfg)
 	}
 

pkg/peer/sidetreesvc/channelctrl_test.go

@@ -159,7 +159,7 @@ func TestChannelController_Update(t *testing.T) {
 
 	time.Sleep(20 * time.Millisecond)
 	require.Len(t, ctrl.Invocations()[eventMethod], count+1)
-	require.Len(t, m.RESTHandlers(), 9)
+	require.Len(t, m.RESTHandlers(), 11)
 
 	t.Run("Update peer config -> success", func(t *testing.T) {
 		count := len(ctrl.Invocations()[eventMethod])

pkg/peer/sidetreesvc/restsvc.go

@@ -142,6 +142,8 @@ func newRESTHandlers(
 		)
 	}
 
+	handlers = append(handlers, sidetreehandler.NewVersionHandler(channelID, cfg))
+
 	return &restHandlers{
 		channelID:    channelID,
 		namespace:    cfg.Namespace,

pkg/peer/sidetreesvc/restsvc_test.go

@@ -84,7 +84,7 @@ func TestRESTHandlers(t *testing.T) {
 		rh, err := newRESTHandlers(channel1, nsCfg, bw, pp, os, restCfg)
 		require.NoError(t, err)
 		require.NotNil(t, rh)
-		require.Len(t, rh.HTTPHandlers(), 2)
+		require.Len(t, rh.HTTPHandlers(), 3)
 	})
 
 	t.Run("No resolver or batch-writer role -> no handlers", func(t *testing.T) {

pkg/rest/sidetreehandler/config.go

@@ -24,6 +24,8 @@ const (
 type Config struct {
 	Authorization authhandler.Config
 
+	// Version contains the version of the Sidetree endpoint
+	Version string
 	// DocType specifies the document type (DID or File index)
 	DocType DocumentType
 	// Namespace is the namespace prefix used in the ID of the document

pkg/rest/sidetreehandler/versionhandler.go

@@ -0,0 +1,27 @@
+/*
+Copyright SecureKey Technologies Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package sidetreehandler
+
+import (
+	"github.com/trustbloc/sidetree-fabric/pkg/rest/versionhandler"
+)
+
+const (
+	moduleName = "Sidetree"
+)
+
+// Version handles version requests
+type Version struct {
+	*versionhandler.Version
+}
+
+// NewVersionHandler returns a new Version handler
+func NewVersionHandler(channelID string, cfg Config) *Version {
+	return &Version{
+		Version: versionhandler.New(channelID, cfg.BasePath, moduleName, cfg.Version),
+	}
+}

pkg/rest/sidetreehandler/versionhandler_test.go

@@ -0,0 +1,59 @@
+/*
+Copyright SecureKey Technologies Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package sidetreehandler
+
+import (
+	"encoding/json"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/trustbloc/sidetree-fabric/pkg/httpserver"
+	"github.com/trustbloc/sidetree-fabric/pkg/rest/versionhandler"
+)
+
+const (
+	channel1 = "channel1"
+	version  = "0.1.3"
+)
+
+func TestNewVersionHandler(t *testing.T) {
+	handlerCfg := Config{
+		BasePath: "/sidetree",
+	}
+
+	h := NewVersionHandler(channel1, handlerCfg)
+	require.NotNil(t, h)
+
+	require.Equal(t, "/sidetree/version", h.Path())
+	require.Equal(t, http.MethodGet, h.Method())
+}
+
+func TestVersion_Handler(t *testing.T) {
+	handlerCfg := Config{
+		BasePath: "/sidetree",
+		Version:  version,
+	}
+
+	h := NewVersionHandler(channel1, handlerCfg)
+	require.NotNil(t, h)
+
+	rw := httptest.NewRecorder()
+	req := httptest.NewRequest(http.MethodGet, "/sidetree/version", nil)
+
+	h.Handler()(rw, req)
+
+	require.Equal(t, http.StatusOK, rw.Result().StatusCode)
+	require.Equal(t, httpserver.ContentTypeJSON, rw.Header().Get(httpserver.ContentTypeHeader))
+
+	resp := &versionhandler.Response{}
+	require.NoError(t, json.Unmarshal(rw.Body.Bytes(), resp))
+	require.Equal(t, moduleName, resp.Name)
+	require.Equal(t, version, resp.Version)
+}

test/bddtests/features/did-sidetree.feature

@@ -63,6 +63,10 @@ Feature:
     Given the authorization bearer token for "GET" requests to path "/sidetree/0.0.1/identifiers" is set to "${did_r}"
     And the authorization bearer token for "POST" requests to path "/sidetree/0.0.1/operations" is set to "${did_w}"
 
+    When an HTTP GET is sent to "https://localhost:48326/sidetree/0.0.1/version"
+    Then the JSON path "name" of the response equals "Sidetree"
+    And the JSON path "version" of the response equals "0.1.3"
+
     When client sends request to "https://localhost:48426/sidetree/0.0.1/operations" to create DID document in namespace "did:sidetree"
     Then check success response contains "#didDocumentHash"