Merge pull request 'moving run command' (#11) from chore/cmd-structure-update into main

Reviewed-on: #11

.gitea/workflows/security.yaml

@@ -1,17 +1,18 @@
 name: "code scans"
 on: 
   push:
-    branches:
-      - main
-  tags:
-    - v*
   pull_request:
 
 jobs:
   scans:
-    runs-on: fire
+    runs-on: wind
     steps:
       - uses: actions/checkout@v4
 
-      - name: "dependency scan and static code analysis"
+      - name: "install go"
-        uses: https://code.jakeyoungdev.com/actions/donotpassgo@v1.1.0
+        uses: https://code.jakeyoungdev.com/actions/install-go@v0.1.3
+
+      - name: "static code analysis"
+        uses: securego/gosec@v2.22.10
+        with:
+          args: ./...

README.md

@@ -82,7 +82,7 @@ Command: kill %s
 ```
 ```bash
 #runs the 'kill' command on 'player'
-mctl command run placeholder kill player
+mctl command run placeholder player
 ```
 Running the placeholder command with the arg 'player' will run 'kill player' on the server
 

client/mcr.go

@@ -32,12 +32,12 @@ func New(name string) (*Client, error) {
 
 	var srv model.Server
 	if name != "" {
-		srv, err = db.GetServer(name)
+		srv, err = db.Server(name)
 		if err != nil {
 			return nil, err
 		}
 	} else {
-		srv, err = db.GetActiveServer()
+		srv, err = db.ActiveServer()
 		if err != nil {
 			return nil, err
 		}

cmd/command/add.go

@@ -8,6 +8,7 @@ import (
 	"fmt"
 	"os"
 
+	"code.jakeyoungdev.com/jake/mctl/constants"
 	"code.jakeyoungdev.com/jake/mctl/database"
 	"github.com/spf13/cobra"
 )
@@ -42,8 +43,8 @@ var addCmd = &cobra.Command{
 
 		err = db.SaveCmd(cfgname, cfgcmd)
 		if err != nil {
-			if err.Error() == ErrInit {
+			if err.Error() == constants.ErrInit {
-				fmt.Println(ErrInitRsp)
+				fmt.Println(constants.ErrInitRsp)
 				return
 			}
 		}

cmd/command/command.go

@@ -7,13 +7,6 @@ import (
 	"github.com/spf13/cobra"
 )
 
-const (
-	//sqlite doesn't have an error type for this error, but we want to catch when this error is thrown
-	//and provide the proper response. It should not be treated as an error if the db isn't setup.
-	ErrInit    = "sqlite3: SQL logic error: no such table: commands"
-	ErrInitRsp = "The 'init' command must be run before mctl can be used"
-)
-
 // CommandCmd is such a cool name lol
 var CommandCmd = &cobra.Command{
 	Use:     "command",

cmd/command/delete.go

@@ -7,6 +7,7 @@ import (
 	"errors"
 	"fmt"
 
+	"code.jakeyoungdev.com/jake/mctl/constants"
 	"code.jakeyoungdev.com/jake/mctl/database"
 	"github.com/spf13/cobra"
 )
@@ -23,8 +24,8 @@ var deleteCmd = &cobra.Command{
 
 		err = db.DeleteCmd(args[0])
 		if err != nil {
-			if err.Error() == ErrInit {
+			if err.Error() == constants.ErrInit {
-				fmt.Println(ErrInitRsp)
+				fmt.Println(constants.ErrInitRsp)
 				return
 			}
 		}

cmd/command/view.go

@@ -6,6 +6,7 @@ package command
 import (
 	"fmt"
 
+	"code.jakeyoungdev.com/jake/mctl/constants"
 	"code.jakeyoungdev.com/jake/mctl/database"
 	"github.com/spf13/cobra"
 )
@@ -20,10 +21,10 @@ var viewCmd = &cobra.Command{
 		cobra.CheckErr(err)
 		defer db.Close()
 
-		ts, err := db.GetAllCmds()
+		ts, err := db.AllCmds()
 		if err != nil {
-			if err.Error() == ErrInit {
+			if err.Error() == constants.ErrInit {
-				fmt.Println(ErrInitRsp)
+				fmt.Println(constants.ErrInitRsp)
 				return
 			}
 		}

cmd/destroy.go

@@ -9,7 +9,7 @@ import (
 	"os"
 	"strings"
 
-	"code.jakeyoungdev.com/jake/mctl/cmd/command"
+	"code.jakeyoungdev.com/jake/mctl/constants"
 	"code.jakeyoungdev.com/jake/mctl/database"
 	"github.com/spf13/cobra"
 )
@@ -32,8 +32,8 @@ var destroyCmd = &cobra.Command{
 
 				err = db.Destroy()
 				if err != nil {
-					if err.Error() == command.ErrInit {
+					if err.Error() == constants.ErrInit {
-						fmt.Println(command.ErrInitRsp)
+						fmt.Println(constants.ErrInitRsp)
 						return
 					}
 				}

cmd/root.go

@@ -16,7 +16,7 @@ var rootCmd = &cobra.Command{
 	Use:     "mctl",
 	Short:   "A remote console client",
 	Long:    `mctl is a terminal-friendly remote console client made to manage game servers.`,
-	Version: "v0.3.4", //change version number
+	Version: "v0.5.1",
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.

cmd/run.go

@@ -1,7 +1,7 @@
 /*
 Copyright © 2025 Jake jake.young.dev@gmail.com
 */
-package command
+package cmd
 
 import (
 	"errors"
@@ -9,6 +9,7 @@ import (
 	"strings"
 
 	"code.jakeyoungdev.com/jake/mctl/client"
+	"code.jakeyoungdev.com/jake/mctl/constants"
 	"code.jakeyoungdev.com/jake/mctl/database"
 	"github.com/spf13/cobra"
 )
@@ -19,7 +20,7 @@ var (
 
 var runCmd = &cobra.Command{
 	Use:          "run",
-	Example:      "mctl command run -s <server> <command> args...",
+	Example:      "mctl run -s <server> <command> args...",
 	Short:        "Runs a saved command on a server",
 	Long:         `Runs the named command with the provided args on the default/active server unless -s is specified`,
 	SilenceUsage: true,
@@ -32,10 +33,10 @@ var runCmd = &cobra.Command{
 		}
 		defer db.Close()
 
-		crun, err := db.GetCmd(cname)
+		crun, err := db.Cmd(cname)
 		if err != nil {
-			if err.Error() == ErrInit {
+			if err.Error() == constants.ErrInit {
-				fmt.Println(ErrInitRsp)
+				fmt.Println(constants.ErrInitRsp)
 				return nil
 			}
 			return err
@@ -76,5 +77,5 @@ var runCmd = &cobra.Command{
 
 func init() {
 	runCmd.Flags().StringVarP(&cfgserver, "server", "s", "", "server name")
-	CommandCmd.AddCommand(runCmd)
+	rootCmd.AddCommand(runCmd)
 }

cmd/server/view.go

@@ -4,12 +4,15 @@ Copyright © 2025 Jake jake.young.dev@gmail.com
 package server
 
 import (
+	"encoding/base64"
 	"fmt"
 
 	"code.jakeyoungdev.com/jake/mctl/database"
 	"github.com/spf13/cobra"
 )
 
+var decode bool
+
 var viewCmd = &cobra.Command{
 	Use:          "view",
 	Example:      "mctl server view",
@@ -17,29 +20,69 @@ var viewCmd = &cobra.Command{
 	SilenceUsage: true,
 	Run: func(cmd *cobra.Command, args []string) {
 		db, err := database.New()
-		cobra.CheckErr(err)
+		if err != nil {
+			fmt.Println(err)
+			return
+		}
 		defer db.Close()
 
-		ts, err := db.GetAllServers()
+		if len(args) > 0 {
+			srvName := args[0]
+			s, err := db.Server(srvName)
+			if err != nil {
+				fmt.Println(err)
+				return
+			}
+			fmt.Println("-----")
+			fmt.Printf("Name: %s\n", s.Name)
+			fmt.Printf("Address: %s\n", s.Server)
+			fmt.Printf("Port: %d\n", s.Port)
+			if decode {
+				pwb, err := base64.StdEncoding.DecodeString(s.Password)
+				if err != nil {
+					fmt.Println(err)
+					return
+				}
+				fmt.Printf("Password: %s\n", string(pwb))
+			} else {
+				fmt.Println("Password: [REDACTED]")
+			}
+			fmt.Printf("Default: %t\n", s.Active)
+			return
+		}
+
+		ts, err := db.AllServers()
 		if err != nil {
 			if err.Error() == ErrInit {
 				fmt.Println(ErrInitRsp)
 				return
+			} else {
+				fmt.Println(err)
+				return
 			}
 		}
-		cobra.CheckErr(err)
 
 		for _, s := range ts {
 			fmt.Println("-----")
 			fmt.Printf("Name: %s\n", s.Name)
 			fmt.Printf("Address: %s\n", s.Server)
 			fmt.Printf("Port: %d\n", s.Port)
-			fmt.Println("Password: [REDACTED]")
+			if decode {
+				pwb, err := base64.StdEncoding.DecodeString(s.Password)
+				if err != nil {
+					fmt.Println(err)
+					return
+				}
+				fmt.Printf("Password: %s\n", string(pwb))
+			} else {
+				fmt.Println("Password: [REDACTED]")
+			}
 			fmt.Printf("Default: %t\n", s.Active)
 		}
 	},
 }
 
 func init() {
+	viewCmd.Flags().BoolVarP(&decode, "decode", "d", false, "decodes server passwords")
 	ServerCmd.AddCommand(viewCmd)
 }

constants/error.go

@@ -0,0 +1,8 @@
+package constants
+
+const (
+	//sqlite doesn't have an error type for this error, but we want to catch when this error is thrown
+	//and provide the proper response. It should not be treated as an error if the db isn't setup.
+	ErrInit    = "sqlite3: SQL logic error: no such table: commands"
+	ErrInitRsp = "The 'init' command must be run before mctl can be used"
+)

database/sqlx.go

@@ -33,15 +33,15 @@ type Database interface {
 	//internals
 	timeout() (context.Context, context.CancelFunc)
 	//command methods
-	GetCmd(name string) (string, error)
+	Cmd(name string) (string, error)
-	GetAllCmds() ([]model.Command, error)
+	AllCmds() ([]model.Command, error)
 	SaveCmd(name, cmd string) error
 	UpdateCmd(name, cmd string) error
 	DeleteCmd(name string) error
 	//server methods
-	GetServer(name string) (model.Server, error)
+	Server(name string) (model.Server, error)
-	GetActiveServer() (model.Server, error)
+	ActiveServer() (model.Server, error)
-	GetAllServers() ([]model.Server, error)
+	AllServers() ([]model.Server, error)
 	SetActiveServer(name string) error
 	SaveServer(srv model.Server) error
 	UpdateServer(name, password string) error
@@ -110,7 +110,7 @@ func (d *database) timeout() (context.Context, context.CancelFunc) {
 }
 
 // gets command using name
-func (d *database) GetCmd(name string) (string, error) {
+func (d *database) Cmd(name string) (string, error) {
 	query := `
 		SELECT
 			command
@@ -135,7 +135,7 @@ func (d *database) GetCmd(name string) (string, error) {
 }
 
 // gets all saved commands
-func (d *database) GetAllCmds() ([]model.Command, error) {
+func (d *database) AllCmds() ([]model.Command, error) {
 	query := `
 		SELECT
 			name,
@@ -208,7 +208,7 @@ func (d *database) DeleteCmd(name string) error {
 	return err
 }
 
-func (d *database) GetServer(name string) (model.Server, error) {
+func (d *database) Server(name string) (model.Server, error) {
 	query := `
 		SELECT
 			name,
@@ -235,7 +235,7 @@ func (d *database) GetServer(name string) (model.Server, error) {
 	return s, nil
 }
 
-func (d *database) GetActiveServer() (model.Server, error) {
+func (d *database) ActiveServer() (model.Server, error) {
 	query := `
 		SELECT
 			name,
@@ -259,7 +259,7 @@ func (d *database) GetActiveServer() (model.Server, error) {
 	return s, err
 }
 
-func (d *database) GetAllServers() ([]model.Server, error) {
+func (d *database) AllServers() ([]model.Server, error) {
 	query := `
 		SELECT
 			name,