modelator 0.4.2

A framework and tools for model-based testing.
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

pub(crate) mod json_trace;
pub(crate) mod model_checker_stdout;
pub(crate) mod tla_config_file;
pub(crate) mod tla_file;
pub(crate) mod tla_file_suite;
pub(crate) mod tla_trace;

use crate::Error;
use std::path::{Path, PathBuf};
use std::str;

/// Try to write each artifact in any object implementing `into_iter` for Artifacts to the given directory
pub fn try_write_to_dir<'a, P: AsRef<Path>, C>(dir: P, collection: C) -> Result<(), Error>
where
    C: IntoIterator<Item = Box<&'a dyn ArtifactSaver>>,
{
    for artifact in collection {
        artifact.try_write_to_dir(dir.as_ref())?;
    }
    Ok(())
}

/// A sister trait for Artifacts for static constructor methods
/// NOTE: static methods and polymorphic methods prevent trait-object instantiation
/// so this approach allows dynamic use of Artifacts
pub trait ArtifactCreator
where
    Self: Sized,
{
    /// Create a new instance from a file content string.
    fn from_string(s: &str) -> Result<Self, Error>;

    /// Tries to read a file and initialize from the content.
    fn try_read_from_file<P: AsRef<Path>>(path: P) -> Result<Self, Error> {
        let file_content = crate::util::try_read_file_contents(path)?;
        Self::from_string(&file_content)
    }
}

/// A wrapper around a file
/// NOTE: for now this is bare-bones but it will eventually include additional meta-data
/// which will justify the additional interface.
pub trait Artifact {
    /// Returns a string representation.
    fn as_string(&self) -> String;

    /// Tries to write the contents to path using the result of `as_string`.
    fn try_write_to_file(&self, path: &Path) -> Result<(), Error> {
        Ok(std::fs::write(path, self.as_string())?)
    }
}

/// An artifact which is a file
/// It can be saved in a directory, as it has its own filename
pub trait ArtifactSaver: Artifact {
    /// Returns filename
    fn filename(&self) -> String;

    /// Tries to save the contents to directory using the file name
    fn try_write_to_dir(&self, path: &Path) -> Result<PathBuf, Error> {
        let full_path = path.join(self.filename());
        std::fs::write(&full_path, self.as_string())?;
        Ok(full_path)
    }
}

// Re-exports.
pub use json_trace::JsonTrace;
pub use model_checker_stdout::ModelCheckerStdout;
pub use tla_config_file::TlaConfigFile;
pub use tla_file::TlaFile;
pub use tla_file_suite::TlaFileSuite;
pub use tla_trace::TlaTrace;