[LTP] [PATCH] testcases/lib/test.sh: added tst_timeout()

[LTP] [PATCH] testcases/lib/test.sh: added tst_timeout()

[Matus Marhefka]

Function tst_timeout() added into LTP test interface:

	tst_timeout "command arg1 arg2 ..." timeout

Function enables waiting for specified command for timeout
seconds. Example usage:

	cmd_output=$(tst_timeout "ping -c 3 localhost" 5)
	if [ $? -ne 0 ]; then
		tst_brkm TBROK "timeout reached!"
	fi

where $cmd_output contains stdout and stderr of ping command.

Signed-off-by: Matus Marhefka <mmarhefk@redhat.com>
---
 testcases/lib/test.sh | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/testcases/lib/test.sh b/testcases/lib/test.sh
index eecbfba..1c5bdf2 100644
--- a/testcases/lib/test.sh
+++ b/testcases/lib/test.sh
@@ -129,6 +129,60 @@ tst_check_cmds()
 	done
 }
 
+# tst_timeout "command arg1 arg2 ..." timeout
+# Runs command for specified timeout (in seconds).
+# Function returns retcode of command or 1 if arguments are invalid.
+tst_timeout()
+{
+	local command=$1
+	local timeout=$2
+	local usleep_time=100000
+
+	# command must be non-empty string with command to run
+	if [ -z "$command" ]; then
+		echo "first argument must be non-empty string"
+		return 1
+	fi
+
+	# accept only numbers as timeout
+	re='^[0-9]+$'
+	if ! [[ $timeout =~ $re ]]; then
+		echo "only numbers as second argument"
+		return 1
+	fi
+
+	if [ -z "$TMPDIR" ]; then
+		TMPDIR="/tmp"
+	fi
+
+	local output=$(mktemp --tmpdir=$TMPDIR)
+	sh -c "eval $command" >$output 2>&1 &
+	local pid=$!
+	timeout=$((timeout*1000000))
+	while [ $timeout -gt 0 ]; do
+		kill -s 0 $pid 2>/dev/null
+		if [ $? -ne 0 ]; then
+			break
+		fi
+		timeout=$((timeout - usleep_time))
+		usleep $usleep_time
+	done
+
+	local ret=0
+	if [ $timeout -le 0 ]; then
+		ret=128
+		kill -9 $pid
+	fi
+
+	wait $pid
+	ret=$((ret | $?))
+
+	cat $output
+	rm -f $output
+
+	return $ret
+}
+
 # Check that test name is set
 if [ -z "$TCID" ]; then
 	tst_brkm TBROK "TCID is not defined"
-- 
1.8.3.1


------------------------------------------------------------------------------
Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
from Actuate! Instantly Supercharge Your Business Reports and Dashboards
with Interactivity, Sharing, Native Excel Exports, App Integration & more
Get technology previously reserved for billion-dollar corporations, FREE
http://pubads.g.doubleclick.net/gampad/clk?id=157005751&iu=/4140/ostg.clktrk
_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list

Re: [LTP] [PATCH] testcases/lib/test.sh: added tst_timeout()

[Cyril Hrubis]

Hi!
> Function tst_timeout() added into LTP test interface:
> 
> 	tst_timeout "command arg1 arg2 ..." timeout
> 
> Function enables waiting for specified command for timeout
> seconds. Example usage:
> 
> 	cmd_output=$(tst_timeout "ping -c 3 localhost" 5)
> 	if [ $? -ne 0 ]; then
> 		tst_brkm TBROK "timeout reached!"
> 	fi
> 
> where $cmd_output contains stdout and stderr of ping command.

Nice idea, comments below.

