Merge pull request #595 from jshufro/jms/v2/testing

Refactor rocketpool-cli.go to improve code organization, make flag parsing testing easier.

Author: 0xfornax

assets/assets_test.go

@@ -0,0 +1,122 @@
+package assets
+
+import (
+	"strings"
+	"testing"
+)
+
+func TestLogo(t *testing.T) {
+	logo := Logo()
+	if logo == "" {
+		t.Fatal("Logo wasn't embedded")
+	}
+}
+
+func TestVersionString(t *testing.T) {
+	// Reset v singleton
+	v = nil
+	vers := RocketPoolVersion()
+	if vers == "" {
+		t.Fatal("Version string wasn't embedded")
+	}
+
+	if v == nil {
+		t.Fatalf("v should be initialized")
+	}
+
+	oldV := v
+
+	// Make sure subsequent calls to RocketPoolVersion are amortized
+	RocketPoolVersion()
+	if oldV != v {
+		t.Fatalf("v was reallocated")
+	}
+}
+
+func shouldPanic(t *testing.T) {
+	if r := recover(); r == nil {
+		t.Fatal("should have panicked!")
+	} else {
+		t.Log(r)
+	}
+}
+
+func TestInvalidJsonVersionPanics(t *testing.T) {
+	// Reset v singleton
+	v = nil
+
+	// Save the version JSON so we can restore it
+	oldVersionJSON := versionJSON
+	defer func() {
+		versionJSON = oldVersionJSON
+	}()
+	// We want to panic when version can't be parsed.
+	defer shouldPanic(t)
+
+	versionJSON = []byte("this is not valid json")
+	_ = RocketPoolVersion()
+
+}
+
+func TestEmptyVersionPanics(t *testing.T) {
+	// Reset v singleton
+	v = nil
+
+	// Save the version JSON so we can restore it
+	oldVersionJSON := versionJSON
+	defer func() {
+		versionJSON = oldVersionJSON
+	}()
+	// We want to panic when version is empty but json is valid
+	defer shouldPanic(t)
+
+	versionJSON = []byte("{}")
+	_ = RocketPoolVersion()
+
+}
+
+func TestPrintPatchNotes(t *testing.T) {
+	// Reset v singleton
+	v = &version{"test"}
+	notes, err := GetPatchNotes()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	t.Log("Rendered patch notes: ", notes)
+
+	// Make sure there are no template directives unpopulated
+	if strings.Contains(notes, "{{") || strings.Contains(notes, "}}") {
+		t.Fatal("encountered unexpanded template directive")
+	}
+
+	if !strings.Contains(notes, Logo()) {
+		t.Fatal("expected logo in patch notes")
+	}
+
+	if !strings.Contains(notes, "test patch notes") {
+		t.Fatal("expected template body in patch notes")
+	}
+}
+
+// This tests ensures each version has a patchnotes template
+func TestPrintCurrentPatchNotes(t *testing.T) {
+	// Reset v singleton
+	v = nil
+
+	notes, err := GetPatchNotes()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	t.Log("Rendered patch notes: ", notes)
+
+	// Make sure there are no template directives unpopulated
+	if strings.Contains(notes, "{{") || strings.Contains(notes, "}}") {
+		t.Fatal("encountered unexpanded template directive")
+	}
+
+	if !strings.Contains(notes, Logo()) {
+		t.Fatal("expected logo in patch notes")
+	}
+}

assets/logo.go

@@ -0,0 +1,13 @@
+package assets
+
+import (
+	_ "embed"
+)
+
+//go:embed logo.txt
+var logo string
+
+// Logo returns the rocket pool ascii art, with padding and newlines
+func Logo() string {
+	return logo
+}

shared/version.go assets/logo.txtshared/version.go renamed to assets/logo.txt

@@ -1,10 +1,7 @@
-package shared
-
-const RocketPoolVersion string = "2.0.0-b3"
-
-const Logo string = `______           _        _    ______           _
+______           _        _    ______           _ 
 | ___ \         | |      | |   | ___ \         | |
 | |_/ /___   ___| | _____| |_  | |_/ /__   ___ | |
 |    // _ \ / __| |/ / _ \ __| |  __/ _ \ / _ \| |
 | |\ \ (_) | (__|   <  __/ |_  | | | (_) | (_) | |
-\_| \_\___/ \___|_|\_\___|\__| \_|  \___/ \___/|_|`
+\_| \_\___/ \___|_|\_\___|\__| \_|  \___/ \___/|_|
+

