Inconsistent Name for Application from inside Subcommands (v1)

[asahasrabuddhe]

Motivation

Fixes #783

The motivation for doing this for v1 is to provide support, and a valuable feature that the users want to stick to v1 can appreciate.

Release Notes

Adds ProgramName and CommandName. The ProgramName will always contain the name of the application as defined by the user. The CommandName will include the ProgramName with the name of the command, and it's parent commands.

Changes

• app.go - Added the ProgramName and CommandName members to the App struct.
• command.go - Added logic to initialise and update the ProgramName and CommandName members.
• command-test.go - Added a test case to validate above change

Testing

I used the following program to help test:

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/urfave/cli"
)

func main() {
	app := cli.NewApp()
	app.Name = "myprogramname"
	app.Action = func(c *cli.Context) error {
		fmt.Println("c.App.Name for app.Action is", c.App.Name)
		fmt.Println("c.App.ProgramName for app.Action is", c.App.ProgramName)
		fmt.Println("c.App.CommandName for app.Action is", c.App.CommandName)
		return nil
	}
	app.Commands = []cli.Command{
		{
			Name: "foo",
			Action: func(c *cli.Context) error {
				fmt.Println("c.App.Name for app.Commands.Action is", c.App.Name)
				fmt.Println("c.App.ProgramName for app.Commands.Action is", c.App.ProgramName)
				fmt.Println("c.App.CommandName for app.Commands.Action is", c.App.CommandName)
				return nil
			},
			Subcommands: []cli.Command{
				{
					Name: "bar",
					Action: func(c *cli.Context) error {
						fmt.Println("c.App.Name for App.Commands.Subcommands.Action is", c.App.Name)
						fmt.Println("c.App.ProgramName for App.Commands.Subcommands.Action is", c.App.ProgramName)
						fmt.Println("c.App.CommandName for App.Commands.Subcommands.Action is", c.App.CommandName)
						return nil
					},
					Subcommands: []cli.Command{
						{
							Name: "baz",
							Action: func(c *cli.Context) error {
								fmt.Println("c.App.Name for App.Commands.Subcommands.Subcommands.Action is", c.App.Name)
								fmt.Println("c.App.ProgramName for App.Commands.Subcommands.Subcommands.Action is", c.App.ProgramName)
								fmt.Println("c.App.CommandName for App.Commands.Subcommands.Subcommands.Action is", c.App.CommandName)
								return nil
							},
						},
					},
				},
			},
		},
	}

	err := app.Run(os.Args)
	if err != nil {
		log.Fatal()
	}
}

The same program was modified to write the test case.

Reviewer Guidelines

The PR is marked as a v2 feature. However, I thought that this, being a simple change, it would be worth our while to get this into v1 for the sake of sanity.

[codecov]

Codecov Report

Merging #973 into v1 will increase coverage by 0.19%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##               v1     #973      +/-   ##
==========================================
+ Coverage   71.65%   71.85%   +0.19%     
==========================================
  Files          30       30              
  Lines        2410     2416       +6     
==========================================
+ Hits         1727     1736       +9     
+ Misses        577      574       -3     
  Partials      106      106

Impacted Files	Coverage Δ
app.go	85.89% <100%> (+1.37%)	⬆️
command.go	84.39% <100%> (+0.36%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ebf9c3e...4d8a76d. Read the comment docs.

[asahasrabuddhe]

This is still WIP

[coilysiren]

Similarly to #974 --- I consider this PR WIP and not approve-able until consensus on the desired solution is reached, that conversation should happen here => #783

[coilysiren]

(clearing the review request, per last comment)

[coilysiren]

Is this still relevant as of #975?

EDIT: nevermind this! I got my issues mixed up.

[coilysiren]

For the sake of making this the most recent comment - this PR is blocked in discussion in => #783

[stale]

This issue or PR has been automatically marked as stale because it has not had recent activity. Please add a comment bumping this if you're still interested in it's resolution! Thanks for your help, please let us know if you need anything else.

[stale]

Closing this as it has become stale.

[meatballhat]

In the end, I think I'd like to close this without merging so that the v1 branch can remain strictly for patches (1.22.x). I'll be opening a separate PR with only the CI config changes.