[E2E Test] Utilities for State Sync Test

.github/workflows/main.yml

@@ -197,4 +197,4 @@ jobs:
 
       - id: "run-e2e-tests"
         run: |
-          ./argo-linux-amd64 submit --wait --log --namespace devnet-issue-${{ github.event.pull_request.number }} --from 'wftmpl/dev-e2e-tests' --parameter gitsha="${{ github.event.pull_request.head.sha }}"
+          ./argo-linux-amd64 submit --wait --log --namespace devnet-issue-${{ github.event.pull_request.number }} --from 'wftmpl/dev-e2e-tests' --parameter tags="~@skip_in_ci" --parameter gitsha="${{ github.event.pull_request.head.sha }}"

.gitignore

@@ -55,9 +55,6 @@ temp_test.go
 test_results.json
 coverage.out
 
-# Output of `make build_and_watch`
-main
-
 # generated RPC server and client from openapi.yaml
 rpc/server.gen.go
 rpc/client.gen.go
@@ -90,3 +87,6 @@ tools/wiki
 
 # ggshield
 .cache_ggshield
+
+# mock temporary files
+**/gomock_reflect_*/

.tiltignore

@@ -41,9 +41,6 @@ temp_test.go
 test_results.json
 coverage.out
 
-# Output of `make build_and_watch`
-main
-
 # generated RPC server and client from openapi.yaml
 rpc/server.gen.go
 rpc/client.gen.go

Makefile

@@ -38,7 +38,7 @@ help:
 docker_check:
 	{ \
 	if ( ! ( command -v docker >/dev/null && (docker compose version >/dev/null || command -v docker-compose >/dev/null) )); then \
-		echo "Seems like you don't have Docker or docker-compose installed. Make sure you review docs/development/README.md before continuing"; \
+		echo "Seems like you don't have Docker or docker-compose installed. Make sure you review build/localnet/README.md and docs/development/README.md  before continuing"; \
 		exit 1; \
 	fi; \
 	}
@@ -47,11 +47,21 @@ docker_check:
 kubectl_check:
 	{ \
 	if ( ! ( command -v kubectl >/dev/null )); then \
-		echo "Seems like you don't have Kubectl installed. Make sure you review docs/development/README.md before continuing"; \
+		echo "Seems like you don't have Kubectl installed. Make sure you review build/localnet/README.md and docs/development/README.md before continuing"; \
 		exit 1; \
 	fi; \
 	}
 
+# Internal helper target - check if rsync is installed.
+rsync_check:
+	{ \
+	if ( ! ( command -v kubectl >/dev/null )); then \
+		echo "Seems like you don't have rsync installed. Make sure you review build/localnet/README.md and docs/development/README.md before continuing"; \
+		exit 1; \
+	fi; \
+	}
+
+
 .PHONY: trigger_ci
 trigger_ci: ## Trigger the CI pipeline by submitting an empty commit; See https://github.com/pokt-network/pocket/issues/900 for details
 	git commit --allow-empty -m "Empty commit"
@@ -133,6 +143,9 @@ go_imports: ## Group imports using rinchsan/gosimports
 go_fmt: ## Format all the .go files in the project in place.
 	gofmt -w -s .
 
+# TODO(#964): add `rsync_check`, `kubectl_check`, `docker_check` as a validation in `install_cli_deps`; https://github.com/pokt-network/pocket/assets/1892194/a7a24a11-f54d-46e2-a73e-9e8ea7d06726
+# 	.PHONY: install_cli_deps
+# 	install_cli_deps: rsync_check kubectl_check docker_check ## Installs `helm`, `tilt` and the underlying `ci_deps`
 .PHONY: install_cli_deps
 install_cli_deps: ## Installs `helm`, `tilt` and the underlying `ci_deps`
 	make install_ci_deps
@@ -163,33 +176,27 @@ develop_test: docker_check ## Run all of the make commands necessary to develop
 		make develop_start && \
 		make test_all
 
-.PHONY: client_start
-client_start: docker_check ## Run a client daemon which is only used for debugging purposes
+.PHONY: lightweight_localnet_client
+lightweight_localnet_client: docker_check ## Run a client daemon which is only used for debugging purposes
+# Add `--build` to rebuild the client
 	${docker-compose} up -d client
 
