rs-consul 0.13.0

This crate provides access to a set of strongly typed apis to interact with consul (https://www.consul.io/)
Documentation
use std::collections::HashMap;

use rs_consul::*;
type Result<T> = std::result::Result<T, rs_consul::ConsulError>;

pub(crate) fn get_client() -> Consul {
    let conf: Config = Config::from_env();
    Consul::new(conf)
}
/// a consul client with write permission allows for manipulating tokens
pub(crate) fn get_privileged_client() -> Consul {
    use std::env;
    let addr = env::var("CONSUL_HTTP_ADDR").unwrap_or_else(|_| "http://127.0.0.1:8500".to_string());
    let conf: Config = Config {
        address: addr,
        token: Some(String::from("8fc9e787-674f-0709-cfd5-bfdabd73a70d")), // use initial-managment
        // token hardcoded in config.hcl
        ..Default::default()
    };
    Consul::new(conf)
}
pub(crate) async fn register_entity(consul: &Consul, service_name: &String, node_id: &str) {
    let ResponseMeta {
        response: service_names_before_register,
        ..
    } = consul
        .get_all_registered_service_names(None)
        .await
        .expect("expected get_registered_service_names request to succeed");
    assert!(!service_names_before_register.contains(service_name));

    let payload = RegisterEntityPayload {
        ID: None,
        Node: node_id.to_string(),
        Address: "127.0.0.1".to_string(),
        Datacenter: None,
        TaggedAddresses: Default::default(),
        NodeMeta: Default::default(),
        Service: Some(RegisterEntityService {
            ID: None,
            Service: service_name.clone(),
            Tags: vec![],
            TaggedAddresses: Default::default(),
            Meta: Default::default(),
            Port: Some(42424),
            Namespace: None,
        }),
        Checks: Vec::new(),
        SkipNodeUpdate: None,
    };
    consul
        .register_entity(&payload)
        .await
        .expect("expected register_entity request to succeed");
}

pub(crate) async fn register_entity_with_checks(
    consul: &Consul,
    service_name: &String,
    node_id: &str,
    checks: Vec<RegisterEntityCheck>,
) {
    let ResponseMeta {
        response: service_names_before_register,
        ..
    } = consul
        .get_all_registered_service_names(None)
        .await
        .expect("expected get_registered_service_names request to succeed");
    assert!(!service_names_before_register.contains(service_name));

    let payload = RegisterEntityPayload {
        ID: None,
        Node: node_id.to_string(),
        Address: "127.0.0.1".to_string(),
        Datacenter: None,
        TaggedAddresses: Default::default(),
        NodeMeta: Default::default(),
        Service: Some(RegisterEntityService {
            ID: Some(service_id(service_name)),
            Service: service_name.clone(),
            Tags: vec![],
            TaggedAddresses: Default::default(),
            Meta: Default::default(),
            Port: Some(42424),
            Namespace: None,
        }),
        Checks: checks,
        SkipNodeUpdate: None,
    };
    consul
        .register_entity(&payload)
        .await
        .expect("expected register_entity request to succeed");
}

pub(crate) async fn register_entity_with_address(
    consul: &Consul,
    service_name: &str,
    node_id: &str,
    address: &str,
) {
    let meta: HashMap<_, _> = (1..5)
        .map(|i| (format!("meta-key-{i}"), format!("meta-value-{i}")))
        .collect();
    let payload = RegisterEntityPayload {
        ID: None,
        Node: node_id.to_string(),
        Address: address.to_string(),
        Datacenter: None,
        TaggedAddresses: Default::default(),
        NodeMeta: meta,
        Service: Some(RegisterEntityService {
            ID: None,
            Service: service_name.to_string(),
            Tags: vec![],
            TaggedAddresses: Default::default(),
            Meta: Default::default(),
            Port: Some(42424),
            Namespace: None,
        }),
        Checks: Vec::new(),
        SkipNodeUpdate: None,
    };
    consul
        .register_entity(&payload)
        .await
        .expect("expected register_entity request to succeed");
}

pub(crate) fn service_id(service_name: &str) -> String {
    format!("{service_name}-ID")
}

pub(crate) async fn is_registered(consul: &Consul, service_name: &String) -> bool {
    let ResponseMeta {
        response: service_names_after_register,
        ..
    } = consul
        .get_all_registered_service_names(None)
        .await
        .expect("expected get_registered_service_names request to succeed");
    service_names_after_register.contains(service_name)
}

pub(crate) async fn create_or_update_key_value(
    consul: &Consul,
    key: &str,
    value: &str,
) -> Result<(bool, u64)> {
    let req = CreateOrUpdateKeyRequest {
        key,
        ..Default::default()
    };
    consul
        .create_or_update_key(req, value.as_bytes().to_vec())
        .await
}

pub(crate) async fn read_key(
    consul: &Consul,
    key: &str,
) -> Result<ResponseMeta<Vec<ReadKeyResponse>>> {
    let req = ReadKeyRequest {
        key,
        ..Default::default()
    };
    consul.read_key(req).await
}

pub(crate) async fn delete_key(consul: &Consul, key: &str) -> Result<bool> {
    let req = DeleteKeyRequest {
        key,
        ..Default::default()
    };
    consul.delete_key(req).await
}

pub(crate) fn assert_expected_result_with_index(res: Result<(bool, u64)>) {
    assert!(res.is_ok());
    let (result, _index) = res.unwrap();
    assert!(result);
}

pub(crate) fn assert_expected_result(res: Result<bool>) {
    assert!(res.is_ok());
    assert!(res.unwrap());
}

pub(crate) async fn get_single_key_value_with_index(
    consul: &Consul,
    key: &str,
) -> (Option<String>, i64) {
    let res = read_key(consul, key).await.expect("failed to read key");
    let r = res.response.into_iter().next().unwrap();
    (r.value, res.index as i64)
}

pub(crate) fn verify_single_value_matches(
    res: Result<ResponseMeta<Vec<ReadKeyResponse>>>,
    value: &str,
) {
    assert!(res.is_ok());
    assert_eq!(
        res.unwrap()
            .response
            .into_iter()
            .next()
            .unwrap()
            .value
            .unwrap(),
        value
    )
}

pub(crate) async fn deregister_entity(
    consul: &Consul,
    node_id: String,
    service_id: Option<String>,
) {
    let payload = DeregisterEntityPayload {
        Node: Some(node_id),
        Datacenter: None,
        CheckID: None,
        ServiceID: service_id,
        Namespace: None,
    };
    consul
        .deregister_entity(&payload)
        .await
        .expect("expected deregister_entity request to succeed");
}

pub(crate) async fn remove_service_node(
    consul: &Consul,
    node_id: String,
    service_id: Option<String>,
) {
    // Remove the service from the node.
    deregister_entity(consul, node_id.clone(), service_id).await;
    // Remove the node. Note that if there are still some services
    // using this node it will not be removed from the catalog and
    // the call will succeed with the node still part of the catalog.
    deregister_entity(consul, node_id, None).await;
}