这是indexloc提供的服务，不要输入任何密码
Skip to content

Merge all option sanitation functions into xpns_opt_checker() #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 16, 2023
Merged

Merge all option sanitation functions into xpns_opt_checker() #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
29febcd
Save current setup
ReDTerraN Apr 14, 2023
e73fc64
adjust positional params and variables
ReDTerraN Apr 14, 2023
4df0cc3
bulletproof the float regex
ReDTerraN Apr 14, 2023
eab9851
Add unit tests for xpns_opt_checker
greymd Apr 15, 2023
0b220f3
Fixed int regex and applied additional unit tests
ReDTerraN Apr 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 26 additions & 50 deletions bin/xpanes
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1840,44 +1840,22 @@ xpns_warning_before_extra() {
fi
}

xpns_opt_check_num() {
xpns_opt_checker() {
local _option="$1"
shift
local _arg="$1"
if [[ -n "$_arg" ]] && [[ -z "${_arg//[0-9]/}" ]]; then
return 0
fi
xpns_msg_error "Invalid argument '$_arg' for $_option option"
exit ${XP_EINVAL}
}

xpns_opt_check_float() {
local _option="$1"
shift
local _arg="$1"
if [[ -n "$_arg" ]] && [[ -z "${_arg//[0-9.]/}" ]]; then
return 0
fi
xpns_msg_error "Invalid argument '$_arg' for $_option option"
exit ${XP_EINVAL}
}

xpns_opt_check_str() {
local _option="$1"
shift
local _arg="$1"
if [[ -n "$_arg" ]]; then
return 0
local _arg="$2"
local _check_value="${3:-default}"
# if we do not define a positional parameter in options, we expect an integer
local _pattern="^[0-9]+$"
if [[ "$_check_value" == "float" ]]; then
_pattern="^[0-9]*\.?[0-9]*$"
elif [[ "$_check_value" == "csv" ]]; then
_pattern="^[0-9]+(,[0-9]+)*$"
elif [[ "$_check_value" == "string" ]]; then
if [[ -n "$_arg" ]]; then
return 0
fi
fi
xpns_msg_error "Invalid argument '$_arg' for $_option option"
exit ${XP_EINVAL}
}

xpns_opt_check_num_csv() {
local _option="$1"
shift
local _arg="$1"
if [[ "$1" =~ ^([0-9][0-9]*,?)+$ ]]; then
if [[ -n "$_arg" ]] && [[ "$_arg" =~ $_pattern ]]; then
return 0
fi
xpns_msg_error "Invalid argument '$_arg' for $_option option"
Expand Down Expand Up @@ -1932,7 +1910,7 @@ xpns_parse_options() {
XP_OPT_IS_SYNC=0
;;
--log-format)
xpns_opt_check_str "$opt" "$1"
xpns_opt_checker "$opt" "$1" "string"
XP_OPTIONS+=("$opt")
XP_OPT_LOG_STORE=1
TMUX_XPANES_LOG_FORMAT="$1"
Expand All @@ -1943,7 +1921,7 @@ xpns_parse_options() {
XP_OPT_LOG_STORE=1
XP_OPTIONS+=("$opt")
TMUX_XPANES_LOG_DIRECTORY="${opt#--log=}"
xpns_opt_check_str "${opt%=}" "$TMUX_XPANES_LOG_DIRECTORY"
xpns_opt_checker "${opt%=}" "$TMUX_XPANES_LOG_DIRECTORY" "string"
;;
--log)
XP_OPT_LOG_STORE=1
Expand All @@ -1964,28 +1942,28 @@ xpns_parse_options() {
XP_OPT_ATTACH=0
;;
--cols)
xpns_opt_check_num "$opt" "$1"
xpns_opt_checker "$opt" "$1"
XP_OPTIONS+=("$opt")
XP_OPT_CUSTOM_SIZE_COLS="$1"
XP_OPTIONS+=("$1")
shift
;;
--rows)
xpns_opt_check_num "$opt" "$1"
xpns_opt_checker "$opt" "$1"
XP_OPTIONS+=("$opt")
XP_OPT_CUSTOM_SIZE_ROWS="$1"
XP_OPTIONS+=("$1")
shift
;;
--bulk-cols)
xpns_opt_check_num_csv "$opt" "$1"
xpns_opt_checker "$opt" "$1" "csv"
XP_OPTIONS+=("$opt")
XP_OPT_BULK_COLS="$1"
XP_OPTIONS+=("$1")
shift
;;
--interval)
xpns_opt_check_float "$opt" "$1"
xpns_opt_checker "$opt" "$1" "float"
XP_OPTIONS+=("$opt")
XP_OPT_INTERVAL="$1"
XP_OPTIONS+=("$1")
Expand Down Expand Up @@ -2055,14 +2033,14 @@ xpns_parse_options() {
# Short options with argument
## ----------------
-I)
xpns_opt_check_str "$opt" "$1"
xpns_opt_checker "$opt" "$1" "string"
XP_OPTIONS+=("$opt")
XP_REPSTR="$1"
XP_OPTIONS+=("$1")
shift
;;
-l)
xpns_opt_check_str "$opt" "$1"
xpns_opt_checker "$opt" "$1" "string"
XP_OPTIONS+=("$opt")
XP_OPT_USE_PRESET_LAYOUT=1
XP_LAYOUT="$(printf '%s\n' "$1" | xpns_layout_short2long)"
Expand All @@ -2072,44 +2050,42 @@ xpns_parse_options() {
;;
-c)
# -c allows empty
# xpns_opt_check_str "$opt" "$1"
XP_OPTIONS+=("$opt")
XP_CMD_UTILITY="$1"
XP_OPT_CMD_UTILITY=1
XP_OPTIONS+=("$1")
shift
;;
-n)
xpns_opt_check_num "$opt" "$1"
xpns_opt_checker "$opt" "$1"
XP_OPTIONS+=("$opt")
XP_MAX_PANE_ARGS="$1"
XP_OPTIONS+=("$1")
shift
;;
-S)
xpns_opt_check_str "$opt" "$1"
xpns_opt_checker "$opt" "$1" "string"
XP_OPTIONS+=("$opt")
XP_SOCKET_PATH="$1"
XP_OPTIONS+=("$1")
shift
;;
-C)
xpns_opt_check_num "$opt" "$1"
xpns_opt_checker "$opt" "$1"
XP_OPTIONS+=("$opt")
XP_OPT_CUSTOM_SIZE_COLS="$1"
XP_OPTIONS+=("$1")
shift
;;
-R)
xpns_opt_check_num "$opt" "$1"
xpns_opt_checker "$opt" "$1"
XP_OPTIONS+=("$opt")
XP_OPT_CUSTOM_SIZE_ROWS="$1"
XP_OPTIONS+=("$1")
shift
;;
-B)
# -B allows empty
# xpns_opt_check_str "$opt" "$1"
XP_OPTIONS+=("$opt")
XP_BEGIN_ARGS+=("$1")
XP_OPTIONS+=("$1")
Expand Down
23 changes: 23 additions & 0 deletions test/unit.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,5 +512,28 @@ test_xpns_parse_options_interval () {
assertEquals "4" "$?"
}

test_xpns_opt_checker () {
( xpns_opt_checker --bulk-cols 1,2,3,4 csv )
assertEquals "0" "$?"
( xpns_opt_checker -n 1 )
assertEquals "0" "$?"
( xpns_opt_checker -S ~/dummy string )
assertEquals "0" "$?"
( xpns_opt_checker --interval 1.1 float )
assertEquals "0" "$?"
( xpns_opt_checker --bulk-cols "invalid" csv )
assertEquals "4" "$?"
( xpns_opt_checker --bulk-cols "1,2,a" csv )
assertEquals "4" "$?"
( xpns_opt_checker -n "invalid" )
assertEquals "4" "$?"
( xpns_opt_checker -n "1.1.1.1" )
assertEquals "4" "$?"
( xpns_opt_checker --interval "invalid" float )
assertEquals "4" "$?"
( xpns_opt_checker --interval "1.1.1.1" float )
assertEquals "4" "$?"
}

# shellcheck source=/dev/null
. "${THIS_DIR}/shunit2/shunit2"