openstack/devstack
Code Issues Proposed changes

Add -sudo option to ini setting options

Browse Source 
Add a -sudo option to allow these functions to operate on root-owned
files.  Test-case is updated, but not enabled by default as we can't
expect test-runner to have sudo access.

Change-Id: I134c3397314c7d9395996eb6c825ecb7e7fdfc69
This commit is contained in:
Ian Wienand 2015-07-22 10:34:47 +10:00
parent b997db602e
commit f44a024f02
2 changed files with 74 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
inc/ini-config
View File

@ -15,30 +15,40 @@ set +o xtrace
# ================ # ================
# Append a new option in an ini file without replacing the old value # Append a new option in an ini file without replacing the old value
# iniadd config-file section option value1 value2 value3 ... # iniadd [-sudo] config-file section option value1 value2 value3 ...
function iniadd { function iniadd {
local xtrace=$(set +o | grep xtrace) local xtrace=$(set +o | grep xtrace)
set +o xtrace set +o xtrace
local sudo=""
if [ $1 == "-sudo" ]; then
sudo="-sudo "
shift
fi
local file=$1 local file=$1
local section=$2 local section=$2
local option=$3 local option=$3
shift 3 shift 3
local values="$(iniget_multiline $file $section $option) $@" local values="$(iniget_multiline $file $section $option) $@"
iniset_multiline $file $section $option $values iniset_multiline $sudo $file $section $option $values
$xtrace $xtrace
} }
# Comment an option in an INI file # Comment an option in an INI file
# inicomment config-file section option # inicomment [-sudo] config-file section option
function inicomment { function inicomment {
local xtrace=$(set +o | grep xtrace) local xtrace=$(set +o | grep xtrace)
set +o xtrace set +o xtrace
local sudo=""
if [ $1 == "-sudo" ]; then
sudo="sudo "
shift
fi
local file=$1 local file=$1
local section=$2 local section=$2
local option=$3 local option=$3
sed -i -e "/^\[$section\]/,/^\[.*\]/ s|^\($option[ \t]*=.*$\)|#\1|" "$file" $sudo sed -i -e "/^\[$section\]/,/^\[.*\]/ s|^\($option[ \t]*=.*$\)|#\1|" "$file"
$xtrace $xtrace
} }
@ -95,10 +105,15 @@ function ini_has_option {
# in the argument list. Doing that will cause incorrect configuration # in the argument list. Doing that will cause incorrect configuration
# if spaces are used in the config values. # if spaces are used in the config values.
# #
# iniadd_literal config-file section option value # iniadd_literal [-sudo] config-file section option value
function iniadd_literal { function iniadd_literal {
local xtrace=$(set +o | grep xtrace) local xtrace=$(set +o | grep xtrace)
set +o xtrace set +o xtrace
local sudo=""
if [ $1 == "-sudo" ]; then
sudo="sudo "
shift
fi
local file=$1 local file=$1
local section=$2 local section=$2
local option=$3 local option=$3
@ -110,7 +125,7 @@ function iniadd_literal {
fi fi
# Add it # Add it
sed -i -e "/^\[$section\]/ a\\ $sudo sed -i -e "/^\[$section\]/ a\\
$option = $value $option = $value
" "$file" " "$file"
@ -118,10 +133,15 @@ $option = $value
} }
# Remove an option from an INI file # Remove an option from an INI file
# inidelete config-file section option # inidelete [-sudo] config-file section option
function inidelete { function inidelete {
local xtrace=$(set +o | grep xtrace) local xtrace=$(set +o | grep xtrace)
set +o xtrace set +o xtrace
local sudo=""
if [ $1 == "-sudo" ]; then
sudo="sudo "
shift
fi
local file=$1 local file=$1
local section=$2 local section=$2
local option=$3 local option=$3
@ -132,16 +152,21 @@ function inidelete {
fi fi
# Remove old values # Remove old values
sed -i -e "/^\[$section\]/,/^\[.*\]/ { /^$option[ \t]*=/ d; }" "$file" $sudo sed -i -e "/^\[$section\]/,/^\[.*\]/ { /^$option[ \t]*=/ d; }" "$file"
$xtrace $xtrace
} }
# Set an option in an INI file # Set an option in an INI file
# iniset config-file section option value # iniset [-sudo] config-file section option value
function iniset { function iniset {
local xtrace=$(set +o | grep xtrace) local xtrace=$(set +o | grep xtrace)
set +o xtrace set +o xtrace
local sudo=""
if [ $1 == "-sudo" ]; then
sudo="sudo "
shift
fi
local file=$1 local file=$1
local section=$2 local section=$2
local option=$3 local option=$3
@ -154,26 +179,31 @@ function iniset {
if ! grep -q "^\[$section\]" "$file" 2>/dev/null; then if ! grep -q "^\[$section\]" "$file" 2>/dev/null; then
# Add section at the end # Add section at the end
echo -e "\n[$section]" >>"$file" echo -e "\n[$section]" | $sudo tee --append "$file" > /dev/null
fi fi
if ! ini_has_option "$file" "$section" "$option"; then if ! ini_has_option "$file" "$section" "$option"; then
# Add it # Add it
sed -i -e "/^\[$section\]/ a\\ $sudo sed -i -e "/^\[$section\]/ a\\
$option = $value $option = $value
" "$file" " "$file"
else else
local sep=$(echo -ne "\x01") local sep=$(echo -ne "\x01")
# Replace it # Replace it
sed -i -e '/^\['${section}'\]/,/^\[.*\]/ s'${sep}'^\('${option}'[ \t]*=[ \t]*\).*$'${sep}'\1'"${value}"${sep} "$file" $sudo sed -i -e '/^\['${section}'\]/,/^\[.*\]/ s'${sep}'^\('${option}'[ \t]*=[ \t]*\).*$'${sep}'\1'"${value}"${sep} "$file"
fi fi
$xtrace $xtrace
} }
# Set a multiple line option in an INI file # Set a multiple line option in an INI file
# iniset_multiline config-file section option value1 value2 valu3 ... # iniset_multiline [-sudo] config-file section option value1 value2 valu3 ...
function iniset_multiline { function iniset_multiline {
local xtrace=$(set +o | grep xtrace) local xtrace=$(set +o | grep xtrace)
set +o xtrace set +o xtrace
local sudo=""
if [ $1 == "-sudo" ]; then
sudo="sudo "
shift
fi
local file=$1 local file=$1
local section=$2 local section=$2
local option=$3 local option=$3
@ -188,14 +218,14 @@ function iniset_multiline {
done done
if ! grep -q "^\[$section\]" "$file"; then if ! grep -q "^\[$section\]" "$file"; then
# Add section at the end # Add section at the end
echo -e "\n[$section]" >>"$file" echo -e "\n[$section]" | $sudo tee --append "$file" > /dev/null
else else
# Remove old values # Remove old values
sed -i -e "/^\[$section\]/,/^\[.*\]/ { /^$option[ \t]*=/ d; }" "$file" $sudo sed -i -e "/^\[$section\]/,/^\[.*\]/ { /^$option[ \t]*=/ d; }" "$file"
fi fi
# Add new ones # Add new ones
for v in $values; do for v in $values; do
sed -i -e "/^\[$section\]/ a\\ $sudo sed -i -e "/^\[$section\]/ a\\
$option = $v $option = $v
" "$file" " "$file"
done done
@ -207,10 +237,15 @@ $option = $v
function iniuncomment { function iniuncomment {
local xtrace=$(set +o | grep xtrace) local xtrace=$(set +o | grep xtrace)
set +o xtrace set +o xtrace
local sudo=""
if [ $1 == "-sudo" ]; then
sudo="sudo "
shift
fi
local file=$1 local file=$1
local section=$2 local section=$2
local option=$3 local option=$3
sed -i -e "/^\[$section\]/,/^\[.*\]/ s|[^ \t]*#[ \t]*\($option[ \t]*=.*$\)|\1|" "$file" $sudo sed -i -e "/^\[$section\]/,/^\[.*\]/ s|[^ \t]*#[ \t]*\($option[ \t]*=.*$\)|\1|" "$file"
$xtrace $xtrace
} }

36
tests/test_ini_config.sh
View File

@ -71,15 +71,23 @@ b=d
EOF EOF
# Test with missing arguments # set TEST_SUDO to test writing to root-owned files
SUDO_ARG=""
SUDO=""
if [ -n "$TEST_SUDO" ]; then
SUDO="sudo "
SUDO_ARG="-sudo "
sudo chown -R root:root ${INI_TMP_ETC_DIR}
fi
# Test with missing arguments
BEFORE=$(cat ${TEST_INI}) BEFORE=$(cat ${TEST_INI})
iniset ${TEST_INI} aaa iniset ${SUDO_ARG} ${TEST_INI} aaa
NO_ATTRIBUTE=$(cat ${TEST_INI}) NO_ATTRIBUTE=$(cat ${TEST_INI})
assert_equal "$BEFORE" "$NO_ATTRIBUTE" "test missing attribute argument" assert_equal "$BEFORE" "$NO_ATTRIBUTE" "test missing attribute argument"
iniset ${TEST_INI} iniset ${SUDO_ARG} ${TEST_INI}
NO_SECTION=$(cat ${TEST_INI}) NO_SECTION=$(cat ${TEST_INI})
assert_equal "$BEFORE" "$NO_SECTION" "missing section argument" assert_equal "$BEFORE" "$NO_SECTION" "missing section argument"
@ -87,7 +95,7 @@ assert_equal "$BEFORE" "$NO_SECTION" "missing section argument"
VAL=$(iniget ${TEST_INI} aaa handlers) VAL=$(iniget ${TEST_INI} aaa handlers)
assert_equal "$VAL" "aa, bb" "iniget spaces in option" assert_equal "$VAL" "aa, bb" "iniget spaces in option"
iniset ${TEST_INI} aaa handlers "11, 22" iniset ${SUDO_ARG} ${TEST_INI} aaa handlers "11, 22"
VAL=$(iniget ${TEST_INI} aaa handlers) VAL=$(iniget ${TEST_INI} aaa handlers)
assert_equal "$VAL" "11, 22" "iniset spaces in option" assert_equal "$VAL" "11, 22" "iniset spaces in option"
@ -95,7 +103,7 @@ assert_equal "$VAL" "11, 22" "iniset spaces in option"
VAL=$(iniget ${TEST_INI} " ccc " spaces) VAL=$(iniget ${TEST_INI} " ccc " spaces)
assert_equal "$VAL" "yes" "iniget with section header space" assert_equal "$VAL" "yes" "iniget with section header space"
iniset ${TEST_INI} "b b" opt_ion 42 iniset ${SUDO_ARG} ${TEST_INI} "b b" opt_ion 42
VAL=$(iniget ${TEST_INI} "b b" opt_ion) VAL=$(iniget ${TEST_INI} "b b" opt_ion)
assert_equal "$VAL" "42" "iniset with section header space" assert_equal "$VAL" "42" "iniset with section header space"
@ -103,7 +111,7 @@ assert_equal "$VAL" "42" "iniset with section header space"
VAL=$(iniget ${TEST_INI} bbb handlers) VAL=$(iniget ${TEST_INI} bbb handlers)
assert_equal "$VAL" "ee,ff" "iniget at EOF" assert_equal "$VAL" "ee,ff" "iniget at EOF"
iniset ${TEST_INI} bbb handlers "33,44" iniset ${SUDO_ARG} ${TEST_INI} bbb handlers "33,44"
VAL=$(iniget ${TEST_INI} bbb handlers) VAL=$(iniget ${TEST_INI} bbb handlers)
assert_equal "$VAL" "33,44" "inset at EOF" assert_equal "$VAL" "33,44" "inset at EOF"
@ -122,12 +130,12 @@ else
fi fi
# test changing empty option # test changing empty option
iniset ${TEST_INI} ddd empty "42" iniset ${SUDO_ARG} ${TEST_INI} ddd empty "42"
VAL=$(iniget ${TEST_INI} ddd empty) VAL=$(iniget ${TEST_INI} ddd empty)
assert_equal "$VAL" "42" "change empty option" assert_equal "$VAL" "42" "change empty option"
# test pipe in option # test pipe in option
iniset ${TEST_INI} aaa handlers "a|b" iniset ${SUDO_ARG} ${TEST_INI} aaa handlers "a|b"
VAL=$(iniget ${TEST_INI} aaa handlers) VAL=$(iniget ${TEST_INI} aaa handlers)
assert_equal "$VAL" "a|b" "pipe in option" assert_equal "$VAL" "a|b" "pipe in option"
@ -146,23 +154,23 @@ else
fi fi
# Test comments # Test comments
inicomment ${TEST_INI} aaa handlers inicomment ${SUDO_ARG} ${TEST_INI} aaa handlers
VAL=$(iniget ${TEST_INI} aaa handlers) VAL=$(iniget ${TEST_INI} aaa handlers)
assert_empty VAL "test inicomment" assert_empty VAL "test inicomment"
# Test multiple line iniset/iniget # Test multiple line iniset/iniget
iniset_multiline ${TEST_INI} eee multi bar1 bar2 iniset_multiline ${SUDO_ARG} ${TEST_INI} eee multi bar1 bar2
VAL=$(iniget_multiline ${TEST_INI} eee multi) VAL=$(iniget_multiline ${TEST_INI} eee multi)
assert_equal "$VAL" "bar1 bar2" "iniget_multiline" assert_equal "$VAL" "bar1 bar2" "iniget_multiline"
# Test iniadd with exiting values # Test iniadd with exiting values
iniadd ${TEST_INI} eee multi bar3 iniadd ${SUDO_ARG} ${TEST_INI} eee multi bar3
VAL=$(iniget_multiline ${TEST_INI} eee multi) VAL=$(iniget_multiline ${TEST_INI} eee multi)
assert_equal "$VAL" "bar1 bar2 bar3" "iniadd with existing values" assert_equal "$VAL" "bar1 bar2 bar3" "iniadd with existing values"
# Test iniadd with non-exiting values # Test iniadd with non-exiting values
iniadd ${TEST_INI} eee non-multi foobar1 foobar2 iniadd ${SUDO_ARG} ${TEST_INI} eee non-multi foobar1 foobar2
VAL=$(iniget_multiline ${TEST_INI} eee non-multi) VAL=$(iniget_multiline ${TEST_INI} eee non-multi)
assert_equal "$VAL" "foobar1 foobar2" "iniadd non-existing values" assert_equal "$VAL" "foobar1 foobar2" "iniadd non-existing values"
@ -176,7 +184,7 @@ del_cases="
del_no_section" del_no_section"
for x in $del_cases; do for x in $del_cases; do
inidelete ${TEST_INI} $x a inidelete ${SUDO_ARG} ${TEST_INI} $x a
VAL=$(iniget_multiline ${TEST_INI} $x a) VAL=$(iniget_multiline ${TEST_INI} $x a)
assert_empty VAL "inidelete $x" assert_empty VAL "inidelete $x"
if [ "$x" = "del_separate_options" -o \ if [ "$x" = "del_separate_options" -o \
@ -191,6 +199,6 @@ for x in $del_cases; do
fi fi
done done
rm -rf ${INI_TMP_DIR} $SUDO rm -rf ${INI_TMP_DIR}
report_results report_results