> Signed-off-by: Matus Marhefka <mmarhefk@redhat.com>
> ---
>  testcases/lib/test.sh | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 54 insertions(+)
> 
> diff --git a/testcases/lib/test.sh b/testcases/lib/test.sh
> index eecbfba..1c5bdf2 100644
> --- a/testcases/lib/test.sh
> +++ b/testcases/lib/test.sh
> @@ -129,6 +129,60 @@ tst_check_cmds()
>  	done
>  }
>  
> +# tst_timeout "command arg1 arg2 ..." timeout
> +# Runs command for specified timeout (in seconds).
> +# Function returns retcode of command or 1 if arguments are invalid.
> +tst_timeout()
> +{
> +	local command=$1
> +	local timeout=$2
> +	local usleep_time=100000
> +
> +	# command must be non-empty string with command to run
> +	if [ -z "$command" ]; then
> +		echo "first argument must be non-empty string"
> +		return 1
> +	fi
> +
> +	# accept only numbers as timeout
> +	re='^[0-9]+$'
> +	if ! [[ $timeout =~ $re ]]; then

This is bashism. The portable way to do this seems to be do
tr -d [:digit:] on the string and checking if result is empty or use
grep.

> +		echo "only numbers as second argument"
> +		return 1
> +	fi
> +
> +	if [ -z "$TMPDIR" ]; then
> +		TMPDIR="/tmp"
> +	fi

I guess that better solution would be to move this check from the
tst_tmpdir() after the LTPROOT check in the test.sh so that we have only
one copy of it.

> +	local output=$(mktemp --tmpdir=$TMPDIR)
> +	sh -c "eval $command" >$output 2>&1 &

Do we really need to redirect the output to the file here? Shouldn't
just redirecting stderr to stdout work?

> +	local pid=$!
> +	timeout=$((timeout*1000000))
> +	while [ $timeout -gt 0 ]; do
> +		kill -s 0 $pid 2>/dev/null
> +		if [ $? -ne 0 ]; then
> +			break
> +		fi
> +		timeout=$((timeout - usleep_time))
> +		usleep $usleep_time

The usleep is bashism as well. What is not POSIX but tend to work is
sleep with a real number, i.e. sleep 0.1 but it does not seems to be
supported under BussyBox.

So we can either do the polling once a second or create our own
tst_usleep C source that calls usleep().

Ah and I've found that coreutils even includes timeout command that
can be used to fairly simplify the code.

Try:

timeout $timeout sh -c "eval $command"
echo $?

> +	done
> +
> +	local ret=0
> +	if [ $timeout -le 0 ]; then
> +		ret=128
> +		kill -9 $pid
> +
> +	fi
> +
> +	wait $pid
> +	ret=$((ret | $?))
> +
> +	cat $output
> +	rm -f $output
> +
> +	return $ret
> +}
> +
>  # Check that test name is set
>  if [ -z "$TCID" ]; then
>  	tst_brkm TBROK "TCID is not defined"
> -- 
> 1.8.3.1
> 
> 
> ------------------------------------------------------------------------------
> Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
> from Actuate! Instantly Supercharge Your Business Reports and Dashboards
> with Interactivity, Sharing, Native Excel Exports, App Integration & more
> Get technology previously reserved for billion-dollar corporations, FREE
> http://pubads.g.doubleclick.net/gampad/clk?id=157005751&iu=/4140/ostg.clktrk
> _______________________________________________
> Ltp-list mailing list
> Ltp-list@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/ltp-list

-- 
Cyril Hrubis
chrubis@suse.cz

------------------------------------------------------------------------------
Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
from Actuate! Instantly Supercharge Your Business Reports and Dashboards
with Interactivity, Sharing, Native Excel Exports, App Integration & more
Get technology previously reserved for billion-dollar corporations, FREE
http://pubads.g.doubleclick.net/gampad/clk?id=157005751&iu=/4140/ostg.clktrk
_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list

Re: [LTP] [PATCH] testcases/lib/test.sh: added tst_timeout()

[Cyril Hrubis]

Hi!
> > Ah and I've found that coreutils even includes timeout command that
> > can be used to fairly simplify the code.
> 
> It should be available since coreutils 7.0:
>   http://git.savannah.gnu.org/cgit/coreutils.git/commit/?id=265c4b83a81c643f3359be926ef8034f28f321ed
> 
> So older distros (e.g. RHEL5) might not have it yet. Shall we fall
> back to script above in that case or brkm(TCONF)?

In that case it's IMHO better to have single implementation for all
distros. The more codepaths we have the more bugs.

-- 
Cyril Hrubis
chrubis@suse.cz

------------------------------------------------------------------------------
Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
from Actuate! Instantly Supercharge Your Business Reports and Dashboards
with Interactivity, Sharing, Native Excel Exports, App Integration & more
Get technology previously reserved for billion-dollar corporations, FREE
http://pubads.g.doubleclick.net/gampad/clk?id=157005751&iu=/4140/ostg.clktrk
_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list

Re: [LTP] [PATCH] testcases/lib/test.sh: added tst_timeout()

[Cyril Hrubis]

Hi!
> > This is bashism. The portable way to do this seems to be do
> > tr -d [:digit:] on the string and checking if result is empty or use
> > grep.
> 
> Indeed, 'tr' may be used in this case, but an (AFAIK) portable
> replacement for =~ is expr(1):

I do not care much about the way it's implemented. All we need is that
the code runs fine at least with bash, dash and bussybox.

>   if ! expr "$timeout" : '.*[0-9]\+$' >/dev/null; then
> 
> although, as you can see, there are several limitations:
> 
>   - IIRC the busybox version doesn't support '+ TOKEN' syntax, so we
>     rely on ie. $timeout != "match"
>   - different implementations may have different syntax, although the
>     `:' notation is AFAIK the oldest
>   - regexp matching is always done from the beginning, so there's `^'
>     implied
>   - path to /dev/null may be different on some systems (_PATH_DEVNULL),
>     not sure if "/dev/null" is a POSIX requirement

