Skip to contentSkip to conversation

iotests: Skip read-only cases in 118 when run as root

PATCH In review Kevin Wolf 3 participants 6 messages Oct 18, 2019

lore
Share & tools
lore

Kevin Wolf

author
#0 lore raw

PATCH 1/1 iotests: Skip read-only cases in 118 when run as root

Some tests in 118 use chmod to remove write permissions from the file and assume that the image can indeed not be opened read-write afterwards. This doesn't work when the test is run as root, because root can still open the file as writable even when the permission bit isn't set.

Introduce a @skip_if_root decorator and use it in 118 to skip the tests in question when the script is run as root.

---
 tests/qemu-iotests/118        |  3 +++
 tests/qemu-iotests/iotests.py | 10 ++++++++++
 2 files changed, 13 insertions(+)
tests/qemu-iotests/118 +3 -0
index ea0b326ae0..9eff46d189 100755
@@ -446,6 +446,7 @@ class TestChangeReadOnly(ChangeBaseClass):
         self.assert_qmp(result, 'return[0]/inserted/ro', True)
         self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
 
+    @iotests.skip_if_root
     def test_rw_ro_retain(self):
         os.chmod(new_img, 0o444)
         self.vm.add_drive(old_img, 'media=disk', 'none')
@@ -530,6 +531,7 @@ class TestChangeReadOnly(ChangeBaseClass):
         self.assert_qmp(result, 'return[0]/inserted/ro', True)
         self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
 
+    @iotests.skip_if_root
     def test_make_ro_rw(self):
         os.chmod(new_img, 0o444)
         self.vm.add_drive(old_img, 'media=disk', 'none')
@@ -571,6 +573,7 @@ class TestChangeReadOnly(ChangeBaseClass):
         self.assert_qmp(result, 'return[0]/inserted/ro', True)
         self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
 
+    @iotests.skip_if_root
     def test_make_ro_rw_by_retain(self):
         os.chmod(new_img, 0o444)
         self.vm.add_drive(old_img, 'media=disk', 'none')
tests/qemu-iotests/iotests.py +10 -0
index 3a8f378f90..9c66db613e 100644
@@ -920,6 +920,16 @@ def skip_if_unsupported(required_formats=[], read_only=False):
         return func_wrapper
     return skip_test_decorator
 
+def skip_if_root(func):
+    '''Skip Test Decorator
+       Runs the test only without root permissions'''
+    def func_wrapper(*args, **kwargs):
+        if os.getuid() == 0:
+            case_notrun('{}: cannot be run as root'.format(args[0]))
+        else:
+            return func(*args, **kwargs)
+    return func_wrapper
+
 def execute_unittest(output, verbosity, debug):
     runner = unittest.TextTestRunner(stream=output, descriptions=True,
                                      verbosity=verbosity)
Signature · 1 line
2.20.1
#1 lore raw

Hi Kevin,

Quoted 20 lines · Kevin Wolf

Some tests in 118 use chmod to remove write permissions from the file and assume that the image can indeed not be opened read-write afterwards. This doesn't work when the test is run as root, because root can still open the file as writable even when the permission bit isn't set.

Introduce a @skip_if_root decorator and use it in 118 to skip the tests in question when the script is run as root.

---
  tests/qemu-iotests/118        |  3 +++
  tests/qemu-iotests/iotests.py | 10 ++++++++++
  2 files changed, 13 insertions(+)
tests/qemu-iotests/118 +0 -0
index ea0b326ae0..9eff46d189 100755

tests/qemu-iotests/118 class TestChangeReadOnly(ChangeBaseClass): · line 449

Quoted 4 lines
tests/qemu-iotests/118 +1 -0
@@ -446,6 +446,7 @@ class TestChangeReadOnly(ChangeBaseClass):
          self.assert_qmp(result, 'return[0]/inserted/ro', True)
          self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
 
+    @iotests.skip_if_root

Why not have case_notrun() return 'reason' and use:

@unittest.skipIf(os.getuid() == 0, case_notrun("cannot be run as root"))

Quoted 24 lines
tests/qemu-iotests/118 +2 -0
      def test_rw_ro_retain(self):
          os.chmod(new_img, 0o444)
          self.vm.add_drive(old_img, 'media=disk', 'none')
