distant/tests/cli/api/metadata.rs

use assert_fs::prelude::*;
use rstest::*;
use serde_json::{json, Value};
use test_log::test;

use crate::common::fixtures::*;

const FILE_CONTENTS: &str = r#"
some text
on multiple lines
that is a file's contents
"#;

#[rstest]
#[test(tokio::test)]
async fn should_support_json_metadata_for_file(mut api_process: CtxCommand<ApiProcess>) {
    validate_authentication(&mut api_process).await;

    let temp = assert_fs::TempDir::new().unwrap();

    let file = temp.child("file");
    file.write_str(FILE_CONTENTS).unwrap();

    let id = rand::random::<u64>().to_string();
    let req = json!({
        "id": id,
        "payload": {
            "type": "metadata",
            "path": file.to_path_buf(),
            "canonicalize": false,
            "resolve_file_type": false,
        },
    });

    let res = api_process.write_and_read_json(req).await.unwrap().unwrap();

    assert_eq!(res["origin_id"], id, "JSON: {res}");
    assert_eq!(res["payload"]["type"], "metadata", "JSON: {res}");
    assert_eq!(
        res["payload"]["canonicalized_path"],
        Value::Null,
        "JSON: {res}"
    );
    assert_eq!(res["payload"]["file_type"], "file", "JSON: {res}");
    assert_eq!(res["payload"]["readonly"], false, "JSON: {res}");
}

#[rstest]
#[test(tokio::test)]
async fn should_support_json_metadata_for_directory(mut api_process: CtxCommand<ApiProcess>) {
    validate_authentication(&mut api_process).await;

    let temp = assert_fs::TempDir::new().unwrap();

    let dir = temp.child("dir");
    dir.create_dir_all().unwrap();

    let id = rand::random::<u64>().to_string();
    let req = json!({
        "id": id,
        "payload": {
            "type": "metadata",
            "path": dir.to_path_buf(),
            "canonicalize": false,
            "resolve_file_type": false,
        },
    });

    let res = api_process.write_and_read_json(req).await.unwrap().unwrap();

    assert_eq!(res["origin_id"], id, "JSON: {res}");
    assert_eq!(res["payload"]["type"], "metadata", "JSON: {res}");
    assert_eq!(
        res["payload"]["canonicalized_path"],
        Value::Null,
        "JSON: {res}"
    );
    assert_eq!(res["payload"]["file_type"], "dir", "JSON: {res}");
    assert_eq!(res["payload"]["readonly"], false, "JSON: {res}");
}

#[rstest]
#[test(tokio::test)]
async fn should_support_json_metadata_for_including_a_canonicalized_path(
    mut api_process: CtxCommand<ApiProcess>,
) {
    validate_authentication(&mut api_process).await;

    let temp = assert_fs::TempDir::new().unwrap();

    let file = temp.child("file");
    file.touch().unwrap();

    let link = temp.child("link");
    link.symlink_to_file(file.path()).unwrap();

    let id = rand::random::<u64>().to_string();
    let req = json!({
        "id": id,
        "payload": {
            "type": "metadata",
            "path": link.to_path_buf(),
            "canonicalize": true,
            "resolve_file_type": false,
        },
    });

    let res = api_process.write_and_read_json(req).await.unwrap().unwrap();

    assert_eq!(res["origin_id"], id, "JSON: {res}");
    assert_eq!(res["payload"]["type"], "metadata", "JSON: {res}");
    assert_eq!(
        res["payload"]["canonicalized_path"],
        json!(file.path().canonicalize().unwrap()),
        "JSON: {res}"
    );
    assert_eq!(res["payload"]["file_type"], "symlink", "JSON: {res}");
    assert_eq!(res["payload"]["readonly"], false, "JSON: {res}");
}

#[rstest]
#[test(tokio::test)]
async fn should_support_json_metadata_for_resolving_file_type_of_symlink(
    mut api_process: CtxCommand<ApiProcess>,
) {
    validate_authentication(&mut api_process).await;

    let temp = assert_fs::TempDir::new().unwrap();

    let file = temp.child("file");
    file.touch().unwrap();

    let link = temp.child("link");
    link.symlink_to_file(file.path()).unwrap();

    let id = rand::random::<u64>().to_string();
    let req = json!({
        "id": id,
        "payload": {
            "type": "metadata",
            "path": link.to_path_buf(),
            "canonicalize": true,
            "resolve_file_type": true,
        },
    });

    let res = api_process.write_and_read_json(req).await.unwrap().unwrap();

    assert_eq!(res["origin_id"], id, "JSON: {res}");
    assert_eq!(res["payload"]["type"], "metadata", "JSON: {res}");
    assert_eq!(res["payload"]["file_type"], "file", "JSON: {res}");
}

#[rstest]
#[test(tokio::test)]
async fn should_support_json_output_for_error(mut api_process: CtxCommand<ApiProcess>) {
    validate_authentication(&mut api_process).await;

    let temp = assert_fs::TempDir::new().unwrap();

    // Don't create file
    let file = temp.child("file");

    let id = rand::random::<u64>().to_string();
    let req = json!({
        "id": id,
        "payload": {
            "type": "metadata",
            "path": file.to_path_buf(),
            "canonicalize": false,
            "resolve_file_type": false,
        },
    });

    let res = api_process.write_and_read_json(req).await.unwrap().unwrap();

    assert_eq!(res["origin_id"], id, "JSON: {res}");
    assert_eq!(res["payload"]["type"], "error", "JSON: {res}");
    assert_eq!(res["payload"]["kind"], "not_found", "JSON: {res}");
}