assets/patchnotes.go

@@ -0,0 +1,61 @@
+package assets
+
+import (
+	"embed"
+	"fmt"
+	"strings"
+	"text/template"
+
+	"github.com/rocket-pool/smartnode/v2/rocketpool-cli/utils/terminal"
+)
+
+var patchnotesTemplateFields = struct {
+	ColorReset        string
+	ColorBold         string
+	ColorRed          string
+	ColorGreen        string
+	ColorYellow       string
+	ColorBlue         string
+	RocketPoolVersion string
+}{
+	ColorReset:        terminal.ColorReset,
+	ColorBold:         terminal.ColorBold,
+	ColorRed:          terminal.ColorRed,
+	ColorGreen:        terminal.ColorGreen,
+	ColorYellow:       terminal.ColorYellow,
+	ColorBlue:         terminal.ColorBlue,
+	RocketPoolVersion: "",
+}
+
+//go:embed patchnotes/*.tmpl
+var patchnotesFS embed.FS
+
+func loadTemplate(version string) (*template.Template, error) {
+	return template.ParseFS(patchnotesFS, fmt.Sprintf("patchnotes/%s.tmpl", version))
+}
+
+// PrintPatchNotes looks for a template in ./patchnotes/ with a name matching the current
+// version of smartnode and a file extension of .tmpl
+//
+// If it finds one, it populates it using the PatchNotes struct defined above, and prints it after printing the logo.
+// It returns an error when no template exists, or the template could not be populated.
+func GetPatchNotes() (string, error) {
+	version := RocketPoolVersion()
+	tmpl, err := loadTemplate(version)
+	if err != nil {
+		return "", fmt.Errorf("unable to read patch notes: %w", err)
+	}
+
+	// Set RocketPoolVersion before executing
+	patchnotesTemplateFields.RocketPoolVersion = version
+
+	notes := new(strings.Builder)
+	notes.WriteString("\n")
+	notes.WriteString(Logo())
+	err = tmpl.Execute(notes, patchnotesTemplateFields)
+	if err != nil {
+		return "", fmt.Errorf("unable to populate patch notes template: %w", err)
+	}
+
+	return notes.String(), nil
+}

assets/patchnotes/2.0.0-b3.tmpl

@@ -0,0 +1,13 @@
+{{.ColorGreen}}=== Smart Node v{{.RocketPoolVersion}} ==={{.ColorReset}}
+
+Changes you should be aware of before starting:
+
+{{.ColorGreen}}=== Welcome to the v2.0 Beta! ==={{.ColorReset}}
+Welcome to Smart Node v2! This is a completely redesigned Smart Node from the ground up, taking advantage of years of lessons learned and user feedback. The list of features and changes is far too long to list here, but here are some highlights:
+- Support for installing and updating via Debian's `apt` package manager (other package managers coming soon!)
+- Support for printing transaction data or signed transactions without submitting them to the network
+- Passwordless mode: an opt-in feature that will no longer save your node wallet's password to disk
+- Overhauled Smart Node service with an HTTP API, support for batching Ethereum queries and transactions together, a new logging system, and consolidation of the api / node / watchtower containers into one
+- And much more!
+
+To learn all about what's changed in Smart Node v2 and how to use it, take a look at our guide: https://github.com/rocket-pool/smartnode/blob/v2/v2.md

assets/patchnotes/test.tmpl

@@ -0,0 +1,4 @@
+{{.RocketPoolVersion}} patch notes.
+
+This file is a test of Patch Note template population and printing.
+{{.ColorGreen}} Green Text {{.ColorReset}}

assets/version.go

