Test breaking a test

.github/workflows/main.yaml

@@ -23,11 +23,6 @@ jobs:
         cd ../../
         PREFIX="$PREFIX" make test-ci
         cat junit.xml
-    - name: Run ShellCheck
-      uses: ludeeus/action-shellcheck@master
-      with:
-        ignore_paths: deps tests installed
-        scandir: .
     - name: Publish Test Report
       uses: mikepenz/action-junit-report@v5
       if: success() || failure() # always run even if the previous step fails

.shellcheckrc

@@ -1,8 +0,0 @@
-# Many array expressions are constructed and eval-ed
-disable=SC2016
-# False positive on "CMDARG_ERROR_BEHAVIOR=return"
-disable=SC2209
-# Checking exit code with $? is more of a preference when the script doesn't try to support the errexit shell option
-disable=SC2181
-# Masking exit codes isn't much of a problem in this script
-disable=SC2155

Makefile

@@ -5,6 +5,18 @@ endif
 VERSION:=$(shell if [ -d .git ]; then bash -c '$(PREFIX)/bin/gitversion.sh | grep "^MAJOR=" | cut -d = -f 2'; else source version.sh && echo $$MAJOR ; fi)
 RELEASE:=$(shell if [ -d .git ]; then bash -c '$(PREFIX)/bin/gitversion.sh | grep "^BUILD=" | cut -d = -f 2'; else source version.sh && echo $$BUILD ; fi)
 DISTFILE=./dist/cmdarg-$(VERSION)-$(RELEASE).tar.gz
+SPECFILE=cmdarg.spec
+ifndef RHEL_VERSION
+	RHEL_VERSION=5
+endif
+ifeq ($(RHEL_VERSION),5)
+        MOCKFLAGS=--define "_source_filedigest_algorithm md5" --define "_binary_filedigest_algorithm md5"
+endif
+
+RHEL_RELEASE:=$(RELEASE).el$(RHEL_VERSION)
+SRPM=cmdarg-$(VERSION)-$(RHEL_RELEASE).src.rpm
+RPM=cmdarg-$(VERSION)-$(RHEL_RELEASE).noarch.rpm
+RHEL_DISTFILE=./dist/cmdarg-$(VERSION)-$(RHEL_RELEASE).tar.gz
 
 ifndef PREFIX
 	PREFIX=''
