Merge pull request #114 from Synicix/test_split

Splitting test into unit and integration tests to match with Rust testing standards

Author: eywalker

.vscode/settings.json

@@ -11,10 +11,6 @@
     "files.insertFinalNewline": true,
     "gitlens.showWhatsNewAfterUpgrades": false,
     "lldb.consoleMode": "evaluate",
-    "rust-analyzer.cargo.features": [
-        "test"
-    ],
-    "rust-analyzer.cargo.noDefaultFeatures": true,
     "rust-analyzer.check.command": "clippy",
     "rust-analyzer.runnables.extraTestBinaryArgs": [
         "--nocapture"

notebook.ipynb

@@ -0,0 +1,65 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "3ba2aae6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import orcapod as op"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4d867643",
+   "metadata": {},
+   "outputs": [
+    {
+     "ename": "TypeError",
+     "evalue": "Pipeline.__init__() missing 4 required positional arguments: 'graph_dot', 'metadata', 'input_spec', and 'output_spec'",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
+      "\u001b[0;31mTypeError\u001b[0m                                 Traceback (most recent call last)",
+      "Cell \u001b[0;32mIn[3], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m \u001b[43mop\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mPipeline\u001b[49m\u001b[43m(\u001b[49m\u001b[43m)\u001b[49m\n",
+      "\u001b[0;31mTypeError\u001b[0m: Pipeline.__init__() missing 4 required positional arguments: 'graph_dot', 'metadata', 'input_spec', and 'output_spec'"
+     ]
+    }
+   ],
+   "source": [
+    "op.Pipeline()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "7626744f",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "orcapod",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.18"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

src/core/crypto.rs

@@ -108,3 +108,43 @@ pub fn make_random_hash() -> String {
     rand::rng().fill_bytes(&mut bytes);
     hex::encode(bytes)
 }
+
+#[cfg(test)]
+mod tests {
+    #![expect(clippy::panic_in_result_fn, reason = "OK in tests.")]
+    use crate::{
+        core::crypto::{hash_buffer, hash_dir, hash_file},
+        uniffi::error::Result,
+    };
+    use std::fs::read;
+
+    #[test]
+    fn consistent_hash() -> Result<()> {
+        let filepath = "./tests/extra/data/images/subject.jpeg";
+        assert_eq!(
+            hash_file(filepath)?,
+            hash_buffer(&read(filepath)?),
+            "Checksum not consistent."
+        );
+        Ok(())
+    }
+
+    #[test]
+    fn complex_hash() -> Result<()> {
+        let dirpath = "./tests/extra/data/images";
+        assert_eq!(
+            hash_dir(dirpath)?,
+            "6c96a478ea25e34fab045bc82858a2980b2cfb22db32e83c01349a8e7ed3b42c".to_owned(),
+            "Directory checksum didn't match."
+        );
+        Ok(())
+    }
+
+    #[test]
+    fn internal_invalid_filepath() {
+        assert!(
+            hash_file("nonexistent_file.txt").is_err(),
+            "Did not raise an invalid filepath error."
+        );
+    }
+}

src/core/mod.rs

@@ -1,41 +1,14 @@
-macro_rules! inner_attr_to_each {
-    { #!$attr:tt $($it:item)* } => {
-        $(
-            #$attr
-            $it
-        )*
-    }
-}
-
 pub(crate) mod error;
 pub(crate) mod graph;
 pub(crate) mod store;
 pub(crate) mod util;
 pub(crate) mod validation;
 
-inner_attr_to_each! {
-    #![cfg(feature = "default")]
-    pub(crate) mod crypto;
-    pub(crate) mod model;
-    pub(crate) mod operator;
-    pub(crate) mod orchestrator;
-    pub(crate) mod pipeline_runner;
-}
+pub(crate) mod crypto;
+/// Model definition for orcapod
+pub mod model;
+pub(crate) mod operator;
+pub(crate) mod orchestrator;
 
-#[cfg(feature = "test")]
-inner_attr_to_each! {
-    #![cfg_attr(
-        feature = "test",
-        allow(
-            missing_docs,
-            clippy::missing_errors_doc,
-            clippy::missing_panics_doc,
-            reason = "Documentation not necessary since private API.",
-        ),
-    )]
-    pub mod crypto;
-    pub mod model;
-    pub mod orchestrator;
-    pub mod pipeline_runner;
-    pub mod operator;
-}
+/// Pipeline runner module
+pub mod pipeline_runner;

src/core/model/mod.rs

@@ -32,7 +32,7 @@ pub fn to_yaml<T: Serialize>(instance: &T) -> Result<String> {
     Ok(yaml)
 }
 
-pub fn serialize_hashmap<S, K: Ord + Serialize, V: Serialize, BH: BuildHasher>(
+pub(crate) fn serialize_hashmap<S, K: Ord + Serialize, V: Serialize, BH: BuildHasher>(
     map: &HashMap<K, V, BH>,
     serializer: S,
 ) -> result::Result<S::Ok, S::Error>
@@ -44,7 +44,7 @@ where
 }
 
 #[allow(clippy::ref_option, reason = "Serde requires this signature.")]
-pub fn serialize_hashmap_option<S, K: Ord + Serialize, V: Serialize, BH: BuildHasher>(
+pub(crate) fn serialize_hashmap_option<S, K: Ord + Serialize, V: Serialize, BH: BuildHasher>(
     map_option: &Option<HashMap<K, V, BH>>,
     serializer: S,
 ) -> result::Result<S::Ok, S::Error>
@@ -57,5 +57,5 @@ where
     sorted.serialize(serializer)
 }
 
-pub mod pipeline;
-pub mod pod;
+pub(crate) mod pipeline;
+pub(crate) mod pod;