sarchive 0.16.0

/*
Copyright 2019-2024 Andy Georges <itkovian+sarchive@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

use super::Archive;
use crate::scheduler::job::JobInfo;
use chrono::{DateTime, Utc};
use clap::{Args, ValueEnum};
use enum_display_derive::Display;
use itertools::Itertools;
use log::{debug, info};
use rdkafka::config::ClientConfig;
use rdkafka::producer::{BaseRecord, DefaultProducerContext, ThreadedProducer};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::fmt::Display;
use std::io::{Error, ErrorKind};

/// Command line options for the kafka archiver subcommand
#[derive(Args, Debug)]
pub struct KafkaArgs {
    #[arg(long, help = "Comma-separated list of brokers")]
    brokers: String,

    #[arg(long, help = "Topic under which to send messages to Kafka", default_value_t = String::from("sarchive"))]
    topic: String,

    #[arg(long, help = "Message timeout in ms", default_value_t = String::from("5000"))]
    message_timeout: String,

    #[arg(long, help = "Protocol used to communicate with Kafka", default_value_t = SecurityProtocol::Plaintext)]
    security_protocol: SecurityProtocol,

    #[arg(long, help = "SSL options for the underlying Kafka lib")]
    ssl: Option<String>,

    #[arg(long, help = "SASL options for the underlying Kafka lib")]
    sasl: Option<String>,
}

#[allow(non_camel_case_types)]
#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Display, ValueEnum, Debug)]
pub enum SecurityProtocol {
    Plaintext,
    Ssl,
    Sasl_plaintext,
    Sasl_ssl,
}

pub struct KafkaArchive {
    producer: ThreadedProducer<DefaultProducerContext>,
    topic: String,
}

impl KafkaArchive {
    /// Creates a new `KafkaArchive` instance with the specified Kafka configuration.
    ///
    /// # Arguments
    ///
    /// * `brokers` - A reference to the Kafka brokers (comma-separated list).
    /// * `topic` - A reference to the Kafka topic for archiving.
    /// * `message_timeout` - A reference to the message timeout duration.
    /// * `security_protocol` - A reference to the `SecurityProtocol` enum indicating the security protocol.
    /// * `ssl` - An optional reference to SSL configuration.
    /// * `sasl` - An optional reference to SASL configuration.
    ///
    /// # Returns
    ///
    /// A new `KafkaArchive` instance.
    ///
    /// # Panics
    ///
    /// Panics if there is an error creating the Kafka producer.
    pub fn new(
        brokers: &String,
        topic: &String,
        message_timeout: &String,
        security_protocol: &SecurityProtocol,
        ssl: &Option<Vec<(&str, &str)>>,
        sasl: &Option<Vec<(&str, &str)>>,
    ) -> Self {
        let mut p = ClientConfig::new()
            .set("bootstrap.servers", brokers)
            .set("message.timeout.ms", message_timeout)
            .set(
                "security.protocol",
                security_protocol
                    .to_string()
                    .to_uppercase()
                    .replace('-', "_"),
            )
            .to_owned();

        if let Some(ssl) = ssl {
            for (k, v) in ssl.iter() {
                debug!("Setting kafka ssl property {k} with value {v}");
                p.set(*k, *v);
            }
        }

        if let Some(sasl) = sasl {
            for (k, v) in sasl.iter() {
                debug!("Setting kafka sasl property {k} with value {v}");
                p.set(*k, *v);
            }
        }

        KafkaArchive {
            producer: p.create().expect("Cannot create Kafka producer. Aborting."),
            topic: topic.to_owned(),
        }
    }

    /// Builds a `KafkaArchive` instance based on the provided `KafkaArgs`.
    ///
    /// # Arguments
    ///
    /// * `args` - A reference to the `KafkaArgs` struct containing Kafka configuration.
    ///
    /// # Returns
    ///
    /// A `Result` containing the created `KafkaArchive` instance or an error.
    pub fn build(args: KafkaArgs) -> Result<Self, Error> {
        info!(
            "Using Kafka archival, talking to {} on topic {} using protocol {}",
            args.brokers, args.topic, args.security_protocol
        );

        let ssl = args
            .ssl
            .as_ref()
            .map(|s| s.split(',').flat_map(|s| s.split('=')).tuples().collect());

        let sasl = args
            .sasl
            .as_ref()
            .map(|s| s.split(',').flat_map(|s| s.split('=')).tuples().collect());

        debug!("Using ssl options {ssl:?}");
        debug!("Using sasl options {sasl:?}");

        Ok(KafkaArchive::new(
            &args.brokers,
            &args.topic,
            &args.message_timeout,
            &args.security_protocol,
            &ssl,
            &sasl,
        ))
    }
}

#[cfg(feature = "kafka")]
#[derive(Serialize, Deserialize)]
struct JobMessage {
    pub id: String,
    pub timestamp: DateTime<Utc>,
    pub cluster: String,
    pub script: String,
    pub hostname: String,
    pub environment: Option<HashMap<String, String>>,
}

impl Archive for KafkaArchive {
    fn archive(&self, job_entry: &Box<dyn JobInfo>) -> Result<(), Error> {
        debug!(
            "Kafka archiver, received an entry for job ID {}",
            job_entry.jobid()
        );

        let doc = JobMessage {
            id: job_entry.jobid(),
            timestamp: Utc::now(),
            cluster: job_entry.cluster(),
            hostname: job_entry.hostname(),
            script: job_entry.script(),
            environment: job_entry.extra_info(),
        };

        if let Ok(serial) = serde_json::to_string(&doc) {
            debug!("Serialisation succeeded");
            match self
                .producer
                .send::<str, str>(BaseRecord::to(&self.topic).payload(&serial))
            {
                Ok(_) => {
                    debug!("Message produced correctly");
                    Ok(())
                }
                Err((_e, _)) => {
                    debug!("Could not produce job entry");
                    Ok(())
                }
            }
        } else {
            Err(Error::new(
                ErrorKind::InvalidData,
                "Cannot convert job info to JSON",
            ))
        }
    }
}

#[cfg(feature = "kafka")]
#[cfg(test)]
mod tests {

    use mockito::Server;
    use std::collections::HashMap;
    use std::path::PathBuf;

    use super::*;
    use crate::scheduler::job::JobInfo;

    #[derive(Debug)]
    struct DummyJobInfo;

    impl JobInfo for DummyJobInfo {
        fn path(&self) -> PathBuf {
            PathBuf::from("/tmp/test")
        }

        fn jobid(&self) -> String {
            "123".to_string()
        }

        fn moment(&self) -> std::time::Instant {
            std::time::Instant::now()
        }

        fn cluster(&self) -> String {
            "test_cluster".to_string()
        }

        fn hostname(&self) -> String {
            "master".to_string()
        }

        fn read_job_info(&mut self) -> Result<(), std::io::Error> {
            Ok(())
        }

        fn files(&self) -> Vec<(String, Vec<u8>)> {
            vec![
                ("file1.txt".to_string(), b"contents1".to_vec()),
                ("file2.txt".to_string(), b"contents2".to_vec()),
            ]
        }

        fn script(&self) -> String {
            "echo 'Hello, World!'".to_string()
        }

        fn extra_info(&self) -> Option<HashMap<String, String>> {
            Some(HashMap::new())
        }
    }

    #[test]
    fn test_kafka_archive_new() {
        // Mock the Kafka broker
        let mut s = Server::new();
        let _m = s.mock("GET", "/").with_status(200).create();

        let brokers = format!("http://{}", s.url());
        let topic = "test_topic".to_string();
        let message_timeout = "5000".to_string();
        let security_protocol = SecurityProtocol::Plaintext;
        let ssl = None;
        let sasl = None;

        let kafka_archive = KafkaArchive::new(
            &brokers,
            &topic,
            &message_timeout,
            &security_protocol,
            &ssl,
            &sasl,
        );

        // Assert that the KafkaArchive was created successfully
        assert_eq!(kafka_archive.topic, topic);
    }

    #[test]
    fn test_kafka_archive_build() {
        // Mock the Kafka broker
        let mut s = mockito::Server::new();
        let _m = s.mock("GET", "/").with_status(200).create();

        let brokers = format!("http://{}", s.url());
        let topic = "test_topic".to_string();
        let message_timeout = "5000".to_string();
        let security_protocol = SecurityProtocol::Plaintext;
        let ssl = None;
        let sasl = None;

        let kafka_args = KafkaArgs {
            brokers,
            topic: topic.clone(),
            message_timeout,
            security_protocol,
            ssl,
            sasl,
        };

        let kafka_archive = KafkaArchive::build(kafka_args).unwrap();

        // Assert that the KafkaArchive was built successfully
        assert_eq!(kafka_archive.topic, topic);
    }
}