proxmox/proxmox-api-macro/tests/api2.rs

use proxmox_api_macro::api;

use anyhow::Error;
use serde_json::Value;

#[api(
    input: {
        properties: {
            message: {
                description: "The message to print",
            }
        }
    }
)]
/// Print the given message.
pub fn hello(message: String) -> Result<(), Error> {
    println!("Hello there. {}", message);
    Ok(())
}

#[api(
    input: {
        properties: {
            num: {
                description: "The version to upgrade to",
            },
        },
    },
)]
/// Return the number...
pub async fn number(num: u32) -> Result<u32, Error> {
    Ok(num)
}

#[test]
fn number_schema_check() {
    const TEST_METHOD: ::proxmox_router::ApiMethod = ::proxmox_router::ApiMethod::new(
        &::proxmox_router::ApiHandler::Async(&api_function_number),
        &::proxmox_schema::ObjectSchema::new(
            "Return the number...",
            &[(
                "num",
                false,
                &::proxmox_schema::IntegerSchema::new("The version to upgrade to")
                    .minimum(0)
                    .maximum(0xffffffff)
                    .schema(),
            )],
        ),
    )
    .protected(false);

    assert_eq!(TEST_METHOD, API_METHOD_NUMBER);
}

#[api(
    input: {
        properties: {
            foo: {
                type: String,
                description: "The great Foo",
            },
            bar: {
                type: String,
                description: "The great Bar",
            },
        },
    },
)]
/// Return the number...
pub async fn more_async_params(param: Value) -> Result<(), Error> {
    let _ = param;
    Ok(())
}

#[test]
fn more_async_params_schema_check() {
    const TEST_METHOD: ::proxmox_router::ApiMethod = ::proxmox_router::ApiMethod::new(
        &::proxmox_router::ApiHandler::Async(&api_function_more_async_params),
        &::proxmox_schema::ObjectSchema::new(
            "Return the number...",
            &[
                (
                    "bar",
                    false,
                    &::proxmox_schema::StringSchema::new("The great Bar").schema(),
                ),
                (
                    "foo",
                    false,
                    &::proxmox_schema::StringSchema::new("The great Foo").schema(),
                ),
            ],
        ),
    )
    .protected(false);

    assert_eq!(TEST_METHOD, API_METHOD_MORE_ASYNC_PARAMS);
}

#[api(
    input: {
        properties: {
            type: {
                type: String,
                description: "The great Foo",
            },
        },
    },
)]
/// Returns nothing.
pub async fn keyword_named_parameters(r#type: String) -> Result<(), Error> {
    let _ = r#type;
    Ok(())
}

#[test]
fn keyword_named_parameters_check() {
    const TEST_METHOD: ::proxmox_router::ApiMethod = ::proxmox_router::ApiMethod::new(
        &::proxmox_router::ApiHandler::Async(&api_function_keyword_named_parameters),
        &::proxmox_schema::ObjectSchema::new(
            "Returns nothing.",
            &[(
                "type",
                false,
                &::proxmox_schema::StringSchema::new("The great Foo").schema(),
            )],
        ),
    )
    .protected(false);

    assert_eq!(TEST_METHOD, API_METHOD_KEYWORD_NAMED_PARAMETERS);
}