7 Commits

Author SHA1 Message Date
cab06fc350 Changed project named from adept to zealot
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2022-09-02 02:04:07 -04:00
e6417cf5a3 Updated woodpecker config to run cargo tests 2022-09-01 23:49:12 -04:00
7d5e1514a1 Version bump to v0.1.3
All checks were successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2022-09-01 23:44:59 -04:00
cd886522ec Added unit tests for the file locking function 2022-09-01 23:44:37 -04:00
44ef95b440 Added a basic check to make sure we don't try to transcode a partially written file 2022-09-01 22:15:46 -04:00
b5d96c21a9 Version bump to v0.1.2 2022-09-01 18:25:18 -04:00
70e2b29121 Added logging functionality via log4rs crate
All checks were successful
ci/woodpecker/tag/woodpecker Pipeline was successful
2022-09-01 16:16:27 -04:00
13 changed files with 134 additions and 43 deletions

View File

@ -1,8 +1,8 @@
pipeline: pipeline:
test_build: tests:
image: rust:1.63 image: rust:1.63
commands: commands:
- "cargo build" - "cargo test"
build_release: build_release:
image: rust:1.63 image: rust:1.63
@ -11,7 +11,7 @@ pipeline:
- "cargo build --release" - "cargo build --release"
- "cargo deb" - "cargo deb"
- "cargo generate-rpm" - "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: when:
event: tag event: tag
@ -23,8 +23,8 @@ pipeline:
base_url: https://git.metaunix.net base_url: https://git.metaunix.net
files: files:
- "target/release/*${CI_COMMIT_TAG}-linux-x86_64" - "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}" title: "${CI_COMMIT_TAG}"
when: when:
event: tag event: tag

View File

@ -1,13 +1,15 @@
[package] [package]
name = "adept" name = "zealot"
description = "Bit Goblin automated video transcoding service." description = "Bit Goblin automated video transcoding service."
version = "0.1.1" version = "0.1.3"
edition = "2021" edition = "2021"
readme = "README.md" readme = "README.md"
license = "BSD 2-Clause" license = "BSD 2-Clause"
authors = ["Gregory Ballantine <gballantine@bitgoblin.tech>"] authors = ["Gregory Ballantine <gballantine@bitgoblin.tech>"]
[dependencies] [dependencies]
log = "0.4"
log4rs = "1.1"
toml = "0.5" toml = "0.5"
serde = "1.0" serde = "1.0"
serde_derive = "1.0" serde_derive = "1.0"
@ -19,21 +21,21 @@ maintainer-scripts = "build/scripts"
depends = "ffmpeg (>= 4)" depends = "ffmpeg (>= 4)"
section = "video" section = "video"
assets = [ 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] [package.metadata.deb.systemd-units]
unit-scripts = "build/debian/service" unit-scripts = "build/debian/service"
unit-name = "adept" unit-name = "zealot"
enable = true enable = true
start = true start = true
[package.metadata.generate-rpm] [package.metadata.generate-rpm]
assets = [ 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" post_install_script = "build/scripts/postinst"
[package.metadata.generate-rpm.requires] [package.metadata.generate-rpm.requires]

View File

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

View File

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

View File

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

View File

@ -1,25 +1,25 @@
#!/bin/sh #!/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 if [ "$GETENT_USER" = "" ]; then
useradd -r adept useradd -r zealot
else else
echo "The 'adept' user already exists, skipping creation." echo "The 'zealot' user already exists, skipping creation."
fi 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 if [ "$GETENT_GROUP" = "" ]; then
groupadd adept groupadd zealot
usermod -aG adept adept usermod -aG zealot zealot
else else
echo "The 'adept' group already exists, skipping creation." echo "The 'zealot' group already exists, skipping creation."
fi fi
# Change the directory ownership of /etc # Change the directory ownership of /etc
chown -R adept:adept /etc/adept chown -R zealot:zealot /etc/zealot
#DEBHELPER# #DEBHELPER#

12
log4rs.yaml Normal file
View File

@ -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

View File

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

2
src/transcoder/mod.rs Normal file
View File

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

View File

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

View File

@ -1,9 +1,11 @@
use std::path::Path; use std::path::Path;
use std::process; use std::process;
use std::{thread, time}; use std::{thread, time};
use log::{info};
use crate::config::Config; use crate::config::Config;
use crate::repository::Repository; use crate::util::io;
use super::repository::Repository;
pub struct Transcoder { pub struct Transcoder {
config: Config, config: Config,
@ -19,7 +21,7 @@ impl Transcoder {
} }
pub fn start(self) { pub fn start(self) {
println!("Starting transcoder..."); info!("Starting transcoder...");
loop { loop {
// search for files in ingest // search for files in ingest
@ -27,9 +29,15 @@ impl Transcoder {
// check if we found any files to transcode // check if we found any files to transcode
if ingest_files.len() < 1 { 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 { } else {
for i in ingest_files { 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 // copy the file to the archive
self.repository.archive_file(&i); self.repository.archive_file(&i);
@ -68,6 +76,6 @@ impl Transcoder {
assert!(cmd_output.status.success()); assert!(cmd_output.status.success());
let results_raw = &String::from_utf8_lossy(&cmd_output.stderr); let results_raw = &String::from_utf8_lossy(&cmd_output.stderr);
println!("{}", results_raw); info!("{}", results_raw);
} }
} }

61
src/util/io.rs Normal file
View File

@ -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),
};
}
}

1
src/util/mod.rs Normal file
View File

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