Skip to contentSkip to conversation

iotests: Work around failing readlink -f

PATCH In review Max Reitz 2 participants 3 messages Sep 14, 2020

lore
Share & tools
lore

Max Reitz

author
#0 lore raw

PATCH v2 1/1 iotests: Work around failing readlink -f

On macOS, (out of the box) readlink does not have -f. If the recent "readlink -f" call introduced by b1cbc33a397 fails, just fall back to the old behavior (which means you can run the iotests only from the build tree, but that worked fine for six years, so it should be fine still).

Suppress all error messages, so in case using $PWD works out, we do not cause the user to worry. If it does not work, we will end up printing the following error message anyway:

check: failed to source common.env (make sure the qemu-iotests are run from tests/qemu-iotests in the build tree)

Following that hint (running check from $build_tree/tests/qemu-iotests) will make it work, and is probably even easier than obtaining a readlink that understands -f.

Fixes b1cbc33a3971b6bb005d5ac3569feae35a71de0f

("iotests: Allow running from different directory")

---
v2: Suppress stderr (as requested and suggested by Peter)

---
 tests/qemu-iotests/check | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
tests/qemu-iotests/check +5 -1
index e14a1f354d..3c9ccc117b 100755
@@ -44,7 +44,11 @@ then
         _init_error "failed to obtain source tree name from check symlink"
     fi
     source_iotests=$(cd "$source_iotests"; pwd) || _init_error "failed to enter source tree"
-    build_iotests=$(readlink -f $(dirname "$0"))
+    build_iotests=$(readlink -f $(dirname "$0") 2>/dev/null)
+    if [ "$?" -ne 0 ]; then
+        # Perhaps -f is unsupported, revert to pre-b1cbc33a397 behavior
+        build_iotests=$PWD
+    fi
 else
     # called from the source tree
     source_iotests=$PWD
Signature · 1 line
2.26.2
#1 lore raw
Quoted 34 lines · Max Reitz

On macOS, (out of the box) readlink does not have -f. If the recent "readlink -f" call introduced by b1cbc33a397 fails, just fall back to the old behavior (which means you can run the iotests only from the build tree, but that worked fine for six years, so it should be fine still).

Suppress all error messages, so in case using $PWD works out, we do not cause the user to worry. If it does not work, we will end up printing the following error message anyway:

check: failed to source common.env (make sure the qemu-iotests are run from tests/qemu-iotests in the build tree)

Following that hint (running check from $build_tree/tests/qemu-iotests) will make it work, and is probably even easier than obtaining a readlink that understands -f.

Fixes b1cbc33a3971b6bb005d5ac3569feae35a71de0f

("iotests: Allow running from different directory")

---
v2: Suppress stderr (as requested and suggested by Peter)

---
 tests/qemu-iotests/check | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
tests/qemu-iotests/check +0 -0
index e14a1f354d..3c9ccc117b 100755

tests/qemu-iotests/check then · line 47

Quoted 5 lines
tests/qemu-iotests/check +1 -1
@@ -44,7 +44,11 @@ then
         _init_error "failed to obtain source tree name from check symlink"
     fi
     source_iotests=$(cd "$source_iotests"; pwd) || _init_error "failed to enter source tree"
-    build_iotests=$(readlink -f $(dirname "$0"))
+    build_iotests=$(readlink -f $(dirname "$0") 2>/dev/null)

Having woken up and actually looked at the context for what we're doing with readlink here, my usual rune for "give me the absolute path that this script is in" is

thisdir="$(cd "$(dirname "$0")"; pwd)"

which should be more portable than readlink. It doesn't give quite the same behaviour if it's run via a path which is a symlink to a directory, eg if bar/ is a symlink to foo/ and you run a script as bar/thescript then you'll get back /path/to/bar/ rather than /path/to/foo/, but do you really need the path with all the symlinks followed rather than just some valid absolute path to the build dir?

thanks
-- PMM

author
#2 lore raw
Quoted 48 lines · Peter Maydell
Quoted 34 lines · Max Reitz

On macOS, (out of the box) readlink does not have -f. If the recent "readlink -f" call introduced by b1cbc33a397 fails, just fall back to the old behavior (which means you can run the iotests only from the build tree, but that worked fine for six years, so it should be fine still).

Suppress all error messages, so in case using $PWD works out, we do not cause the user to worry. If it does not work, we will end up printing the following error message anyway:

check: failed to source common.env (make sure the qemu-iotests are run from tests/qemu-iotests in the build tree)

Following that hint (running check from $build_tree/tests/qemu-iotests) will make it work, and is probably even easier than obtaining a readlink that understands -f.

Fixes b1cbc33a3971b6bb005d5ac3569feae35a71de0f

("iotests: Allow running from different directory")

---
v2: Suppress stderr (as requested and suggested by Peter)

---
 tests/qemu-iotests/check | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
tests/qemu-iotests/check +0 -0
index e14a1f354d..3c9ccc117b 100755

tests/qemu-iotests/check then · line 47

Quoted 5 lines
tests/qemu-iotests/check +1 -1
@@ -44,7 +44,11 @@ then
         _init_error "failed to obtain source tree name from check symlink"
     fi
     source_iotests=$(cd "$source_iotests"; pwd) || _init_error "failed to enter source tree"
-    build_iotests=$(readlink -f $(dirname "$0"))
+    build_iotests=$(readlink -f $(dirname "$0") 2>/dev/null)

Having woken up and actually looked at the context for what we're doing with readlink here, my usual rune for "give me the absolute path that this script is in" is

thisdir="$(cd "$(dirname "$0")"; pwd)"

Quoted 7 lines

which should be more portable than readlink. It doesn't give quite the same behaviour if it's run via a path which is a symlink to a directory, eg if bar/ is a symlink to foo/ and you run a script as bar/thescript then you'll get back /path/to/bar/ rather than /path/to/foo/, but do you really need the path with all the symlinks followed rather than just some valid absolute path to the build dir?

Interesting. Sounds good.

The only reason we did use readlink here was because realpath wasn’t available on the BSDs. We don’t really need the symlink, we just need the full absolute path to $(dirname $0).

Thanks!

Max