aboutsummaryrefslogtreecommitdiffstats
path: root/crates/atuin-scripts/src/store/script.rs
diff options
context:
space:
mode:
Diffstat (limited to 'crates/atuin-scripts/src/store/script.rs')
-rw-r--r--crates/atuin-scripts/src/store/script.rs151
1 files changed, 0 insertions, 151 deletions
diff --git a/crates/atuin-scripts/src/store/script.rs b/crates/atuin-scripts/src/store/script.rs
deleted file mode 100644
index af180320..00000000
--- a/crates/atuin-scripts/src/store/script.rs
+++ /dev/null
@@ -1,151 +0,0 @@
-use atuin_common::record::DecryptedData;
-use eyre::{Result, bail, ensure};
-use uuid::Uuid;
-
-use rmp::{
- decode::{self, Bytes},
- encode,
-};
-use typed_builder::TypedBuilder;
-
-pub const SCRIPT_VERSION: &str = "v0";
-pub const SCRIPT_TAG: &str = "script";
-pub const SCRIPT_LEN: usize = 20000; // 20kb max total len
-
-#[derive(Debug, Clone, PartialEq, Eq, TypedBuilder)]
-/// A script is a set of commands that can be run, with the specified shebang
-pub struct Script {
- /// The id of the script
- #[builder(default = uuid::Uuid::new_v4())]
- pub id: Uuid,
-
- /// The name of the script
- pub name: String,
-
- /// The description of the script
- #[builder(default = String::new())]
- pub description: String,
-
- /// The interpreter of the script
- #[builder(default = String::new())]
- pub shebang: String,
-
- /// The tags of the script
- #[builder(default = Vec::new())]
- pub tags: Vec<String>,
-
- /// The script content
- pub script: String,
-}
-
-impl Script {
- pub fn serialize(&self) -> Result<DecryptedData> {
- // sort the tags first, to ensure consistent ordering
- let mut tags = self.tags.clone();
- tags.sort();
-
- let mut output = vec![];
-
- encode::write_array_len(&mut output, 6)?;
- encode::write_str(&mut output, &self.id.to_string())?;
- encode::write_str(&mut output, &self.name)?;
- encode::write_str(&mut output, &self.description)?;
- encode::write_str(&mut output, &self.shebang)?;
- encode::write_array_len(&mut output, self.tags.len() as u32)?;
-
- for tag in &tags {
- encode::write_str(&mut output, tag)?;
- }
-
- encode::write_str(&mut output, &self.script)?;
-
- Ok(DecryptedData(output))
- }
-
- pub fn deserialize(bytes: &[u8]) -> Result<Self> {
- let mut bytes = decode::Bytes::new(bytes);
- let nfields = decode::read_array_len(&mut bytes).unwrap();
-
- ensure!(nfields == 6, "too many entries in v0 script record");
-
- let bytes = bytes.remaining_slice();
-
- let (id, bytes) = decode::read_str_from_slice(bytes).unwrap();
- let (name, bytes) = decode::read_str_from_slice(bytes).unwrap();
- let (description, bytes) = decode::read_str_from_slice(bytes).unwrap();
- let (shebang, bytes) = decode::read_str_from_slice(bytes).unwrap();
-
- let mut bytes = Bytes::new(bytes);
- let tags_len = decode::read_array_len(&mut bytes).unwrap();
-
- let mut bytes = bytes.remaining_slice();
-
- let mut tags = Vec::new();
- for _ in 0..tags_len {
- let (tag, remaining) = decode::read_str_from_slice(bytes).unwrap();
- tags.push(tag.to_owned());
- bytes = remaining;
- }
-
- let (script, bytes) = decode::read_str_from_slice(bytes).unwrap();
-
- if !bytes.is_empty() {
- bail!("trailing bytes in encoded script record. malformed")
- }
-
- Ok(Script {
- id: Uuid::parse_str(id).unwrap(),
- name: name.to_owned(),
- description: description.to_owned(),
- shebang: shebang.to_owned(),
- tags,
- script: script.to_owned(),
- })
- }
-}
-
-#[cfg(test)]
-mod tests {
- use super::*;
-
- #[test]
- fn test_serialize() {
- let script = Script {
- id: uuid::Uuid::parse_str("0195c825a35f7982bdb016168881cbc6").unwrap(),
- name: "test".to_string(),
- description: "test".to_string(),
- shebang: "test".to_string(),
- tags: vec!["test".to_string()],
- script: "test".to_string(),
- };
-
- let serialized = script.serialize().unwrap();
- assert_eq!(
- serialized.0,
- vec![
- 150, 217, 36, 48, 49, 57, 53, 99, 56, 50, 53, 45, 97, 51, 53, 102, 45, 55, 57, 56,
- 50, 45, 98, 100, 98, 48, 45, 49, 54, 49, 54, 56, 56, 56, 49, 99, 98, 99, 54, 164,
- 116, 101, 115, 116, 164, 116, 101, 115, 116, 164, 116, 101, 115, 116, 145, 164,
- 116, 101, 115, 116, 164, 116, 101, 115, 116
- ]
- );
- }
-
- #[test]
- fn test_serialize_deserialize() {
- let script = Script {
- id: uuid::Uuid::new_v4(),
- name: "test".to_string(),
- description: "test".to_string(),
- shebang: "test".to_string(),
- tags: vec!["test".to_string()],
- script: "test".to_string(),
- };
-
- let serialized = script.serialize().unwrap();
-
- let deserialized = Script::deserialize(&serialized.0).unwrap();
-
- assert_eq!(script, deserialized);
- }
-}