re_redap_tests 0.31.2

Official test suite for the Rerun Data Protocol
Documentation
use arrow::datatypes::{DataType, Field, Schema};
use re_log_types::EntryId;
use re_protos::cloud::v1alpha1::ext::{
    CreateDatasetEntryRequest, CreateTableEntryRequest, DatasetDetails, DatasetEntry, EntryDetails,
    LanceTable, ProviderDetails,
};
use re_protos::cloud::v1alpha1::rerun_cloud_service_server::RerunCloudService;
use re_protos::cloud::v1alpha1::{
    EntryFilter, EntryKind, FindEntriesRequest, ReadDatasetEntryRequest,
};
use re_protos::headers::RerunHeadersInjectorExt as _;

use super::common::entry_name;

pub async fn create_dataset_tests(service: impl RerunCloudService) {
    //
    // Create a dataset with just a name
    //

    let dataset1_name = "dataset1";

    create_dataset_entry(
        &service,
        CreateDatasetEntryRequest {
            name: entry_name(dataset1_name),
            id: None,
        },
    )
    .await
    .unwrap();

    let entry_details = entry_details_from_name(&service, dataset1_name, EntryKind::Dataset)
        .await
        .unwrap();

    let dataset_details = dataset_details_from_id(&service, entry_details.id)
        .await
        .unwrap();

    assert!(dataset_details.blueprint_dataset.is_some());
    assert!(dataset_details.default_blueprint_segment.is_none());

    //
    // Check the dataset got a matching blueprint dataset
    //

    let bp_entry_id = dataset_details
        .blueprint_dataset
        .expect("there should be a blueprint dataset");

    let _ = entry_details_from_id(&service, bp_entry_id, EntryKind::BlueprintDataset)
        .await
        .unwrap();

    let bp_dataset_details = dataset_details_from_id(&service, bp_entry_id)
        .await
        .unwrap();

    assert!(bp_dataset_details.blueprint_dataset.is_none());
    assert!(bp_dataset_details.default_blueprint_segment.is_none());

    //
    // Check a duplicate entry name is rejected.
    //

    let status = create_dataset_entry(
        &service,
        CreateDatasetEntryRequest {
            name: entry_name(dataset1_name),
            id: None,
        },
    )
    .await
    .unwrap_err();

    assert_eq!(
        status.code(),
        tonic::Code::AlreadyExists,
        "unexpected status: {status:?}"
    );

    //
    // Check a duplicate entry id is rejected.
    //

    let status = create_dataset_entry(
        &service,
        CreateDatasetEntryRequest {
            name: entry_name("this name is for sure not used but the id might"),
            id: Some(entry_details.id),
        },
    )
    .await
    .unwrap_err();

    assert_eq!(
        status.code(),
        tonic::Code::AlreadyExists,
        "unexpected status: {status:?}"
    );

    //
    // Create another dataset with an enforced entry id
    //

    let dataset2_name = "dataset2";
    let dataset2_id = EntryId::from(re_tuid::Tuid::from_u128(123));

    create_dataset_entry(
        &service,
        CreateDatasetEntryRequest {
            name: entry_name(dataset2_name),
            id: Some(dataset2_id),
        },
    )
    .await
    .unwrap();

    let _ = entry_details_from_name(&service, dataset2_name, EntryKind::Dataset)
        .await
        .unwrap();

    let _ = entry_details_from_id(&service, dataset2_id, EntryKind::Dataset)
        .await
        .unwrap();

    let dataset_details = dataset_details_from_id(&service, dataset2_id)
        .await
        .unwrap();

    assert!(dataset_details.blueprint_dataset.is_some());
    assert!(dataset_details.default_blueprint_segment.is_none());

    //
    // Create a table
    //

    let tmp_dir = tempfile::tempdir().expect("create temp dir");
    let table_name = "created_table";
    let schema = Schema::new(vec![Field::new("column_a", DataType::Utf8, false)]);

    let table_url =
        url::Url::from_directory_path(tmp_dir.path()).expect("create url from tmp directory");
    let provider_details = ProviderDetails::LanceTable(LanceTable { table_url });

    let create_table_request = CreateTableEntryRequest {
        name: entry_name(table_name),
        schema: schema.clone(),
        provider_details: Some(provider_details),
    }
    .try_into()
    .expect("Unable to create table request");

    let _ = service
        .create_table_entry(tonic::Request::new(create_table_request))
        .await
        .expect("create table entry");

    //
    // Dataset with same name as table fails
    //

    let status = create_dataset_entry(
        &service,
        CreateDatasetEntryRequest {
            name: entry_name(table_name),
            id: None,
        },
    )
    .await
    .unwrap_err();

    assert_eq!(
        status.code(),
        tonic::Code::AlreadyExists,
        "unexpected status: {status:?}"
    );
}

// ---

async fn create_dataset_entry(
    service: &impl RerunCloudService,
    request: CreateDatasetEntryRequest,
) -> tonic::Result<DatasetEntry> {
    service
        .create_dataset_entry(tonic::Request::new(request.clone().into()))
        .await
        .map(|result| result.into_inner().dataset.unwrap().try_into().unwrap())
}

/// Get the entry details or return the endpoint error (all other errors panic)
async fn entry_details_from_name(
    service: &impl RerunCloudService,
    name: &str,
    entry_kind: EntryKind,
) -> tonic::Result<EntryDetails> {
    let mut result = service
        .find_entries(tonic::Request::new(FindEntriesRequest {
            filter: Some(EntryFilter {
                id: None,
                name: Some(name.to_owned()),
                entry_kind: Some(entry_kind as i32),
            }),
        }))
        .await?
        .into_inner()
        .entries;

    assert_eq!(result.len(), 1);

    let entry_details = result.pop().unwrap();
    assert_eq!(entry_details.name.as_deref(), Some(name));
    assert_eq!(entry_details.entry_kind, entry_kind as i32);

    Ok(entry_details.try_into().unwrap())
}

/// Get the entry details or return the endpoint error (all other errors panic)
async fn entry_details_from_id(
    service: &impl RerunCloudService,
    entry_id: EntryId,
    entry_kind: EntryKind,
) -> tonic::Result<EntryDetails> {
    let mut result = service
        .find_entries(tonic::Request::new(FindEntriesRequest {
            filter: Some(EntryFilter {
                id: Some(entry_id.into()),
                name: None,
                entry_kind: Some(entry_kind as i32),
            }),
        }))
        .await?
        .into_inner()
        .entries;

    assert_eq!(result.len(), 1);

    let entry_details = result.pop().unwrap();
    assert_eq!(entry_details.id, Some(entry_id.into()));
    assert_eq!(entry_details.entry_kind, entry_kind as i32);

    Ok(entry_details.try_into().unwrap())
}

/// Get the dataset details or return the endpoint error (all other errors panic)
async fn dataset_details_from_id(
    service: &impl RerunCloudService,
    entry_id: EntryId,
) -> tonic::Result<DatasetDetails> {
    service
        .read_dataset_entry(
            tonic::Request::new(ReadDatasetEntryRequest {})
                .with_entry_id(entry_id)
                .unwrap(),
        )
        .await
        .map(|resp| {
            resp.into_inner()
                .dataset
                .unwrap()
                .dataset_details
                .unwrap()
                .try_into()
                .unwrap()
        })
}