Version bump to v0.2.0

.woodpecker.yml

@@ -1,8 +1,10 @@
 pipeline:
-  test_build:
+  tests:
     image: rust:1.63
     commands:
-      - "cargo build"
+      - "apt update"
+      - "apt install -y lsof"
+      - "cargo test"
 
   build_release:
     image: rust:1.63
@@ -11,7 +13,7 @@ pipeline:
       - "cargo build --release"
       - "cargo deb"
       - "cargo generate-rpm"
-      - "mv target/release/adept target/release/adept-${CI_COMMIT_TAG}-linux-x86_64"
+      - "mv target/release/zealot target/release/zealot-${CI_COMMIT_TAG}-linux-x86_64"
     when:
       event: tag
 
@@ -23,8 +25,8 @@ pipeline:
       base_url: https://git.metaunix.net
       files:
         - "target/release/*${CI_COMMIT_TAG}-linux-x86_64"
-        - "target/debian/adept*.deb"
+        - "target/debian/zealot*.deb"
-        - "target/generate-rpm/adept*.rpm"
+        - "target/generate-rpm/zealot*.rpm"
       title: "${CI_COMMIT_TAG}"
     when:
       event: tag

Cargo.toml

@@ -1,13 +1,16 @@
 [package]
-name = "adept"
+name = "zealot"
 description = "Bit Goblin automated video transcoding service."
-version = "0.1.1"
+version = "0.2.0"
 edition = "2021"
 readme = "README.md"
 license = "BSD 2-Clause"
 authors = ["Gregory Ballantine <gballantine@bitgoblin.tech>"]
 
 [dependencies]
+config = { version = "0.13", features = ['toml'] }
+log = "0.4"
+log4rs = "1.1"
 toml = "0.5"
 serde = "1.0"
 serde_derive = "1.0"
@@ -19,21 +22,21 @@ maintainer-scripts = "build/scripts"
 depends = "ffmpeg (>= 4)"
 section = "video"
 assets = [
-	["target/release/adept", "usr/bin/adept", "755"],
+	["target/release/zealot", "usr/bin/zealot", "755"],
-	["build/etc/example.toml", "etc/adept/example.toml", "644"],
+	["build/etc/example.toml", "etc/zealot/example.toml", "644"],
-	["README.md", "usr/share/doc/adept/README", "644"]
+	["README.md", "usr/share/doc/zealot/README", "644"]
 ]
 [package.metadata.deb.systemd-units]
 unit-scripts = "build/debian/service"
-unit-name = "adept"
+unit-name = "zealot"
 enable = true
 start = true
 
 [package.metadata.generate-rpm]
 assets = [
-  { source = "target/release/adept", dest = "/usr/bin/adept", mode = "755" },
+  { source = "target/release/zealot", dest = "/usr/bin/zealot", mode = "755" },
-  { source = "build/etc/example.toml", dest = "/etc/adept/example.toml", mode = "755"},
+  { source = "build/etc/example.toml", dest = "/etc/zealot/example.toml", mode = "755"},
-  { source = "README.md", dest = "/usr/share/doc/adept/README", mode = "644"}
+  { source = "README.md", dest = "/usr/share/doc/zealot/README", mode = "644"}
 ]
 post_install_script = "build/scripts/postinst"
 [package.metadata.generate-rpm.requires]

README.md

@@ -1,3 +1,3 @@
-# adept
+# zealot
 
 Bit Goblin video transcoder service

build/debian/service/adept.service

@@ -1,10 +1,10 @@
 [Unit]
-Description=Adept video transcoder service
+Description=Zealot video transcoder service
 
 [Service]
-User=adept
+User=zealot
-Group=adept
+Group=zealot
-ExecStart=/usr/bin/adept
+ExecStart=/usr/bin/zealot
 SuccessExitStatus=143
 
 [Install]

build/etc/example.toml

@@ -1,6 +1,6 @@
 # This example transcodes footage to DNxHD 1080p60 for use in video editors like DaVinci Resolve.
 [transcoder]
-repository = "~/adept" # location of the videos to transcode
+repository = "~/zealot" # location of the videos to transcode
 interval = 15
 video_format = "mov" # video container format
 video_codec = "dnxhd" # video codec to use

build/scripts/postinst

@@ -1,25 +1,25 @@
 #!/bin/sh
 
-GETENT_USER=$(getent passwd adept)
+GETENT_USER=$(getent passwd zealot)
-GETENT_GROUP=$(getent group adept)
+GETENT_GROUP=$(getent group zealot)
 
-# Create the adept user if it doesn't already exist
+# Create the zealot user if it doesn't already exist
 if [ "$GETENT_USER" = "" ]; then
-	useradd -r adept
+	useradd -r zealot
 else
-	echo "The 'adept' user already exists, skipping creation."
+	echo "The 'zealot' user already exists, skipping creation."
 fi
 
-# Create the adept group if it doesn't already exist
+# Create the zealot group if it doesn't already exist
 if [ "$GETENT_GROUP" = "" ]; then