We rely on /dev/null heavily in all parts of LTP. The goal is to be
portable across various Linux distributions, even embedded ones. We do
not care about rest of the UNIX world much (the exception is the Open
Posix Testsuite which should be written to the POSIX standard).

Ahd the whole problem reminds me an old saying:

"I'ts easier to implement portable shell than a porable shell code."

-- 
Cyril Hrubis
chrubis@suse.cz

------------------------------------------------------------------------------
Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
from Actuate! Instantly Supercharge Your Business Reports and Dashboards
with Interactivity, Sharing, Native Excel Exports, App Integration & more
Get technology previously reserved for billion-dollar corporations, FREE
http://pubads.g.doubleclick.net/gampad/clk?id=164703151&iu=/4140/ostg.clktrk
_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list

[LTP] [PATCH v2] testcases/lib/test.sh: added tst_timeout()

[Matus Marhefka]

Function tst_timeout() added into LTP test interface:

	tst_timeout "command arg1 arg2 ..." timeout

Function enables waiting for specified command for timeout
seconds. Example usage:

	cmd_output=$(tst_timeout "ping -c 3 localhost" 5)
	if [ $? -ne 0 ]; then
		tst_brkm TBROK "timeout reached!"
	fi

where $cmd_output contains stdout and stderr of ping command.

Signed-off-by: Matus Marhefka <mmarhefk@redhat.com>
---
 testcases/lib/test.sh | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/testcases/lib/test.sh b/testcases/lib/test.sh
index eecbfba..d31fcb8 100644
--- a/testcases/lib/test.sh
+++ b/testcases/lib/test.sh
@@ -129,6 +129,50 @@ tst_check_cmds()
 	done
 }
 
+# tst_timeout "command arg1 arg2 ..." timeout
+# Runs command for specified timeout (in seconds).
+# Function returns retcode of command or 1 if arguments are invalid.
+tst_timeout()
+{
+	local command=$1
+	local timeout=$(echo $2 | grep -o "^[0-9]\+$")
+
+	# command must be non-empty string with command to run
+	if [ -z "$command" ]; then
+		echo "first argument must be non-empty string"
+		return 1
+	fi
+
+	# accept only numbers as timeout
+	if [ -z "$timeout" ]; then
+		echo "only numbers as second argument"
+		return 1
+	fi
+
+	setsid sh -c "eval $command" 2>&1 &
+	local pid=$!
+	local pgid=$(ps -eo pid,pgid | grep $pid | sed 's/^.* //')
+	while [ $timeout -gt 0 ]; do
+		kill -s 0 $pid 2>/dev/null
+		if [ $? -ne 0 ]; then
+			break
+		fi
+		timeout=$((timeout - 1))
+		sleep 1
+	done
+
+	local ret=0
+	if [ $timeout -le 0 ]; then
+		ret=128
+		kill -TERM -- -$pgid
+	fi
+
+	wait $pid
+	ret=$((ret | $?))
+
+	return $ret
+}
+
 # Check that test name is set
 if [ -z "$TCID" ]; then
 	tst_brkm TBROK "TCID is not defined"
-- 
1.8.3.1


------------------------------------------------------------------------------
Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
from Actuate! Instantly Supercharge Your Business Reports and Dashboards
with Interactivity, Sharing, Native Excel Exports, App Integration & more
Get technology previously reserved for billion-dollar corporations, FREE
http://pubads.g.doubleclick.net/gampad/clk?id=164703151&iu=/4140/ostg.clktrk
_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list

Re: [LTP] [PATCH v2] testcases/lib/test.sh: added tst_timeout()

[Cyril Hrubis]

