xtalforge-modules 1.5.0

Module registry, run records and on-disk workspace for xtalforge.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

//! Test stub module (Task 5.10.5).
//!
//! A module that does nothing, so the registry, the parameter forms of front
//! ends, cancellation and run folders can be exercised without a real
//! calculation.

use serde_json::json;
use xtalforge_core::Error;

use crate::registry::{Module, ModuleInfo};

/// The stub module implementation.
#[derive(Debug, Clone, Copy, Default)]
pub struct TestModule;

impl Module for TestModule {
    fn info(&self) -> ModuleInfo {
        ModuleInfo {
            name: "test".to_owned(),
            description: "Stub module that reports availability and does nothing.".to_owned(),
            version: env!("CARGO_PKG_VERSION").to_owned(),
            parameters: Vec::new(),
        }
    }

    fn available(&self) -> bool {
        true
    }

    fn run(&self, _parameters: &serde_json::Value) -> Result<serde_json::Value, Error> {
        Ok(json!({
            "ok": true,
            "module": "test",
            "message": "test module ran",
        }))
    }
}

/// Creates the stub module for registration and surface tests.
#[must_use]
pub fn test_module() -> Box<dyn Module> {
    Box::new(TestModule)
}