@@ -13,7 +25,7 @@ endif
 DISTFILE_DEPS=$(shell find . -type f | grep -Ev '\.git|\./dist/|$(DISTFILE)')
 JUNIT_DEPS=$(wildcard *.sh) $(wildcard tests/*.sh)
 
-all: $(DISTFILE)
+all: ./dist/$(RPM)
 
 # --- PHONY targets
 
@@ -24,6 +36,10 @@ clean:
 
 dist: $(DISTFILE)
 
+srpm: ./dist/$(SRPM)
+
+rpm: ./dist/$(RPM) ./dist/$(SRPM)
+
 gitclean:
 	git clean -df
 
@@ -48,6 +64,19 @@ $(DISTFILE): version.sh
 	rsync -aWH . --exclude=.git --exclude=dist ./dist/cmdarg-$(VERSION)-$(RELEASE)/
 	cd dist && tar -czvf ../$@ cmdarg-$(VERSION)-$(RELEASE)
 
+$(RHEL_DISTFILE): $(DISTFILE)
+	cd dist && \
+		cp -R cmdarg-$(VERSION)-$(RELEASE) cmdarg-$(VERSION)-$(RHEL_RELEASE) && \
+		tar -czvf ../$@ cmdarg-$(VERSION)-$(RHEL_RELEASE)
+
+./dist/$(SRPM): $(RHEL_DISTFILE)
+	rm -fr ./dist/$(SRPM)
+	mock -r epel-$(RHEL_VERSION)-noarch --buildsrpm --verbose --spec $(SPECFILE) $(MOCKFLAGS) --sources ./dist/ --resultdir ./dist/ --define "version $(VERSION)" --define "release $(RHEL_RELEASE)"
+
+./dist/$(RPM): ./dist/$(SRPM)
+	rm -fr ./dist/$(RPM)
+	mock --verbose -r epel-$(RHEL_VERSION)-noarch ./dist/$(SRPM) --resultdir ./dist/ --define "version $(VERSION)" --define "release $(RHEL_RELEASE)"
+
 uninstall:
 	rm -f $(PREFIX)/usr/lib/cmdarg.sh
 

README.md

@@ -1,6 +1,8 @@
 cmdarg
 ======
 
+[![Build Status](http://jenkins.aklabs.net/buildStatus/icon?job=cmdarg-test)](http://jenkins.aklabs.net/job/cmdarg-test/)
+
 Requires bash >= 4.
 
     source cmdarg.sh
@@ -12,7 +14,13 @@ Installation
 
 From source
 
-    cp cmdarg.sh PATH_WHERE_YOU_WANT_IT
+    cd cmdarg
+    make install
+
+From RPM
+
+    # add http://yum.aklabs.net/el/[5|6]/noarch as a yum repo for your system
+    yum install cmdarg
 
 Usage
 =====

cmdarg.sh

@@ -36,7 +36,7 @@ function cmdarg
 	echo "-h is reserved for cmdarg usage" >&2
 	${CMDARG_ERROR_BEHAVIOR} 1
     fi
-    if  [[ "$(type -t cmdarg_"$key")" != "" ]] || \
+    if  [[ "$(type -t cmdarg_$key)" != "" ]] || \
 	[[ "${CMDARG_FLAGS[$shortopt]}" != "" ]] || \
 	[[ "${CMDARG_TYPES[$key]}" != "" ]]; then
 	echo "command line key '$shortopt ($key)' is reserved by cmdarg or defined twice" >&2
@@ -53,14 +53,14 @@ function cmdarg
     elif [[ "$argtype" != "" ]]; then
 	CMDARG_FLAGS[$shortopt]=${argtypemap["$argtype"]}
 	if [[ "${1:2:4}" == "[]" ]]; then
-            declare -p "${key}" >/dev/null 2>&1
+	    declare -p ${key} >/dev/null 2>&1
 	    if [[ $? -ne 0 ]]; then
 		echo 'Array variable '"${key}"' does not exist. Array variables MUST be declared by the user!' >&2
 		${CMDARG_ERROR_BEHAVIOR} 1
 	    fi
 	    CMDARG_TYPES[$key]=$CMDARG_TYPE_ARRAY
 	elif [[ "${1:2:4}" == "{}" ]]; then
-            declare -p "${key}" >/dev/null 2>&1
+	    declare -p ${key} >/dev/null 2>&1
 	    if [[ $? -ne 0 ]]; then
 		echo 'Hash variable '"${key}"' does not exist. Hash variables MUST be declared by the user!' >&2
 		${CMDARG_ERROR_BEHAVIOR} 1
@@ -80,14 +80,14 @@ function cmdarg
     CMDARG_DESC["$shortopt"]=$3
     CMDARG_DEFAULT["$shortopt"]=${4:-}
     if [[ ${CMDARG_FLAGS[$shortopt]} -eq $CMDARG_FLAG_REQARG ]] && [[ "${4:-}" == "" ]]; then
-        CMDARG_REQUIRED+=("$shortopt")
+	CMDARG_REQUIRED+=($shortopt)
     else
-        CMDARG_OPTIONAL+=("$shortopt")
+	CMDARG_OPTIONAL+=($shortopt)
     fi
     cmdarg_cfg["$2"]="${4:-}"
     local validatorfunc
     validatorfunc=${5:-}
-    if [[ "$validatorfunc" != "" ]] && [[ "$(declare -F "$validatorfunc")" == "" ]]; then
+    if [[ "$validatorfunc" != "" ]] && [[ "$(declare -F $validatorfunc)" == "" ]]; then
 	echo "Validators must be bash functions accepting 1 argument (not '$validatorfunc')" >&2
 	${CMDARG_ERROR_BEHAVIOR} 1
     fi
@@ -120,7 +120,7 @@ function cmdarg_describe
     local flags="${CMDARG_FLAGS[$opt]}"
     local validator="${CMDARG_VALIDATORS[$opt]}"
 
-    ${cmdarg_helpers['describe']} "$longopt" "$opt" "$argtype" "${default}" "${description}" "${flags}" "${validator}"
+    ${cmdarg_helpers['describe']} $longopt $opt $argtype "${default}" "${description}" "${flags}" "${validator}"
 }
 
 function cmdarg_describe_default
@@ -139,16 +139,16 @@ function cmdarg_describe_default
 	default="(Default \"${default}\")"
     fi
     case ${argtype} in
-        "$CMDARG_TYPE_STRING")
+	$CMDARG_TYPE_STRING)
 	    echo "-${opt},--${longopt} v : String. ${description} ${default}"
 	    ;;
-        "$CMDARG_TYPE_BOOLEAN")
+	$CMDARG_TYPE_BOOLEAN)
 	    echo "-${opt},--${longopt} : Boolean. ${description} ${default}"
 	    ;;
-        "$CMDARG_TYPE_ARRAY")
+	$CMDARG_TYPE_ARRAY)
 	    echo "-${opt},--${longopt} v[, ...] : Array. ${description}. Pass this argument multiple times for multiple values. ${default}"
 	    ;;
-        "$CMDARG_TYPE_HASH")
+	$CMDARG_TYPE_HASH)
 	    echo "-${opt},--${longopt} k=v{, ..} : Hash. ${description}. Pass this argument multiple times for multiple key/value pairs. ${default}"
 	    ;;
 	*)
@@ -164,10 +164,7 @@ function cmdarg_usage
     # cmdarg_usage
     #
     # Prints a very helpful usage message about the current program.
-    local copyright=${CMDARG_INFO['copyright']:+ ${CMDARG_INFO['copyright']}}
+    echo "$(basename $0) ${CMDARG_INFO['copyright']} : ${CMDARG_INFO['author']}"
-    local author=${CMDARG_INFO['author']:+ : ${CMDARG_INFO['author']}}
-
-    echo "$(basename "$0")$copyright$author"
     echo
     echo "${CMDARG_INFO['header']}"
     echo
@@ -176,7 +173,7 @@ function cmdarg_usage
 	echo "Required Arguments:"
 	for key in "${CMDARG_REQUIRED[@]}"
 	do
-            echo "    $(cmdarg_describe "$key")"
+	    echo "    $(cmdarg_describe $key)"
 	done
 	echo
     fi
@@ -184,7 +181,7 @@ function cmdarg_usage
 	echo "Optional Arguments":
 	for key in "${CMDARG_OPTIONAL[@]}"
 	do
-            echo "    $(cmdarg_describe "$key")"
+	    echo "    $(cmdarg_describe $key)"
 	done
     fi
     echo
@@ -218,29 +215,29 @@ function cmdarg_set_opt
     set +u
 
     case ${CMDARG_TYPES[$key]} in
-        "$CMDARG_TYPE_STRING")
+	$CMDARG_TYPE_STRING)
 	    cmdarg_cfg[$key]=$arg
 	    cmdarg_validate "$key" "$arg" || ${CMDARG_ERROR_BEHAVIOR} 1
 	    ;;
-        "$CMDARG_TYPE_BOOLEAN")
+	$CMDARG_TYPE_BOOLEAN)
 	    cmdarg_cfg[$key]=true
 	    cmdarg_validate "$key" "$arg" || ${CMDARG_ERROR_BEHAVIOR} 1
 	    ;;
-        "$CMDARG_TYPE_ARRAY")
+	$CMDARG_TYPE_ARRAY)
 	    local arrname="${key}"
 	    local str='${#'"$arrname"'[@]}'
 	    local prevlen=$(eval "echo $str")
 	    eval "${arrname}[$((prevlen + 1))]=\"$arg\""
 	    cmdarg_validate "$key" "$arg" || ${CMDARG_ERROR_BEHAVIOR} 1
 	    ;;
-        "$CMDARG_TYPE_HASH")
+	$CMDARG_TYPE_HASH)
 	    local k=${arg%%=*}
 	    local v=${arg#*=}
 	    if [[ "$k" == "$arg" ]] && [[ "$v" == "$arg" ]] && [[ "$k" == "$v" ]]; then
 		echo "Malformed hash argument: $arg" >&2
 		${CMDARG_ERROR_BEHAVIOR} 1
 	    fi
-            eval "${key}[\$k]=\$v"
+	    eval "$key[\$k]=\$v"
 	    cmdarg_validate "$key" "$v" "$k" || ${CMDARG_ERROR_BEHAVIOR} 1
 	    ;;
 	*)
@@ -258,18 +255,18 @@ function cmdarg_check_empty
     local type=${CMDARG_TYPES[$longopt]}
 
     case $type in
-        "$CMDARG_TYPE_STRING")
+	$CMDARG_TYPE_STRING)
-            echo "${cmdarg_cfg[$longopt]}"
+            echo ${cmdarg_cfg[$longopt]}
             ;;
-        "$CMDARG_TYPE_BOOLEAN")
+	$CMDARG_TYPE_BOOLEAN)
-            echo "${cmdarg_cfg[$longopt]}"
+	    echo ${cmdarg_cfg[$longopt]}
 	    ;;
-        "$CMDARG_TYPE_ARRAY")
+	$CMDARG_TYPE_ARRAY)
 	    local arrname="${longopt}"
 	    local lval='${!'"${arrname}"'[@]}'
 	    eval "echo $lval"
 	    ;;
-        "$CMDARG_TYPE_HASH")
+	$CMDARG_TYPE_HASH)
 	    local arrname="${longopt}"
 	    local lval='${!'"${arrname}"'[@]}'
 	    eval "echo $lval"
@@ -306,7 +303,7 @@ function cmdarg_parse
 	fi
 
 	if [[ "$fullopt" == "--" ]] && [[ $parsing -eq 0 ]]; then
-            cmdarg_argv+=("$@")
+	    cmdarg_argv+=($@)
 	    break
 	elif [[ "${fullopt:0:2}" == "--" ]]; then
 	    longopt=${fullopt:2}
@@ -319,7 +316,7 @@ function cmdarg_parse
 	    continue
 	else
 	    echo "Malformed argument: ${fullopt}" >&2
-            echo "While parsing: $*" >&2
+	    echo "While parsing: $@" >&2
 	    ${cmdarg_helpers['usage']} >&2
 	    ${CMDARG_ERROR_BEHAVIOR} 1
 	fi
@@ -329,7 +326,7 @@ function cmdarg_parse
     	    ${CMDARG_ERROR_BEHAVIOR} 1
     	fi
 
-        if [[ $is_equals_arg -eq 1 && -n "$opt" ]]; then
+	if [[ $is_equals_arg -eq 1 ]]; then
 	    if [[ ${CMDARG_FLAGS[$opt]} -eq ${CMDARG_FLAG_REQARG} ]] || \
 		[[ ${CMDARG_FLAGS[$opt]} -eq ${CMDARG_FLAG_OPTARG} ]]; then
 		optarg=$1
@@ -337,10 +334,10 @@ function cmdarg_parse
 	    fi
 	fi
 
-        if [ -n "$opt" ] && [ ${CMDARG["${opt}"]+abc} ]; then
+	if [ ${CMDARG["${opt}"]+abc} ]; then
 	    cmdarg_set_opt "${CMDARG[$opt]}" "$optarg"
 	    local rc=$?
-            failed=$((failed + rc))
+	    failed=$((failed + $rc))
     	else
 	    echo "Unknown argument or invalid value : -${opt} | --${longopt}" >&2
     	    ${cmdarg_helpers['usage']} >&2
@@ -354,7 +351,7 @@ function cmdarg_parse
     local key
     for key in "${CMDARG_REQUIRED[@]}"
     do
-        if [[ "$(cmdarg_check_empty "$key")" == "" ]]; then
+	if [[ "$(cmdarg_check_empty $key)" == "" ]]; then
 	    missing="${missing} -${key}"
 	    failed=$((failed + 1))
 	fi
@@ -377,7 +374,7 @@ function cmdarg_traceback
     local FRAMES=${#BASH_LINENO[@]}
     # FRAMES-2 skips main, the last one in arrays
     for ((i=FRAMES-2; i>=1; i--)); do
-        echo "  File \"${BASH_SOURCE[i+1]}\", line ${BASH_LINENO[i]}, probably in ${FUNCNAME[i+1]}" >&2
+	echo '  File' \"${BASH_SOURCE[i+1]}\", line ${BASH_LINENO[i]}, probably in ${FUNCNAME[i+1]} >&2
 	# Grab the source code of the line
 	sed -n "${BASH_LINENO[i]}{s/^/    /;p}" "${BASH_SOURCE[i+1]}" >&2
     done
@@ -395,10 +392,10 @@ function cmdarg_dump
     local ref
     local value
 
-    for key in "${!cmdarg_cfg[@]}"
+    for key in ${!cmdarg_cfg[@]}
     do
 	repr="${key}:${CMDARG_TYPES[$key]}"
-        if [[ ${CMDARG_TYPES[$key]} == "$CMDARG_TYPE_ARRAY" ]] || [[ ${CMDARG_TYPES[$key]} == "$CMDARG_TYPE_HASH" ]] ; then
+	if [[ ${CMDARG_TYPES[$key]} == $CMDARG_TYPE_ARRAY ]] || [[ ${CMDARG_TYPES[$key]} == $CMDARG_TYPE_HASH ]] ; then
 	    arrname="${key}"
 	    echo "${repr} => "
 	    keys='${!'"$arrname"'[@]}'
@@ -412,11 +409,6 @@ function cmdarg_dump
 	    echo "${repr} => ${cmdarg_cfg[$key]}"
 	fi
     done
-    echo "argv =>"
-    for idx in "${!cmdarg_argv[@]}"
-    do
-	echo "        ${idx} => ${cmdarg_argv[$idx]}"
-    done
 }
 
 function cmdarg_purge

cmdarg.spec

@@ -0,0 +1,27 @@
+%define __os_install_post %{nil}
+Summary: Bash Command Line Argument Parsing Library
+Name: cmdarg
+Version: %{version}
+Release: %{release}
+License: MIT
+Vendor: Andrew Kesterson
+Packager: Andrew Kesterson <andrew@aklabs.net>
+Group: Development Tools
+Provides: %{name}
+BuildArch: noarch
+BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}
+Source: %{name}-%{version}-%{release}.tar.gz
+
+Requires: bash
+
+%description
+
+%install
+mkdir -p %{buildroot}/usr/src
+tar -zxvf %{_sourcedir}/%{name}-%{version}-%{release}.tar.gz
+cd %{name}-%{version}-%{release}
+PREFIX=%{buildroot} make install
+PREFIX=%{buildroot} make MANIFEST
+cp MANIFEST /tmp/
+
+%files -f /tmp/MANIFEST

tests/test_types.sh

@@ -86,7 +86,7 @@ function shunittest_hash_values
 	cmp="$cmp ${k}=${hash[$k]}"
     done
     cmp=$(echo "$cmp" | sed s/'^ *'//)
-    if [[ "$cmp" != "$base" ]]; then
+    if [[ "$cmp" == "$base" ]]; then
     	echo "Hash does not contain expected arguments ($cmp vs $base)"
     	cmdarg_dump >&2
     	return 1