diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..7fba8f6 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,34 @@ +# Include any files or directories that you don't want to be copied to your +# container here (e.g., local build artifacts, temporary files, etc.). +# +# For more help, visit the .dockerignore file reference guide at +# https://docs.docker.com/engine/reference/builder/#dockerignore-file + +**/.DS_Store +**/.classpath +**/.dockerignore +**/.env +**/.git +**/.gitignore +**/.project +**/.settings +**/.toolstarget +**/.vs +**/.vscode +**/*.*proj.user +**/*.dbmdl +**/*.jfm +**/charts +**/docker-compose* +**/compose* +**/Dockerfile* +**/node_modules +**/npm-debug.log +**/secrets.dev.yaml +**/values.dev.yaml +/bin +/target +LICENSE +README.md +config.toml +mastodon-data.toml diff --git a/.gitignore b/.gitignore index d948472..9ec0dd3 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,4 @@ mastodon-data.toml *.csv *.tmp *.log -tmp/ \ No newline at end of file +tmp/ diff --git a/Cargo.lock b/Cargo.lock index 95cbfe6..d11b776 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -850,7 +850,7 @@ dependencies = [ [[package]] name = "mastodon-image-uploader-bot" -version = "0.2.2" +version = "0.3.0" dependencies = [ "async-std", "log", @@ -859,7 +859,7 @@ dependencies = [ "serde", "stderrlog", "tokio", - "toml 0.7.6", + "toml 0.8.8", ] [[package]] @@ -1287,9 +1287,9 @@ dependencies = [ [[package]] name = "serde_spanned" -version = "0.6.3" +version = "0.6.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "96426c9936fd7a0124915f9185ea1d20aa9445cc9821142f0a73bc9207a2e186" +checksum = "eb3622f419d1296904700073ea6cc23ad690adbd66f13ea683df73298736f0c1" dependencies = [ "serde", ] @@ -1620,9 +1620,9 @@ dependencies = [ [[package]] name = "toml" -version = "0.7.6" +version = "0.8.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c17e963a819c331dcacd7ab957d80bc2b9a9c1e71c804826d2f283dd65306542" +checksum = "a1a195ec8c9da26928f773888e0742ca3ca1040c6cd859c919c9f59c1954ab35" dependencies = [ "serde", "serde_spanned", @@ -1632,18 +1632,18 @@ dependencies = [ [[package]] name = "toml_datetime" -version = "0.6.3" +version = "0.6.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7cda73e2f1397b1262d6dfdcef8aafae14d1de7748d66822d3bfeeb6d03e5e4b" +checksum = "3550f4e9685620ac18a50ed434eb3aec30db8ba93b0287467bca5826ea25baf1" dependencies = [ "serde", ] [[package]] name = "toml_edit" -version = "0.19.13" +version = "0.21.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5f8751d9c1b03c6500c387e96f81f815a4f8e72d142d2d4a9ffa6fedd51ddee7" +checksum = "d34d383cd00a163b4a5b85053df514d45bc330f6de7737edfe0a93311d1eaa03" dependencies = [ "indexmap 2.0.0", "serde", diff --git a/Cargo.toml b/Cargo.toml index 3c94170..3addf43 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,15 +1,18 @@ [package] name = "mastodon-image-uploader-bot" -version = "0.2.2" +version = "0.3.0" edition = "2021" +[alias] +test = "cargo test -- --test-threads=1" + # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] tokio = { version = "1", features = ["macros", "rt-multi-thread"] } reqwest = "0.11.14" serde = "1.0.171" -toml = "0.7.1" +toml = "0.8.8" log = "0.4.19" stderrlog = "0.5.4" async-std = "1.12.0" diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..b829760 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,62 @@ +# syntax=docker/dockerfile:1 + +# Comments are provided throughout this file to help you get started. +# If you need more help, visit the Dockerfile reference guide at +# https://docs.docker.com/engine/reference/builder/ + +################################################################################ +# Create a stage for building the application. + +ARG RUST_VERSION=1.71.0 +ARG APP_NAME=mastodon-image-uploader-bot +FROM rust:${RUST_VERSION}-slim-bullseye AS build +ARG APP_NAME +WORKDIR /app + +# Build the application. +# Leverage a cache mount to /usr/local/cargo/registry/ +# for downloaded dependencies and a cache mount to /app/target/ for +# compiled dependencies which will speed up subsequent builds. +# Leverage a bind mount to the src directory to avoid having to copy the +# source code into the container. Once built, copy the executable to an +# output directory before the cache mounted /app/target is unmounted. +RUN --mount=type=bind,source=src,target=src \ + --mount=type=bind,source=Cargo.toml,target=Cargo.toml \ + --mount=type=bind,source=Cargo.lock,target=Cargo.lock \ + --mount=type=cache,target=/app/target/ \ + --mount=type=cache,target=/usr/local/cargo/registry/ \ + < DynResult<()> { .verbosity(4) // Debug .timestamp(stderrlog::Timestamp::Second) .init()?; - let config: Config = match parse_config(CONFIG_FILENAME) { - Ok(config) => config, - Err(err) => { - log::error!("Config file parsing unsuccesful: {}", err); - exit(1); - } - }; - let mastodon = if let Ok(data) = masto_toml::from_file("mastodon-data.toml") { - Mastodon::from(data) - } else { - match register(&config).await { - Ok(account) => account, - Err(err) => { - log::error!("Api registation unsuccesful: {}", err); - exit(1); - } - } - }; + let config: Config = get_config(); + let mastodon = get_account(&config).await; match get_next_url(&config) { Ok(url) => match url { Some(url) => { let mut retry: u8 = 0; - while let Err(err) = post_image(&mastodon, &url, &config).await { + while let Err(err) = post_image(&mastodon, &url, &config, Visibility::Unlisted).await { log::warn!("Cannot post image, retry: {}, {}", retry, err); async_std::task::sleep(Duration::new(1, 0)).await; retry += 1; if retry >= config.errors.retry { log::error!("Max ammount of retries reached on post_image"); log::info!("Reverting file changes"); - while let Err(err) = pop_last_line_of_file(&config.files.posted) { - log::warn!("Failed to revert, retrying: {}", err); - async_std::task::sleep(Duration::new(1, 0)).await; - } exit(1); } } + set_url_as_posted(&config, &url)?; let mut retry: u8 = 0; while let Err(err) = update_bio(&mastodon, &config).await { log::warn!("Cannot update bio, retry: {}, {}", retry, err); @@ -106,7 +88,16 @@ async fn main() -> DynResult<()> { } None => { let mut retry: u8 = 0; - while let Err(err) = post(&mastodon, &config.errors.out_of_images).await { + while let Err(err) = post( + &mastodon, + &format!( + "{} {}", + &config.errors.maintainers, &config.errors.out_of_images + ), + Visibility::Direct, + ) + .await + { log::warn!("Cannot post, retry: {}, {}", retry, err); async_std::task::sleep(Duration::new(1, 0)).await; retry += 1; @@ -119,7 +110,13 @@ async fn main() -> DynResult<()> { }, Err(err) => { log::error!("Cannot get next image: {}", err); - match post(&mastodon, &err.to_string()).await { + match post( + &mastodon, + &format!("{} {}", &config.errors.maintainers, &err.to_string()), + Visibility::Direct, + ) + .await + { Ok(_) => {} Err(err) => { log::error!("Cannot post error message: {}", err); @@ -131,21 +128,36 @@ async fn main() -> DynResult<()> { Ok(()) } +fn get_config() -> Config { + match parse_config(CONFIG_FILENAME) { + Ok(config) => config, + Err(err) => { + log::error!("Config file parsing unsuccesful: {}", err); + exit(1); + } + } +} + +async fn get_account(config: &Config) -> Mastodon { + if let Ok(data) = masto_toml::from_file("mastodon-data.toml") { + Mastodon::from(data) + } else { + match register(config).await { + Ok(account) => account, + Err(err) => { + log::error!("Api registation unsuccesful: {}", err); + exit(1); + } + } + } +} + /// Parses the given filename to a config struct fn parse_config(filename: &str) -> DynResult { let toml_file = std::fs::read_to_string(filename)?; //.expect("No config file, consider getting the original one and modifing it"); Ok(toml::from_str(&toml_file)?) //("Malformed config file, check the original one for reference") } -fn pop_last_line_of_file(filename: &str) -> DynResult<()> { - let binding = std::fs::read_to_string(filename)?; - let mut posted: Vec<_> = binding.lines().collect(); - posted.pop(); - std::fs::write(filename, posted.concat())?; - log::info!("Success reverting changes"); - Ok(()) -} - fn get_next_url(config: &Config) -> DynResult> { let binding = std::fs::read_to_string(&config.files.posted)?; //.expect("Posted file not found"); let posted = binding.lines().collect::>(); @@ -155,16 +167,26 @@ fn get_next_url(config: &Config) -> DynResult> { if urls.is_empty() { Ok(None) } else { - let mut file = std::fs::OpenOptions::new() - .write(true) - .append(true) // This is needed to append to file - .open(&config.files.posted)?; //.expect("Cannot open posted file"); // Maybe we should retry just in case - write!(file, "{}\n", urls[0])?; //.expect("Cannot write to posted file"); // maybe we should retry tbh Ok(Some(urls[0].to_string().clone())) } } -async fn post_image(account: &Mastodon, url: &String, config: &Config) -> DynResult<()> { +fn set_url_as_posted(config: &Config, url: &String) -> DynResult<()> { + let mut file = std::fs::OpenOptions::new() + .write(true) + .append(true) // This is needed to append to file + .open(&config.files.posted)?; //.expect("Cannot open posted file"); // Maybe we should retry just in case + write!(file, "{}\n", url)?; //.expect("Cannot write to posted file"); // maybe we should retry tbh + log::info!("Set url {} as posted", url); + Ok(()) +} + +async fn post_image( + account: &Mastodon, + url: &String, + config: &Config, + visibility: Visibility, +) -> DynResult { fetch_url(url, &config.files.tempfile).await?; //.expect("Error fetching url"); let attachment = account .media(&config.files.tempfile, Some(url.to_string())) @@ -174,12 +196,12 @@ async fn post_image(account: &Mastodon, url: &String, config: &Config) -> DynRes .await?; //.expect("Attachment processing error"); let status = StatusBuilder::new() .media_ids(&[attachment.id]) - .visibility(Visibility::Unlisted) + .visibility(visibility) .sensitive(true) .build()?; //.expect("Could not build status"); // we should retry - account.new_status(status).await?; //.expect("Error generating status"); // we should retry or delete last url in posted + let status = account.new_status(status).await?; //.expect("Error generating status"); // we should retry or delete last url in posted log::info!("Image status posted: {}", url); - Ok(()) + Ok(status) } async fn update_bio(account: &Mastodon, config: &Config) -> DynResult<()> { @@ -208,14 +230,14 @@ async fn update_bio(account: &Mastodon, config: &Config) -> DynResult<()> { Ok(()) } -async fn post(account: &Mastodon, msg: &str) -> DynResult<()> { +async fn post(account: &Mastodon, msg: &str, visibility: Visibility) -> DynResult { let status = StatusBuilder::new() - .visibility(Visibility::Direct) + .visibility(visibility) .status(msg) .build()?; //.expect("Error building error status"); - account.new_status(status).await?; //.expect("Error posting error status"); + let post = account.new_status(status).await?; //.expect("Error posting error status"); log::info!("Text status posted: {}", msg); - Ok(()) + Ok(post) } async fn fetch_url(url: &String, file_name: &String) -> DynResult<()> { @@ -229,7 +251,7 @@ async fn fetch_url(url: &String, file_name: &String) -> DynResult<()> { async fn register(config: &Config) -> DynResult { let registration = Registration::new(&config.bot.instance) .client_name(&config.bot.name) - .scopes(Scopes::write_all()) + .scopes(Scopes::all()) .build() .await?; let mastodon = cli::authenticate(registration).await?; @@ -239,3 +261,101 @@ async fn register(config: &Config) -> DynResult { Ok(mastodon) } + +#[cfg(test)] +mod tests { + + use reqwest::StatusCode; + + use super::*; + const TMPTESTDIR: &str = "/tmp/botimage"; + const TEST_URL: &str = "https://2.gravatar.com/avatar/be8eb8426d68e4beb50790647eda6f6b"; + + #[tokio::test] + async fn fetch_url_should_fetch() { + fetch_url(&TEST_URL.to_string(), &TMPTESTDIR.to_string()) + .await + .unwrap(); + std::fs::read(TMPTESTDIR).unwrap(); + } + + #[tokio::test] + async fn post_should_post() { + let client = reqwest::Client::new(); + let config = get_config(); + let account = get_account(&config).await; + let msg = format!("Test!"); + + let status = post(&account, &msg, Visibility::Direct).await.unwrap(); + let response = client + .get(dbg!(format!( + "{}/api/v1/statuses/{}", + &config.bot.instance, + &status.id.to_string() + ))) + .bearer_auth(dbg!(&account.data.token)) + .send() + .await + .unwrap(); + account.delete_status(&status.id).await.unwrap(); + + assert_eq!(response.status(), StatusCode::OK) + } + + #[tokio::test] + async fn post_image_works() { + let client = reqwest::Client::new(); + let config = get_config(); + let account = get_account(&config).await; + + let status = post_image(&account, &TEST_URL.to_string(), &config, Visibility::Direct) + .await + .unwrap(); + + let response = account.get_status(&status.id).await.unwrap(); + + account.delete_status(&status.id).await.unwrap(); + let attachment = &response.media_attachments[0]; + + let response = client + .get(attachment.url.clone().unwrap()) + .bearer_auth(dbg!(&account.data.token)) + .send() + .await + .unwrap(); + + assert_eq!(response.status(), StatusCode::OK) + } + + #[test] + fn set_as_posted_works() { + let config = get_config(); + + std::fs::write(&config.files.posted, "").unwrap(); + + set_url_as_posted(&config, &TEST_URL.to_string()).unwrap(); + let file = std::fs::read_to_string(&config.files.posted).unwrap(); + let url = file.lines().next_back().unwrap(); + assert_eq!(url, TEST_URL) + } + + #[test] + fn get_next_url_works() { + let config = get_config(); + // Reset file + std::fs::write(&config.files.posted, "").unwrap(); + + // Get test url + let url = get_next_url(&config).unwrap().unwrap(); + assert_eq!(url, TEST_URL); + + set_url_as_posted(&config, &TEST_URL.to_string()).unwrap(); + let file = std::fs::read_to_string(&config.files.posted).unwrap(); + let url = file.lines().next_back().unwrap(); + assert_eq!(url, TEST_URL); + + // Test that now it does not get it + let url = get_next_url(&config).unwrap(); + assert_eq!(url, None); + } +}