Merge pull request #146 from digitalghost-dev/1.2.4

1.2.4

Author: digitalghost-dev

.github/workflows/ci.yml

@@ -26,7 +26,7 @@ on:
       - main
 
 env:
-  VERSION_NUMBER: 'v1.2.3'
+  VERSION_NUMBER: 'v1.2.4'
   DOCKERHUB_REGISTRY_NAME: 'digitalghostdev/poke-cli'
   AWS_REGION: 'us-west-2'
 

.goreleaser.yaml

@@ -14,7 +14,7 @@ builds:
       - windows
       - darwin
     ldflags:
-      - -s -w -X main.version=v1.2.3
+      - -s -w -X main.version=v1.2.4
 
 archives:
   - format: tar.gz

CHANGELOG.md

@@ -8,7 +8,7 @@ RUN go mod download
 
 COPY . .
 
-RUN go build -ldflags "-X main.version=v1.2.3" -o poke-cli .
+RUN go build -ldflags "-X main.version=v1.2.4" -o poke-cli .
 
 # build 2
 FROM --platform=$BUILDPLATFORM alpine:latest

Dockerfile

@@ -2,7 +2,7 @@
     <img height="250" width="350" src="pokemon.svg" alt="pokemon-logo"/>
     <h1>Pokémon CLI</h1>
     <img src="https://img.shields.io/github/v/release/digitalghost-dev/poke-cli?style=flat-square&logo=git&logoColor=FFCC00&label=Release%20Version&labelColor=EEE&color=FFCC00" alt="version-label">
-    <img src="https://img.shields.io/docker/image-size/digitalghostdev/poke-cli/v1.2.3?arch=arm64&style=flat-square&logo=docker&logoColor=FFCC00&labelColor=EEE&color=FFCC00" alt="docker-image-size">
+    <img src="https://img.shields.io/docker/image-size/digitalghostdev/poke-cli/v1.2.4?arch=arm64&style=flat-square&logo=docker&logoColor=FFCC00&labelColor=EEE&color=FFCC00" alt="docker-image-size">
     <img src="https://img.shields.io/github/actions/workflow/status/digitalghost-dev/poke-cli/ci.yml?branch=main&style=flat-square&logo=github&logoColor=FFCC00&label=CI&labelColor=EEE&color=FFCC00" alt="ci-status-badge">
 </div>
 <div align="center">
@@ -76,11 +76,11 @@ View future plans in the [Roadmap](#roadmap) section.
 3. Choose how to interact with the container:
    * Run a single command and exit:
     ```bash
-    docker run --rm -it digitalghostdev/poke-cli:v1.2.3 <command> [subcommand] flag]
+    docker run --rm -it digitalghostdev/poke-cli:v1.2.4 <command> [subcommand] flag]
     ```
    * Enter the container and use its shell:
     ```bash
-    docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.2.3 -c "cd /app && exec sh"
+    docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.2.4 -c "cd /app && exec sh"
    # placed into the /app directory, run the program with './poke-cli'
    # example: ./poke-cli ability swift-swim
     ```

README.md

@@ -3,16 +3,18 @@ package main
 import (
 	"flag"
 	"fmt"
-	"github.com/digitalghost-dev/poke-cli/cmd"
 	"github.com/digitalghost-dev/poke-cli/cmd/ability"
 	"github.com/digitalghost-dev/poke-cli/cmd/move"
 	"github.com/digitalghost-dev/poke-cli/cmd/natures"
+	"github.com/digitalghost-dev/poke-cli/cmd/pokemon"
 	"github.com/digitalghost-dev/poke-cli/cmd/search"
 	"github.com/digitalghost-dev/poke-cli/cmd/types"
+	"github.com/digitalghost-dev/poke-cli/cmd/utils"
 	"github.com/digitalghost-dev/poke-cli/flags"
 	"github.com/digitalghost-dev/poke-cli/styling"
 	"os"
 	"runtime/debug"
+	"strings"
 )
 
 var version = "(devel)"
@@ -38,13 +40,9 @@ func currentVersion() {
 	}
 }
 
