github.com/urfave/cli v1.22.14: Context

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify github.com/urfave/cli.Context in pkg:golang/github.com/urfave/cli@v1.22.14
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/urfave/cli@v1.22.14
Demonstrate these symbols/APIs:
  - github.com/urfave/cli.Context

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

package main

import (
	"fmt"
	"os"

	"github.com/urfave/cli"
)

// CliState captures parsed context values during command execution.
type CliState struct {
	ConfigPath   string
	Port         int
	Verbose      bool
	IsVerboseSet bool
	Args         []string
	FirstArg     string
	ArgCount     int
	ParentName   string
	UpdatedFlag  string
}

// BuildContextDemoApp builds a CLI application designed to demonstrate cli.Context capabilities.
func BuildContextDemoApp(state *CliState) *cli.App {
	app := cli.NewApp()
	app.Name = "contextdemo"
	app.Usage = "demonstrate urfave cli.Context API methods"
	app.Version = "1.0.0"

	app.Flags = []cli.Flag{
		cli.StringFlag{
			Name:  "config, c",
			Value: "default.yaml",
			Usage: "path to configuration file",
		},
		cli.BoolFlag{
			Name:  "verbose, V",
			Usage: "verbose diagnostic logging",
		},
	}

	app.Commands = []cli.Command{
		{
			Name:  "service",
			Usage: "manage services",
			Flags: []cli.Flag{
				cli.IntFlag{
					Name:  "port, p",
					Value: 8080,
					Usage: "port to bind",
				},
				cli.StringFlag{
					Name:  "override",
					Value: "initial",
					Usage: "dynamically modifiable flag",
				},
			},
			Action: func(c *cli.Context) error {
				if state != nil {
					// 1. Flag inspection and IsSet checks
					state.Port = c.Int("port")
					state.ConfigPath = c.GlobalString("config")
					state.Verbose = c.GlobalBool("verbose")
					state.IsVerboseSet = c.GlobalIsSet("verbose")

					// 2. Positional argument handling via c.Args()
					state.ArgCount = c.NArg()
					state.Args = c.Args()
					if c.NArg() > 0 {
						state.FirstArg = c.Args().First()
					}

					// 3. Parent context inspection
					if c.Parent() != nil && c.Parent().App != nil {
						state.ParentName = c.Parent().App.Name
					}

					// 4. Dynamic flag modification via c.Set
					_ = c.Set("override", "modified-at-runtime")
					state.UpdatedFlag = c.String("override")
				}
				return nil
			},
		},
	}

	return app
}

func main() {
	state := &CliState{}
	app := BuildContextDemoApp(state)
	if err := app.Run(os.Args); err != nil {
		fmt.Fprintf(os.Stderr, "Error: %v\n", err)
		os.Exit(1)
	}
}

{"case":{"caseId":"case:sha256:f6a1f27bc59b217ba501679fb45388e1fae84477c43fb54045a926dba84ab869","contract":["cli.Context provides flag values and IsSet checks for command flags","cli.Context Args provides positional arguments count and element access","cli.Context Parent provides access to parent command context","cli.Context Set modifies context flag value at runtime"],"goal":"verify github.com/urfave/cli.Context in pkg:golang/github.com/urfave/cli@v1.22.14","kind":"HOW","packages":["pkg:golang/github.com/urfave/cli@v1.22.14"],"schemaVersion":1,"symbols":["github.com/urfave/cli.Context"]},"contractCommand":["go","test","./..."],"environment":{"arch":"amd64","distro":"ubuntu","ecosystem":"golang","language":"go","languageVersion":"1.26.6","libc":"glibc","libcVersion":"2.39","moduleSystem":"go-mod","os":"linux","osVersionBucket":"24","packageManager":"go","packageManagerVersion":"1.26.6","runtime":"go","runtimeVersion":"1.26.6","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/github.com/urfave/cli@v1.22.14"],"schemaVersion":1,"subject":"pkg:golang/github.com/urfave/cli@v1.22.14","symbols":["github.com/urfave/cli.Context"],"verifierAdapter":"golang@1"}

module urfave-cli-context

go 1.26.6

require (
	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
	github.com/russross/blackfriday/v2 v2.1.0 // indirect
	github.com/urfave/cli v1.22.14
)

github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w=
github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
github.com/urfave/cli v1.22.14 h1:ebbhrRiGK2i4naQJr+1Xj92HXZCrK7MsyTS/ob3HnAk=
github.com/urfave/cli v1.22.14/go.mod h1:X0eDS6pD6Exaclxm99NJ3FiCDRED7vIHpx2mDOHLvkA=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

{
  "schemaVersion": 1,
  "goal": "verify github.com/urfave/cli.Context in pkg:golang/github.com/urfave/cli@v1.22.14",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/urfave/cli@v1.22.14"
  ],
  "symbols": [
    "github.com/urfave/cli.Context"
  ]
}

package contract_test

import (
	"reflect"
	"testing"

	"github.com/urfave/cli"
)

// CliState captures parsed context values during command execution.
type CliState struct {
	ConfigPath   string
	Port         int
	Verbose      bool
	IsVerboseSet bool
	Args         []string
	FirstArg     string
	ArgCount     int
	ParentName   string
	UpdatedFlag  string
}