-	groupadd adept
+	groupadd zealot
-	usermod -aG adept adept
+	usermod -aG zealot zealot
 else
-	echo "The 'adept' group already exists, skipping creation."
+	echo "The 'zealot' group already exists, skipping creation."
 fi
 
 # Change the directory ownership of /etc
-chown -R adept:adept /etc/adept
+chown -R zealot:zealot /etc/zealot
 
 #DEBHELPER#
 

log4rs.yaml

@@ -0,0 +1,12 @@
+appenders:
+  stdout:
+    kind: console
+    encoder:
+      pattern: "{d(%+)(utc)} {h({l})}: {m}{n}"
+    filters:
+      - kind: threshold
+        level: info
+root:
+  level: info
+  appenders:
+    - stdout

src/config.rs

@@ -1,34 +0,0 @@
-use serde_derive::Deserialize;
-use std::fs;
-
-#[derive(Deserialize)]
-pub struct Config {
-  pub transcoder: Transcoder,
-}
-
-impl Config {
-  pub fn new(config_path: &str) -> Config {
-    let resolved_path = shellexpand::tilde(config_path);
-    let config_text = fs::read_to_string(&*resolved_path).unwrap();
-    let c: Config = toml::from_str(&config_text).unwrap();
-    return c;
-  }
-
-  pub fn get_repository(&self) -> String {
-    let resolved_path = shellexpand::tilde(&self.transcoder.repository);
-    return String::from(&*resolved_path);
-  }
-}
-
-#[derive(Deserialize)]
-pub struct Transcoder {
-  pub repository:       String,
-  pub interval:         u16,
-  pub video_format:     String,
-  pub video_codec:      String,
-  pub video_profile:    String,
-  pub video_resolution: String,
-  pub video_framerate:  u8,
-  pub video_color:      String,
-  pub audio_codec:      String,
-}

src/main.rs

@@ -1,15 +1,19 @@
+use log4rs;
 use config::Config;
-use repository::Repository;
+use transcoder::repository::Repository;
-use transcoder::Transcoder;
+use transcoder::transcoder::Transcoder;
 
-mod config;
+mod settings;
-mod repository;
 mod transcoder;
