Merge ~kzapalowicz/snappy-hwe-snaps/+git/engineering-tests:feature/udisks2-add-debug-tests into ~snappy-hwe-team/snappy-hwe-snaps/+git/engineering-tests:master

[Konrad Zapałowicz]

udisks2: add tests for debug config option

This commit adds tests for debug config option as well as it
removes a note related to https://bugs.launchpad.net/snapd/+bug/1636934
which is not valid anymore.

[System Enablement Bot (system-enablement-ci-bot)]

PASSED: Continuous integration, rev:9c83a173d676d3a3c99c030ea268c6f32a50218d
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1550/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-build-snap-worker/1850
    None: https://jenkins.canonical.com/system-enablement/job/generic-update-snap-mp/1458/console
    SUCCESS: https://jenkins.canonical.com/system-enablement/job/generic-test-snap/2232
    None: https://jenkins.canonical.com/system-enablement/job/generic-cleanup-snap/1429/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/system-enablement/job/generic-build-snap/1550/rebuild

review: Approve (continuous-integration)

[Simon Fels (morphis)]

LGTM

review: Approve

diff --git a/udisks2/units/udisks2.pxu b/udisks2/units/udisks2.pxu
index 7c944b8..7006baf 100644
--- a/udisks2/units/udisks2.pxu
+++ b/udisks2/units/udisks2.pxu
@@ -131,13 +131,6 @@ _steps:
      $ sudo snap get udisks2 automount.enable
 _verification:
   Verify that the returned value is "false"
-  .
-  Note that there is a known bug in snapd which preserves the state of the
-  config options between snap remove and snap install. Therefore, if you have
-  ever set the automount option to 'true' before, then it will not be 'false'
-  even if you install the snap fresh. You need to use a fresh image for
-  testing.
-  bug url: https://bugs.launchpad.net/snapd/+bug/1636934
 
 id: udisks2/automount/disabling_works
 category_id: udisks2
@@ -273,3 +266,53 @@ _steps:
 _verification:
   Verify that the USB drive that has been plugged in after the first one has
   been unmounted manually is mounted.
+
+id: udisks2/debug/default_off
+category_id: udisks2
+plugin: manual
+depends: udisks2/setup/ensure_interface_connection_setup
+_summary: The debug option defaults to off
+_purpose:
+  Makes sure that the debug option defaults to disabled
+_steps:
+  1. Install the udisks2 snap fresh (i.e. not an upgrade)
+  2. Run the following:
+     .
+     $ sudo snap get udisks2 debug.enable
+_verification:
+  Verify that the returned value is "false"
+
+id: udisks2/debug/disabling_works
+category_id: udisks2
+plugin: manual
+depends: udisks2/debug/default_off
+_summary: Disabling debug actually disables debug logging
+_purpose:
+  Makes sure that when debug.enabled is set to "false" no loggs are written
+_steps:
+  1. Make sure that debug is disabled. Run:
+     .
+     $ sudo snap set udisks2 debug.enable=false
+  2. Plug in a USB storage device
+_verification:
+  Verify that no debug information coming from files such as jobs.go,
+  dispatcher.go, udisks2.go is written to the journal.
+
+id: udisks2/automount/debug_works
+category_id: udisks2
+plugin: manual
+depends: udisks2/debug/default_off
+_summary: When debug is enabled logs are available
+_purpose:
+  Makes sure that when debug option is enabled the logs are available
+_steps:
+  1. Make sure that debug is enabled. Run:
+     .
+     $ sudo snap set udisks2 debug.enable=true
+  2. Restart ciborium service for the above change to take effect
+     .
+     $ sudo systemctl restart snap.udisks2.ciborium.service
+  3. Plug in a USB storage drive
+_verification:
+  Verify that debug information coming from udisks2 snap (files such as
+  jobs.go, dispatcher.go, udisks2.go) is written to the journal.