Add assert_cmd_err and assert_ok macros to tests

These macros allow easier comparisions using the new error type.  This
patch fixes all tests and updates nitrokey-test to 0.2.0 so that it
integrates with the new error structure.

Some tests may still fail until CommunicationError::NotConnected is
actually returned.

1 files changed, 74 insertions, 83 deletions

diff --git a/tests/device.rs b/tests/device.rs
index abede67..174624f 100644
--- a/tests/device.rs
+++ b/tests/device.rs
@@ -5,7 +5,7 @@ use std::process::Command;
 use std::{thread, time};
 
 use nitrokey::{
-    Authenticate, CommandError, Config, ConfigureOtp, Device, GenerateOtp, GetPasswordSafe,
+    Authenticate, CommandError, Config, ConfigureOtp, Device, Error, GenerateOtp, GetPasswordSafe,
     OtpMode, OtpSlotData, Storage, VolumeMode,
 };
 use nitrokey_test::test as test_device;
@@ -125,20 +125,20 @@ fn get_retry_count(device: DeviceWrapper) {
 fn config(device: DeviceWrapper) {
     let admin = device.authenticate_admin(ADMIN_PASSWORD).unwrap();
     let config = Config::new(None, None, None, true);
-    assert_eq!(Ok(()), admin.write_config(config));
+    assert_ok!((), admin.write_config(config));
     let get_config = admin.get_config().unwrap();
     assert_eq!(config, get_config);
 
     let config = Config::new(None, Some(9), None, true);
-    assert_eq!(Err(CommandError::InvalidSlot), admin.write_config(config));
+    assert_cmd_err!(CommandError::InvalidSlot, admin.write_config(config));
 
     let config = Config::new(Some(1), None, Some(0), false);
-    assert_eq!(Ok(()), admin.write_config(config));
+    assert_ok!((), admin.write_config(config));
     let get_config = admin.get_config().unwrap();
     assert_eq!(config, get_config);
 
     let config = Config::new(None, None, None, false);
-    assert_eq!(Ok(()), admin.write_config(config));
+    assert_ok!((), admin.write_config(config));
     let get_config = admin.get_config().unwrap();
     assert_eq!(config, get_config);
 }
@@ -159,7 +159,7 @@ fn change_user_pin(device: DeviceWrapper) {
         .device();
 
     let result = device.change_user_pin(USER_PASSWORD, USER_PASSWORD);
-    assert_eq!(Err(CommandError::WrongPassword), result);
+    assert_cmd_err!(CommandError::WrongPassword, result);
 
     assert!(device
         .change_user_pin(USER_NEW_PASSWORD, USER_PASSWORD)
@@ -184,8 +184,8 @@ fn change_admin_pin(device: DeviceWrapper) {
         .unwrap()
         .device();
 
-    assert_eq!(
-        Err(CommandError::WrongPassword),
+    assert_cmd_err!(
+        CommandError::WrongPassword,
         device.change_admin_pin(ADMIN_PASSWORD, ADMIN_PASSWORD)
     );
 
@@ -205,7 +205,10 @@ where
     let result = device.authenticate_user(password);
     assert!(result.is_err());
     let err = result.unwrap_err();
-    assert_eq!(error, err.1);
+    match err.1 {
+        Error::CommandError(err) => assert_eq!(error, err),
+        _ => assert!(false),
+    };
     err.0
 }
 
@@ -215,8 +218,8 @@ fn unlock_user_pin(device: DeviceWrapper) {
     assert!(device
         .unlock_user_pin(ADMIN_PASSWORD, USER_PASSWORD)
         .is_ok());
-    assert_eq!(
-        Err(CommandError::WrongPassword),
+    assert_cmd_err!(
+        CommandError::WrongPassword,
         device.unlock_user_pin(USER_PASSWORD, USER_PASSWORD)
     );
 
@@ -228,8 +231,8 @@ fn unlock_user_pin(device: DeviceWrapper) {
     let device = require_failed_user_login(device, USER_PASSWORD, CommandError::WrongPassword);
 
     // unblock with current PIN
-    assert_eq!(
-        Err(CommandError::WrongPassword),
+    assert_cmd_err!(
+        CommandError::WrongPassword,
         device.unlock_user_pin(USER_PASSWORD, USER_PASSWORD)
     );
     assert!(device
@@ -244,8 +247,8 @@ fn unlock_user_pin(device: DeviceWrapper) {
     let device = require_failed_user_login(device, USER_PASSWORD, CommandError::WrongPassword);
 
     // unblock with new PIN
-    assert_eq!(
-        Err(CommandError::WrongPassword),
+    assert_cmd_err!(
+        CommandError::WrongPassword,
         device.unlock_user_pin(USER_PASSWORD, USER_PASSWORD)
     );
     assert!(device
@@ -262,39 +265,33 @@ fn unlock_user_pin(device: DeviceWrapper) {
 fn factory_reset(device: DeviceWrapper) {
     let admin = device.authenticate_admin(ADMIN_PASSWORD).unwrap();
     let otp_data = OtpSlotData::new(1, "test", "0123468790", OtpMode::SixDigits);
-    assert_eq!(Ok(()), admin.write_totp_slot(otp_data, 30));
+    assert_ok!((), admin.write_totp_slot(otp_data, 30));
 
     let device = admin.device();
     let pws = device.get_password_safe(USER_PASSWORD).unwrap();
-    assert_eq!(Ok(()), pws.write_slot(0, "test", "testlogin", "testpw"));
+    assert_ok!((), pws.write_slot(0, "test", "testlogin", "testpw"));
     drop(pws);
 
-    assert_eq!(
-        Ok(()),
-        device.change_user_pin(USER_PASSWORD, USER_NEW_PASSWORD)
-    );
-    assert_eq!(
-        Ok(()),
+    assert_ok!((), device.change_user_pin(USER_PASSWORD, USER_NEW_PASSWORD));
+    assert_ok!(
+        (),
         device.change_admin_pin(ADMIN_PASSWORD, ADMIN_NEW_PASSWORD)
     );
 
-    assert_eq!(
-        Err(CommandError::WrongPassword),
+    assert_cmd_err!(
+        CommandError::WrongPassword,
         device.factory_reset(USER_NEW_PASSWORD)
     );
-    assert_eq!(
-        Err(CommandError::WrongPassword),
+    assert_cmd_err!(
+        CommandError::WrongPassword,
         device.factory_reset(ADMIN_PASSWORD)
     );
-    assert_eq!(Ok(()), device.factory_reset(ADMIN_NEW_PASSWORD));
+    assert_ok!((), device.factory_reset(ADMIN_NEW_PASSWORD));
 
     let device = device.authenticate_admin(ADMIN_PASSWORD).unwrap().device();
 
     let user = device.authenticate_user(USER_PASSWORD).unwrap();
-    assert_eq!(
-        Err(CommandError::SlotNotProgrammed),
-        user.get_totp_slot_name(1)
-    );
+    assert_cmd_err!(CommandError::SlotNotProgrammed, user.get_totp_slot_name(1));
 
     let device = user.device();
     let pws = device.get_password_safe(USER_PASSWORD).unwrap();
@@ -302,20 +299,20 @@ fn factory_reset(device: DeviceWrapper) {
     assert_ne!("testlogin".to_string(), pws.get_slot_login(0).unwrap());
     assert_ne!("testpw".to_string(), pws.get_slot_password(0).unwrap());
 
-    assert_eq!(Ok(()), device.build_aes_key(ADMIN_PASSWORD));
+    assert_ok!((), device.build_aes_key(ADMIN_PASSWORD));
 }
 
 #[test_device]
 fn build_aes_key(device: DeviceWrapper) {
     let pws = device.get_password_safe(USER_PASSWORD).unwrap();
-    assert_eq!(Ok(()), pws.write_slot(0, "test", "testlogin", "testpw"));
+    assert_ok!((), pws.write_slot(0, "test", "testlogin", "testpw"));
     drop(pws);
 
-    assert_eq!(
-        Err(CommandError::WrongPassword),
+    assert_cmd_err!(
+        CommandError::WrongPassword,
         device.build_aes_key(USER_PASSWORD)
     );
-    assert_eq!(Ok(()), device.build_aes_key(ADMIN_PASSWORD));
+    assert_ok!((), device.build_aes_key(ADMIN_PASSWORD));
 
     let device = device.authenticate_admin(ADMIN_PASSWORD).unwrap().device();
 
@@ -327,74 +324,71 @@ fn build_aes_key(device: DeviceWrapper) {
 
 #[test_device]
 fn change_update_pin(device: Storage) {
-    assert_eq!(
-        Err(CommandError::WrongPassword),
+    assert_cmd_err!(
+        CommandError::WrongPassword,
         device.change_update_pin(UPDATE_NEW_PIN, UPDATE_PIN)
     );
-    assert_eq!(Ok(()), device.change_update_pin(UPDATE_PIN, UPDATE_NEW_PIN));
-    assert_eq!(Ok(()), device.change_update_pin(UPDATE_NEW_PIN, UPDATE_PIN));
+    assert_ok!((), device.change_update_pin(UPDATE_PIN, UPDATE_NEW_PIN));
+    assert_ok!((), device.change_update_pin(UPDATE_NEW_PIN, UPDATE_PIN));
 }
 
 #[test_device]
 fn encrypted_volume(device: Storage) {
-    assert_eq!(Ok(()), device.lock());
+    assert_ok!((), device.lock());
 
     assert_eq!(1, count_nitrokey_block_devices());
-    assert_eq!(Ok(()), device.disable_encrypted_volume());
+    assert_ok!((), device.disable_encrypted_volume());
     assert_eq!(1, count_nitrokey_block_devices());
-    assert_eq!(
-        Err(CommandError::WrongPassword),
+    assert_cmd_err!(
+        CommandError::WrongPassword,
         device.enable_encrypted_volume("123")
     );
     assert_eq!(1, count_nitrokey_block_devices());
-    assert_eq!(Ok(()), device.enable_encrypted_volume(USER_PASSWORD));
+    assert_ok!((), device.enable_encrypted_volume(USER_PASSWORD));
     assert_eq!(2, count_nitrokey_block_devices());
-    assert_eq!(Ok(()), device.disable_encrypted_volume());
+    assert_ok!((), device.disable_encrypted_volume());
     assert_eq!(1, count_nitrokey_block_devices());
 }
 
 #[test_device]
 fn hidden_volume(device: Storage) {
-    assert_eq!(Ok(()), device.lock());
+    assert_ok!((), device.lock());
 
     assert_eq!(1, count_nitrokey_block_devices());
-    assert_eq!(Ok(()), device.disable_hidden_volume());
+    assert_ok!((), device.disable_hidden_volume());
     assert_eq!(1, count_nitrokey_block_devices());
 
-    assert_eq!(Ok(()), device.enable_encrypted_volume(USER_PASSWORD));
+    assert_ok!((), device.enable_encrypted_volume(USER_PASSWORD));
     assert_eq!(2, count_nitrokey_block_devices());
 
     // TODO: why this error code?
-    assert_eq!(
-        Err(CommandError::WrongPassword),
+    assert_cmd_err!(
+        CommandError::WrongPassword,
         device.create_hidden_volume(5, 0, 100, "hiddenpw")
     );
-    assert_eq!(Ok(()), device.create_hidden_volume(0, 20, 21, "hidden-pw"));
-    assert_eq!(
-        Ok(()),
-        device.create_hidden_volume(0, 20, 21, "hiddenpassword")
-    );
-    assert_eq!(Ok(()), device.create_hidden_volume(1, 0, 1, "otherpw"));
+    assert_ok!((), device.create_hidden_volume(0, 20, 21, "hidden-pw"));
+    assert_ok!((), device.create_hidden_volume(0, 20, 21, "hiddenpassword"));
+    assert_ok!((), device.create_hidden_volume(1, 0, 1, "otherpw"));
     // TODO: test invalid range (not handled by libnitrokey)
     assert_eq!(2, count_nitrokey_block_devices());
 
-    assert_eq!(
-        Err(CommandError::WrongPassword),
+    assert_cmd_err!(
+        CommandError::WrongPassword,
         device.enable_hidden_volume("blubb")
     );
-    assert_eq!(Ok(()), device.enable_hidden_volume("hiddenpassword"));
+    assert_ok!((), device.enable_hidden_volume("hiddenpassword"));
     assert_eq!(2, count_nitrokey_block_devices());
-    assert_eq!(Ok(()), device.enable_hidden_volume("otherpw"));
+    assert_ok!((), device.enable_hidden_volume("otherpw"));
     assert_eq!(2, count_nitrokey_block_devices());
 
-    assert_eq!(Ok(()), device.disable_hidden_volume());
+    assert_ok!((), device.disable_hidden_volume());
     assert_eq!(1, count_nitrokey_block_devices());
 }
 
 #[test_device]
 fn lock(device: Storage) {
-    assert_eq!(Ok(()), device.enable_encrypted_volume(USER_PASSWORD));
-    assert_eq!(Ok(()), device.lock());
+    assert_ok!((), device.enable_encrypted_volume(USER_PASSWORD));
+    assert_ok!((), device.lock());
     assert_eq!(1, count_nitrokey_block_devices());
 }
 
@@ -410,17 +404,14 @@ fn set_unencrypted_volume_mode(device: Storage) {
     }
 
     fn assert_success(device: &Storage, mode: VolumeMode) {
-        assert_eq!(
-            Ok(()),
-            device.set_unencrypted_volume_mode(ADMIN_PASSWORD, mode)
-        );
+        assert_ok!((), device.set_unencrypted_volume_mode(ADMIN_PASSWORD, mode));
         assert_mode(&device, mode);
     }
 
     assert_success(&device, VolumeMode::ReadOnly);
 
-    assert_eq!(
-        Err(CommandError::WrongPassword),
+    assert_cmd_err!(
+        CommandError::WrongPassword,
         device.set_unencrypted_volume_mode(USER_PASSWORD, VolumeMode::ReadOnly)
     );
     assert_mode(&device, VolumeMode::ReadOnly);
@@ -460,17 +451,17 @@ fn get_production_info(device: Storage) {
 
 #[test_device]
 fn clear_new_sd_card_warning(device: Storage) {
-    assert_eq!(Ok(()), device.factory_reset(ADMIN_PASSWORD));
+    assert_ok!((), device.factory_reset(ADMIN_PASSWORD));
     thread::sleep(time::Duration::from_secs(3));
-    assert_eq!(Ok(()), device.build_aes_key(ADMIN_PASSWORD));
+    assert_ok!((), device.build_aes_key(ADMIN_PASSWORD));
 
     // We have to perform an SD card operation to reset the new_sd_card_found field
-    assert_eq!(Ok(()), device.lock());
+    assert_ok!((), device.lock());
 
     let status = device.get_status().unwrap();
     assert!(status.new_sd_card_found);
 
-    assert_eq!(Ok(()), device.clear_new_sd_card_warning(ADMIN_PASSWORD));
+    assert_ok!((), device.clear_new_sd_card_warning(ADMIN_PASSWORD));
 
     let status = device.get_status().unwrap();
     assert!(!status.new_sd_card_found);
@@ -478,18 +469,18 @@ fn clear_new_sd_card_warning(device: Storage) {
 
 #[test_device]
 fn export_firmware(device: Storage) {
-    assert_eq!(
-        Err(CommandError::WrongPassword),
+    assert_cmd_err!(
+        CommandError::WrongPassword,
         device.export_firmware("someadminpn")
     );
-    assert_eq!(Ok(()), device.export_firmware(ADMIN_PASSWORD));
-    assert_eq!(
-        Ok(()),
+    assert_ok!((), device.export_firmware(ADMIN_PASSWORD));
+    assert_ok!(
+        (),
         device.set_unencrypted_volume_mode(ADMIN_PASSWORD, VolumeMode::ReadWrite)
     );
-    assert_eq!(Ok(()), device.export_firmware(ADMIN_PASSWORD));
-    assert_eq!(
-        Ok(()),
+    assert_ok!((), device.export_firmware(ADMIN_PASSWORD));
+    assert_ok!(
+        (),
         device.set_unencrypted_volume_mode(ADMIN_PASSWORD, VolumeMode::ReadOnly)
     );
 }