-func printWrapper(f func() string) func() {
-	return func() {
-		fmt.Println(f())
-	}
-}
-
 func runCLI(args []string) int {
+	var output strings.Builder
+
 	mainFlagSet := flag.NewFlagSet("poke-cli", flag.ContinueOnError)
 
 	// -l, --latest flag retrieves the latest Docker image and GitHub release versions available
@@ -97,27 +95,34 @@ func runCLI(args []string) int {
 	}
 
 	commands := map[string]func(){
-		"ability": printWrapper(ability.AbilityCommand),
-		"move":    printWrapper(move.MoveCommand),
-		"natures": printWrapper(natures.NaturesCommand),
-		"pokemon": cmd.PokemonCommand,
-		"types":   printWrapper(types.TypesCommand),
+		"ability": utils.HandleCommandOutput(ability.AbilityCommand),
+		"move":    utils.HandleCommandOutput(move.MoveCommand),
+		"natures": utils.HandleCommandOutput(natures.NaturesCommand),
+		"pokemon": utils.HandleCommandOutput(pokemon.PokemonCommand),
+		"types":   utils.HandleCommandOutput(types.TypesCommand),
 		"search":  search.SearchCommand,
 	}
 
-	if len(os.Args) < 2 {
+	cmdArg := ""
+	if len(os.Args) >= 2 {
+		cmdArg = os.Args[1]
+	}
+	cmdFunc, exists := commands[cmdArg]
+
+	switch {
+	case len(os.Args) < 2:
 		mainFlagSet.Usage()
 		return 1
-	} else if *latestFlag || *shortLatestFlag {
+	case *latestFlag || *shortLatestFlag:
 		flags.LatestFlag()
 		return 0
-	} else if *currentVersionFlag || *shortCurrentVersionFlag {
+	case *currentVersionFlag || *shortCurrentVersionFlag:
 		currentVersion()
 		return 0
-	} else if cmdFunc, exists := commands[os.Args[1]]; exists {
+	case exists:
 		cmdFunc()
 		return 0
-	} else {
+	default:
 		command := os.Args[1]
 		errMessage := styling.ErrorBorder.Render(
 			styling.ErrorColor.Render("Error!"),
@@ -131,7 +136,11 @@ func runCLI(args []string) int {
 			fmt.Sprintf("\n\t%-15s %s", "types", "Get details about a typing"),
 			fmt.Sprintf("\n\nAlso run %s for more info!", styling.StyleBold.Render("poke-cli -h")),
 		)
-		fmt.Printf("%s\n", errMessage)
+		output.WriteString(errMessage)
+
+		// This would typically be returned in a function or passed to something else
+		fmt.Println(output.String())
+
 		return 1
 	}
 }

cli.go

@@ -2,6 +2,9 @@ package main
 
 import (
 	"bytes"
+	"github.com/digitalghost-dev/poke-cli/cmd/utils"
+	"github.com/digitalghost-dev/poke-cli/styling"
+	"github.com/stretchr/testify/assert"
 	"os"
 	"regexp"
 	"testing"
@@ -93,119 +96,28 @@ func TestRunCLI(t *testing.T) {
 		expectedCode   int
 	}{
 		{
-			name: "No Arguments",
-			args: []string{},
-			expectedOutput: "╭──────────────────────────────────────────────────────────╮\n" +
-				"│Welcome! This tool displays data related to Pokémon!      │\n" +
-				"│                                                          │\n" +
-				"│ USAGE:                                                   │\n" +
-				"│    poke-cli [flag]                                       │\n" +
-				"│    poke-cli <command> [flag]                             │\n" +
-				"│    poke-cli <command> <subcommand> [flag]                │\n" +
-				"│                                                          │\n" +
-				"│ FLAGS:                                                   │\n" +
-				"│    -h, --help      Shows the help menu                   │\n" +
-				"│    -l, --latest    Prints the latest version available   │\n" +
-				"│    -v, --version   Prints the current version            │\n" +
-				"│                                                          │\n" +
-				"│ COMMANDS:                                                │\n" +
-				"│    ability         Get details about an ability          │\n" +
-				"│    move            Get details about a move              │\n" +
-				"│    natures         Get details about all natures         │\n" +
-				"│    pokemon         Get details about a Pokémon           │\n" +
-				"│    search          Search for a resource                 │\n" +
-				"│    types           Get details about a typing            │\n" +
-				"│                                                          │\n" +
-				"│ hint: when calling a resource with a space, use a hyphen │\n" +
-				"│ example: poke-cli ability strong-jaw                     │\n" +
-				"│ example: poke-cli pokemon flutter-mane                   │\n" +
-				"╰──────────────────────────────────────────────────────────╯",
-			expectedCode: 0,
-		},
-		{
-			name: "Help Flag Short",
-			args: []string{"-h"},
-			expectedOutput: "╭──────────────────────────────────────────────────────────╮\n" +
-				"│Welcome! This tool displays data related to Pokémon!      │\n" +
-				"│                                                          │\n" +
-				"│ USAGE:                                                   │\n" +
-				"│    poke-cli [flag]                                       │\n" +
-				"│    poke-cli <command> [flag]                             │\n" +
-				"│    poke-cli <command> <subcommand> [flag]                │\n" +
-				"│                                                          │\n" +
-				"│ FLAGS:                                                   │\n" +
-				"│    -h, --help      Shows the help menu                   │\n" +
-				"│    -l, --latest    Prints the latest version available   │\n" +
-				"│    -v, --version   Prints the current version            │\n" +
-				"│                                                          │\n" +
-				"│ COMMANDS:                                                │\n" +
-				"│    ability         Get details about an ability          │\n" +
-				"│    move            Get details about a move              │\n" +
-				"│    natures         Get details about all natures         │\n" +
-				"│    pokemon         Get details about a Pokémon           │\n" +
-				"│    search          Search for a resource                 │\n" +
-				"│    types           Get details about a typing            │\n" +
-				"│                                                          │\n" +
-				"│ hint: when calling a resource with a space, use a hyphen │\n" +
-				"│ example: poke-cli ability strong-jaw                     │\n" +
-				"│ example: poke-cli pokemon flutter-mane                   │\n" +
-				"╰──────────────────────────────────────────────────────────╯",
-			expectedCode: 0,
-		},
-		{
-			name: "Help Flag Long",
-			args: []string{"--help"},
-			expectedOutput: "╭──────────────────────────────────────────────────────────╮\n" +
-				"│Welcome! This tool displays data related to Pokémon!      │\n" +
-				"│                                                          │\n" +
-				"│ USAGE:                                                   │\n" +
-				"│    poke-cli [flag]                                       │\n" +
-				"│    poke-cli <command> [flag]                             │\n" +
-				"│    poke-cli <command> <subcommand> [flag]                │\n" +
-				"│                                                          │\n" +
-				"│ FLAGS:                                                   │\n" +
-				"│    -h, --help      Shows the help menu                   │\n" +
-				"│    -l, --latest    Prints the latest version available   │\n" +
-				"│    -v, --version   Prints the current version            │\n" +
-				"│                                                          │\n" +
-				"│ COMMANDS:                                                │\n" +
-				"│    ability         Get details about an ability          │\n" +
-				"│    move            Get details about a move              │\n" +
-				"│    natures         Get details about all natures         │\n" +
-				"│    pokemon         Get details about a Pokémon           │\n" +
-				"│    search          Search for a resource                 │\n" +
-				"│    types           Get details about a typing            │\n" +
-				"│                                                          │\n" +
-				"│ hint: when calling a resource with a space, use a hyphen │\n" +
-				"│ example: poke-cli ability strong-jaw                     │\n" +
-				"│ example: poke-cli pokemon flutter-mane                   │\n" +
-				"╰──────────────────────────────────────────────────────────╯",
-
-			expectedCode: 0,
-		},
-		{
-			name:           "Invalid Command",
-			args:           []string{"invalid"},
-			expectedOutput: "Error!",
-			expectedCode:   1,
+			name:           "Test CLI help flag",
+			args:           []string{"--help"},
+			expectedOutput: utils.LoadGolden(t, "cli_help.golden"),
+			expectedCode:   0,
 		},
 	}
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			exit = func(code int) {}
+			originalArgs := os.Args
+			os.Args = append([]string{"poke-cli"}, tt.args...)
+			defer func() { os.Args = originalArgs }()
+
+			var exitCode int
 			output := captureOutput(func() {
-				code := runCLI(tt.args)
-				if code != tt.expectedCode {
-					t.Errorf("Expected exit code %d, got %d", tt.expectedCode, code)
-				}
+				exitCode = runCLI(tt.args)
 			})
 
-			output = stripANSI(output)
+			cleanOutput := styling.StripANSI(output)
 
-			if !bytes.Contains([]byte(output), []byte(tt.expectedOutput)) {
-				t.Errorf("Expected output to contain %q, got %q", tt.expectedOutput, output)
-			}
+			assert.Equal(t, tt.expectedOutput, cleanOutput, "Output should match expected")
+			assert.Equal(t, tt.expectedCode, exitCode, "Exit code should match expected")
 		})
 	}
 }