Hi!
> +# tst_timeout "command arg1 arg2 ..." timeout
> +# Runs command for specified timeout (in seconds).
> +# Function returns retcode of command or 1 if arguments are invalid.
> +tst_timeout()
> +{
> +	local command=$1
> +	local timeout=$(echo $2 | grep -o "^[0-9]\+$")
> +
> +	# command must be non-empty string with command to run
> +	if [ -z "$command" ]; then
> +		echo "first argument must be non-empty string"
> +		return 1
> +	fi
> +
> +	# accept only numbers as timeout
> +	if [ -z "$timeout" ]; then
> +		echo "only numbers as second argument"
> +		return 1
> +	fi
> +
> +	setsid sh -c "eval $command" 2>&1 &
> +	local pid=$!
> +	local pgid=$(ps -eo pid,pgid | grep $pid | sed 's/^.* //')

Hmm, wouldn't be the $pid == $pgid in this case? Or is there a scenario
where this would not hold?

Otherwise it looks good to me.

-- 
Cyril Hrubis
chrubis@suse.cz

------------------------------------------------------------------------------
Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
from Actuate! Instantly Supercharge Your Business Reports and Dashboards
with Interactivity, Sharing, Native Excel Exports, App Integration & more
Get technology previously reserved for billion-dollar corporations, FREE
http://pubads.g.doubleclick.net/gampad/clk?id=164703151&iu=/4140/ostg.clktrk
_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list

Re: [LTP] [PATCH v3] testcases/lib/test.sh: added tst_timeout()

[Wanlong Gao]

On 12/19/2014 07:11 PM, Matus Marhefka wrote:
> Function tst_timeout() added into LTP test interface:
> 
> 	tst_timeout "command arg1 arg2 ..." timeout
> 
> Function enables waiting for specified command for timeout
> seconds. Example usage:
> 
> 	cmd_output=$(tst_timeout "ping -c 3 localhost" 5)
> 	if [ $? -ne 0 ]; then
> 		tst_brkm TBROK "timeout reached!"
> 	fi
> 
> where $cmd_output contains stdout and stderr of ping command.
> 
> Signed-off-by: Matus Marhefka <mmarhefk@redhat.com>

Nice function.

Acked-by: Wanlong Gao <gaowanlong@cn.fujitsu.com>


> ---
>  testcases/lib/test.sh | 43 +++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 43 insertions(+)
> 
> diff --git a/testcases/lib/test.sh b/testcases/lib/test.sh
> index eecbfba..ad78a87 100644
> --- a/testcases/lib/test.sh
> +++ b/testcases/lib/test.sh
> @@ -129,6 +129,49 @@ tst_check_cmds()
>  	done
>  }
>  
> +# tst_timeout "command arg1 arg2 ..." timeout
> +# Runs command for specified timeout (in seconds).
> +# Function returns retcode of command or 1 if arguments are invalid.
> +tst_timeout()
> +{
> +	local command=$1
> +	local timeout=$(echo $2 | grep -o "^[0-9]\+$")
> +
> +	# command must be non-empty string with command to run
> +	if [ -z "$command" ]; then
> +		echo "first argument must be non-empty string"
> +		return 1
> +	fi
> +
> +	# accept only numbers as timeout
> +	if [ -z "$timeout" ]; then
> +		echo "only numbers as second argument"
> +		return 1
> +	fi
> +
> +	setsid sh -c "eval $command" 2>&1 &
> +	local pid=$!
> +	while [ $timeout -gt 0 ]; do
> +		kill -s 0 $pid 2>/dev/null
> +		if [ $? -ne 0 ]; then
> +			break
> +		fi
> +		timeout=$((timeout - 1))
> +		sleep 1
> +	done
> +
> +	local ret=0
> +	if [ $timeout -le 0 ]; then
> +		ret=128
> +		kill -TERM -- -$pid
> +	fi
> +
> +	wait $pid
> +	ret=$((ret | $?))
> +
> +	return $ret
> +}
> +
>  # Check that test name is set
>  if [ -z "$TCID" ]; then
>  	tst_brkm TBROK "TCID is not defined"
> 


------------------------------------------------------------------------------
Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
from Actuate! Instantly Supercharge Your Business Reports and Dashboards
with Interactivity, Sharing, Native Excel Exports, App Integration & more
Get technology previously reserved for billion-dollar corporations, FREE
http://pubads.g.doubleclick.net/gampad/clk?id=164703151&iu=/4140/ostg.clktrk
_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list

Re: [LTP] [PATCH v3] testcases/lib/test.sh: added tst_timeout()

[Cyril Hrubis]

Hi!
> Function tst_timeout() added into LTP test interface:
> 
> 	tst_timeout "command arg1 arg2 ..." timeout
> 
> Function enables waiting for specified command for timeout
> seconds. Example usage:
> 
> 	cmd_output=$(tst_timeout "ping -c 3 localhost" 5)
> 	if [ $? -ne 0 ]; then
> 		tst_brkm TBROK "timeout reached!"
> 	fi
> 
> where $cmd_output contains stdout and stderr of ping command.

Pushed, thanks.

It would be a nice to have a paragraph about the usage in the test
writing guidelines. Can you send a patch for that too?

-- 
Cyril Hrubis
chrubis@suse.cz

------------------------------------------------------------------------------
Dive into the World of Parallel Programming! The Go Parallel Website,
sponsored by Intel and developed in partnership with Slashdot Media, is your
hub for all things parallel software development, from weekly thought
leadership blogs to news, videos, case studies, tutorials and more. Take a
look and join the conversation now. http://goparallel.sourceforge.net
_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list