Allow fly logs to read --machine flag (#3820)

* Allow fly logs to read --machine flag, throw error if --instance clashes with --machine(they should not clash as they identify the same value, that is a machine id)

* test

* 1. Include --instance as an alias for --machine for fly logs
2. Remove integration test for fly_logs
3. Create preflight test for fly_logs

* Fix trailing spaces, go linter error

* Update test name to properly identify what is being tested

* Update preflight test for fly logs to get machine id directly from MachineList, remove logic for parsing machine id from fly machines list outpu

* Add logic for UseAliasShortHand in makeAlias function. This boolean parameter would allow the inclusion of aliases default shorthands(first character of alias).

* Remove the function GetMachineId, as creating an alias for instance already handles its logic, remove test for GetMachineId, add test for shorthand flags for instance(-i) and machine(-m) for fly logs

* fix trailing whitespaces, use gofmt to relevant files to pass gh workflow tests

* Update the names of subtests in fly_logs_test to better reflect their objectives

* Remove shorthand m for machine flag for fly logs

* Remove testcase for shorthand -m for fly logs

---------

Co-authored-by: Kathryn Anne S Tan <[email protected]>

Author: KTanAug21

internal/command/logs/logs.go

@@ -50,9 +50,10 @@ Use --no-tail to only fetch the logs in the buffer.
 		flag.Region(),
 		flag.JSONOutput(),
 		flag.String{
-			Name:        "instance",
-			Shorthand:   "i",
-			Description: "Filter by instance ID",
+			Name:              "machine",
+			Description:       "Filter by machine ID",
+			Aliases:           []string{"instance"},
+			UseAliasShortHand: true,
 		},
 		flag.Bool{
 			Name:        "no-tail",
@@ -69,7 +70,7 @@ func run(ctx context.Context) error {
 	opts := &logs.LogOptions{
 		AppName:    appconfig.NameFromContext(ctx),
 		RegionCode: config.FromContext(ctx).Region,
-		VMID:       flag.GetString(ctx, "instance"),
+		VMID:       flag.GetString(ctx, "machine"),
 		NoTail:     flag.GetBool(ctx, "no-tail"),
 	}
 

internal/flag/flag.go

@@ -14,6 +14,7 @@ import (
 type extraArgsContextKey struct{}
 
 func makeAlias[T any](template T, name string) T {
+
 	var ret T
 	value := reflect.ValueOf(&ret).Elem()
 
@@ -31,6 +32,15 @@ func makeAlias[T any](template T, name string) T {
 	if hiddenField.IsValid() {
 		hiddenField.SetBool(true)
 	}
+
+	useAliasShortHandField := reflect.ValueOf(template).FieldByName("UseAliasShortHand")
+	if useAliasShortHandField.IsValid() {
+		useAliasShortHand := useAliasShortHandField.Interface().(bool)
+		if useAliasShortHand == true {
+			value.FieldByName("Shorthand").SetString(string(name[0]))
+		}
+	}
+
 	return ret
 }
 
@@ -88,16 +98,17 @@ func (b Bool) addTo(cmd *cobra.Command) {
 
 // String wraps the set of string flags.
 type String struct {
-	Name         string
-	Shorthand    string
-	Description  string
-	Default      string
-	NoOptDefVal  string
-	ConfName     string
-	EnvName      string
-	Hidden       bool
-	Aliases      []string
-	CompletionFn func(ctx context.Context, cmd *cobra.Command, args []string, partial string) ([]string, error)
+	Name              string
+	Shorthand         string
+	Description       string
+	Default           string
+	NoOptDefVal       string
+	ConfName          string
+	EnvName           string
+	Hidden            bool
+	Aliases           []string
+	UseAliasShortHand bool
+	CompletionFn      func(ctx context.Context, cmd *cobra.Command, args []string, partial string) ([]string, error)
 }
 
 func (s String) addTo(cmd *cobra.Command) {

test/preflight/fly_logs_test.go

@@ -0,0 +1,43 @@
+//go:build integration
+// +build integration
+
+package preflight
+
+import (
+	"github.com/stretchr/testify/require"
+	"github.com/superfly/flyctl/test/preflight/testlib"
+	"testing"
+)
+
+
+func TestFlyLogsMachineFlagBehavior(t *testing.T) {
+	// Test `flyctl logs` with different flag combinations
+
+	// Get library from preflight test lib using env variables form  .direnv/preflight
+	f := testlib.NewTestEnvFromEnv(t)
+	if f.VMSize != "" {
+		t.Skip()
+	}
+
+	// Create app, Create Machine, get Machine ID
+	appName := f.CreateRandomAppMachines()
+	f.Fly("machine run -a %s nginx --port 80:81 --autostop --region %s", appName, f.PrimaryRegion())
+	ml := f.MachinesList(appName)
+	require.Equal(f, 1, len(ml))
+	machineId := ml[0].ID
+
+	// Test if --machine works, should not throw an error
+	t.Run("TestRunsWhenMachineFlagProvided", func(tt *testing.T) {
+		f.Fly("logs --app "+appName+" --no-tail --machine " + machineId)
+	})
+
+	// Test if --instance works, should not throw an error
+	t.Run("TestRunsWhenInstanceFlagProvided", func(tt *testing.T) {
+		f.Fly("logs  --app "+appName+" --no-tail --instance " + machineId)
+	})
+
+	// Test if alias shorthand -i works, should not throw an error
+	t.Run("TestRunsWhenInstanceShorthandProvided", func(tt *testing.T) {
+		f.Fly("logs --app "+appName+" --no-tail -i " + machineId)
+	})
+}