opendal_core/services/hdfs_native/
config.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use std::fmt::Debug;
19
20use serde::Deserialize;
21use serde::Serialize;
22
23use super::backend::HdfsNativeBuilder;
24
25/// Config for HdfsNative services support.
26#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
27#[serde(default)]
28#[non_exhaustive]
29pub struct HdfsNativeConfig {
30    /// work dir of this backend
31    pub root: Option<String>,
32    /// name_node of this backend
33    pub name_node: Option<String>,
34    /// enable the append capacity
35    pub enable_append: bool,
36}
37
38impl Debug for HdfsNativeConfig {
39    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
40        f.debug_struct("HdfsNativeConfig")
41            .field("root", &self.root)
42            .field("name_node", &self.name_node)
43            .field("enable_append", &self.enable_append)
44            .finish_non_exhaustive()
45    }
46}
47
48impl crate::Configurator for HdfsNativeConfig {
49    type Builder = HdfsNativeBuilder;
50
51    fn from_uri(uri: &crate::types::OperatorUri) -> crate::Result<Self> {
52        let mut map = uri.options().clone();
53        if let Some(authority) = uri.authority() {
54            map.insert("name_node".to_string(), format!("hdfs://{authority}"));
55        }
56
57        if let Some(root) = uri.root() {
58            if !root.is_empty() {
59                map.insert("root".to_string(), root.to_string());
60            }
61        }
62
63        Self::from_iter(map)
64    }
65
66    fn into_builder(self) -> Self::Builder {
67        HdfsNativeBuilder { config: self }
68    }
69}
70
71#[cfg(test)]
72mod tests {
73    use super::*;
74    use crate::Configurator;
75    use crate::types::OperatorUri;
76
77    #[test]
78    fn from_uri_sets_name_node_and_root() {
79        let uri = OperatorUri::new(
80            "hdfs-native://namenode:9000/user/project",
81            Vec::<(String, String)>::new(),
82        )
83        .unwrap();
84
85        let cfg = HdfsNativeConfig::from_uri(&uri).unwrap();
86        assert_eq!(cfg.name_node.as_deref(), Some("hdfs://namenode:9000"));
87        assert_eq!(cfg.root.as_deref(), Some("user/project"));
88    }
89
90    #[test]
91    fn from_uri_allows_missing_authority() {
92        let uri = OperatorUri::new("hdfs-native", Vec::<(String, String)>::new()).unwrap();
93
94        let cfg = HdfsNativeConfig::from_uri(&uri).unwrap();
95        assert!(cfg.name_node.is_none());
96    }
97}