args_test.go

/*
   Szerszam argument library: szargs.
   Copyright (C) 2024  Leslie Dancsecs

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

package szargs_test

import (
	"testing"

	"github.com/dancsecs/szargs"
	"github.com/dancsecs/sztestlog"
)

func TestSzargs_New_NoArgs(t *testing.T) {
	chk := sztestlog.CaptureLogAndStderrAndStdout(t)
	defer chk.Release()

	args := szargs.New("description", nil)

	chk.Err(
		args.Err(),
		szargs.ErrNoArgs.Error(),
	)

	chk.Log()
	chk.Stderr()
	chk.Stdout()
}

func TestSzargs_New_PushArgs(t *testing.T) {
	chk := sztestlog.CaptureLogAndStderrAndStdout(t)
	defer chk.Release()

	args := szargs.New("description", []string{"programName"})

	if !args.HasNext() {
		args.PushArg("theDefaultOptionalArg")
	}

	arg := args.NextString("theOptionalArg", "An optional string argument.")

	chk.Str(arg, "theDefaultOptionalArg")

	args.Done()

	chk.NoErr(args.Err())

	chk.Log()
	chk.Stderr()
	chk.Stdout()
}

func TestSzargs_New_JustProgramName(t *testing.T) {
	chk := sztestlog.CaptureLogAndStderrAndStdout(t)
	defer chk.Release()

	description := "" +
		"This description will demo\n" +
		"patching together shorter lines and then reformat\n" +
		"to fit in the usage width.\n\n" +
		"While this line starts anew."

	args := szargs.New(description, []string{"noProgName"})

	chk.Int(
		args.Count("[ -v | --verbose]", "how chatty should I be"),
		0,
	)

	chk.False(
		args.Is(
			"[-f|--flag]",
			"a test flag\n\n"+
				"And a needlessly long sentence to over the eighty byte "+
				"threshold so we can see a result of wrapping a line at "+
				"eighty characters."+
				"",
		),
	)
	chk.False(args.Is("[-g|--group]", "a group flag"))
	chk.False(args.Is("[-h|--human]", "a human flag"))
	chk.False(args.Is("[-q|--quick_mode]", "magic mystery method"))
	chk.False(args.Is("[-o|--over]", "an over flag"))

	args.Done()
	chk.NoErr(args.Err())

	chk.Log()
	chk.Stderr()
	chk.Stdout()
}

func TestSzargs_New_AmbiguousIsName(t *testing.T) {
	chk := sztestlog.CaptureLogAndStderrAndStdout(t)
	defer chk.Release()

	args := szargs.New("description", []string{
		"noProgName",
		"-f", "FirstOccurrence",
		"--flag", "SecondOccurrence",
	})

	chk.Int(
		args.Count("[ -v | --verbose]", "how chatty should I be"),
		0,
	)

	chk.False(args.Is("[-f|--flag]", "a test flag"))

	args.Done()

	chk.True(args.HasNext())
	chk.True(args.HasErr())
	chk.Err(
		args.Err(),
		chk.ErrChain(
			szargs.ErrAmbiguous,
			"'[-f|--flag]' found 2 times",
			szargs.ErrUnexpected,
			"[FirstOccurrence SecondOccurrence]",
		),
	)

	chk.Log()
	chk.Stderr()
	chk.Stdout()
}

func TestSzargs_Group(t *testing.T) {
	chk := sztestlog.CaptureLogAndStderrAndStdout(t)
	defer chk.Release()

	args := szargs.New("description", []string{
		"noProgName",
		"-abcdef",
	})

	chk.True(args.Is("-a", "test a"))
	chk.True(args.Is("-b", "test b"))
	chk.True(args.Is("-c", "test c"))
	chk.True(args.Is("-d", "test d"))
	chk.True(args.Is("-e", "test e"))
	chk.True(args.Is("-f", "test f"))
	chk.False(args.Is("-g", "test g"))

	args.Done()

	chk.NoErr(args.Err())

	chk.Log()
	chk.Stderr()
	chk.Stdout()
}

func TestSzargs_ProgramName(t *testing.T) {
	chk := sztestlog.CaptureLogAndStderrAndStdout(t)
	defer chk.Release()

	args := szargs.New("description", []string{
		"noProgName",
	})

	chk.Str(args.ProgramName(), "noProgName")
	args.Done()

	chk.NoErr(args.Err())

	chk.Log()
	chk.Stderr()
	chk.Stdout()
}