From 711618b42c6ec585968aa408d2640dafb4a13bba Mon Sep 17 00:00:00 2001 From: naskya Date: Mon, 6 May 2024 05:16:49 +0900 Subject: [PATCH] test (backend-rs): add tests for nodeinfo (de)serialization --- .../backend-rs/src/service/nodeinfo/schema.rs | 86 ++++++++++++++++--- 1 file changed, 76 insertions(+), 10 deletions(-) diff --git a/packages/backend-rs/src/service/nodeinfo/schema.rs b/packages/backend-rs/src/service/nodeinfo/schema.rs index 51f2ebf687..ae7b5a52c2 100644 --- a/packages/backend-rs/src/service/nodeinfo/schema.rs +++ b/packages/backend-rs/src/service/nodeinfo/schema.rs @@ -6,7 +6,7 @@ use std::collections::HashMap; // - #[serde(tag = "version", rename = "2.1")] (https://github.com/3Hren/msgpack-rust/issues/318) /// NodeInfo schema version 2.1. https://nodeinfo.diaspora.software/docson/index.html#/ns/schema/2.1 -#[derive(Deserialize, Serialize, Debug)] +#[derive(Deserialize, Serialize, Debug, PartialEq)] #[serde(rename_all = "camelCase")] pub struct Nodeinfo21 { /// The schema version, must be 2.1. @@ -26,7 +26,7 @@ pub struct Nodeinfo21 { } /// NodeInfo schema version 2.0. https://nodeinfo.diaspora.software/docson/index.html#/ns/schema/2.0 -#[derive(Deserialize, Serialize, Debug)] +#[derive(Deserialize, Serialize, Debug, PartialEq)] #[serde(rename_all = "camelCase")] pub struct Nodeinfo20 { /// The schema version, must be 2.0. @@ -46,7 +46,7 @@ pub struct Nodeinfo20 { } /// Metadata about server software in use (version 2.1). -#[derive(Deserialize, Serialize, Debug)] +#[derive(Deserialize, Serialize, Debug, PartialEq)] #[serde(rename_all = "camelCase")] pub struct Software21 { /// The canonical name of this server software. @@ -60,7 +60,7 @@ pub struct Software21 { } /// Metadata about server software in use (version 2.0). -#[derive(Deserialize, Serialize, Debug)] +#[derive(Deserialize, Serialize, Debug, PartialEq)] #[serde(rename_all = "camelCase")] pub struct Software20 { /// The canonical name of this server software. @@ -69,7 +69,7 @@ pub struct Software20 { pub version: String, } -#[derive(Deserialize, Serialize, Debug)] +#[derive(Deserialize, Serialize, Debug, PartialEq)] #[serde(rename_all = "lowercase")] pub enum Protocol { Activitypub, @@ -85,7 +85,7 @@ pub enum Protocol { } /// The third party sites this server can connect to via their application API. -#[derive(Deserialize, Serialize, Debug)] +#[derive(Deserialize, Serialize, Debug, PartialEq)] #[serde(rename_all = "camelCase")] pub struct Services { /// The third party sites this server can retrieve messages from for combined display with regular traffic. @@ -95,7 +95,7 @@ pub struct Services { } /// The third party sites this server can retrieve messages from for combined display with regular traffic. -#[derive(Deserialize, Serialize, Debug)] +#[derive(Deserialize, Serialize, Debug, PartialEq)] #[serde(rename_all = "lowercase")] pub enum Inbound { #[serde(rename = "atom1.0")] @@ -112,7 +112,7 @@ pub enum Inbound { } /// The third party sites this server can publish messages to on the behalf of a user. -#[derive(Deserialize, Serialize, Debug)] +#[derive(Deserialize, Serialize, Debug, PartialEq)] #[serde(rename_all = "lowercase")] pub enum Outbound { #[serde(rename = "atom1.0")] @@ -148,7 +148,7 @@ pub enum Outbound { } /// Usage statistics for this server. -#[derive(Deserialize, Serialize, Debug)] +#[derive(Deserialize, Serialize, Debug, PartialEq)] #[serde(rename_all = "camelCase")] pub struct Usage { pub users: Users, @@ -157,7 +157,7 @@ pub struct Usage { } /// statistics about the users of this server. -#[derive(Deserialize, Serialize, Debug)] +#[derive(Deserialize, Serialize, Debug, PartialEq)] #[serde(rename_all = "camelCase")] pub struct Users { pub total: Option, @@ -187,3 +187,69 @@ impl From for Nodeinfo20 { } } } + +#[cfg(test)] +mod unit_test { + use super::{Nodeinfo20, Nodeinfo21}; + use pretty_assertions::assert_eq; + + #[test] + fn parse_nodeinfo_2_0() { + let json_str_1 = r#"{"version":"2.0","software":{"name":"mastodon","version":"4.3.0-nightly.2024-04-30"},"protocols":["activitypub"],"services":{"outbound":[],"inbound":[]},"usage":{"users":{"total":1935016,"activeMonth":238223,"activeHalfyear":618795},"localPosts":90175135},"openRegistrations":true,"metadata":{"nodeName":"Mastodon","nodeDescription":"The original server operated by the Mastodon gGmbH non-profit"}}"#; + let parsed_1: Nodeinfo20 = serde_json::from_str(json_str_1).unwrap(); + let serialized_1 = serde_json::to_string(&parsed_1).unwrap(); + let reparsed_1: Nodeinfo20 = serde_json::from_str(&serialized_1).unwrap(); + + assert_eq!(parsed_1, reparsed_1); + assert_eq!(parsed_1.software.name, "mastodon"); + assert_eq!(parsed_1.software.version, "4.3.0-nightly.2024-04-30"); + + let json_str_2 = r#"{"version":"2.0","software":{"name":"peertube","version":"5.0.0"},"protocols":["activitypub"],"services":{"inbound":[],"outbound":["atom1.0","rss2.0"]},"openRegistrations":false,"usage":{"users":{"total":5,"activeMonth":0,"activeHalfyear":2},"localPosts":1018,"localComments":1},"metadata":{"taxonomy":{"postsName":"Videos"},"nodeName":"Blender Video","nodeDescription":"Blender Foundation PeerTube instance.","nodeConfig":{"search":{"remoteUri":{"users":true,"anonymous":false}},"plugin":{"registered":[]},"theme":{"registered":[],"default":"default"},"email":{"enabled":false},"contactForm":{"enabled":true},"transcoding":{"hls":{"enabled":true},"webtorrent":{"enabled":true},"enabledResolutions":[1080]},"live":{"enabled":false,"transcoding":{"enabled":true,"enabledResolutions":[]}},"import":{"videos":{"http":{"enabled":true},"torrent":{"enabled":false}}},"autoBlacklist":{"videos":{"ofUsers":{"enabled":false}}},"avatar":{"file":{"size":{"max":4194304},"extensions":[".png",".jpeg",".jpg",".gif",".webp"]}},"video":{"image":{"extensions":[".png",".jpg",".jpeg",".webp"],"size":{"max":4194304}},"file":{"extensions":[".webm",".ogv",".ogg",".mp4",".mkv",".mov",".qt",".mqv",".m4v",".flv",".f4v",".wmv",".avi",".3gp",".3gpp",".3g2",".3gpp2",".nut",".mts",".m2ts",".mpv",".m2v",".m1v",".mpg",".mpe",".mpeg",".vob",".mxf",".mp3",".wma",".wav",".flac",".aac",".m4a",".ac3"]}},"videoCaption":{"file":{"size":{"max":20971520},"extensions":[".vtt",".srt"]}},"user":{"videoQuota":5368709120,"videoQuotaDaily":-1},"trending":{"videos":{"intervalDays":7}},"tracker":{"enabled":true}}}}"#; + let parsed_2: Nodeinfo20 = serde_json::from_str(json_str_2).unwrap(); + let serialized_2 = serde_json::to_string(&parsed_2).unwrap(); + let reparsed_2: Nodeinfo20 = serde_json::from_str(&serialized_2).unwrap(); + + assert_eq!(parsed_2, reparsed_2); + assert_eq!(parsed_2.software.name, "peertube"); + assert_eq!(parsed_2.software.version, "5.0.0"); + + let json_str_3 = r#"{"metadata":{"nodeName":"pixelfed","software":{"homepage":"https://pixelfed.org","repo":"https://github.com/pixelfed/pixelfed"},"config":{"features":{"timelines":{"local":true,"network":true},"mobile_apis":true,"stories":true,"video":true,"import":{"instagram":false,"mastodon":false,"pixelfed":false},"label":{"covid":{"enabled":false,"org":"visit the WHO website","url":"https://www.who.int/emergencies/diseases/novel-coronavirus-2019/advice-for-public"}},"hls":{"enabled":false}}}},"protocols":["activitypub"],"services":{"inbound":[],"outbound":[]},"software":{"name":"pixelfed","version":"0.12.0"},"usage":{"localPosts":24059868,"localComments":0,"users":{"total":112832,"activeHalfyear":24366,"activeMonth":8921}},"version":"2.0","openRegistrations":true}"#; + let parsed_3: Nodeinfo20 = serde_json::from_str(json_str_3).unwrap(); + let serialized_3 = serde_json::to_string(&parsed_3).unwrap(); + let reparsed_3: Nodeinfo20 = serde_json::from_str(&serialized_3).unwrap(); + + assert_eq!(parsed_3, reparsed_3); + assert_eq!(parsed_3.software.name, "pixelfed"); + assert_eq!(parsed_3.software.version, "0.12.0"); + } + + #[test] + fn parse_nodeinfo_2_1() { + let json_str_1 = r##"{"version":"2.1","software":{"name":"catodon","version":"24.04-dev.2","repository":"https://codeberg.org/catodon/catodon","homepage":"https://codeberg.org/catodon/catodon"},"protocols":["activitypub"],"services":{"inbound":[],"outbound":["atom1.0","rss2.0"]},"openRegistrations":true,"usage":{"users":{"total":294,"activeHalfyear":292,"activeMonth":139},"localPosts":22616,"localComments":0},"metadata":{"nodeName":"Catodon Social","nodeDescription":"🌎 Home of Catodon, a new platform for fedi communities, initially based on Iceshrimp/Firefish/Misskey. Be aware that our first release is not out yet, so things are still experimental.","maintainer":{"name":"admin","email":"redacted@example.com"},"langs":[],"tosUrl":"https://example.com/redacted","repositoryUrl":"https://codeberg.org/catodon/catodon","feedbackUrl":"https://codeberg.org/catodon/catodon/issues","disableRegistration":false,"disableLocalTimeline":false,"disableRecommendedTimeline":true,"disableGlobalTimeline":false,"emailRequiredForSignup":true,"postEditing":true,"postImports":false,"enableHcaptcha":true,"enableRecaptcha":false,"maxNoteTextLength":8000,"maxCaptionTextLength":1500,"enableGithubIntegration":false,"enableDiscordIntegration":false,"enableEmail":true,"themeColor":"#31748f"}}"##; + let parsed_1: Nodeinfo21 = serde_json::from_str(json_str_1).unwrap(); + let serialized_1 = serde_json::to_string(&parsed_1).unwrap(); + let reparsed_1: Nodeinfo21 = serde_json::from_str(&serialized_1).unwrap(); + + assert_eq!(parsed_1, reparsed_1); + assert_eq!(parsed_1.software.name, "catodon"); + assert_eq!(parsed_1.software.version, "24.04-dev.2"); + + let json_str_2 = r#"{"version":"2.1","software":{"name":"meisskey","version":"10.102.699-m544","repository":"https://github.com/mei23/misskey"},"protocols":["activitypub"],"services":{"inbound":[],"outbound":["atom1.0","rss2.0"]},"openRegistrations":true,"usage":{"users":{"total":1123,"activeHalfyear":305,"activeMonth":89},"localPosts":268739,"localComments":0},"metadata":{"nodeName":"meisskey.one","nodeDescription":"ローカルタイムラインのないインスタンスなのだわ\n\n\n[通報・報告 (Report)](https://example.com/redacted)","name":"meisskey.one","description":"ローカルタイムラインのないインスタンスなのだわ\n\n\n[通報・報告 (Report)](https://example.com/redacted)","maintainer":{"name":"redacted","email":"redacted"},"langs":[],"announcements":[{"title":"問題・要望など","text":"問題・要望などは #meisskeyone要望 で投稿してなのだわ"}],"relayActor":"https://example.com/redacted","relays":[],"disableRegistration":false,"disableLocalTimeline":true,"enableRecaptcha":true,"maxNoteTextLength":5000,"enableTwitterIntegration":false,"enableGithubIntegration":false,"enableDiscordIntegration":false,"enableServiceWorker":true,"proxyAccountName":"ghost"}}"#; + let parsed_2: Nodeinfo21 = serde_json::from_str(json_str_2).unwrap(); + let serialized_2 = serde_json::to_string(&parsed_2).unwrap(); + let reparsed_2: Nodeinfo21 = serde_json::from_str(&serialized_2).unwrap(); + + assert_eq!(parsed_2, reparsed_2); + assert_eq!(parsed_2.software.name, "meisskey"); + assert_eq!(parsed_2.software.version, "10.102.699-m544"); + + let json_str_3 = r##"{"metadata":{"enableGlobalTimeline":true,"enableGuestTimeline":false,"enableLocalTimeline":true,"enableRecommendedTimeline":false,"maintainerEmail":"","maintainerName":"Firefish dev team","nodeDescription":"","nodeName":"Firefish","repositoryUrl":"https://firefish.dev/firefish/firefish","themeColor":"#F25A85"},"openRegistrations":false,"protocols":["activitypub"],"services":{"inbound":[],"outbound":["atom1.0","rss2.0"]},"software":{"homepage":"https://firefish.dev/firefish/firefish","name":"firefish","repository":"https://firefish.dev/firefish/firefish","version":"20240504"},"usage":{"localPosts":23857,"users":{"activeHalfyear":7,"activeMonth":7,"total":9}},"version":"2.1"}"##; + let parsed_3: Nodeinfo20 = serde_json::from_str(json_str_3).unwrap(); + let serialized_3 = serde_json::to_string(&parsed_3).unwrap(); + let reparsed_3: Nodeinfo20 = serde_json::from_str(&serialized_3).unwrap(); + + assert_eq!(parsed_3, reparsed_3); + assert_eq!(parsed_3.software.name, "firefish"); + assert_eq!(parsed_3.software.version, "20240504"); + } +}