Add configured nodes count (PR #8, fixes issue #5)

* Add count of configured nodes to response
* Test new number of configured nodes response property
* Add custom docker build script for a feature branch

Author: qubicmio

.github/workflows/push-docker-custom.yaml

@@ -0,0 +1,25 @@
+name: Deploy dev images to GHCR
+
+on:
+  push:
+    branches:
+      - 'feature/configured-nodes-count'
+
+jobs:
+  push-store-image:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout GitHub Action'
+        uses: actions/checkout@main
+
+      - name: 'Login to GitHub Container Registry'
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{github.actor}}
+          password: ${{secrets.GITHUB_TOKEN}}
+
+      - name: 'Build Inventory Image'
+        run: |
+          docker build . --tag ghcr.io/qubic/qubic-nodes:feature-configured-nodes
+          docker push ghcr.io/qubic/qubic-nodes:feature-configured-nodes

go.mod

@@ -6,11 +6,14 @@ require (
 	github.com/ardanlabs/conf v1.5.0
 	github.com/pkg/errors v0.9.1
 	github.com/qubic/go-node-connector v0.7.0
+	github.com/stretchr/testify v1.2.2
 )
 
 require (
 	github.com/cloudflare/circl v1.3.7 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/konsorten/go-windows-terminal-sequences v1.0.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/silenceper/pool v1.0.0 // indirect
 	github.com/sirupsen/logrus v1.4.2 // indirect
 	golang.org/x/sys v0.15.0 // indirect

web/handler.go

@@ -14,10 +14,11 @@ type RequestHandler struct {
 }
 
 type statusResponse struct {
-	MaxTick          uint32         `json:"max_tick"`
-	LastUpdate       int64          `json:"last_update"`
-	ReliableNodes    []nodeResponse `json:"reliable_nodes"`
-	MostReliableNode nodeResponse   `json:"most_reliable_node"`
+	MaxTick                 uint32         `json:"max_tick"`
+	LastUpdate              int64          `json:"last_update"`
+	NumberOfConfiguredNodes int            `json:"number_of_configured_nodes"`
+	ReliableNodes           []nodeResponse `json:"reliable_nodes"`
+	MostReliableNode        nodeResponse   `json:"most_reliable_node"`
 }
 
 type nodeResponse struct {
@@ -68,10 +69,11 @@ func (h *RequestHandler) HandleStatus(writer http.ResponseWriter, _ *http.Reques
 	}
 
 	response := statusResponse{
-		MaxTick:          containerResponse.MaxTick,
-		LastUpdate:       containerResponse.LastUpdate,
-		ReliableNodes:    reliableNodes,
-		MostReliableNode: mostReliableResponse,
+		MaxTick:                 containerResponse.MaxTick,
+		LastUpdate:              containerResponse.LastUpdate,
+		NumberOfConfiguredNodes: len(h.Container.Addresses),
+		ReliableNodes:           reliableNodes,
+		MostReliableNode:        mostReliableResponse,
 	}
 
 	data, err := json.Marshal(response)

web/handler_test.go

@@ -0,0 +1,93 @@
+package web
+
+import (
+	"github.com/qubic/go-qubic-nodes/node"
+	"github.com/stretchr/testify/assert"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+)
+
+func TestHandler_whenStatus_thenReturnNumberOfConfiguredNodes(t *testing.T) {
+
+	var node1 = node.Node{
+		Address:           "1.2.3.4",
+		Port:              "12345",
+		Peers:             []string{"2.3.4.5", "3.4.5.6"},
+		LastTick:          123,
+		LastUpdate:        1500000000,
+		LastUpdateSuccess: true,
+	}
+
+	var node2 = node.Node{
+		Address:           "2.3.4.5",
+		Port:              "12345",
+		Peers:             []string{"3.4.5.6", "1.2.3.4"},
+		LastTick:          122,
+		LastUpdate:        1500000000,
+		LastUpdateSuccess: true,
+	}
+
+	var container = node.Container{
+
+		Addresses:          []string{node1.Address, node2.Address},
+		Port:               "12345",
+		TickErrorThreshold: 3,
+		ReliableTickRange:  4,
+		OnlineNodes:        nil,
+		MaxTick:            123,
+		LastUpdate:         1500000000,
+		ReliableNodes:      []*node.Node{&node1},
+		MostReliableNode:   &node1,
+	}
+
+	handler := RequestHandler{
+		Container: &container,
+	}
+
+	expectedResponse := `{
+		"max_tick": 123,
+		"last_update": 1500000000,
+		"number_of_configured_nodes": 2,
+		"reliable_nodes": [
+			{ 
+			  "address": "1.2.3.4",
+			  "port": "12345",
+			  "peers": [
+				"2.3.4.5",
+				"3.4.5.6"
+			  ],
+			  "last_tick": 123,
+			  "last_update": 1500000000
+			}
+		],
+		"most_reliable_node": {
+			"address": "1.2.3.4",
+			"port": "12345",
+			"peers": [
+				"2.3.4.5",
+				"3.4.5.6"
+			],
+			"last_tick": 123,
+			"last_update": 1500000000
+		}
+	}`
+
+	resp := makeStatusCall(handler)
+	assert.Equal(t, "application/json", resp.Header.Get("Content-Type"), "Unexpected content type header")
+	assert.Equal(t, 200, resp.StatusCode, "Unexpected http status")
+	data, err := io.ReadAll(resp.Body)
+	assert.NoError(t, err)
+	assert.JSONEq(t, expectedResponse, string(data))
+}
+
+func makeStatusCall(handler RequestHandler) *http.Response {
+	rec := httptest.NewRecorder()
+	handler.HandleStatus(rec, nil)
+	resp := rec.Result()
+	defer func(Body io.ReadCloser) {
+		_ = Body.Close()
+	}(resp.Body)
+	return resp
+}