Parsing default plan values is strange

[donoghuc]

Describe the Bug

There is some strangeness how puppet-strings/YARD parses default plan parameters. The following plan shows some of the discrepensies:

plan test::parsing(
	$bare = bare,
	$single = 'single',
	$double = "double",
	$arithmetic = 1 + 1,
	$code = Target.new('foo')
){}

cas@cas-ThinkPad-T460p:~/working_dir/bolt$ bolt plan show test::parsing

test::parsing

USAGE:
bolt plan run test::parsing [bare=<value>] [single=<value>] [double=<value>] [arithmetic=<value>] [code=<value>]

PARAMETERS:
- bare: Any
    Default: bare
- single: Any
    Default: 'single'
- double: Any
    Default: "double"
- arithmetic: Any
    Default: +
- code: Any
    Default: ('foo')

MODULE:
/home/cas/working_dir/bolt/Boltdir/site/test

Expected Behavior

Some of those appear to be bugs, Others (like the quoting of strings) is maybe right? Either way it appears to be kind of strange.

Additional context

We are looking at displaying default values in the PE console.

[adreyer]

We shouldn't invest a huge amount of time in this right now if we discover it's a hard fix.

[npwalker]

I thought adding parens around 1+1 might help but it just returns (.

MacBook-Pro:myboltproj nw$ /opt/puppetlabs/bin/bolt plan show myboltproj::parsing
Concurrency will default to 85 because ulimit is low: 256. Set concurrency with '--concurrency', or set your ulimit with 'ulimit -n <limit>'

myboltproj::parsing

USAGE:
bolt plan run myboltproj::parsing [bare=<value>] [single=<value>] [double=<value>] [arithmetic=<value>] [code=<value>]

PARAMETERS:
- bare: Any
    Default: bare
- single: Any
    Default: 'single'
- double: Any
    Default: "double"
- arithmetic: Integer
    Default: (
- code: Any
    Default: ('foo')

MODULE:
/Users/nw/myboltproj
MacBook-Pro:myboltproj nw$ cat plans/parsing.pp
plan myboltproj::parsing(
	$bare = bare,
	$single = 'single',
	$double = "double",
	Integer $arithmetic = (1 + 1),
	$code = Target.new('foo')
){}

[nicklewis]

This appears to be an issue with the SourcePosAdapter in Puppet that is used by puppet-strings. When given an AST node with children, it only extracts the text for the parent node.

This appears to be an existing issue in puppet-strings that also affects how classes and defines are parsed.

[nicklewis]

As this is an existing (not plan specific) bug in puppet-strings, I've filed puppetlabs/puppet-strings#240 to track the issue there.

[github-actions]

This issue has not had activity for 60 days and will be marked as stale.
If this issue continues to have no activity for 7 days, it will be closed.

[github-actions]

This issue is stale and has been closed. If you believe this is in error,
or would like the Bolt team to reconsider it, please reopen the issue.