cli_test.go

@@ -13,7 +13,7 @@ import (
 	"strings"
 )
 
-func AbilityCommand() string {
+func AbilityCommand() (string, error) {
 	var output strings.Builder
 
 	flag.Usage = func() {
@@ -38,12 +38,12 @@ func AbilityCommand() string {
 
 	if len(os.Args) == 3 && (os.Args[2] == "-h" || os.Args[2] == "--help") {
 		flag.Usage()
-		return output.String()
+		return output.String(), nil
 	}
 
 	if err := utils.ValidateAbilityArgs(args); err != nil {
 		output.WriteString(err.Error())
-		return output.String()
+		return output.String(), err
 	}
 
 	endpoint := strings.ToLower(args[1])
@@ -55,7 +55,7 @@ func AbilityCommand() string {
 		if os.Getenv("GO_TESTING") != "1" {
 			os.Exit(1)
 		}
-		return output.String()
+		return output.String(), err
 	}
 
 	abilitiesStruct, abilityName, err := connections.AbilityApiCall(endpoint, abilityName, connections.APIURL)
@@ -64,7 +64,7 @@ func AbilityCommand() string {
 			fmt.Fprintln(os.Stderr, err)
 			os.Exit(1)
 		}
-		return err.Error()
+		return err.Error(), nil
 	}
 
 	// Extract English short_effect
@@ -108,11 +108,9 @@ func AbilityCommand() string {
 	if *pokemonFlag || *shortPokemonFlag {
 		if err := flags.PokemonAbilitiesFlag(&output, endpoint, abilityName); err != nil {
 			output.WriteString(fmt.Sprintf("error parsing flags: %v\n", err))
-			if os.Getenv("GO_TESTING") != "1" {
-				os.Exit(1)
-			}
+			return "", fmt.Errorf("error parsing flags: %w", err)
 		}
 	}
 
-	return output.String()
+	return output.String(), nil
 }

cmd/ability/ability.go

@@ -32,6 +32,11 @@ func TestAbilityCommand(t *testing.T) {
 			args:           []string{"ability", "--help"},
 			expectedOutput: utils.LoadGolden(t, "ability_help.golden"),
 		},
+		{
+			name:           "Ability help flag",
+			args:           []string{"ability", "-h"},
+			expectedOutput: utils.LoadGolden(t, "ability_help.golden"),
+		},
 		{
 			name:           "Ability command: clear-body",
 			args:           []string{"ability", "clear-body"},
@@ -43,6 +48,11 @@ func TestAbilityCommand(t *testing.T) {
 			expectedOutput: utils.LoadGolden(t, "ability_misspelled.golden"),
 			wantError:      true,
 		},
+		{
+			name:           "Ability command: --pokemon flag",
+			args:           []string{"ability", "anger-point", "--pokemon"},
+			expectedOutput: utils.LoadGolden(t, "ability_flag_pokemon.golden"),
+		},
 	}
 
 	for _, tt := range tests {
@@ -51,7 +61,7 @@ func TestAbilityCommand(t *testing.T) {
 			os.Args = append([]string{"poke-cli"}, tt.args...)
 			defer func() { os.Args = originalArgs }()
 
-			output := AbilityCommand()
+			output, _ := AbilityCommand()
 			cleanOutput := styling.StripANSI(output)
 
 			assert.Equal(t, tt.expectedOutput, cleanOutput, "Output should match expected")