+mod util;
 
 fn main() {
+  // initialize the log4rs logger
+  log4rs::init_file("./log4rs.yaml", Default::default()).unwrap();
+
   // create and initialize our config and repository objects
-  let c: Config = Config::new("~/.config/adept.toml");
+  let c: Config = settings::load_config();
-  let r: Repository = Repository::new(&c.get_repository());
+  let r: Repository = Repository::new(&shellexpand::tilde(&c.get_string("transcoder.repository").unwrap()));
 
   // create and start the video transcoder object
   let t: Transcoder = Transcoder::new(c, r);

src/settings.rs

@@ -0,0 +1,12 @@
+use config::Config;
+
+pub fn load_config() -> Config {
+  let settings = Config::builder()
+    // Add in `./Settings.toml`
+    .add_source(config::File::with_name("/etc/zealot/config.toml").required(false))
+    .add_source(config::File::with_name(&shellexpand::tilde("~/.config/zealot.toml")).required(false))
+    .build()
+    .unwrap();
+
+  return settings;
+}

src/transcoder/mod.rs

@@ -0,0 +1,2 @@
+pub mod repository;
+pub mod transcoder;

src/transcoder/repository.rs

@@ -1,5 +1,6 @@
 use std::fs;
 use std::path::Path;
+use log::{error, info};
 
 pub struct Repository {
   pub base_dir: String,
@@ -53,10 +54,10 @@ impl Repository {
 
     match fs::copy(&ingest_file, &archive_file) {
       Ok(_) => {
-        println!("Archiving video file {}.", ingest_file.to_str().unwrap());
+        info!("Archiving video file {}.", ingest_file.to_str().unwrap());
       },
       Err(e) => {
-        eprintln!("Error archiving file {}: {}", ingest_file.to_str().unwrap(), e);
+        error!("Error archiving file {}: {}", ingest_file.to_str().unwrap(), e);
         std::process::exit(1);
       }
     }
@@ -72,14 +73,14 @@ impl Repository {
 fn create_directory(path: &str) {
   let d = Path::new(path);
   if d.is_dir() {
-    println!("Directory {} already exists.", path);
+    info!("Directory {} already exists.", path);
   } else {
     match fs::create_dir(path) {
       Ok(_) => {
-        println!("Creating directory {}.", path);
+        info!("Creating directory {}.", path);
       },
       Err(e) => {
-        eprintln!("Error creating {}: {}", path, e);
+        error!("Error creating {}: {}", path, e);
         std::process::exit(1);
       }
     }

src/transcoder/transcoder.rs

@@ -1,9 +1,11 @@
+use config::Config;
 use std::path::Path;
 use std::process;
 use std::{thread, time};
+use log::{info};
 
-use crate::config::Config;
+use crate::util::io;
-use crate::repository::Repository;
+use super::repository::Repository;
 
 pub struct Transcoder {
   config: Config,
@@ -19,7 +21,7 @@ impl Transcoder {
   }
 
   pub fn start(self) {
-    println!("Starting transcoder...");
+    info!("Starting transcoder...");
 
     loop {
       // search for files in ingest
@@ -27,9 +29,15 @@ impl Transcoder {
 
       // check if we found any files to transcode
       if ingest_files.len() < 1 {
-        println!("There were no files found in ingest to transcode; skipping run.");
+        info!("There were no files found in ingest to transcode; skipping run.");
       } else {
         for i in ingest_files {
+          let ingest_path = Path::new(&self.repository.ingest_dir).join(&i);
+          if io::is_file_locked(&ingest_path.to_str().unwrap()) {
+            info!("{} is currently open in another program; skipping it for this run.", &i);
+            continue;
+          }
+
           // copy the file to the archive
           self.repository.archive_file(&i);
 
@@ -42,7 +50,7 @@ impl Transcoder {
       }
 
       // put the loop to sleep for X minutes
-      let sleep_minutes = time::Duration::from_secs((self.config.transcoder.interval * 60).into());
+      let sleep_minutes = time::Duration::from_secs((self.config.get_int("transcoder.interval").unwrap() as u64 * 60).into());
       thread::sleep(sleep_minutes);
     }
   }
@@ -54,13 +62,13 @@ impl Transcoder {
     let cmd_output = process::Command::new("/usr/bin/ffmpeg")
       .arg("-i")        .arg(&*ingest_file.to_string_lossy())
       .arg("-y")
-      .arg("-f")        .arg(&self.config.transcoder.video_format)
+      .arg("-f")        .arg(&self.config.get_string("transcoder.video_format").unwrap())
-      .arg("-c:v")      .arg(&self.config.transcoder.video_codec)
+      .arg("-c:v")      .arg(&self.config.get_string("transcoder.video_codec").unwrap())
-      .arg("-s")        .arg(&self.config.transcoder.video_resolution)
+      .arg("-s")        .arg(&self.config.get_string("transcoder.video_resolution").unwrap())
-      .arg("-r")        .arg(format!("{}", self.config.transcoder.video_framerate))
+      .arg("-r")        .arg(format!("{}", self.config.get_string("transcoder.video_framerate").unwrap()))
-      .arg("-vf")       .arg(format!("format={}", &self.config.transcoder.video_color))
+      .arg("-vf")       .arg(format!("format={}", &self.config.get_string("transcoder.video_color").unwrap()))
-      .arg("-profile:v").arg(&self.config.transcoder.video_profile)
+      .arg("-profile:v").arg(&self.config.get_string("transcoder.video_profile").unwrap())
-      .arg("-c:a")      .arg(&self.config.transcoder.audio_codec)
+      .arg("-c:a")      .arg(&self.config.get_string("transcoder.audio_codec").unwrap())
       .arg(&*output_file.to_string_lossy())
       .output()
       .expect("Failed to execute command");
@@ -68,6 +76,6 @@ impl Transcoder {
     assert!(cmd_output.status.success());
 
     let results_raw = &String::from_utf8_lossy(&cmd_output.stderr);
-    println!("{}", results_raw);
+    info!("{}", results_raw);
   }
 }

src/util/io.rs

@@ -0,0 +1,61 @@
+use std::process;
+
+// checks whether a file is currently open in another program (e.g. still being written)
+pub fn is_file_locked(filepath: &str) -> bool {
+  let cmd = process::Command::new("/usr/bin/lsof")
+    .arg(filepath)
+    .output()
+    .expect("Failed to execute command");
+
+  let results = &String::from_utf8_lossy(&cmd.stdout);
+  println!("{}", results);
+  if results.contains(filepath) {
+    return true;
+  }
+
+  return false;
+}
+
+#[cfg(test)]
+mod tests {
+  use std::fs;
+  use std::mem::drop;
+  use std::path::Path;
+
+  use super::*;
+
+  #[test]
+  fn file_should_not_be_locked() {
+    setup("test-not-locked.txt");
+    assert!(!is_file_locked("test-not-locked.txt"));
+    teardown("test-not-locked.txt");
+  }
+
+  #[test]
+  fn file_should_be_locked() {
+    setup("test-locked.txt");
+    let path = Path::new("test-locked.txt");
+    match fs::File::open(&path) {
+      Err(e) => panic!("couldn't open {}: {}", "test-locked.txt", e),
+      Ok(_) => assert!(is_file_locked("test-locked.txt")),
+    };
+    teardown("test-locked.txt");
+  }
+
+  // get things ready for our tests
+  fn setup(test_file: &str) {
+    let f = match fs::File::create(test_file) {
+      Ok(file) => file,
+      Err(e) => panic!("{:?}", e),
+    };
+    drop(f);
+  }
+
+  // clean up after running tests
+  fn teardown(test_file: &str) {
+    match fs::remove_file(test_file) {
+      Ok(_) => {},
+      Err(e) => panic!("{:?}", e),
+    };
+  }
+}

src/util/mod.rs

@@ -0,0 +1 @@
+pub mod io;