@@ -0,0 +1,35 @@
+package assets
+
+import (
+	_ "embed"
+	"encoding/json"
+)
+
+// Using go-embed to import version means a build pipeline can use the .txt file to tag commits/containers
+// Id est, one can simply add $(jq -r .Version assets/version.json) to any command to reference the current version.
+// We use json because vim (and other editors) likes to add newlines to the end of files.
+//go:embed version.json
+var versionJSON []byte
+
+type version struct {
+	Version string
+}
+
+// singleton to hold version after first time parsing
+var v *version
+
+func RocketPoolVersion() string {
+	if v != nil {
+		return v.Version
+	}
+
+	v = new(version)
+	if err := json.Unmarshal(versionJSON, v); err != nil {
+		panic(err)
+	}
+	if v.Version == "" {
+		panic("version must be defined")
+	}
+
+	return v.Version
+}

assets/version.json

@@ -0,0 +1,3 @@
+{
+  "Version": "2.0.0-b3"
+}

rocketpool-cli/client/client.go

@@ -9,7 +9,7 @@ import (
 	"github.com/fatih/color"
 	"github.com/rocket-pool/node-manager-core/log"
 	"github.com/rocket-pool/smartnode/v2/client"
-	"github.com/rocket-pool/smartnode/v2/rocketpool-cli/utils/context"
+	"github.com/rocket-pool/smartnode/v2/rocketpool-cli/settings"
 	"github.com/rocket-pool/smartnode/v2/shared/config"
 	"github.com/urfave/cli/v2"
 )
@@ -30,7 +30,7 @@ const (
 // Rocket Pool client
 type Client struct {
 	Api      *client.ApiClient
-	Context  *context.SmartNodeContext
+	Context  *settings.SmartNodeSettings
 	Logger   *slog.Logger
 	docker   *docker.Client
 	cfg      *config.SmartNodeConfig
@@ -39,27 +39,27 @@ type Client struct {
 
 // Create new Rocket Pool client from CLI context
 func NewClientFromCtx(c *cli.Context) (*Client, error) {
-	snCtx := context.GetSmartNodeContext(c)
-	logger := log.NewTerminalLogger(snCtx.DebugEnabled, terminalLogColor)
+	snSettings := settings.GetSmartNodeSettings(c)
+	logger := log.NewTerminalLogger(snSettings.DebugEnabled, terminalLogColor)
 
 	// Create the tracer if required
 	var tracer *httptrace.ClientTrace
-	if snCtx.HttpTraceFile != nil {
+	if snSettings.HttpTraceFile != nil {
 		var err error
-		tracer, err = createTracer(snCtx.HttpTraceFile, logger.Logger)
+		tracer, err = createTracer(snSettings.HttpTraceFile, logger.Logger)
 		if err != nil {
 			logger.Error("Error creating HTTP trace", log.Err(err))
 		}
 	}
 
 	// Make the client
 	rpClient := &Client{
-		Context: snCtx,
+		Context: snSettings,
 		Logger:  logger.Logger,
 	}
 
 	// Get the API URL
-	url := snCtx.ApiUrl
+	url := snSettings.ApiUrl
 	if url == nil {
 		// Load the config to get the API port
 		cfg, _, err := rpClient.LoadConfig()

rocketpool-cli/commands/service/config.go

@@ -7,11 +7,11 @@ import (
 
 	"github.com/rivo/tview"
 	nmc_config "github.com/rocket-pool/node-manager-core/config"
+	"github.com/rocket-pool/smartnode/v2/assets"
 	"github.com/rocket-pool/smartnode/v2/rocketpool-cli/client"
 	cliconfig "github.com/rocket-pool/smartnode/v2/rocketpool-cli/commands/service/config"
 	"github.com/rocket-pool/smartnode/v2/rocketpool-cli/utils"
 	"github.com/rocket-pool/smartnode/v2/rocketpool-cli/utils/terminal"
-	"github.com/rocket-pool/smartnode/v2/shared"
 	"github.com/rocket-pool/smartnode/v2/shared/config"
 	"github.com/urfave/cli/v2"
 )
@@ -40,7 +40,7 @@ func configureService(c *cli.Context) error {
 
 	// Check if this is an update
 	oldVersion := strings.TrimPrefix(cfg.Version, "v")
-	currentVersion := strings.TrimPrefix(shared.RocketPoolVersion, "v")
+	currentVersion := strings.TrimPrefix(assets.RocketPoolVersion(), "v")
 	isUpdate := c.Bool(installUpdateDefaultsFlag.Name) || (oldVersion != currentVersion)
 
 	// For upgrades, move the config to the old one and create a new upgraded copy