Discoverabiltiy in kuksa.val.v1 API to enable e.g. Autocompletion

kuksa_databroker/databroker/src/glob.rs

@@ -13,6 +13,7 @@
 
 use regex::Regex;
 
+#[derive(Debug)]
 pub enum Error {
     RegexError,
 }
@@ -51,3 +52,64 @@ pub fn to_regex(glob: &str) -> Result<Regex, Error> {
     let re = to_regex_string(glob);
     Regex::new(&re).map_err(|_err| Error::RegexError)
 }
+
+pub fn matches_path_pattern(input: &str) -> bool {
+    if !input.starts_with('*') {
+        let pattern = r"^(?:\w+(?:\.\w+)*)(?:\.\*+)?$";
+        let regex = Regex::new(pattern).unwrap();
+
+        let pattern2 = r"^[^.]+(\.[^.]+)*\.(\*{2}|\*|[A-Za-z]+)(\.[^.]+)*\.[^.]+$";
+        let regex2 = Regex::new(pattern2).unwrap();
+
+        regex.is_match(input) || regex2.is_match(input)
+    } else {
+        false
+    }
+}
+
+#[tokio::test]
+async fn test_valid_request_path() {
+    let inputs = vec![
+        "String.*",
+        "String.**",
+        "String.String.String.String.*",
+        "String.String.String.String.**",
+        "String.String.String.String",
+        "String.String.String.String.String.**",
+        "String.String.String.*.String",
+        "String.String.String.**.String",
+        "String.String.String.String.String.**.String",
+        "String.String.String.String.*.String.String",
+        "String.*.String.String",
+        "String.String.**.String.String",
+        "String.**.String.String",
+        "String.String.String.",
+        "String.String.String.String..",
+        "String.*.String.String..",
+        "*.String.String.String..",
+        "*.String.String.String",
+        "**.String.String.String.**",
+        "**.String.String.String.*",
+    ];
+
+    assert!(matches_path_pattern(inputs[0]));
+    assert!(matches_path_pattern(inputs[1]));
+    assert!(matches_path_pattern(inputs[2]));
+    assert!(matches_path_pattern(inputs[3]));
+    assert!(matches_path_pattern(inputs[4]));
+    assert!(matches_path_pattern(inputs[5]));
+    assert!(matches_path_pattern(inputs[6]));
+    assert!(matches_path_pattern(inputs[7]));
+    assert!(matches_path_pattern(inputs[8]));
+    assert!(matches_path_pattern(inputs[9]));
+    assert!(matches_path_pattern(inputs[10]));
+    assert!(matches_path_pattern(inputs[11]));
+    assert!(matches_path_pattern(inputs[12]));
+    assert!(!matches_path_pattern(inputs[13]));
+    assert!(!matches_path_pattern(inputs[14]));
+    assert!(!matches_path_pattern(inputs[15]));
+    assert!(!matches_path_pattern(inputs[16]));
+    assert!(!matches_path_pattern(inputs[17]));
+    assert!(!matches_path_pattern(inputs[18]));
+    assert!(!matches_path_pattern(inputs[19]));
+}

kuksa_databroker/databroker/src/grpc/kuksa_val_v1/val.rs

@@ -11,7 +11,6 @@
 * SPDX-License-Identifier: Apache-2.0
 ********************************************************************************/
 
-use regex::Regex;
 use std::collections::HashMap;
 use std::collections::HashSet;
 use std::iter::FromIterator;
@@ -27,6 +26,7 @@ use crate::broker;
 use crate::broker::ReadError;
 use crate::broker::SubscriptionError;
 use crate::permissions::Permissions;
+use crate::glob;
 
 #[tonic::async_trait]
 impl proto::val_server::Val for broker::DataBroker {
@@ -55,7 +55,7 @@ impl proto::val_server::Val for broker::DataBroker {
             let mut errors = Vec::new();
 
             for request in requested {
-                match matches_path_pattern(&request.path) {
+                match glob::matches_path_pattern(&request.path) {
                     true => {
                         match broker.get_entry_by_path(&request.path).await {
                             Ok(entry) => {
@@ -749,12 +749,6 @@ fn combine_view_and_fields(
     combined
 }
 
-fn matches_path_pattern(input: &str) -> bool {
-    let pattern = r"^(?:\w+(?:\.\w+)*)(?:\.\*+)?$";
-    let regex = Regex::new(pattern).unwrap();
-    regex.is_match(input)
-}
-
 impl broker::EntryUpdate {
     fn from_proto_entry_and_fields(
         entry: &proto::DataEntry,
@@ -846,31 +840,4 @@ mod tests {
             Err(_status) => panic!("failed to execute set request"),
         }
     }
-
-    #[tokio::test]
-    async fn test_valid_request_path() {
-        let inputs = vec![
-            "String.*",
-            "String.**",
-            "String.String.String.String.*",
-            "String.String.String.String.**",
-            "String.String.String.String",
-            "String.String.String.String.String.**",
-            "String.String.String.",
-            "String.String.String.String..",
-            "String.*.String.String..",
-            "*.String.String.String..",
-        ];
-
-        assert!(matches_path_pattern(inputs[0]));
-        assert!(matches_path_pattern(inputs[1]));
-        assert!(matches_path_pattern(inputs[2]));
-        assert!(matches_path_pattern(inputs[3]));
-        assert!(matches_path_pattern(inputs[4]));
-        assert!(matches_path_pattern(inputs[5]));
-        assert!(!matches_path_pattern(inputs[6]));
-        assert!(!matches_path_pattern(inputs[7]));
-        assert!(!matches_path_pattern(inputs[8]));
-        assert!(!matches_path_pattern(inputs[9]));
-    }
 }