@@ -530,6 +531,7 @@ class TestChangeReadOnly(ChangeBaseClass):
          self.assert_qmp(result, 'return[0]/inserted/ro', True)
          self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
 
+    @iotests.skip_if_root
      def test_make_ro_rw(self):
          os.chmod(new_img, 0o444)
          self.vm.add_drive(old_img, 'media=disk', 'none')
@@ -571,6 +573,7 @@ class TestChangeReadOnly(ChangeBaseClass):
          self.assert_qmp(result, 'return[0]/inserted/ro', True)
          self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
 
+    @iotests.skip_if_root
      def test_make_ro_rw_by_retain(self):
          os.chmod(new_img, 0o444)
          self.vm.add_drive(old_img, 'media=disk', 'none')
tests/qemu-iotests/iotests.py +0 -0
index 3a8f378f90..9c66db613e 100644

tests/qemu-iotests/iotests.py def skip_if_unsupported(required_formats=[], read_only=False): · line 923

Quoted 4 lines
tests/qemu-iotests/iotests.py +1 -0
@@ -920,6 +920,16 @@ def skip_if_unsupported(required_formats=[], read_only=False):
          return func_wrapper
      return skip_test_decorator
 
+def skip_if_root(func):

skip_if_user_is_root() is slightly less confuse.

Quoted 13 lines
tests/qemu-iotests/iotests.py +9 -0
+    '''Skip Test Decorator
+       Runs the test only without root permissions'''
+    def func_wrapper(*args, **kwargs):
+        if os.getuid() == 0:
+            case_notrun('{}: cannot be run as root'.format(args[0]))
+        else:
+            return func(*args, **kwargs)
+    return func_wrapper
+
  def execute_unittest(output, verbosity, debug):
      runner = unittest.TextTestRunner(stream=output, descriptions=True,
                                       verbosity=verbosity)
author
#2 lore raw

Am 18.10.2019 um 14:59 hat Philippe Mathieu-Daudé geschrieben:

Quoted 29 lines

Hi Kevin,

Quoted 20 lines · Kevin Wolf

Some tests in 118 use chmod to remove write permissions from the file and assume that the image can indeed not be opened read-write afterwards. This doesn't work when the test is run as root, because root can still open the file as writable even when the permission bit isn't set.

Introduce a @skip_if_root decorator and use it in 118 to skip the tests in question when the script is run as root.

---
  tests/qemu-iotests/118        |  3 +++
  tests/qemu-iotests/iotests.py | 10 ++++++++++
  2 files changed, 13 insertions(+)
tests/qemu-iotests/118 +0 -0
index ea0b326ae0..9eff46d189 100755

tests/qemu-iotests/118 class TestChangeReadOnly(ChangeBaseClass): · line 448

Quoted 3 lines
tests/qemu-iotests/118 +1 -0
@@ -446,6 +446,7 @@ class TestChangeReadOnly(ChangeBaseClass):
          self.assert_qmp(result, 'return[0]/inserted/ro', True)
          self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
+    @iotests.skip_if_root

Why not have case_notrun() return 'reason' and use:

Quoted 1 line

@unittest.skipIf(os.getuid() == 0, case_notrun("cannot be run as root"))

Because we can't skip test cases using unittest functionality, it results in different output (the test is marked as 's' instead of '.' and a message '(skipped=n)' is added), which means failure for qemu-iotests.

Apart from that, it would duplicate the logic and the error message in every place, which wouldn't be very nice anyway. With the necessary iotests.case_notrun() the line becomes > 80 characters, too.

Quoted 19 lines
Quoted 19 lines
tests/qemu-iotests/118 +2 -0
      def test_rw_ro_retain(self):
          os.chmod(new_img, 0o444)
          self.vm.add_drive(old_img, 'media=disk', 'none')
@@ -530,6 +531,7 @@ class TestChangeReadOnly(ChangeBaseClass):
          self.assert_qmp(result, 'return[0]/inserted/ro', True)
          self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
+    @iotests.skip_if_root
      def test_make_ro_rw(self):
          os.chmod(new_img, 0o444)
          self.vm.add_drive(old_img, 'media=disk', 'none')