-.PHONY: rebuild_client_start
-rebuild_client_start: docker_check ## Rebuild and run a client daemon which is only used for debugging purposes
-	${docker-compose} up -d --build client
-
-.PHONY: client_connect
-client_connect: docker_check ## Connect to the running client debugging daemon
+.PHONY: lightweight_localnet_client_debug
+lightweight_localnet_client_debug: docker_check ## Connect to the running client debugging daemon
 	docker exec -it client /bin/bash -c "go run -tags=debug app/client/*.go DebugUI"
 
-.PHONY: build_and_watch
-build_and_watch: ## Continous build Pocket's main entrypoint as files change
-	/bin/sh ${PWD}/build/scripts/watch_build.sh
+# IMPROVE: Avoid building the binary on every shell execution and sync it from local instead
+.PHONY: lightweight_localnet_shell
+lightweight_localnet_shell: docker_check ## Connect to the running client debugging daemon
+	docker exec -it client /bin/bash -c "go build -tags=debug -o p1 ./app/client/*.go && chmod +x p1 && mv p1 /usr/bin && echo \"Finished building a new p1 binary\" && /bin/bash"
 
-# TODO(olshansky): Need to think of a Pocket related name for `compose_and_watch`, maybe just `pocket_watch`?
-.PHONY: compose_and_watch
-compose_and_watch: docker_check db_start monitoring_start ## Run a localnet composed of 4 consensus validators w/ hot reload & debugging
+.PHONY: lightweight_localnet
+lightweight_localnet: docker_check db_start monitoring_start ## Run a lightweight localnet composed of 4 validators w/ hot reload & debugging
+# Add `--build` to rebuild the client
 	${docker-compose} up --force-recreate validator1 validator2 validator3 validator4 servicer1 fisherman1
 
-.PHONY: rebuild_and_compose_and_watch
-rebuild_and_compose_and_watch: docker_check db_start monitoring_start ## Rebuilds the container from scratch and launches compose_and_watch
-	${docker-compose} up --build --force-recreate validator1 validator2 validator3 validator4 servicer1 fisherman1
-
 .PHONY: db_start
-db_start: docker_check ## Start a detached local postgres and admin instance; compose_and_watch is responsible for instantiating the actual schemas
+db_start: docker_check ## Start a detached local postgres and admin instance; lightweight_localnet is responsible for instantiating the actual schemas
 	${docker-compose} up --no-recreate -d db pgadmin
 
 .PHONY: db_cli
@@ -245,7 +252,7 @@ docker_wipe_nodes: docker_check prompt_user db_drop ## [WARNING] Remove all the
 	docker ps -a -q --filter="name=node*" | xargs -r -I {} docker rm {}
 
 .PHONY: monitoring_start
-monitoring_start: docker_check ## Start grafana, metrics and logging system (this is auto-triggered by compose_and_watch)
+monitoring_start: docker_check ## Start grafana, metrics and logging system (this is auto-triggered by lightweight_localnet)
 	${docker-compose} up --no-recreate -d grafana loki vm
 
 .PHONY: docker_loki_install

app/client/cli/debug.go

