Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Initial implementation for ListMetadata #3

Merged
merged 2 commits into from
Aug 6, 2024
Merged

Initial implementation for ListMetadata #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
277fc5d
Initial implementation for ListMetadata
rafaeling Jul 30, 2024
3f6a68c
Extend unit test
rafaeling Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions databroker/src/grpc/kuksa_val_v2/conversions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,3 +146,44 @@ impl From<&broker::UpdateError> for proto::Error {
}
}
}

impl From<broker::DataType> for proto::DataType {
fn from(from: broker::DataType) -> Self {
match from {
broker::DataType::String => proto::DataType::String,
broker::DataType::Bool => proto::DataType::Boolean,
broker::DataType::Int8 => proto::DataType::Int8,
broker::DataType::Int16 => proto::DataType::Int16,
broker::DataType::Int32 => proto::DataType::Int32,
broker::DataType::Int64 => proto::DataType::Int64,
broker::DataType::Uint8 => proto::DataType::Uint8,
broker::DataType::Uint16 => proto::DataType::Uint16,
broker::DataType::Uint32 => proto::DataType::Uint32,
broker::DataType::Uint64 => proto::DataType::Uint64,
broker::DataType::Float => proto::DataType::Float,
broker::DataType::Double => proto::DataType::Double,
broker::DataType::StringArray => proto::DataType::StringArray,
broker::DataType::BoolArray => proto::DataType::BooleanArray,
broker::DataType::Int8Array => proto::DataType::Int8Array,
broker::DataType::Int16Array => proto::DataType::Int16Array,
broker::DataType::Int32Array => proto::DataType::Int32Array,
broker::DataType::Int64Array => proto::DataType::Int64Array,
broker::DataType::Uint8Array => proto::DataType::Uint8Array,
broker::DataType::Uint16Array => proto::DataType::Uint16Array,
broker::DataType::Uint32Array => proto::DataType::Uint32Array,
broker::DataType::Uint64Array => proto::DataType::Uint64Array,
broker::DataType::FloatArray => proto::DataType::FloatArray,
broker::DataType::DoubleArray => proto::DataType::DoubleArray,
}
}
}

impl From<broker::EntryType> for proto::EntryType {
fn from(from: broker::EntryType) -> Self {
match from {
broker::EntryType::Sensor => proto::EntryType::Sensor,
broker::EntryType::Attribute => proto::EntryType::Attribute,
broker::EntryType::Actuator => proto::EntryType::Actuator,
}
}
}
228 changes: 226 additions & 2 deletions databroker/src/grpc/kuksa_val_v2/val.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ use std::{collections::HashMap, pin::Pin};

use crate::{
broker::{self, AuthorizedAccess},
glob::Matcher,
permissions::Permissions,
};

Expand All @@ -26,6 +27,7 @@ use databroker_proto::kuksa::val::v2::{
open_provider_stream_response, OpenProviderStreamResponse, PublishValuesResponse,
};

use kuksa::proto::v2::{ListMetadataResponse, Metadata};
use tokio::{select, sync::mpsc};
use tokio_stream::{wrappers::ReceiverStream, Stream};
use tonic::{Code, Response};
Expand Down Expand Up @@ -84,11 +86,88 @@ impl proto::val_server::Val for broker::DataBroker {
Err(tonic::Status::new(Code::Unimplemented, "Unimplemented"))
}

/// List metadata of signals matching the wildcard branch request.
///
/// # Arguments
///
/// ```
/// `request`:
/// ListMetadataRequest {
/// root: String
/// filter: String
/// }
///
/// # Response
/// `response`:
/// ListMetadataResponse {
/// metadata: Vec<Metadata>
/// }
/// ```
///
/// # Errors
///
/// Returns (GRPC error code):
/// NOT_FOUND if the specified root branch does not exist
/// INVALID_ARGUMENT if the request pattern is invalid
///
/// # Examples
/// For details, please refer to
/// [Wildcard Matching](https://github.com/eclipse-kuksa/kuksa-databroker/blob/main/doc/wildcard_matching.md#examples)
async fn list_metadata(
&self,
_request: tonic::Request<proto::ListMetadataRequest>,
request: tonic::Request<proto::ListMetadataRequest>,
) -> Result<tonic::Response<proto::ListMetadataResponse>, tonic::Status> {
Err(tonic::Status::new(Code::Unimplemented, "Unimplemented"))
debug!(?request);
let permissions = match request.extensions().get::<Permissions>() {
Some(permissions) => {
debug!(?permissions);
permissions.clone()
}
None => return Err(tonic::Status::unauthenticated("Unauthenticated")),
};
let broker = self.authorized_access(&permissions);

let metadata_request = request.into_inner();

match Matcher::new(&metadata_request.root) {
Ok(matcher) => {
let mut metadata_response = Vec::new();
broker
.for_each_entry(|entry| {
let entry_metadata = &entry.metadata();
if matcher.is_match(&entry_metadata.glob_path) {
metadata_response.push(Metadata {
id: entry_metadata.id,
data_type: proto::DataType::from(entry_metadata.data_type.clone())
as i32,
entry_type: proto::EntryType::from(
entry_metadata.entry_type.clone(),
) as i32,
description: Some(entry_metadata.description.clone()),
comment: None,
deprecation: None,
unit: entry_metadata.unit.clone(),
value_restriction: None,
lukasmittag marked this conversation as resolved.
Show resolved Hide resolved
})
}
})
.await;
if metadata_response.is_empty() {
Err(tonic::Status::new(
tonic::Code::NotFound,
"Specified root branch does not exist",
))
} else {
Ok(Response::new(ListMetadataResponse {
metadata: metadata_response,
}))
}
}
Err(_) => Err(tonic::Status::new(
tonic::Code::InvalidArgument,
"Invalid Pattern Argument",
)),
}
}