@@ -571,6 +573,7 @@ class TestChangeReadOnly(ChangeBaseClass):
          self.assert_qmp(result, 'return[0]/inserted/ro', True)
          self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
+    @iotests.skip_if_root
      def test_make_ro_rw_by_retain(self):
          os.chmod(new_img, 0o444)
          self.vm.add_drive(old_img, 'media=disk', 'none')
tests/qemu-iotests/iotests.py +0 -0
index 3a8f378f90..9c66db613e 100644
Quoted 8 lines

tests/qemu-iotests/iotests.py def skip_if_unsupported(required_formats=[], read_only=False): · line 922

Quoted 6 lines
tests/qemu-iotests/iotests.py +1 -0
@@ -920,6 +920,16 @@ def skip_if_unsupported(required_formats=[], read_only=False):
          return func_wrapper
      return skip_test_decorator
+def skip_if_root(func):

skip_if_user_is_root() is slightly less confuse.

Ok, I can make this change.

Kevin

#3 lore raw
Quoted 30 lines · Kevin Wolf

Am 18.10.2019 um 14:59 hat Philippe Mathieu-Daudé geschrieben:

Quoted 29 lines

Hi Kevin,

Quoted 20 lines · Kevin Wolf

Some tests in 118 use chmod to remove write permissions from the file and assume that the image can indeed not be opened read-write afterwards. This doesn't work when the test is run as root, because root can still open the file as writable even when the permission bit isn't set.

Introduce a @skip_if_root decorator and use it in 118 to skip the tests in question when the script is run as root.

---
   tests/qemu-iotests/118        |  3 +++
   tests/qemu-iotests/iotests.py | 10 ++++++++++
   2 files changed, 13 insertions(+)
tests/qemu-iotests/118 +0 -0
index ea0b326ae0..9eff46d189 100755

tests/qemu-iotests/118 class TestChangeReadOnly(ChangeBaseClass): · line 448

Quoted 3 lines
tests/qemu-iotests/118 +1 -0
@@ -446,6 +446,7 @@ class TestChangeReadOnly(ChangeBaseClass):
           self.assert_qmp(result, 'return[0]/inserted/ro', True)
           self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
+    @iotests.skip_if_root

Why not have case_notrun() return 'reason' and use:

Quoted 6 lines
Quoted 1 line

@unittest.skipIf(os.getuid() == 0, case_notrun("cannot be run as root"))

Because we can't skip test cases using unittest functionality, it results in different output (the test is marked as 's' instead of '.' and a message '(skipped=n)' is added), which means failure for qemu-iotests.

Ah, I see.

Quoted 4 lines

Apart from that, it would duplicate the logic and the error message in every place, which wouldn't be very nice anyway. With the necessary iotests.case_notrun() the line becomes > 80 characters, too.

OK.

Quoted 29 lines
Quoted 20 lines
Quoted 20 lines
tests/qemu-iotests/118 +2 -0
       def test_rw_ro_retain(self):
           os.chmod(new_img, 0o444)
           self.vm.add_drive(old_img, 'media=disk', 'none')
@@ -530,6 +531,7 @@ class TestChangeReadOnly(ChangeBaseClass):
           self.assert_qmp(result, 'return[0]/inserted/ro', True)
           self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
+    @iotests.skip_if_root
       def test_make_ro_rw(self):
           os.chmod(new_img, 0o444)
           self.vm.add_drive(old_img, 'media=disk', 'none')
@@ -571,6 +573,7 @@ class TestChangeReadOnly(ChangeBaseClass):
           self.assert_qmp(result, 'return[0]/inserted/ro', True)
           self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
+    @iotests.skip_if_root
       def test_make_ro_rw_by_retain(self):
           os.chmod(new_img, 0o444)
           self.vm.add_drive(old_img, 'media=disk', 'none')
tests/qemu-iotests/iotests.py +0 -0
index 3a8f378f90..9c66db613e 100644
Quoted 8 lines

tests/qemu-iotests/iotests.py def skip_if_unsupported(required_formats=[], read_only=False): · line 922

Quoted 6 lines
tests/qemu-iotests/iotests.py +1 -0
@@ -920,6 +920,16 @@ def skip_if_unsupported(required_formats=[], read_only=False):
           return func_wrapper
       return skip_test_decorator