@@ -1,11 +1,15 @@
 package cli
 
 import (
+	"fmt"
+	"log"
 	"os"
+	"os/exec"
 	"time"
 
 	"github.com/manifoldco/promptui"
 	"github.com/spf13/cobra"
+	"golang.org/x/exp/slices"
 	"google.golang.org/protobuf/types/known/anypb"
 
 	"github.com/pokt-network/pocket/app/client/cli/helpers"
@@ -35,46 +39,123 @@ var items = []string{
 }
 
 func init() {
+	dbg := newDebugCommand()
+	dbg.AddCommand(newDebugSubCommands()...)
+	rootCmd.AddCommand(dbg)
+
 	dbgUI := newDebugUICommand()
-	dbgUI.AddCommand(newDebugUISubCommands()...)
 	rootCmd.AddCommand(dbgUI)
 }
 
-// newDebugUISubCommands builds out the list of debug subcommands by matching the
-// handleSelect dispatch to the appropriate command.
-// * To add a debug subcommand, you must add it to the `items` array and then
-// write a function handler to match for it in `handleSelect`.
-func newDebugUISubCommands() []*cobra.Command {
-	commands := make([]*cobra.Command, len(items))
-	for idx, promptItem := range items {
-		commands[idx] = &cobra.Command{
-			Use:               promptItem,
+// newDebugCommand returns the cobra CLI for the Debug command.
+func newDebugCommand() *cobra.Command {
+	return &cobra.Command{
+		Use:     "Debug",
+		Aliases: []string{"d"},
+		Short:   "Debug utility for rapid development",
+		Long:    "Debug utility to send fire-and-forget messages to the network for development purposes",
+		Args:    cobra.MaximumNArgs(1),
+	}
+}
+
+// newDebugSubCommands is a list of commands that can be "fired & forgotten" (no selection necessary)
+func newDebugSubCommands() []*cobra.Command {
+	cmds := []*cobra.Command{
+		{
+			Use:               "PrintNodeState",
+			Aliases:           []string{"print", "state"},
+			Short:             "Prints the node state",
+			Long:              "Sends a message to all visible nodes to log the current state of their consensus",
+			Args:              cobra.ExactArgs(0),
 			PersistentPreRunE: helpers.P2PDependenciesPreRunE,
-			Run: func(cmd *cobra.Command, _ []string) {
-				// TECHDEBT(#874): this is a magic number, but an alternative would be to have the p2p module wait until connections are open and to flush the message correctly
-				time.Sleep(500 * time.Millisecond) // give p2p module time to start
-				handleSelect(cmd, cmd.Use)
-				time.Sleep(500 * time.Millisecond) // give p2p module time to broadcast
+			Run: func(cmd *cobra.Command, args []string) {
+				runWithSleep(func() {
+					handleSelect(cmd, PromptPrintNodeState)
+				})
 			},
-			ValidArgs: items,
-		}
+		},
+		{
+			Use:               "ResetToGenesis",
+			Aliases:           []string{"reset", "genesis"},
+			Short:             "Reset to genesis",
+			Long:              "Broadcast a message to all visible nodes to reset the state to genesis",
+			Args:              cobra.ExactArgs(0),
+			PersistentPreRunE: helpers.P2PDependenciesPreRunE,
+			Run: func(cmd *cobra.Command, args []string) {
+				runWithSleep(func() {
+					handleSelect(cmd, PromptResetToGenesis)
+				})
+			},
+		},
+		{
+			Use:               "TriggerView",
+			Aliases:           []string{"next", "trigger", "view"},
+			Short:             "Trigger the next view in consensus",
+			Long:              "Sends a message to all visible nodes on the network to start the next view (height/step/round) in consensus",
+			Args:              cobra.ExactArgs(0),
+			PersistentPreRunE: helpers.P2PDependenciesPreRunE,
+			Run: func(cmd *cobra.Command, args []string) {
+				runWithSleep(func() {
+					handleSelect(cmd, PromptTriggerNextView)
+				})
+			},
+		},
+		{
+			Use:               "TogglePacemakerMode",
+			Aliases:           []string{"toggle", "pcm"},
+			Short:             "Toggle the pacemaker",
+			Long:              "Toggle the consensus pacemaker either on or off so the chain progresses on its own or loses liveness",
+			Args:              cobra.ExactArgs(0),
+			PersistentPreRunE: helpers.P2PDependenciesPreRunE,
+			Run: func(cmd *cobra.Command, args []string) {
+				runWithSleep(func() {
+					handleSelect(cmd, PromptTogglePacemakerMode)
+				})
+			},
+		},
+		{
+			Use:               "ScaleActor",
+			Aliases:           []string{"scale"},
+			Short:             "Scales the number of actors up or down",
+			Long:              "Scales the type of actor specified to the number provided",
+			Args:              cobra.ExactArgs(2),
+			PersistentPreRunE: helpers.P2PDependenciesPreRunE,
+			Run: func(cmd *cobra.Command, args []string) {
+				actor := args[0]
+				numActors := args[1]
+				validActors := []string{"fishermen", "full_nodes", "servicers", "validators"}
+				if !slices.Contains(validActors, actor) {
+					logger.Global.Fatal().Msg("Invalid actor type provided")
+				}
+				sedReplaceCmd := fmt.Sprintf("/%s:/,/count:/ s/count: [0-9]*/count: %s/", actor, numActors)
+				sedCmd := exec.Command("sed", "-i", sedReplaceCmd, "/usr/local/localnet_config.yaml")
+				if err := sedCmd.Run(); err != nil {
+					log.Fatal(err)
+				}
+			},
+		},
 	}
-	return commands
+	return cmds
 }
 
 // newDebugUICommand returns the cobra CLI for the Debug UI interface.
 func newDebugUICommand() *cobra.Command {
 	return &cobra.Command{
 		Aliases:           []string{"dui", "debug"},
 		Use:               "DebugUI",
-		Short:             "Debug selection ui for rapid development",
+		Short:             "Debug utility with an interactive UI for development purposes",
+		Long:              "Opens a shell-driven selection UI to view and select from a list of debug actions for development purposes",
 		Args:              cobra.MaximumNArgs(0),
 		PersistentPreRunE: helpers.P2PDependenciesPreRunE,
-		RunE:              runDebug,
+		RunE:              selectDebugCommand,
 	}
 }
 
-func runDebug(cmd *cobra.Command, _ []string) (err error) {
+// selectDebugCommand builds out the list of debug subcommands by matching the
+// handleSelect dispatch to the appropriate command.
+//   - To add a debug subcommand, you must add it to the `items` array and then
+//     write a function handler to match for it in `handleSelect`.
+func selectDebugCommand(cmd *cobra.Command, _ []string) error {
 	for {
 		if selection, err := promptGetInput(); err == nil {
 			handleSelect(cmd, selection)
@@ -162,7 +243,17 @@ func handleSelect(cmd *cobra.Command, selection string) {
 	}
 }
 
-// Broadcast to the entire network.
+// HACK: Because of how the p2p module works, we need to surround it with sleep both BEFORE and AFTER the task.
+// - Starting the task too early after the debug client initializes results in a lack of visibility of the nodes in the network
+// - Ending the task too early before the debug client completes its task results in a lack of propagation of the message or retrieval of the result
+// TECHDEBT: There is likely an event based solution to this but it would require a lot more refactoring of the p2p module.
+func runWithSleep(task func()) {
+	time.Sleep(1000 * time.Millisecond)
+	task()
+	time.Sleep(1000 * time.Millisecond)
+}
+
+// broadcastDebugMessage broadcasts the debug message to the entire visible network.
 func broadcastDebugMessage(cmd *cobra.Command, debugMsg *messaging.DebugMessage) {
 	anyProto, err := anypb.New(debugMsg)
 	if err != nil {
@@ -178,7 +269,7 @@ func broadcastDebugMessage(cmd *cobra.Command, debugMsg *messaging.DebugMessage)
 	}
 }
 
-// Send to just a single (i.e. first) validator in the set
+// sendDebugMessage sends the debug message to just a single (i.e. first) node visible
 func sendDebugMessage(cmd *cobra.Command, debugMsg *messaging.DebugMessage) {
 	anyProto, err := anypb.New(debugMsg)
 	if err != nil {

build/config/README.md

@@ -12,7 +12,7 @@ It is not recommended at this time to build infrastructure components that rely
 
 ## Origin Document
 
-Currently, the Genesis and Configuration generator is necessary to create development `localnet` environments for iterating on V1. A current example (as of 09/2022) of this is the `make compose_and_watch` debug utility that generates a `localnet` using `docker-compose` by injecting the appropriate `config.json` and `genesis.json` files.
+Currently, the Genesis and Configuration generator is necessary to create development `localnet` environments for iterating on V1. A current example (as of 09/2022) of this is the `make lightweight_localnet` debug utility that generates a `localnet` using `docker-compose` by injecting the appropriate `config.json` and `genesis.json` files.
 
 ## Usage
 

build/docs/CHANGELOG.md

@@ -233,7 +233,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.0.0.1] - 2022-12-29
 
 - Updated all `config*.json` files with the missing `max_mempool_count` value
-- Added `is_client_only` to `config1.json` so Viper knows it can be overridden. The config override is done in the Makefile's `client_connect` target. Setting this can be avoided if we merge the changes in https://github.com/pokt-network/pocket/compare/main...issue/cli-viper-environment-vars-fix
+- Added `is_client_only` to `config1.json` so Viper knows it can be overridden. The config override is done in the Makefile's `lightweight_localnet_client_debug` target. Setting this can be avoided if we merge the changes in https://github.com/pokt-network/pocket/compare/main...issue/cli-viper-environment-vars-fix
 
 ## [0.0.0.0] - 2022-12-22
 

build/localnet/README.md

@@ -2,7 +2,7 @@
 
 This guide shows how to deploy a LocalNet using [pocket-operator](https://github.com/pokt-network/pocket-operator).
 
-- [TLDR](#tldr)
+- [TL;DR](#tldr)
 - [Dependencies](#dependencies)
   - [Choosing Kubernetes Distribution](#choosing-kubernetes-distribution)
     - [How to create Kind Kubernetes cluster](#how-to-create-kind-kubernetes-cluster)
@@ -16,6 +16,8 @@ This guide shows how to deploy a LocalNet using [pocket-operator](https://github
   - [Interacting w/ LocalNet](#interacting-w-localnet)
     - [Make Targets](#make-targets)
   - [Addresses and keys on LocalNet](#addresses-and-keys-on-localnet)
+    - [Applications staked on LocalNet](#applications-staked-on-localnet)
+    - [Servicers staked on LocalNet](#servicers-staked-on-localnet)
 - [How to change configuration files](#how-to-change-configuration-files)
   - [Overriding default values for localnet with Tilt](#overriding-default-values-for-localnet-with-tilt)
 - [How does it work?](#how-does-it-work)
@@ -26,7 +28,7 @@ This guide shows how to deploy a LocalNet using [pocket-operator](https://github
   - [Full Cleanup](#full-cleanup)
 - [Code Structure](#code-structure)
 
-## TLDR
+## TL;DR
 
 If you feel adventurous, and you know what you're doing, here is a rapid guide to start LocalNet:
 
@@ -46,6 +48,7 @@ All necessary dependencies, except Docker and Kubernetes cluster, are installed
 3. `Kubernetes cluster`: refer to [Choosing Kubernetes Distribution](#choosing-kubernetes-distribution) section for more details.
 4. `kubectl`: CLI is required and should be configured to access the cluster. This should happen automatically if using Docker Desktop, Rancher Desktop, k3s, k3d, minikube, etc.
 5. [helm](https://helm.sh/docs/intro/install): required to template the YAML manifests for the dependencies (e.g., Postgres, Grafana). Installation instructions available.
+6. [rsync](https://www.hostinger.com/tutorials/how-to-use-rsync): required to for some extensions used with `Tilt`; https://github.com/tilt-dev/tilt-extensions/tree/master/syncback#usage
 
 ### Choosing Kubernetes Distribution
 
@@ -149,8 +152,8 @@ For example:
 - `0010297b55fc9278e4be4f1bcfe52bf9bd0443f8` is a servicer #001.
 - `314019dbb7faf8390c1f0cf4976ef1215c90b7e4` is an application #314.
 
-
 #### Applications staked on LocalNet
+
 Applications with the following addresses are staked on LocalNet, through the [applications field of the genesis.json in the LocalNet configuration](https://github.com/pokt-network/pocket/blob/main/build/localnet/manifests/configs.yaml#L4088)
 
 - `00001fff518b1cdddd74c197d76ba5b5dedc0301`
@@ -159,6 +162,7 @@ Applications with the following addresses are staked on LocalNet, through the [a
 These addresses can be used for e.g. testing the CLI.
 
 #### Servicers staked on LocalNet
+
 Servicers with the following addresses are staked on LocalNet, through the [servicers field of the genesis.json in the LocalNet configuration](https://github.com/pokt-network/pocket/blob/main/build/localnet/manifests/configs.yaml#L4120)
 
 - `00002b8cea1bcc3dadc72ebecf95564ceb9c2e2a`