diff mbox series

[v2] selftests/kselftest/runner/run_one(): Allow running non-executable files

Message ID 20210810164534.25902-1-sj38.park@gmail.com
State New
Headers show
Series [v2] selftests/kselftest/runner/run_one(): Allow running non-executable files | expand

Commit Message

SeongJae Park Aug. 10, 2021, 4:45 p.m. UTC 
From: SeongJae Park <sjpark@amazon.de>

When running a test program, 'run_one()' checks if the program has the
execution permission and fails if it doesn't.  However, it's easy to
mistakenly missing the permission, as some common tools like 'diff'
don't support the permission change well[1].  Compared to that, making
mistakes in the test program's path would only rare, as those are
explicitly listed in 'TEST_PROGS'.  Therefore, it might make more sense
to resolve the situation on our own and run the program.

For the reason, this commit makes the test program runner function to
still print the warning message but try parsing the interpreter of the
program and explicitly run it with the interpreter, in the case.

[1] https://lore.kernel.org/mm-commits/YRJisBs9AunccCD4@kroah.com/

Suggested-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: SeongJae Park <sjpark@amazon.de>
---
Changes from v1
(https://lore.kernel.org/linux-kselftest/20210810140459.23990-1-sj38.park@gmail.com/)
- Parse and use the interpreter instead of changing the file

 tools/testing/selftests/kselftest/runner.sh | 28 +++++++++++++--------
 1 file changed, 18 insertions(+), 10 deletions(-)

Comments

SeongJae Park Sept. 13, 2021, 11:24 a.m. UTC | #1 
From: SeongJae Park <sjpark@amazon.de>


Hello Shuah,


Could you I ask your comment for this patch?


Thanks,
SJ

On Tue, 10 Aug 2021 16:45:34 +0000 SeongJae Park <sj38.park@gmail.com> wrote:

> From: SeongJae Park <sjpark@amazon.de>

> 

> When running a test program, 'run_one()' checks if the program has the

> execution permission and fails if it doesn't.  However, it's easy to

> mistakenly missing the permission, as some common tools like 'diff'

> don't support the permission change well[1].  Compared to that, making

> mistakes in the test program's path would only rare, as those are

> explicitly listed in 'TEST_PROGS'.  Therefore, it might make more sense

> to resolve the situation on our own and run the program.

> 

> For the reason, this commit makes the test program runner function to

> still print the warning message but try parsing the interpreter of the

> program and explicitly run it with the interpreter, in the case.

> 

> [1] https://lore.kernel.org/mm-commits/YRJisBs9AunccCD4@kroah.com/

> 

> Suggested-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

> Signed-off-by: SeongJae Park <sjpark@amazon.de>

> ---

> Changes from v1

> (https://lore.kernel.org/linux-kselftest/20210810140459.23990-1-sj38.park@gmail.com/)

> - Parse and use the interpreter instead of changing the file

> 

>  tools/testing/selftests/kselftest/runner.sh | 28 +++++++++++++--------

>  1 file changed, 18 insertions(+), 10 deletions(-)

> 

> diff --git a/tools/testing/selftests/kselftest/runner.sh b/tools/testing/selftests/kselftest/runner.sh

> index cc9c846585f0..a9ba782d8ca0 100644

> --- a/tools/testing/selftests/kselftest/runner.sh

> +++ b/tools/testing/selftests/kselftest/runner.sh

> @@ -33,9 +33,9 @@ tap_timeout()

>  {

>  	# Make sure tests will time out if utility is available.

>  	if [ -x /usr/bin/timeout ] ; then

> -		/usr/bin/timeout --foreground "$kselftest_timeout" "$1"

> +		/usr/bin/timeout --foreground "$kselftest_timeout" $1

>  	else

> -		"$1"

> +		$1

>  	fi

>  }

>  

> @@ -65,17 +65,25 @@ run_one()

>  

>  	TEST_HDR_MSG="selftests: $DIR: $BASENAME_TEST"

>  	echo "# $TEST_HDR_MSG"

> -	if [ ! -x "$TEST" ]; then

> -		echo -n "# Warning: file $TEST is "

> -		if [ ! -e "$TEST" ]; then

> -			echo "missing!"

> -		else

> -			echo "not executable, correct this."

> -		fi

> +	if [ ! -e "$TEST" ]; then

> +		echo "# Warning: file $TEST is missing!"

>  		echo "not ok $test_num $TEST_HDR_MSG"

>  	else

> +		cmd="./$BASENAME_TEST"

> +		if [ ! -x "$TEST" ]; then

> +			echo "# Warning: file $TEST is not executable"

> +

> +			if [ $(head -n 1 "$TEST" | cut -c -2) = "#!" ]

> +			then

> +				interpreter=$(head -n 1 "$TEST" | cut -c 3-)

> +				cmd="$interpreter ./$BASENAME_TEST"

> +			else

> +				echo "not ok $test_num $TEST_HDR_MSG"

> +				return

> +			fi

> +		fi

>  		cd `dirname $TEST` > /dev/null

> -		((((( tap_timeout ./$BASENAME_TEST 2>&1; echo $? >&3) |

> +		((((( tap_timeout "$cmd" 2>&1; echo $? >&3) |

>  			tap_prefix >&4) 3>&1) |

>  			(read xs; exit $xs)) 4>>"$logfile" &&

>  		echo "ok $test_num $TEST_HDR_MSG") ||

> -- 

> 2.17.1

>
SeongJae Park Oct. 8, 2021, 9:58 a.m. UTC | #2 
Hello Shuah,


I was wondering if you had a chance to read this patch.

Without this patch, DAMON selftest fails as below:

    $ make -C tools/testing/selftests/damon/ run_tests
    make: Entering directory '/home/sjpark/linux/tools/testing/selftests/damon'
    TAP version 13
    1..1
    # selftests: damon: debugfs_attrs.sh
    # Warning: file debugfs_attrs.sh is not executable, correct this.
    not ok 1 selftests: damon: debugfs_attrs.sh
    make: Leaving directory '/home/sjpark/linux/tools/testing/selftests/damon'

If you disagree in the approach, please also take a look in this one:
https://lore.kernel.org/linux-kselftest/20210810112050.22225-1-sj38.park@gmail.com/


Thanks,
SJ


On Mon, 13 Sep 2021 11:24:42 +0000 SeongJae Park <sj38.park@gmail.com> wrote:

> From: SeongJae Park <sjpark@amazon.de>

> 

> Hello Shuah,

> 

> 

> Could you I ask your comment for this patch?

> 

> 

> Thanks,

> SJ

> 

> On Tue, 10 Aug 2021 16:45:34 +0000 SeongJae Park <sj38.park@gmail.com> wrote:

> 

> > From: SeongJae Park <sjpark@amazon.de>

> > 

> > When running a test program, 'run_one()' checks if the program has the

> > execution permission and fails if it doesn't.  However, it's easy to

> > mistakenly missing the permission, as some common tools like 'diff'

> > don't support the permission change well[1].  Compared to that, making

> > mistakes in the test program's path would only rare, as those are

> > explicitly listed in 'TEST_PROGS'.  Therefore, it might make more sense

> > to resolve the situation on our own and run the program.

> > 

> > For the reason, this commit makes the test program runner function to

> > still print the warning message but try parsing the interpreter of the

> > program and explicitly run it with the interpreter, in the case.

> > 

> > [1] https://lore.kernel.org/mm-commits/YRJisBs9AunccCD4@kroah.com/

> > 

> > Suggested-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

> > Signed-off-by: SeongJae Park <sjpark@amazon.de>

> > ---

> > Changes from v1

> > (https://lore.kernel.org/linux-kselftest/20210810140459.23990-1-sj38.park@gmail.com/)

> > - Parse and use the interpreter instead of changing the file

> > 

> >  tools/testing/selftests/kselftest/runner.sh | 28 +++++++++++++--------

> >  1 file changed, 18 insertions(+), 10 deletions(-)

> > 

> > diff --git a/tools/testing/selftests/kselftest/runner.sh b/tools/testing/selftests/kselftest/runner.sh

> > index cc9c846585f0..a9ba782d8ca0 100644

> > --- a/tools/testing/selftests/kselftest/runner.sh

> > +++ b/tools/testing/selftests/kselftest/runner.sh

> > @@ -33,9 +33,9 @@ tap_timeout()

> >  {

> >  	# Make sure tests will time out if utility is available.

> >  	if [ -x /usr/bin/timeout ] ; then

> > -		/usr/bin/timeout --foreground "$kselftest_timeout" "$1"

> > +		/usr/bin/timeout --foreground "$kselftest_timeout" $1

> >  	else

> > -		"$1"

> > +		$1

> >  	fi

> >  }

> >  

> > @@ -65,17 +65,25 @@ run_one()

> >  

> >  	TEST_HDR_MSG="selftests: $DIR: $BASENAME_TEST"

> >  	echo "# $TEST_HDR_MSG"

> > -	if [ ! -x "$TEST" ]; then

> > -		echo -n "# Warning: file $TEST is "

> > -		if [ ! -e "$TEST" ]; then

> > -			echo "missing!"

> > -		else

> > -			echo "not executable, correct this."

> > -		fi

> > +	if [ ! -e "$TEST" ]; then

> > +		echo "# Warning: file $TEST is missing!"

> >  		echo "not ok $test_num $TEST_HDR_MSG"

> >  	else

> > +		cmd="./$BASENAME_TEST"

> > +		if [ ! -x "$TEST" ]; then

> > +			echo "# Warning: file $TEST is not executable"

> > +

> > +			if [ $(head -n 1 "$TEST" | cut -c -2) = "#!" ]

> > +			then

> > +				interpreter=$(head -n 1 "$TEST" | cut -c 3-)

> > +				cmd="$interpreter ./$BASENAME_TEST"

> > +			else

> > +				echo "not ok $test_num $TEST_HDR_MSG"

> > +				return

> > +			fi

> > +		fi

> >  		cd `dirname $TEST` > /dev/null

> > -		((((( tap_timeout ./$BASENAME_TEST 2>&1; echo $? >&3) |

> > +		((((( tap_timeout "$cmd" 2>&1; echo $? >&3) |

> >  			tap_prefix >&4) 3>&1) |

> >  			(read xs; exit $xs)) 4>>"$logfile" &&

> >  		echo "ok $test_num $TEST_HDR_MSG") ||

> > -- 

> > 2.17.1

> >
SeongJae Park April 25, 2023, 12:46 a.m. UTC | #3 
Hi Greg and Sasha,

On Tue, 10 Aug 2021 16:45:34 +0000 SeongJae Park <sj38.park@gmail.com> wrote:

> From: SeongJae Park <sjpark@amazon.de>
> 
> When running a test program, 'run_one()' checks if the program has the
> execution permission and fails if it doesn't.  However, it's easy to
> mistakenly missing the permission, as some common tools like 'diff'
> don't support the permission change well[1].  Compared to that, making
> mistakes in the test program's path would only rare, as those are
> explicitly listed in 'TEST_PROGS'.  Therefore, it might make more sense
> to resolve the situation on our own and run the program.
> 
> For the reason, this commit makes the test program runner function to
> still print the warning message but try parsing the interpreter of the
> program and explicitly run it with the interpreter, in the case.
> 
> [1] https://lore.kernel.org/mm-commits/YRJisBs9AunccCD4@kroah.com/
> 
> Suggested-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Signed-off-by: SeongJae Park <sjpark@amazon.de>

This patch has merged into the mainline by the commit 303f8e2d0200
("selftests/kselftest/runner/run_one(): allow running non-executable files").
However, this patch has not added to v5.15.y, while there are some selftests
having no execution permission, including that for DAMON.  As a result, the
selftests always fail unless this patch is manually applied.  Could you please
add this patch to v5.15.y?  I confirmed this patch can cleanly cherry-picked on
the latest v5.15.y.


Thanks,
SJ
Greg Kroah-Hartman April 27, 2023, 8:29 a.m. UTC | #4 
On Tue, Apr 25, 2023 at 12:46:37AM +0000, SeongJae Park wrote:
> Hi Greg and Sasha,
> 
> On Tue, 10 Aug 2021 16:45:34 +0000 SeongJae Park <sj38.park@gmail.com> wrote:
> 
> > From: SeongJae Park <sjpark@amazon.de>
> > 
> > When running a test program, 'run_one()' checks if the program has the
> > execution permission and fails if it doesn't.  However, it's easy to
> > mistakenly missing the permission, as some common tools like 'diff'
> > don't support the permission change well[1].  Compared to that, making
> > mistakes in the test program's path would only rare, as those are
> > explicitly listed in 'TEST_PROGS'.  Therefore, it might make more sense
> > to resolve the situation on our own and run the program.
> > 
> > For the reason, this commit makes the test program runner function to
> > still print the warning message but try parsing the interpreter of the
> > program and explicitly run it with the interpreter, in the case.
> > 
> > [1] https://lore.kernel.org/mm-commits/YRJisBs9AunccCD4@kroah.com/
> > 
> > Suggested-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> > Signed-off-by: SeongJae Park <sjpark@amazon.de>
> 
> This patch has merged into the mainline by the commit 303f8e2d0200
> ("selftests/kselftest/runner/run_one(): allow running non-executable files").
> However, this patch has not added to v5.15.y, while there are some selftests
> having no execution permission, including that for DAMON.  As a result, the
> selftests always fail unless this patch is manually applied.  Could you please
> add this patch to v5.15.y?  I confirmed this patch can cleanly cherry-picked on
> the latest v5.15.y.

Now queued up, thanks.

greg k-h
diff mbox series

Patch

diff --git a/tools/testing/selftests/kselftest/runner.sh b/tools/testing/selftests/kselftest/runner.sh
index cc9c846585f0..a9ba782d8ca0 100644
--- a/tools/testing/selftests/kselftest/runner.sh
+++ b/tools/testing/selftests/kselftest/runner.sh
@@ -33,9 +33,9 @@  tap_timeout()
 {
 	# Make sure tests will time out if utility is available.
 	if [ -x /usr/bin/timeout ] ; then
-		/usr/bin/timeout --foreground "$kselftest_timeout" "$1"
+		/usr/bin/timeout --foreground "$kselftest_timeout" $1
 	else
-		"$1"
+		$1
 	fi
 }
 
@@ -65,17 +65,25 @@  run_one()
 
 	TEST_HDR_MSG="selftests: $DIR: $BASENAME_TEST"
 	echo "# $TEST_HDR_MSG"
-	if [ ! -x "$TEST" ]; then
-		echo -n "# Warning: file $TEST is "
-		if [ ! -e "$TEST" ]; then
-			echo "missing!"
-		else
-			echo "not executable, correct this."
-		fi
+	if [ ! -e "$TEST" ]; then
+		echo "# Warning: file $TEST is missing!"
 		echo "not ok $test_num $TEST_HDR_MSG"
 	else
+		cmd="./$BASENAME_TEST"
+		if [ ! -x "$TEST" ]; then
+			echo "# Warning: file $TEST is not executable"
+
+			if [ $(head -n 1 "$TEST" | cut -c -2) = "#!" ]
+			then
+				interpreter=$(head -n 1 "$TEST" | cut -c 3-)
+				cmd="$interpreter ./$BASENAME_TEST"
+			else
+				echo "not ok $test_num $TEST_HDR_MSG"
+				return
+			fi
+		fi
 		cd `dirname $TEST` > /dev/null
-		((((( tap_timeout ./$BASENAME_TEST 2>&1; echo $? >&3) |
+		((((( tap_timeout "$cmd" 2>&1; echo $? >&3) |
 			tap_prefix >&4) 3>&1) |
 			(read xs; exit $xs)) 4>>"$logfile" &&
 		echo "ok $test_num $TEST_HDR_MSG") ||