Add test for securejoin source stats

Author: Hocuri

src/securejoin.rs

@@ -144,12 +144,7 @@ async fn get_self_fingerprint(context: &Context) -> Result<Fingerprint> {
 ///
 /// The function returns immediately and the handshake will run in background.
 pub async fn join_securejoin(context: &Context, qr: &str) -> Result<ChatId> {
-    securejoin(context, qr).await.map_err(|err| {
-        warn!(context, "Fatal joiner error: {:#}", err);
-        // The user just scanned this QR code so has context on what failed.
-        error!(context, "QR process failed");
-        err
-    })
+    join_securejoin_with_source(context, qr, None).await
 }
 
 /// Take a scanned QR-code and do the setup-contact/join-group/invite handshake.
@@ -163,7 +158,12 @@ pub async fn join_securejoin_with_source(
     qr: &str,
     source: Option<u32>,
 ) -> Result<ChatId> {
-    let res = join_securejoin(context, qr).await?;
+    let res = securejoin(context, qr).await.map_err(|err| {
+        warn!(context, "Fatal joiner error: {:#}", err);
+        // The user just scanned this QR code so has context on what failed.
+        error!(context, "QR process failed");
+        err
+    })?;
 
     self_reporting::count_securejoin_source(context, source)
         .await

src/self_reporting/self_reporting_tests.rs

@@ -1,7 +1,9 @@
 use super::*;
 use crate::chat::Chat;
 use crate::mimeparser::SystemMessage;
-use crate::test_utils::{get_chat_msg, TestContext, TestContextManager};
+use crate::securejoin::{get_securejoin_qr, join_securejoin, join_securejoin_with_source};
+use crate::test_utils::{TestContext, TestContextManager, get_chat_msg};
+use pretty_assertions::assert_eq;
 
 #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
 async fn test_send_self_report() -> Result<()> {
@@ -79,3 +81,73 @@ async fn test_self_report_one_contact() -> Result<()> {
 
     Ok(())
 }
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
+async fn test_self_report_securejoin_source_stats() -> Result<()> {
+    let mut tcm = TestContextManager::new();
+    let alice = &tcm.alice().await;
+    let bob = &tcm.bob().await;
+    alice.set_config_bool(Config::SelfReporting, true).await?;
+
+    let mut expected = SecurejoinSourceStats {
+        unknown: 0,
+        external_link: 0,
+        internal_link: 0,
+        clipboard: 0,
+        image_loaded: 0,
+        scan: 0,
+    };
+
+    check_securejoin_report(alice, &expected).await;
+
+    let qr = get_securejoin_qr(bob, None).await?;
+
+    join_securejoin(alice, &qr).await?;
+    expected.unknown += 1;
+    check_securejoin_report(alice, &expected).await;
+
+    join_securejoin(alice, &qr).await?;
+    expected.unknown += 1;
+    check_securejoin_report(alice, &expected).await;
+
+    join_securejoin_with_source(alice, &qr, Some(SecurejoinSource::Clipboard as u32)).await?;
+    expected.clipboard += 1;
+    check_securejoin_report(alice, &expected).await;
+
+    join_securejoin_with_source(alice, &qr, Some(SecurejoinSource::ExternalLink as u32)).await?;
+    expected.external_link += 1;
+    check_securejoin_report(alice, &expected).await;
+
+    join_securejoin_with_source(alice, &qr, Some(SecurejoinSource::InternalLink as u32)).await?;
+    expected.internal_link += 1;
+    check_securejoin_report(alice, &expected).await;
+
+    join_securejoin_with_source(alice, &qr, Some(SecurejoinSource::ImageLoaded as u32)).await?;
+    expected.image_loaded += 1;
+    check_securejoin_report(alice, &expected).await;
+
+    join_securejoin_with_source(alice, &qr, Some(SecurejoinSource::Scan as u32)).await?;
+    expected.scan += 1;
+    check_securejoin_report(alice, &expected).await;
+
+    join_securejoin_with_source(alice, &qr, Some(SecurejoinSource::Clipboard as u32)).await?;
+    expected.clipboard += 1;
+    check_securejoin_report(alice, &expected).await;
+
+    join_securejoin_with_source(alice, &qr, Some(SecurejoinSource::Clipboard as u32)).await?;
+    expected.clipboard += 1;
+    check_securejoin_report(alice, &expected).await;
+
+    Ok(())
+}
+
+async fn check_securejoin_report(context: &TestContext, expected: &SecurejoinSourceStats) {
+    let report = get_self_report(context).await.unwrap();
+    let actual: serde_json::Value = serde_json::from_str(&report).unwrap();
+    let actual = &actual["securejoin_source_stats"];
+
+    let expected = serde_json::to_string_pretty(&expected).unwrap();
+    let expected: serde_json::Value = serde_json::from_str(&expected).unwrap();
+
+    assert_eq!(&expected, actual);
+}