feat: Add serverinfo command (#440)

Author: ankitpokhrel

internal/cmd/root/root.go

@@ -4,8 +4,6 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/ankitpokhrel/jira-cli/pkg/netrc"
-
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
@@ -18,10 +16,12 @@ import (
 	"github.com/ankitpokhrel/jira-cli/internal/cmd/me"
 	"github.com/ankitpokhrel/jira-cli/internal/cmd/open"
 	"github.com/ankitpokhrel/jira-cli/internal/cmd/project"
+	"github.com/ankitpokhrel/jira-cli/internal/cmd/serverinfo"
 	"github.com/ankitpokhrel/jira-cli/internal/cmd/sprint"
 	"github.com/ankitpokhrel/jira-cli/internal/cmd/version"
 	"github.com/ankitpokhrel/jira-cli/internal/cmdutil"
 	jiraConfig "github.com/ankitpokhrel/jira-cli/internal/config"
+	"github.com/ankitpokhrel/jira-cli/pkg/netrc"
 
 	"github.com/zalando/go-keyring"
 )
@@ -124,6 +124,7 @@ func addChildCommands(cmd *cobra.Command) {
 		project.NewCmdProject(),
 		open.NewCmdOpen(),
 		me.NewCmdMe(),
+		serverinfo.NewCmdServerInfo(),
 		completion.NewCmdCompletion(),
 		version.NewCmdVersion(),
 		man.NewCmdMan(),

internal/cmd/serverinfo/serverinfo.go

@@ -0,0 +1,42 @@
+package serverinfo
+
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/ankitpokhrel/jira-cli/api"
+	"github.com/ankitpokhrel/jira-cli/internal/cmdutil"
+	"github.com/ankitpokhrel/jira-cli/internal/view"
+	"github.com/ankitpokhrel/jira-cli/pkg/jira"
+)
+
+// NewCmdServerInfo is a server info command.
+func NewCmdServerInfo() *cobra.Command {
+	return &cobra.Command{
+		Use:     "serverinfo",
+		Short:   "Displays information about the Jira instance",
+		Long:    "Displays information about the Jira instance.",
+		Aliases: []string{"systeminfo"},
+		Run:     serverInfo,
+	}
+}
+
+func serverInfo(cmd *cobra.Command, _ []string) {
+	debug, err := cmd.Flags().GetBool("debug")
+	cmdutil.ExitIfError(err)
+
+	info, err := func() (*jira.ServerInfo, error) {
+		s := cmdutil.Info("Fetching server info...")
+		defer s.Stop()
+
+		info, err := api.Client(jira.Config{Debug: debug}).ServerInfo()
+		if err != nil {
+			return nil, err
+		}
+		return info, nil
+	}()
+	cmdutil.ExitIfError(err)
+
+	v := view.NewServerInfo(info)
+
+	cmdutil.ExitIfError(v.Render())
+}

internal/view/serverinfo.go

@@ -0,0 +1,56 @@
+package view
+
+import (
+	"bytes"
+	"fmt"
+	"io"
+	"text/tabwriter"
+
+	"github.com/ankitpokhrel/jira-cli/pkg/jira"
+	"github.com/ankitpokhrel/jira-cli/pkg/tui"
+)
+
+// ServerInfoOption is a functional option to wrap serverinfo properties.
+type ServerInfoOption func(*ServerInfo)
+
+// ServerInfo is a serveronfo view.
+type ServerInfo struct {
+	data   *jira.ServerInfo
+	writer io.Writer
+	buf    *bytes.Buffer
+}
+
+// NewServerInfo initializes server info struct.
+func NewServerInfo(data *jira.ServerInfo, opts ...ServerInfoOption) *ServerInfo {
+	s := ServerInfo{
+		data: data,
+		buf:  new(bytes.Buffer),
+	}
+	s.writer = tabwriter.NewWriter(s.buf, 0, tabWidth, 1, '\t', 0)
+
+	for _, opt := range opts {
+		opt(&s)
+	}
+	return &s
+}
+
+// WithServerInfoWriter sets a writer for the serverinfo view.
+func WithServerInfoWriter(w io.Writer) ServerInfoOption {
+	return func(s *ServerInfo) {
+		s.writer = w
+	}
+}
+
+// Render renders the serverinfo view.
+func (s ServerInfo) Render() error {
+	fmt.Fprintf(s.writer, `SERVER INFO
+-----------
+
+Version: 	 %s
+Build Number: 	 %d
+Deployment Type: %s
+Default Locale:  %s
+`, s.data.Version, s.data.BuildNumber, s.data.DeploymentType, s.data.DefaultLocale.Locale)
+
+	return tui.PagerOut(s.buf.String())
+}

internal/view/serverinfo_test.go

@@ -0,0 +1,39 @@
+package view
+
+import (
+	"bytes"
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/ankitpokhrel/jira-cli/pkg/jira"
+)
+
+func TestServerInfoRender(t *testing.T) {
+	var b bytes.Buffer
+
+	data := &jira.ServerInfo{
+		Version:        "9.1.0",
+		VersionNumbers: []int{9, 1, 0},
+		DeploymentType: "Server",
+		BuildNumber:    901000,
+		DefaultLocale: struct {
+			Locale string `json:"locale"`
+		}{Locale: "en_US"},
+	}
+
+	serverInfo := NewServerInfo(data, WithServerInfoWriter(&b))
+	assert.NoError(t, serverInfo.Render())
+
+	expected := fmt.Sprintf(`SERVER INFO
+-----------
+
+Version: 	 %s
+Build Number: 	 %d
+Deployment Type: %s
+Default Locale:  %s
+`, data.Version, data.BuildNumber, data.DeploymentType, data.DefaultLocale.Locale)
+
+	assert.Equal(t, expected, b.String())
+}

pkg/jira/serverinfo.go

@@ -0,0 +1,38 @@
+package jira
+
+import (
+	"context"
+	"encoding/json"
+	"net/http"
+)
+
+// ServerInfo struct holds response from /serverInfo endpoint.
+type ServerInfo struct {
+	Version        string `json:"version"`
+	VersionNumbers []int  `json:"versionNumbers"`
+	DeploymentType string `json:"deploymentType"`
+	BuildNumber    int    `json:"buildNumber"`
+	DefaultLocale  struct {
+		Locale string `json:"locale"`
+	} `json:"defaultLocale"`
+}
+
+// ServerInfo fetches response from /serverInfo endpoint.
+func (c *Client) ServerInfo() (*ServerInfo, error) {
+	res, err := c.GetV2(context.Background(), "/serverInfo", nil)
+	if err != nil {
+		return nil, err
+	}
+	if res != nil {
+		defer func() { _ = res.Body.Close() }()
+	}
+	if res.StatusCode != http.StatusOK {
+		return nil, formatUnexpectedResponse(res)
+	}
+
+	var info ServerInfo
+
+	err = json.NewDecoder(res.Body).Decode(&info)
+
+	return &info, err
+}

pkg/jira/serverinfo_test.go

@@ -0,0 +1,52 @@
+package jira
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestServerInfo(t *testing.T) {
+	var unexpectedStatusCode bool
+
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		assert.Equal(t, "/rest/api/2/serverInfo", r.URL.Path)
+
+		if unexpectedStatusCode {
+			w.WriteHeader(400)
+		} else {
+			resp, err := os.ReadFile("./testdata/serverinfo.json")
+			assert.NoError(t, err)
+
+			w.Header().Set("Content-Type", "application/json")
+			w.WriteHeader(200)
+			_, _ = w.Write(resp)
+		}
+	}))
+	defer server.Close()
+
+	client := NewClient(Config{Server: server.URL}, WithTimeout(3*time.Second))
+
+	actual, err := client.ServerInfo()
+	assert.NoError(t, err)
+
+	expected := &ServerInfo{
+		Version:        "1001.0.0-SNAPSHOT",
+		VersionNumbers: []int{1001, 0, 0},
+		DeploymentType: "Cloud",
+		BuildNumber:    100204,
+		DefaultLocale: struct {
+			Locale string `json:"locale"`
+		}{Locale: "en_US"},
+	}
+	assert.Equal(t, expected, actual)
+
+	unexpectedStatusCode = true
+
+	_, err = client.ServerInfo()
+	assert.Error(t, &ErrUnexpectedResponse{}, err)
+}

pkg/jira/testdata/serverinfo.json

@@ -0,0 +1,18 @@
+{
+  "baseUrl": "https://demo.atlassian.net",
+  "version": "1001.0.0-SNAPSHOT",
+  "versionNumbers": [
+    1001,
+    0,
+    0
+  ],
+  "deploymentType": "Cloud",
+  "buildNumber": 100204,
+  "buildDate": "2022-08-12T12:59:12.000+0200",
+  "serverTime": "2022-08-15T21:08:52.725+0200",
+  "scmInfo": "948b370c557f4bbf768b92203f3aca5d86ee9758",
+  "serverTitle": "Jira",
+  "defaultLocale": {
+    "locale": "en_US"
+  }
+}