func buildTestApp(state *CliState) *cli.App {
	app := cli.NewApp()
	app.Name = "contextdemo"
	app.Usage = "demonstrate urfave cli.Context API methods"
	app.Version = "1.0.0"

	app.Flags = []cli.Flag{
		cli.StringFlag{
			Name:  "config, c",
			Value: "default.yaml",
			Usage: "path to configuration file",
		},
		cli.BoolFlag{
			Name:  "verbose, V",
			Usage: "verbose diagnostic logging",
		},
	}

	app.Commands = []cli.Command{
		{
			Name:  "service",
			Usage: "manage services",
			Flags: []cli.Flag{
				cli.IntFlag{
					Name:  "port, p",
					Value: 8080,
					Usage: "port to bind",
				},
				cli.StringFlag{
					Name:  "override",
					Value: "initial",
					Usage: "dynamically modifiable flag",
				},
			},
			Action: func(c *cli.Context) error {
				if state != nil {
					// 1. Flag inspection and IsSet checks
					state.Port = c.Int("port")
					state.ConfigPath = c.GlobalString("config")
					state.Verbose = c.GlobalBool("verbose")
					state.IsVerboseSet = c.GlobalIsSet("verbose")

					// 2. Positional argument handling via c.Args()
					state.ArgCount = c.NArg()
					state.Args = c.Args()
					if c.NArg() > 0 {
						state.FirstArg = c.Args().First()
					}

					// 3. Parent context inspection
					if c.Parent() != nil && c.Parent().App != nil {
						state.ParentName = c.Parent().App.Name
					}

					// 4. Dynamic flag modification via c.Set
					_ = c.Set("override", "modified-at-runtime")
					state.UpdatedFlag = c.String("override")
				}
				return nil
			},
		},
	}

	return app
}

func TestContract_ContextFlagAccessAndIsSet(t *testing.T) {
	// Case 1: Flag explicitly provided
	state := &CliState{}
	app := buildTestApp(state)

	args := []string{"contextdemo", "--verbose", "service", "--port", "9090"}
	if err := app.Run(args); err != nil {
		t.Fatalf("app.Run failed: %v", err)
	}

	if state.Port != 9090 {
		t.Fatalf("expected Port 9090, got %d", state.Port)
	}
	if !state.Verbose {
		t.Fatal("expected Verbose to be true")
	}
	if !state.IsVerboseSet {
		t.Fatal("expected IsVerboseSet to be true when --verbose passed")
	}

	// Case 2: Flag not provided (default value and IsSet == false)
	stateDefault := &CliState{}
	appDefault := buildTestApp(stateDefault)

	argsDefault := []string{"contextdemo", "service"}
	if err := appDefault.Run(argsDefault); err != nil {
		t.Fatalf("appDefault.Run failed: %v", err)
	}

	if stateDefault.Port != 8080 {
		t.Fatalf("expected default Port 8080, got %d", stateDefault.Port)
	}
	if stateDefault.Verbose {
		t.Fatal("expected default Verbose to be false")
	}
	if stateDefault.IsVerboseSet {
		t.Fatal("expected IsVerboseSet to be false when --verbose omitted")
	}
}

func TestContract_ContextArgs(t *testing.T) {
	state := &CliState{}
	app := buildTestApp(state)

	args := []string{"contextdemo", "service", "arg1", "arg2", "arg3"}
	if err := app.Run(args); err != nil {
		t.Fatalf("app.Run failed: %v", err)
	}

	if state.ArgCount != 3 {
		t.Fatalf("expected ArgCount 3, got %d", state.ArgCount)
	}
	if state.FirstArg != "arg1" {
		t.Fatalf("expected FirstArg 'arg1', got '%s'", state.FirstArg)
	}
	expectedArgs := []string{"arg1", "arg2", "arg3"}
	if !reflect.DeepEqual([]string(state.Args), expectedArgs) {
		t.Fatalf("expected args %v, got %v", expectedArgs, state.Args)
	}
}

func TestContract_ContextParent(t *testing.T) {
	state := &CliState{}
	app := buildTestApp(state)

	args := []string{"contextdemo", "--config", "custom.yaml", "service"}
	if err := app.Run(args); err != nil {
		t.Fatalf("app.Run failed: %v", err)
	}

	if state.ParentName != "contextdemo" {
		t.Fatalf("expected ParentName 'contextdemo', got '%s'", state.ParentName)
	}
	if state.ConfigPath != "custom.yaml" {
		t.Fatalf("expected ConfigPath 'custom.yaml', got '%s'", state.ConfigPath)
	}
}

func TestContract_ContextSet(t *testing.T) {
	state := &CliState{}
	app := buildTestApp(state)

	args := []string{"contextdemo", "service"}
	if err := app.Run(args); err != nil {
		t.Fatalf("app.Run failed: %v", err)
	}

	if state.UpdatedFlag != "modified-at-runtime" {
		t.Fatalf("expected UpdatedFlag 'modified-at-runtime', got '%s'", state.UpdatedFlag)
	}
}