refactor: Update variable names for consistency

ethpandaops · Dec 19, 2024 · d77c5a7 · d77c5a7
1 parent be7292d
commit d77c5a7
Show file tree

Hide file tree

Showing 23 changed files with 101 additions and 101 deletions.
diff --git a/cmd/cli/commands/config/config.go b/cmd/cli/commands/config/config.go
@@ -19,20 +19,20 @@ func RegisterCommands(app *cli.App, opts *options.CommandOpts) {
 		Action: func(c *cli.Context) error {
 			log := opts.Logger()
 
-			sidecarConfig, err := sidecar.NewConfigService(log, c.GlobalString("config-path"))
+			sidecarCfg, err := sidecar.NewConfigService(log, c.GlobalString("config-path"))
 			if err != nil {
 				return fmt.Errorf("%serror loading config: %v%s", tui.TerminalColorRed, err, tui.TerminalColorReset)
 			}
 
-			return configureContributoor(c, log, sidecarConfig)
+			return configureContributoor(c, log, sidecarCfg)
 		},
 	})
 }
 
-func configureContributoor(c *cli.Context, log *logrus.Logger, sidecarConfig sidecar.ConfigManager) error {
+func configureContributoor(c *cli.Context, log *logrus.Logger, sidecarCfg sidecar.ConfigManager) error {
 	var (
 		app     = tview.NewApplication()
-		display = NewConfigDisplay(log, app, sidecarConfig)
+		display = NewConfigDisplay(log, app, sidecarCfg)
 	)
 
 	if err := display.Run(); err != nil {

diff --git a/cmd/cli/commands/config/config_network.go b/cmd/cli/commands/config/config_network.go
@@ -70,7 +70,7 @@ func (p *NetworkConfigPage) initPage() {
 
 	// Add our form fields.
 	// Find the index of the current network (from the sidecar config) in the list.
-	currentNetwork := p.display.sidecarConfig.Get().NetworkName
+	currentNetwork := p.display.sidecarCfg.Get().NetworkName
 	currentNetworkIndex := 0
 
 	for i, network := range networks {
@@ -84,7 +84,7 @@ func (p *NetworkConfigPage) initPage() {
 	form.AddDropDown("Network", networks, currentNetworkIndex, func(option string, index int) {
 		p.description.SetText(networkDescriptions[option])
 	})
-	form.AddInputField("Beacon Node Address", p.display.sidecarConfig.Get().BeaconNodeAddress, 0, nil, nil)
+	form.AddInputField("Beacon Node Address", p.display.sidecarCfg.Get().BeaconNodeAddress, 0, nil, nil)
 
 	// Add a save button and ensure we validate the input.
 	saveButton := tview.NewButton(tui.ButtonSaveSettings)
@@ -176,7 +176,7 @@ func validateAndUpdate(p *NetworkConfigPage, input *tview.InputField) {
 		return
 	}
 
-	if err := p.display.sidecarConfig.Update(func(cfg *sidecar.Config) {
+	if err := p.display.sidecarCfg.Update(func(cfg *sidecar.Config) {
 		cfg.BeaconNodeAddress = input.GetText()
 	}); err != nil {
 		p.openErrorModal(err)

diff --git a/cmd/cli/commands/config/config_output_server.go b/cmd/cli/commands/config/config_output_server.go
@@ -84,7 +84,7 @@ func (p *OutputServerConfigPage) initPage() {
 	// of the current server so we can prepopulate the form with the current
 	// values.
 	defaultIndex := 0
-	currentAddress := p.display.sidecarConfig.Get().OutputServer.Address
+	currentAddress := p.display.sidecarCfg.Get().OutputServer.Address
 
 	// Check if it's a custom output server address.
 	if !strings.Contains(currentAddress, "platform.ethpandaops.io") {
@@ -123,7 +123,7 @@ func (p *OutputServerConfigPage) initPage() {
 			// Add appropriate fields based on selection.
 			if option == "Custom" {
 				// If it's a custom server, we need to add the server address field.
-				defaultAddress := p.display.sidecarConfig.Get().OutputServer.Address
+				defaultAddress := p.display.sidecarCfg.Get().OutputServer.Address
 				if strings.Contains(defaultAddress, "platform.ethpandaops.io") {
 					defaultAddress = ""
 				}
@@ -132,12 +132,12 @@ func (p *OutputServerConfigPage) initPage() {
 				form.AddInputField("Server Address", defaultAddress, 0, nil, nil)
 
 				// Add the username and password fields.
-				username, password := getCredentialsFromConfig(p.display.sidecarConfig.Get())
+				username, password := getCredentialsFromConfig(p.display.sidecarCfg.Get())
 				form.AddInputField("Username", username, 0, nil, nil)
 				form.AddPasswordField("Password", password, 0, '*', nil)
 			} else {
 				// Otherwise, it's an ethPandaOps server.
-				username, password := getCredentialsFromConfig(p.display.sidecarConfig.Get())
+				username, password := getCredentialsFromConfig(p.display.sidecarCfg.Get())
 				form.AddInputField("Username", username, 0, nil, nil)
 				form.AddPasswordField("Password", password, 0, '*', nil)
 			}
@@ -312,7 +312,7 @@ func validateAndUpdateOutputServer(p *OutputServerConfigPage) {
 	}
 
 	// Update config with validated values.
-	if err := p.display.sidecarConfig.Update(func(cfg *sidecar.Config) {
+	if err := p.display.sidecarCfg.Update(func(cfg *sidecar.Config) {
 		cfg.OutputServer.Address = serverAddress
 		if username != "" && password != "" {
 			cfg.OutputServer.Credentials = validate.EncodeCredentials(username, password)

diff --git a/cmd/cli/commands/config/display.go b/cmd/cli/commands/config/display.go
@@ -14,7 +14,7 @@ type ConfigDisplay struct {
 	pages                  *tview.Pages
 	frame                  *tview.Frame
 	log                    *logrus.Logger
-	sidecarConfig          sidecar.ConfigManager
+	sidecarCfg             sidecar.ConfigManager
 	homePage               *tui.Page
 	categoryList           *tview.List
 	content                tview.Primitive
@@ -26,12 +26,12 @@ type ConfigDisplay struct {
 }
 
 // NewConfigDisplay creates a new Configtui.
-func NewConfigDisplay(log *logrus.Logger, app *tview.Application, sidecarConfig sidecar.ConfigManager) *ConfigDisplay {
+func NewConfigDisplay(log *logrus.Logger, app *tview.Application, sidecarCfg sidecar.ConfigManager) *ConfigDisplay {
 	display := &ConfigDisplay{
-		app:           app,
-		pages:         tview.NewPages(),
-		log:           log,
-		sidecarConfig: sidecarConfig,
+		app:        app,
+		pages:      tview.NewPages(),
+		log:        log,
+		sidecarCfg: sidecarCfg,
 	}
 
 	display.homePage = tui.NewPage(nil, "config-home", "Categories", "", nil)

diff --git a/cmd/cli/commands/install/display.go b/cmd/cli/commands/install/display.go
@@ -13,7 +13,7 @@ type InstallDisplay struct {
 	pages                       *tview.Pages
 	frame                       *tview.Frame
 	log                         *logrus.Logger
-	sidecarConfig               sidecar.ConfigManager
+	sidecarCfg                  sidecar.ConfigManager
 	installPages                []tui.PageInterface
 	welcomePage                 *WelcomePage
 	networkConfigPage           *NetworkConfigPage
@@ -24,12 +24,12 @@ type InstallDisplay struct {
 }
 
 // NewInstallDisplay creates a new InstallDisplay.
-func NewInstallDisplay(log *logrus.Logger, app *tview.Application, sidecarConfig sidecar.ConfigManager) *InstallDisplay {
+func NewInstallDisplay(log *logrus.Logger, app *tview.Application, sidecarCfg sidecar.ConfigManager) *InstallDisplay {
 	display := &InstallDisplay{
-		app:           app,
-		pages:         tview.NewPages(),
-		log:           log,
-		sidecarConfig: sidecarConfig,
+		app:        app,
+		pages:      tview.NewPages(),
+		log:        log,
+		sidecarCfg: sidecarCfg,
 	}
 
 	// Create all of our install wizard pages.
@@ -71,7 +71,7 @@ func NewInstallDisplay(log *logrus.Logger, app *tview.Application, sidecarConfig
 func (d *InstallDisplay) Run() error {
 	d.setPage(d.welcomePage.GetPage())
 
-	cfg := d.sidecarConfig.Get()
+	cfg := d.sidecarCfg.Get()
 
 	d.log.WithFields(logrus.Fields{
 		"config_path": cfg.ContributoorDirectory,

diff --git a/cmd/cli/commands/install/install.go b/cmd/cli/commands/install/install.go
@@ -21,12 +21,12 @@ func RegisterCommands(app *cli.App, opts *options.CommandOpts) {
 		Action: func(c *cli.Context) error {
 			log := opts.Logger()
 
-			sidecarConfig, err := sidecar.NewConfigService(log, c.GlobalString("config-path"))
+			sidecarCfg, err := sidecar.NewConfigService(log, c.GlobalString("config-path"))
 			if err != nil {
 				return fmt.Errorf("error loading config: %w", err)
 			}
 
-			return installContributoor(c, log, sidecarConfig)
+			return installContributoor(c, log, sidecarCfg)
 		},
 		Flags: []cli.Flag{
 			cli.StringFlag{
@@ -43,10 +43,10 @@ func RegisterCommands(app *cli.App, opts *options.CommandOpts) {
 	})
 }
 
-func installContributoor(c *cli.Context, log *logrus.Logger, sidecarConfig sidecar.ConfigManager) error {
+func installContributoor(c *cli.Context, log *logrus.Logger, sidecarCfg sidecar.ConfigManager) error {
 	var (
 		app     = tview.NewApplication()
-		display = NewInstallDisplay(log, app, sidecarConfig)
+		display = NewInstallDisplay(log, app, sidecarCfg)
 	)
 
 	// Run the display.

diff --git a/cmd/cli/commands/install/page_20_network.go b/cmd/cli/commands/install/page_20_network.go
@@ -91,7 +91,7 @@ func (p *NetworkConfigPage) initPage() {
 
 		// Add button to our form.
 		form.AddButton(label, func() {
-			if err := p.display.sidecarConfig.Update(func(cfg *sidecar.Config) {
+			if err := p.display.sidecarCfg.Update(func(cfg *sidecar.Config) {
 				cfg.NetworkName = tui.AvailableNetworks[index].Value
 			}); err != nil {
 				p.openErrorModal(err)

diff --git a/cmd/cli/commands/install/page_20_network_test.go b/cmd/cli/commands/install/page_20_network_test.go
@@ -21,9 +21,9 @@ func TestNetworkConfigPage(t *testing.T) {
 		mockConfig.EXPECT().Update(gomock.Any()).Return(nil).AnyTimes()
 
 		return &InstallDisplay{
-			app:           tview.NewApplication(),
-			log:           logrus.New(),
-			sidecarConfig: mockConfig,
+			app:        tview.NewApplication(),
+			log:        logrus.New(),
+			sidecarCfg: mockConfig,
 		}
 	}
 

diff --git a/cmd/cli/commands/install/page_30_beacon_node.go b/cmd/cli/commands/install/page_30_beacon_node.go
@@ -66,7 +66,7 @@ func (p *BeaconNodePage) initPage() {
 	// Add input field to our form to capture the users beacon node address.
 	inputField := tview.NewInputField().
 		SetLabel("Beacon Node Address: ").
-		SetText(p.display.sidecarConfig.Get().BeaconNodeAddress).
+		SetText(p.display.sidecarCfg.Get().BeaconNodeAddress).
 		SetFieldBackgroundColor(tcell.ColorBlack).
 		SetLabelColor(tcell.ColorLightGray)
 	form.AddFormItem(inputField)
@@ -133,7 +133,7 @@ func validateAndUpdate(p *BeaconNodePage, input *tview.InputField) {
 		return
 	}
 
-	if err := p.display.sidecarConfig.Update(func(cfg *sidecar.Config) {
+	if err := p.display.sidecarCfg.Update(func(cfg *sidecar.Config) {
 		cfg.BeaconNodeAddress = input.GetText()
 	}); err != nil {
 		p.openErrorModal(err)

diff --git a/cmd/cli/commands/install/page_30_beacon_node_test.go b/cmd/cli/commands/install/page_30_beacon_node_test.go
@@ -20,9 +20,9 @@ func TestBeaconNodePage(t *testing.T) {
 		mockConfig.EXPECT().Get().Return(cfg).AnyTimes()
 
 		return &InstallDisplay{
-			app:           tview.NewApplication(),
-			log:           logrus.New(),
-			sidecarConfig: mockConfig,
+			app:        tview.NewApplication(),
+			log:        logrus.New(),
+			sidecarCfg: mockConfig,
 			networkConfigPage: &NetworkConfigPage{
 				page: &tui.Page{ID: "network-config"},
 			},

diff --git a/cmd/cli/commands/install/page_40_output_server.go b/cmd/cli/commands/install/page_40_output_server.go
@@ -68,8 +68,8 @@ func (p *OutputServerPage) initPage() {
 	p.form = form
 
 	// Get current selection from config
-	if p.display.sidecarConfig.Get().OutputServer == nil {
-		if err := p.display.sidecarConfig.Update(func(cfg *sidecar.Config) {
+	if p.display.sidecarCfg.Get().OutputServer == nil {
+		if err := p.display.sidecarCfg.Update(func(cfg *sidecar.Config) {
 			cfg.OutputServer = &sidecar.OutputServerConfig{}
 		}); err != nil {
 			p.openErrorModal(err)
@@ -78,7 +78,7 @@ func (p *OutputServerPage) initPage() {
 		}
 	}
 
-	currentAddress := p.display.sidecarConfig.Get().OutputServer.Address
+	currentAddress := p.display.sidecarCfg.Get().OutputServer.Address
 	defaultIndex := 0 // Default to first option
 
 	// Check if it's a custom server address.
@@ -114,13 +114,13 @@ func (p *OutputServerPage) initPage() {
 		}
 
 		// Clear credentials when switching server types
-		currentAddress := p.display.sidecarConfig.Get().OutputServer.Address
+		currentAddress := p.display.sidecarCfg.Get().OutputServer.Address
 		wasEthPandaOps := validate.IsEthPandaOpsServer(currentAddress)
 		isEthPandaOps := validate.IsEthPandaOpsServer(selectedValue)
 
 		if wasEthPandaOps != isEthPandaOps {
 			// Server type changed, clear credentials
-			if err := p.display.sidecarConfig.Update(func(cfg *sidecar.Config) {
+			if err := p.display.sidecarCfg.Update(func(cfg *sidecar.Config) {
 				cfg.OutputServer.Credentials = ""
 			}); err != nil {
 				p.openErrorModal(err)
@@ -132,12 +132,12 @@ func (p *OutputServerPage) initPage() {
 		// Handle custom server field.
 		if selectedValue == "custom" {
 			// If we're switching to custom, preserve existing custom address.
-			existingAddress := p.display.sidecarConfig.Get().OutputServer.Address
+			existingAddress := p.display.sidecarCfg.Get().OutputServer.Address
 			if strings.Contains(existingAddress, "platform.ethpandaops.io") {
 				existingAddress = ""
 			}
 
-			if err := p.display.sidecarConfig.Update(func(cfg *sidecar.Config) {
+			if err := p.display.sidecarCfg.Update(func(cfg *sidecar.Config) {
 				cfg.OutputServer.Address = existingAddress
 			}); err != nil {
 				p.openErrorModal(err)
@@ -146,7 +146,7 @@ func (p *OutputServerPage) initPage() {
 			}
 
 			input := form.AddInputField("Server Address", existingAddress, 40, nil, func(address string) {
-				if err := p.display.sidecarConfig.Update(func(cfg *sidecar.Config) {
+				if err := p.display.sidecarCfg.Update(func(cfg *sidecar.Config) {
 					cfg.OutputServer.Address = address
 				}); err != nil {
 					p.openErrorModal(err)
@@ -157,7 +157,7 @@ func (p *OutputServerPage) initPage() {
 			input.SetBackgroundColor(tui.ColorFormBackground)
 		} else {
 			// Only update config when explicitly selecting a standard server.
-			if err := p.display.sidecarConfig.Update(func(cfg *sidecar.Config) {
+			if err := p.display.sidecarCfg.Update(func(cfg *sidecar.Config) {
 				cfg.OutputServer.Address = selectedValue
 			}); err != nil {
 				p.openErrorModal(err)
@@ -203,7 +203,7 @@ func (p *OutputServerPage) initPage() {
 		}
 
 		// Update config with validated address
-		if err := p.display.sidecarConfig.Update(func(cfg *sidecar.Config) {
+		if err := p.display.sidecarCfg.Update(func(cfg *sidecar.Config) {
 			cfg.OutputServer.Address = address
 		}); err != nil {
 			p.openErrorModal(err)

diff --git a/cmd/cli/commands/install/page_40_output_server_test.go b/cmd/cli/commands/install/page_40_output_server_test.go
@@ -25,9 +25,9 @@ func TestOutputServerPage(t *testing.T) {
 		mockConfig.EXPECT().Update(gomock.Any()).Return(nil).AnyTimes()
 
 		return &InstallDisplay{
-			app:           tview.NewApplication(),
-			log:           logrus.New(),
-			sidecarConfig: mockConfig,
+			app:        tview.NewApplication(),
+			log:        logrus.New(),
+			sidecarCfg: mockConfig,
 			beaconPage: &BeaconNodePage{
 				page: &tui.Page{ID: "beacon-node"},
 			},

diff --git a/cmd/cli/commands/install/page_50_output_server_credentials.go b/cmd/cli/commands/install/page_50_output_server_credentials.go
@@ -63,7 +63,7 @@ func (p *OutputServerCredentialsPage) initPage() {
 	p.form = form
 
 	// Get existing credentials if any
-	if currentCreds := p.display.sidecarConfig.Get().OutputServer.Credentials; currentCreds != "" {
+	if currentCreds := p.display.sidecarCfg.Get().OutputServer.Credentials; currentCreds != "" {
 		if decoded, err := base64.StdEncoding.DecodeString(currentCreds); err == nil {
 			parts := strings.Split(string(decoded), ":")
 			if len(parts) == 2 {
@@ -156,7 +156,7 @@ func validateAndSaveCredentials(p *OutputServerCredentialsPage) {
 		}
 	}
 
-	currentAddress := p.display.sidecarConfig.Get().OutputServer.Address
+	currentAddress := p.display.sidecarCfg.Get().OutputServer.Address
 	isEthPandaOps := validate.IsEthPandaOpsServer(currentAddress)
 
 	if err := validate.ValidateOutputServerCredentials(username, password, isEthPandaOps); err != nil {
@@ -166,7 +166,7 @@ func validateAndSaveCredentials(p *OutputServerCredentialsPage) {
 	}
 
 	// Update config with credentials
-	if err := p.display.sidecarConfig.Update(func(cfg *sidecar.Config) {
+	if err := p.display.sidecarCfg.Update(func(cfg *sidecar.Config) {
 		// For custom servers, allow empty credentials
 		// For ethPandaOps servers, we know credentials are valid (non-empty) due to validation.
 		if username != "" && password != "" {

diff --git a/cmd/cli/commands/install/page_50_output_server_credentials_test.go b/cmd/cli/commands/install/page_50_output_server_credentials_test.go
@@ -25,9 +25,9 @@ func TestOutputServerCredentialsPage(t *testing.T) {
 		mockConfig.EXPECT().Update(gomock.Any()).Return(nil).AnyTimes()
 
 		return &InstallDisplay{
-			app:           tview.NewApplication(),
-			log:           logrus.New(),
-			sidecarConfig: mockConfig,
+			app:        tview.NewApplication(),
+			log:        logrus.New(),
+			sidecarCfg: mockConfig,
 			outputPage: &OutputServerPage{
 				page: &tui.Page{ID: "output-server"},
 			},

diff --git a/cmd/cli/commands/install/page_60_finished_test.go b/cmd/cli/commands/install/page_60_finished_test.go
@@ -22,9 +22,9 @@ func TestFinishedPage(t *testing.T) {
 		}).AnyTimes()
 
 		display := &InstallDisplay{
-			app:           tview.NewApplication(),
-			log:           logrus.New(),
-			sidecarConfig: mockConfig,
+			app:        tview.NewApplication(),
+			log:        logrus.New(),
+			sidecarCfg: mockConfig,
 		}
 
 		// Initialize requiredpages