Issue adding speakers with script

[jerdog]

I'm trying to add our speakers, and getting the following error:

utilities git:(jerdog/kc2024-AddProgram) ✗ ./add_speakers.sh                                 
Enter your event year (default: 2024): 2024
Enter your city name: Kansas City
sed: 1: "../content/events/2024- ...": invalid command code .

Anyone else seeing this? It will create the folder speakers but errors out I'm guessing here since it doesn't create the file

devopsdays-web/utilities/add_speakers.sh

Line 35 in 9cc902e

cp examples/templates/speakers.md $speakerspage

[yvovandoorn]

Putting in my comments from Slack in here:

It looks like its coming out of sed .. specifically the BSD shipped version on macOS.

Specifically here:

+ escaped_rhs='Kansas City'
+ file=../content/events/2024-kansas-city/speakers.md
+ [[ -w ../content/events/2024-kansas-city/speakers.md ]]
+ sed -i 's/CITY/Kansas City/' ../content/events/2024-kansas-city/speakers.md
sed: 1: "../content/events/2024- ...": invalid command code .

The script calls function string_replace which is being set in

devopsdays-web/utilities/common_code

Lines 22 to 41 in 07eb28b

	string_replace() {
	# requires 3 arguments
	if [[ $# -ne 3 ]] ; then
	echo "string_replace requires 3 arguments: key to be replaced, string replacement, file"
	exit 1
	fi
	# escape our left hand side, and right hand side of sed args
	escaped_lhs=$(printf '%s\n' "$1" | sed 's:[][\\/.^$*]:\\&:g')
	escaped_rhs=$(printf '%s\n' "$2" | sed 's:[\\/&]:\\&:g;$!s/$/\\/')
	file=$3
	if [[ -w "${file}" ]] ; then
	# sed -i'' should work for macos and linux equally.
	sed -i'' "s/${escaped_lhs}/${escaped_rhs}/" "${file}"
	else
	echo "WARNING: ${file} not writeable"
	return 1
	fi
	}

.

The same file has some sed detection logic which is going unused.

devopsdays-web/utilities/common_code

Lines 7 to 18 in 07eb28b

	function sedcmd() {
	local osname=`uname`
	local gnused=$(which sed)
	if [[ $osname == 'Linux' ]]; then
	sed -i "$@"
	elif [[ $osname == 'Darwin' && $gnused == '/usr/local/bin/sed' ]]; then
	sed -i "$@"
	else
	sed -i '' "$@"
	fi
	}

Using the sedcmd function to execute the command makes the script function.

diff --git a/utilities/common_code b/utilities/common_code
index 3903c0b46c..c8592c0b1d 100644
--- a/utilities/common_code
+++ b/utilities/common_code
@@ -33,7 +33,8 @@ string_replace() {

   if [[ -w "${file}" ]] ; then
     # sed -i'' should work for macos and linux equally.
-    sed -i'' "s/${escaped_lhs}/${escaped_rhs}/" "${file}"
+    # sed -i'' "s/${escaped_lhs}/${escaped_rhs}/" "${file}"
+    sedcmd "s/${escaped_lhs}/${escaped_rhs}/" "${file}"
   else
     echo "WARNING: ${file} not writeable"
     return 1

Output:

+ escaped_rhs='Kansas City'
+ file=../content/events/2024-kansas-city/speakers.md
+ [[ -w ../content/events/2024-kansas-city/speakers.md ]]
+ sedcmd 's/CITY/Kansas City/' ../content/events/2024-kansas-city/speakers.md
uname
++ uname
+ local osname=Darwin
which sed
++ which sed
+ local gnused=/usr/bin/sed
+ [[ Darwin == \L\i\n\u\x ]]
+ [[ Darwin == \D\a\r\w\i\n ]]
+ [[ /usr/bin/sed == \/\u\s\r\/\l\o\c\a\l\/\b\i\n\/\s\e\d ]]
+ sed -i '' 's/CITY/Kansas City/' ../content/events/2024-kansas-city/speakers.md

# Prompt for inputting speakers
while [ 1 ]
do
echo "Entering speakers; use CTRL+C to stop..."

Before I submit a PR, would be good to get context from @mattstratton and @rexroof, as this change was introduced in 3d92859.

[mattstratton]

I don't know what the change was for, so I can't weigh in, but probably safe to revert it?

[rexroof]

I added this general solution so that the script could support replacement strings that contained numerous special characters.

it is possible it was only tested on linux.

[jerdog]

Yeah I am on MacOS so that could explain it @rexroof