refactor pipe script and improve debug mode

[lukdz]

Description

• switch to long options to make command more readable
• improve debug mode by using set -x, which does show how command arguments are split;
  echo outputs values without quotes, which makes it difficult to debug arguments split by incorrectly escaped whitespaces
• fix indents

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I have signed the Adobe Open Source CLA.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[npeltier]

can you please show examples of what the output is?

[npeltier]

(and good morning, thanks a lot for that contribution :p i forgot to be polite!)

[lukdz]

Hi,

Example of execution of pipe with identical arguments but different debug implementation:

echo doesn't show where pipe_cmd argument starts and ends;
user doesn't know if /jcr:root... is interpreted as a part of pipe_cmd or the next curl argument

set -x with single quotes show where pipe_cmd argument starts and ends;
user does know that /jcr:root... is interpreted as a part of pipe_cmd

[lukdz]

bump

[npeltier]

lgtm, thanks for your contribution! probably we should remove password from debug output though

[lukdz]

Thank you for approval.

[praveenrv]

@lukdz I observe that the bindings to the content script are failing with the latest pull.
For example:
./pipe test.txt -n 1000 -b modifiedDate=2023-08-30T10:20:20.206Z

The script generates curl command like this for the binding and the script at AEM is failing with binding parameter not availalble:
-form ‘bindings=‘\’‘{“modifiedDate”:“2023-08-30T10:20:20.206Z”}‘\’’'

cc: @npeltier

[lukdz]

I tested example providede:

$ ./pipe test.txt -n 1000 -b modifiedDate=2023-08-30T10:20:20.206Z
+ curl --user admin:admin --show-error --silent --fail --form pipe_cmd=test.txt --form 'bindings='\''{"modifiedDate":"2023-08-30T10:20:20.206Z"}'\''' --form size=1000 http://localhost:4502/apps/dx/scripts/exec.json

Reverting:

-                b)  opts="--form bindings='$(generate_json "$2")' $opts"; shift ;;
+                b)  opts="-F bindings='`generate_json "$2"`' $opts"; shift ;;

Doesn't change the result:

$ ./pipe test.txt -n 1000 -b modifiedDate=2023-08-30T10:20:20.206Z
+ curl --user admin:admin --show-error --silent --fail --form pipe_cmd=test.txt -F 'bindings='\''{"modifiedDate":"2023-08-30T10:20:20.206Z"}'\''' --form size=1000 http://localhost:4502/apps/dx/scripts/exec.json

But adding back eval:

-  curl \
+ eval curl \

Does change the result:

$ ./pipe test.txt -n 1000 -b modifiedDate=2023-08-30T10:20:20.206Z
+ eval curl --user admin:admin --show-error --silent --fail --form pipe_cmd=test.txt -F 'bindings='\''{"modifiedDate":"2023-08-30T10:20:20.206Z"}'\''' --form size=1000 http://localhost:4502/apps/dx/scripts/exec.json
++ curl --user admin:admin --show-error --silent --fail --form pipe_cmd=test.txt -F 'bindings={"modifiedDate":"2023-08-30T10:20:20.206Z"}' --form size=1000 http://localhost:4502/apps/dx/scripts/exec.json

Looks like eval is removing '\''.
The proper fix seems to be removal of single quotes:

-                b)  opts="--form bindings='$(generate_json "$2")' $opts"; shift ;;
+                b)  opts="--form bindings=$(generate_json "$2") $opts"; shift ;;

Which results in (without adding back eval):

$ ./pipe test.txt -n 1000 -b modifiedDate=2023-08-30T10:20:20.206Z
+ curl --user admin:admin --show-error --silent --fail --form pipe_cmd=test.txt --form 'bindings={"modifiedDate":"2023-08-30T10:20:20.206Z"}' --form size=1000 http://localhost:4502/apps/dx/scripts/exec.json

This fix would require validation from @praveenrv
afterwards, it can be merged: #202

[praveenrv]

@lukdz thanks for the details and fix. I see it working after removing the single quotes.

opts="--form bindings=$(generate_json "$2") $opts"; shift ;;

test:

./pipe test.txt -n 1000 -b modifiedDate=2023-08-30T10:20:20.206Z
+ curl --user admin:admin --show-error --silent --fail --form pipe_cmdfile=@test.txt --form 'bindings={"modifiedDate":"2023-08-30T10:20:20.206Z"}' --form size=1000 http://localhost:4502/apps/dx/scripts/exec.json

cc: @npeltier