Add unwrap_ok macro to replace unwrap in unit tests

The unwrap error message is not very useful.  This patch adds the
unwrap_ok macro that is basically the same as unwrap but prints a more
readable error message.

5 files changed, 56 insertions, 45 deletions

diff --git a/tests/device.rs b/tests/device.rs
index cd37869..67c2713 100644
--- a/tests/device.rs
+++ b/tests/device.rs
@@ -87,15 +87,13 @@ fn disconnect(device: DeviceWrapper) {
 
 #[test_device]
 fn get_serial_number(device: DeviceWrapper) {
-    let result = device.get_serial_number();
-    assert!(result.is_ok());
-    let serial_number = result.unwrap();
+    let serial_number = unwrap_ok!(device.get_serial_number());
     assert!(serial_number.is_ascii());
     assert!(serial_number.chars().all(|c| c.is_ascii_hexdigit()));
 }
 #[test_device]
 fn get_firmware_version(device: Pro) {
-    let version = device.get_firmware_version().unwrap();
+    let version = unwrap_ok!(device.get_firmware_version());
     assert_eq!(0, version.major);
     assert!(version.minor > 0);
 }
@@ -135,7 +133,7 @@ fn get_retry_count(device: DeviceWrapper) {
 
 #[test_device]
 fn config(device: DeviceWrapper) {
-    let admin = device.authenticate_admin(ADMIN_PASSWORD).unwrap();
+    let admin = unwrap_ok!(device.authenticate_admin(ADMIN_PASSWORD));
 
     let config = Config::new(None, None, None, true);
     assert_ok!((), admin.write_config(config));
@@ -274,12 +272,12 @@ fn assert_utf8_err_or_ne(left: &str, right: Result<String, Error>) {
 
 #[test_device]
 fn factory_reset(device: DeviceWrapper) {
-    let admin = device.authenticate_admin(ADMIN_PASSWORD).unwrap();
+    let admin = unwrap_ok!(device.authenticate_admin(ADMIN_PASSWORD));
     let otp_data = OtpSlotData::new(1, "test", "0123468790", OtpMode::SixDigits);
     assert_ok!((), admin.write_totp_slot(otp_data, 30));
 
     let device = admin.device();
-    let pws = device.get_password_safe(USER_PASSWORD).unwrap();
+    let pws = unwrap_ok!(device.get_password_safe(USER_PASSWORD));
     assert_ok!((), pws.write_slot(0, "test", "testlogin", "testpw"));
     drop(pws);
 
@@ -301,11 +299,11 @@ fn factory_reset(device: DeviceWrapper) {
 
     let device = device.authenticate_admin(ADMIN_PASSWORD).unwrap().device();
 
-    let user = device.authenticate_user(USER_PASSWORD).unwrap();
+    let user = unwrap_ok!(device.authenticate_user(USER_PASSWORD));
     assert_cmd_err!(CommandError::SlotNotProgrammed, user.get_totp_slot_name(1));
 
     let device = user.device();
-    let pws = device.get_password_safe(USER_PASSWORD).unwrap();
+    let pws = unwrap_ok!(device.get_password_safe(USER_PASSWORD));
     assert_utf8_err_or_ne("test", pws.get_slot_name(0));
     assert_utf8_err_or_ne("testlogin", pws.get_slot_login(0));
     assert_utf8_err_or_ne("testpw", pws.get_slot_password(0));
@@ -315,7 +313,7 @@ fn factory_reset(device: DeviceWrapper) {
 
 #[test_device]
 fn build_aes_key(device: DeviceWrapper) {
-    let pws = device.get_password_safe(USER_PASSWORD).unwrap();
+    let pws = unwrap_ok!(device.get_password_safe(USER_PASSWORD));
     assert_ok!((), pws.write_slot(0, "test", "testlogin", "testpw"));
     drop(pws);
 
@@ -327,7 +325,7 @@ fn build_aes_key(device: DeviceWrapper) {
 
     let device = device.authenticate_admin(ADMIN_PASSWORD).unwrap().device();
 
-    let pws = device.get_password_safe(USER_PASSWORD).unwrap();
+    let pws = unwrap_ok!(device.get_password_safe(USER_PASSWORD));
     assert_utf8_err_or_ne("test", pws.get_slot_name(0));
     assert_utf8_err_or_ne("testlogin", pws.get_slot_login(0));
     assert_utf8_err_or_ne("testpw", pws.get_slot_password(0));
@@ -406,10 +404,9 @@ fn lock(device: Storage) {
 #[test_device]
 fn set_unencrypted_volume_mode(device: Storage) {
     fn assert_mode(device: &Storage, mode: VolumeMode) {
-        let status = device.get_status();
-        assert!(status.is_ok());
+        let status = unwrap_ok!(device.get_status());
         assert_eq!(
-            status.unwrap().unencrypted_volume.read_only,
+            status.unencrypted_volume.read_only,
             mode == VolumeMode::ReadOnly
         );
     }
@@ -434,15 +431,14 @@ fn set_unencrypted_volume_mode(device: Storage) {
 
 #[test_device]
 fn get_storage_status(device: Storage) {
-    let status = device.get_status().unwrap();
-
+    let status = unwrap_ok!(device.get_status());
     assert!(status.serial_number_sd_card > 0);
     assert!(status.serial_number_smart_card > 0);
 }
 
 #[test_device]
 fn get_production_info(device: Storage) {
-    let info = device.get_production_info().unwrap();
+    let info = unwrap_ok!(device.get_production_info());
     assert_eq!(0, info.firmware_version.major);
     assert!(info.firmware_version.minor != 0);
     assert!(info.serial_number_cpu != 0);
@@ -455,7 +451,7 @@ fn get_production_info(device: Storage) {
     assert!(info.sd_card.oem != 0);
     assert!(info.sd_card.manufacturer != 0);
 
-    let status = device.get_status().unwrap();
+    let status = unwrap_ok!(device.get_status());
     assert_eq!(status.firmware_version, info.firmware_version);
     assert_eq!(status.serial_number_sd_card, info.sd_card.serial_number);
 }
@@ -469,12 +465,12 @@ fn clear_new_sd_card_warning(device: Storage) {
     // We have to perform an SD card operation to reset the new_sd_card_found field
     assert_ok!((), device.lock());
 
-    let status = device.get_status().unwrap();
+    let status = unwrap_ok!(device.get_status());
     assert!(status.new_sd_card_found);
 
     assert_ok!((), device.clear_new_sd_card_warning(ADMIN_PASSWORD));
 
-    let status = device.get_status().unwrap();
+    let status = unwrap_ok!(device.get_status());
     assert!(!status.new_sd_card_found);
 }
 
diff --git a/tests/lib.rs b/tests/lib.rs
index 697024d..8ab75f6 100644
--- a/tests/lib.rs
+++ b/tests/lib.rs
@@ -1,9 +1,11 @@
 // Copyright (C) 2019 Robin Krahl <robin.krahl@ireas.org>
 // SPDX-License-Identifier: MIT
 
+mod util;
+
 #[test]
 fn get_library_version() {
-    let version = nitrokey::get_library_version().unwrap();
+    let version = unwrap_ok!(nitrokey::get_library_version());
 
     assert!(version.git.is_empty() || version.git.starts_with("v"));
     assert!(version.major > 0);
diff --git a/tests/otp.rs b/tests/otp.rs
index e424673..fc0e79e 100644
--- a/tests/otp.rs
+++ b/tests/otp.rs
@@ -56,8 +56,7 @@ fn configure_hotp(admin: &ConfigureOtp, counter: u8) {
 fn check_hotp_codes(device: &GenerateOtp, offset: u8) {
     HOTP_CODES.iter().enumerate().for_each(|(i, code)| {
         if i >= offset as usize {
-            let result = device.get_hotp_code(1);
-            assert_eq!(code, &result.unwrap());
+            assert_ok!(code.to_string(), device.get_hotp_code(1));
         }
     });
 }
@@ -93,7 +92,7 @@ fn hotp_pin(device: DeviceWrapper) {
     assert_ok!((), admin.write_config(config));
 
     configure_hotp(&admin, 0);
-    let user = admin.device().authenticate_user(USER_PASSWORD).unwrap();
+    let user = unwrap_ok!(admin.device().authenticate_user(USER_PASSWORD));
     check_hotp_codes(&user, 0);
 
     assert_cmd_err!(CommandError::NotAuthorized, user.device().get_hotp_code(1));
@@ -106,10 +105,8 @@ fn hotp_slot_name(device: DeviceWrapper) {
     assert_ok!((), admin.write_hotp_slot(slot_data, 0));
 
     let device = admin.device();
-    let result = device.get_hotp_slot_name(1);
-    assert_eq!("test-hotp", result.unwrap());
-    let result = device.get_hotp_slot_name(4);
-    assert_lib_err!(LibraryError::InvalidSlot, result);
+    assert_ok!("test-hotp".to_string(), device.get_hotp_slot_name(1));
+    assert_lib_err!(LibraryError::InvalidSlot, device.get_hotp_slot_name(4));
 }
 
 #[test_device]
@@ -149,7 +146,7 @@ fn hotp_erase(device: DeviceWrapper) {
     let result = device.get_hotp_code(1);
     assert_cmd_err!(CommandError::SlotNotProgrammed, result);
 
-    assert_eq!("test2", device.get_hotp_slot_name(2).unwrap());
+    assert_ok!("test2".to_string(), device.get_hotp_slot_name(2));
 }
 
 fn configure_totp(admin: &ConfigureOtp, factor: u64) {
@@ -167,7 +164,7 @@ fn check_totp_codes(device: &GenerateOtp, factor: u64, timestamp_size: TotpTimes
         }
 
         assert_ok!((), device.set_time(time, true));
-        let code = device.get_totp_code(1).unwrap();
+        let code = unwrap_ok!(device.get_totp_code(1));
         assert!(
             code.contains(&code),
             "Generated TOTP code {} for {}, but expected one of {}",
@@ -221,7 +218,7 @@ fn totp_pin(device: DeviceWrapper) {
     assert_ok!((), admin.write_config(config));
 
     configure_totp(&admin, 1);
-    let user = admin.device().authenticate_user(USER_PASSWORD).unwrap();
+    let user = unwrap_ok!(admin.device().authenticate_user(USER_PASSWORD));
     check_totp_codes(&user, 1, TotpTimestampSize::U32);
 
     assert_cmd_err!(CommandError::NotAuthorized, user.device().get_totp_code(1));
@@ -235,7 +232,7 @@ fn totp_pin_64(device: Pro) {
     assert_ok!((), admin.write_config(config));
 
     configure_totp(&admin, 1);
-    let user = admin.device().authenticate_user(USER_PASSWORD).unwrap();
+    let user = unwrap_ok!(admin.device().authenticate_user(USER_PASSWORD));
     check_totp_codes(&user, 1, TotpTimestampSize::U64);
 
     assert_cmd_err!(CommandError::NotAuthorized, user.device().get_totp_code(1));
@@ -291,5 +288,5 @@ fn totp_erase(device: DeviceWrapper) {
     let result = device.get_totp_code(1);
     assert_cmd_err!(CommandError::SlotNotProgrammed, result);
 
-    assert_eq!("test2", device.get_totp_slot_name(2).unwrap());
+    assert_ok!("test2".to_string(), device.get_totp_slot_name(2));
 }
diff --git a/tests/pws.rs b/tests/pws.rs
index df99e1c..3ec7e38 100644
--- a/tests/pws.rs
+++ b/tests/pws.rs
@@ -37,7 +37,7 @@ fn get_pws<T>(device: &T) -> PasswordSafe
 where
     T: Device,
 {
-    device.get_password_safe(USER_PASSWORD).unwrap()
+    unwrap_ok!(device.get_password_safe(USER_PASSWORD))
 }
 
 #[test_device]
@@ -59,7 +59,7 @@ fn drop(device: DeviceWrapper) {
     {
         let pws = get_pws(&device);
         assert_ok!((), pws.write_slot(1, "name", "login", "password"));
-        assert_eq!("name", pws.get_slot_name(1).unwrap());
+        assert_ok!("name".to_string(), pws.get_slot_name(1));
         let result = get_slot_name_direct(1);
         assert_ok!(String::from("name"), result);
     }
@@ -76,11 +76,11 @@ fn get_status(device: DeviceWrapper) {
     for i in 0..SLOT_COUNT {
         assert_ok!((), pws.erase_slot(i));
     }
-    let status = pws.get_slot_status().unwrap();
+    let status = unwrap_ok!(pws.get_slot_status());
     assert_eq!(status, [false; SLOT_COUNT as usize]);
 
     assert_ok!((), pws.write_slot(1, "name", "login", "password"));
-    let status = pws.get_slot_status().unwrap();
+    let status = unwrap_ok!(pws.get_slot_status());
     for i in 0..SLOT_COUNT {
         assert_eq!(i == 1, status[i as usize]);
     }
@@ -88,17 +88,16 @@ fn get_status(device: DeviceWrapper) {
     for i in 0..SLOT_COUNT {
         assert_ok!((), pws.write_slot(i, "name", "login", "password"));
     }
-    let status = pws.get_slot_status().unwrap();
-    assert_eq!(status, [true; SLOT_COUNT as usize]);
+    assert_ok!([true; SLOT_COUNT as usize], pws.get_slot_status());
 }
 
 #[test_device]
 fn get_data(device: DeviceWrapper) {
     let pws = get_pws(&device);
     assert_ok!((), pws.write_slot(1, "name", "login", "password"));
-    assert_eq!("name", pws.get_slot_name(1).unwrap());
-    assert_eq!("login", pws.get_slot_login(1).unwrap());
-    assert_eq!("password", pws.get_slot_password(1).unwrap());
+    assert_ok!("name".to_string(), pws.get_slot_name(1));
+    assert_ok!("login".to_string(), pws.get_slot_login(1));
+    assert_ok!("password".to_string(), pws.get_slot_password(1));
 
     assert_ok!((), pws.erase_slot(1));
     assert_cmd_err!(CommandError::SlotNotProgrammed, pws.get_slot_name(1));
@@ -109,9 +108,9 @@ fn get_data(device: DeviceWrapper) {
     let login = "pär@test.com";
     let password = "'i3lJc[09?I:,[u7dWz9";
     assert_ok!((), pws.write_slot(1, name, login, password));
-    assert_eq!(name, pws.get_slot_name(1).unwrap());
-    assert_eq!(login, pws.get_slot_login(1).unwrap());
-    assert_eq!(password, pws.get_slot_password(1).unwrap());
+    assert_ok!(name.to_string(), pws.get_slot_name(1));
+    assert_ok!(login.to_string(), pws.get_slot_login(1));
+    assert_ok!(password.to_string(), pws.get_slot_password(1));
 
     assert_lib_err!(LibraryError::InvalidSlot, pws.get_slot_name(SLOT_COUNT));
     assert_lib_err!(LibraryError::InvalidSlot, pws.get_slot_login(SLOT_COUNT));
diff --git a/tests/util/mod.rs b/tests/util/mod.rs
index 49ec13e..2bda9ba 100644
--- a/tests/util/mod.rs
+++ b/tests/util/mod.rs
@@ -1,10 +1,27 @@
 // Copyright (C) 2018-2019 Robin Krahl <robin.krahl@ireas.org>
 // SPDX-License-Identifier: MIT
 
+#[allow(dead_code)]
 pub static ADMIN_PASSWORD: &str = "12345678";
+#[allow(dead_code)]
 pub static USER_PASSWORD: &str = "123456";
 
 #[macro_export]
+macro_rules! unwrap_ok {
+    ($val:expr) => {{
+        match $val {
+            Ok(val) => val,
+            Err(err) => panic!(
+                r#"assertion failed: `(left == right)`
+  left: `Ok(_)`,
+ right: `Err({:?})`"#,
+                err
+            ),
+        }
+    }};
+}
+
+#[macro_export]
 macro_rules! assert_ok {
     ($left:expr, $right:expr) => {{
         match &$right {