async fn publish_value(
Expand Down Expand Up @@ -460,4 +539,149 @@ mod tests {
}
}
}

#[tokio::test]
async fn test_list_metadata_using_wildcard() {
let broker = DataBroker::default();
let authorized_access = broker.authorized_access(&permissions::ALLOW_ALL);

authorized_access
.add_entry(
"test.datapoint1".to_owned(),
broker::DataType::Bool,
broker::ChangeType::OnChange,
broker::EntryType::Sensor,
"Test datapoint 1".to_owned(),
None,
None,
)
.await
.expect("Register datapoint should succeed");

authorized_access
.add_entry(
"test.branch.datapoint2".to_owned(),
broker::DataType::Bool,
broker::ChangeType::OnChange,
broker::EntryType::Sensor,
"Test branch datapoint 2".to_owned(),
None,
None,
)
.await
.expect("Register datapoint should succeed");

let mut wildcard_req_two_asteriks = tonic::Request::new(proto::ListMetadataRequest {
root: "test.**".to_owned(),
filter: "".to_owned(),
});

let mut wildcard_req_one_asterik = tonic::Request::new(proto::ListMetadataRequest {
root: "test.*".to_owned(),
filter: "".to_owned(),
});
// Manually insert permissions
wildcard_req_two_asteriks
.extensions_mut()
.insert(permissions::ALLOW_ALL.clone());

wildcard_req_one_asterik
.extensions_mut()
.insert(permissions::ALLOW_ALL.clone());

match proto::val_server::Val::list_metadata(&broker, wildcard_req_two_asteriks)
.await
.map(|res| res.into_inner())
{
Ok(list_response) => {
let entries_size = list_response.metadata.len();
assert_eq!(entries_size, 2);
}
Err(_status) => panic!("failed to execute get request"),
}
lukasmittag marked this conversation as resolved.
Show resolved Hide resolved

match proto::val_server::Val::list_metadata(&broker, wildcard_req_one_asterik)
.await
.map(|res| res.into_inner())
{
Ok(list_response) => {
let entries_size = list_response.metadata.len();
assert_eq!(entries_size, 1);
}
Err(_status) => panic!("failed to execute get request"),
}
}

#[tokio::test]
async fn test_list_metadata_bad_request_pattern_or_not_found() {
let broker = DataBroker::default();
let authorized_access = broker.authorized_access(&permissions::ALLOW_ALL);

authorized_access
.add_entry(
"test.datapoint1".to_owned(),
broker::DataType::Bool,
broker::ChangeType::OnChange,
broker::EntryType::Sensor,
"Test datapoint 1".to_owned(),
None,
None,
)
.await
.expect("Register datapoint should succeed");

let mut wildcard_req = tonic::Request::new(proto::ListMetadataRequest {
root: "test. **".to_owned(),
filter: "".to_owned(),
});

// Manually insert permissions
wildcard_req
.extensions_mut()
.insert(permissions::ALLOW_ALL.clone());

match proto::val_server::Val::list_metadata(&broker, wildcard_req)
.await
.map(|res| res.into_inner())
{
Ok(_) => {}
Err(error) => {
assert_eq!(
error.code(),
tonic::Code::InvalidArgument,
"unexpected error code"
);
assert_eq!(
error.message(),
"Invalid Pattern Argument",
"unexpected error reason"
);
}
}

let mut not_found_req = tonic::Request::new(proto::ListMetadataRequest {
root: "test.notfound".to_owned(),
filter: "".to_owned(),
});

// Manually insert permissions
not_found_req
.extensions_mut()
.insert(permissions::ALLOW_ALL.clone());

match proto::val_server::Val::list_metadata(&broker, not_found_req)
.await
.map(|res| res.into_inner())
{
Ok(_) => {}
Err(error) => {
assert_eq!(error.code(), tonic::Code::NotFound, "unexpected error code");
assert_eq!(
error.message(),
"Specified root branch does not exist",
"unexpected error reason"
);
}
}
}
}
Loading