+def skip_if_root(func):

skip_if_user_is_root() is slightly less confuse.

Quoted 1 line

Ok, I can make this change.

Thanks.

#4 lore raw
In reply to Kevin Wolf
Quoted 30 lines · Kevin Wolf

Am 18.10.2019 um 14:59 hat Philippe Mathieu-Daudé geschrieben:

Quoted 29 lines

Hi Kevin,

Quoted 20 lines · Kevin Wolf

Some tests in 118 use chmod to remove write permissions from the file and assume that the image can indeed not be opened read-write afterwards. This doesn't work when the test is run as root, because root can still open the file as writable even when the permission bit isn't set.

Introduce a @skip_if_root decorator and use it in 118 to skip the tests in question when the script is run as root.

---
  tests/qemu-iotests/118        |  3 +++
  tests/qemu-iotests/iotests.py | 10 ++++++++++
  2 files changed, 13 insertions(+)
tests/qemu-iotests/118 +0 -0
index ea0b326ae0..9eff46d189 100755

tests/qemu-iotests/118 class TestChangeReadOnly(ChangeBaseClass): · line 448

Quoted 3 lines
tests/qemu-iotests/118 +1 -0
@@ -446,6 +446,7 @@ class TestChangeReadOnly(ChangeBaseClass):
          self.assert_qmp(result, 'return[0]/inserted/ro', True)
          self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
+    @iotests.skip_if_root

Why not have case_notrun() return 'reason' and use:

Quoted 6 lines
Quoted 1 line

@unittest.skipIf(os.getuid() == 0, case_notrun("cannot be run as root"))

Because we can't skip test cases using unittest functionality, it results in different output (the test is marked as 's' instead of '.' and a message '(skipped=n)' is added), which means failure for qemu-iotests.

Not arguing that we should use unittest skipping here, but my “Selfish patches” series allows it:

https://lists.nongnu.org/archive/html/qemu-devel/2019-09/msg03423.html

The advantage is that using unittest skipping works in setUp, too.

Max

author
#5 lore raw

Am 18.10.2019 um 17:00 hat Max Reitz geschrieben:

Quoted 38 lines · Kevin Wolf
Quoted 30 lines

Am 18.10.2019 um 14:59 hat Philippe Mathieu-Daudé geschrieben:

Quoted 29 lines

Hi Kevin,

Quoted 20 lines · Kevin Wolf

Some tests in 118 use chmod to remove write permissions from the file and assume that the image can indeed not be opened read-write afterwards. This doesn't work when the test is run as root, because root can still open the file as writable even when the permission bit isn't set.

Introduce a @skip_if_root decorator and use it in 118 to skip the tests in question when the script is run as root.

---
  tests/qemu-iotests/118        |  3 +++
  tests/qemu-iotests/iotests.py | 10 ++++++++++
  2 files changed, 13 insertions(+)
tests/qemu-iotests/118 +0 -0
index ea0b326ae0..9eff46d189 100755

tests/qemu-iotests/118 class TestChangeReadOnly(ChangeBaseClass): · line 448

Quoted 3 lines
tests/qemu-iotests/118 +1 -0
@@ -446,6 +446,7 @@ class TestChangeReadOnly(ChangeBaseClass):
          self.assert_qmp(result, 'return[0]/inserted/ro', True)
          self.assert_qmp(result, 'return[0]/inserted/image/filename', new_img)
+    @iotests.skip_if_root

Why not have case_notrun() return 'reason' and use:

Quoted 6 lines
Quoted 1 line

@unittest.skipIf(os.getuid() == 0, case_notrun("cannot be run as root"))

Because we can't skip test cases using unittest functionality, it results in different output (the test is marked as 's' instead of '.' and a message '(skipped=n)' is added), which means failure for qemu-iotests.

Quoted 6 lines

Not arguing that we should use unittest skipping here, but my “Selfish patches” series allows it:

https://lists.nongnu.org/archive/html/qemu-devel/2019-09/msg03423.html

The advantage is that using unittest skipping works in setUp, too.

Ah, good to know. If this had already been in master, I might have chosen a simple function call iotests.skip_if_root() inside the test function instead of using a decorator. But in the end, I don't think it makes a big difference in this case.

Kevin