cmd/
standalone.rs

1// Copyright 2023 Greptime Team
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::fmt::Debug;
16use std::net::SocketAddr;
17use std::path::Path;
18use std::sync::Arc;
19use std::{fs, path};
20
21use async_trait::async_trait;
22use cache::{build_fundamental_cache_registry, with_default_composite_cache_registry};
23use catalog::information_schema::InformationExtensionRef;
24use catalog::kvbackend::{CatalogManagerConfiguratorRef, KvBackendCatalogManagerBuilder};
25use catalog::process_manager::ProcessManager;
26use clap::Parser;
27use common_base::Plugins;
28use common_catalog::consts::{MIN_USER_FLOW_ID, MIN_USER_TABLE_ID};
29use common_config::{Configurable, metadata_store_dir};
30use common_error::ext::BoxedError;
31use common_meta::cache::LayeredCacheRegistryBuilder;
32use common_meta::ddl::flow_meta::FlowMetadataAllocator;
33use common_meta::ddl::table_meta::TableMetadataAllocator;
34use common_meta::ddl::{DdlContext, NoopRegionFailureDetectorControl};
35use common_meta::ddl_manager::{DdlManager, DdlManagerConfiguratorRef};
36use common_meta::key::flow::FlowMetadataManager;
37use common_meta::key::{TableMetadataManager, TableMetadataManagerRef};
38use common_meta::kv_backend::KvBackendRef;
39use common_meta::procedure_executor::LocalProcedureExecutor;
40use common_meta::region_keeper::MemoryRegionKeeper;
41use common_meta::region_registry::LeaderRegionRegistry;
42use common_meta::sequence::SequenceBuilder;
43use common_meta::wal_provider::{WalProviderRef, build_wal_provider};
44use common_procedure::ProcedureManagerRef;
45use common_query::prelude::set_default_prefix;
46use common_telemetry::info;
47use common_telemetry::logging::{DEFAULT_LOGGING_DIR, TracingOptions};
48use common_time::timezone::set_default_timezone;
49use common_version::{short_version, verbose_version};
50use datanode::config::DatanodeOptions;
51use datanode::datanode::{Datanode, DatanodeBuilder};
52use flow::{
53    FlownodeBuilder, FlownodeInstance, FlownodeOptions, FrontendClient, FrontendInvoker,
54    GrpcQueryHandlerWithBoxedError,
55};
56use frontend::frontend::Frontend;
57use frontend::instance::StandaloneDatanodeManager;
58use frontend::instance::builder::FrontendBuilder;
59use frontend::server::Services;
60use meta_srv::metasrv::{FLOW_ID_SEQ, TABLE_ID_SEQ};
61use plugins::frontend::context::{
62    CatalogManagerConfigureContext, StandaloneCatalogManagerConfigureContext,
63};
64use plugins::standalone::context::DdlManagerConfigureContext;
65use servers::tls::{TlsMode, TlsOption, merge_tls_option};
66use snafu::ResultExt;
67use standalone::options::StandaloneOptions;
68use standalone::{StandaloneInformationExtension, StandaloneRepartitionProcedureFactory};
69use tracing_appender::non_blocking::WorkerGuard;
70
71use crate::error::{OtherSnafu, Result, StartFlownodeSnafu};
72use crate::options::{GlobalOptions, GreptimeOptions};
73use crate::{App, create_resource_limit_metrics, error, log_versions, maybe_activate_heap_profile};
74
75pub const APP_NAME: &str = "greptime-standalone";
76
77#[derive(Parser)]
78pub struct Command {
79    #[clap(subcommand)]
80    subcmd: SubCommand,
81}
82
83impl Command {
84    pub async fn build(&self, opts: GreptimeOptions<StandaloneOptions>) -> Result<Instance> {
85        self.subcmd.build(opts).await
86    }
87
88    pub fn load_options(
89        &self,
90        global_options: &GlobalOptions,
91    ) -> Result<GreptimeOptions<StandaloneOptions>> {
92        self.subcmd.load_options(global_options)
93    }
94}
95
96#[derive(Parser)]
97enum SubCommand {
98    Start(StartCommand),
99}
100
101impl SubCommand {
102    async fn build(&self, opts: GreptimeOptions<StandaloneOptions>) -> Result<Instance> {
103        match self {
104            SubCommand::Start(cmd) => cmd.build(opts).await,
105        }
106    }
107
108    fn load_options(
109        &self,
110        global_options: &GlobalOptions,
111    ) -> Result<GreptimeOptions<StandaloneOptions>> {
112        match self {
113            SubCommand::Start(cmd) => cmd.load_options(global_options),
114        }
115    }
116}
117
118pub struct Instance {
119    datanode: Datanode,
120    frontend: Frontend,
121    flownode: FlownodeInstance,
122    procedure_manager: ProcedureManagerRef,
123    wal_provider: WalProviderRef,
124    // Keep the logging guard to prevent the worker from being dropped.
125    _guard: Vec<WorkerGuard>,
126}
127
128impl Instance {
129    /// Find the socket addr of a server by its `name`.
130    pub fn server_addr(&self, name: &str) -> Option<SocketAddr> {
131        self.frontend.server_handlers().addr(name)
132    }
133}
134
135#[async_trait]
136impl App for Instance {
137    fn name(&self) -> &str {
138        APP_NAME
139    }
140
141    async fn start(&mut self) -> Result<()> {
142        self.datanode.start_telemetry();
143
144        self.procedure_manager
145            .start()
146            .await
147            .context(error::StartProcedureManagerSnafu)?;
148
149        self.wal_provider
150            .start()
151            .await
152            .context(error::StartWalProviderSnafu)?;
153
154        plugins::start_frontend_plugins(self.frontend.instance.plugins().clone())
155            .await
156            .context(error::StartFrontendSnafu)?;
157
158        self.frontend
159            .start()
160            .await
161            .context(error::StartFrontendSnafu)?;
162
163        self.flownode.start().await.context(StartFlownodeSnafu)?;
164
165        Ok(())
166    }
167
168    async fn stop(&mut self) -> Result<()> {
169        self.frontend
170            .shutdown()
171            .await
172            .context(error::ShutdownFrontendSnafu)?;
173
174        self.procedure_manager
175            .stop()
176            .await
177            .context(error::StopProcedureManagerSnafu)?;
178
179        self.datanode
180            .shutdown()
181            .await
182            .context(error::ShutdownDatanodeSnafu)?;
183
184        self.flownode
185            .shutdown()
186            .await
187            .context(error::ShutdownFlownodeSnafu)?;
188
189        info!("Datanode instance stopped.");
190
191        Ok(())
192    }
193}
194
195#[derive(Debug, Default, Parser)]
196pub struct StartCommand {
197    #[clap(long)]
198    http_addr: Option<String>,
199    #[clap(long, alias = "rpc-addr")]
200    rpc_bind_addr: Option<String>,
201    #[clap(long)]
202    mysql_addr: Option<String>,
203    #[clap(long)]
204    postgres_addr: Option<String>,
205    #[clap(short, long)]
206    influxdb_enable: bool,
207    #[clap(short, long)]
208    pub config_file: Option<String>,
209    #[clap(long)]
210    tls_mode: Option<TlsMode>,
211    #[clap(long)]
212    tls_cert_path: Option<String>,
213    #[clap(long)]
214    tls_key_path: Option<String>,
215    #[clap(long)]
216    tls_watch: bool,
217    #[clap(long)]
218    user_provider: Option<String>,
219    #[clap(long, default_value = "GREPTIMEDB_STANDALONE")]
220    pub env_prefix: String,
221    /// The working home directory of this standalone instance.
222    #[clap(long)]
223    data_home: Option<String>,
224}
225
226impl StartCommand {
227    /// Load the GreptimeDB options from various sources (command line, config file or env).
228    pub fn load_options(
229        &self,
230        global_options: &GlobalOptions,
231    ) -> Result<GreptimeOptions<StandaloneOptions>> {
232        let mut opts = GreptimeOptions::<StandaloneOptions>::load_layered_options(
233            self.config_file.as_deref(),
234            self.env_prefix.as_ref(),
235        )
236        .context(error::LoadLayeredConfigSnafu)?;
237
238        self.merge_with_cli_options(global_options, &mut opts.component)?;
239        opts.component.sanitize();
240
241        Ok(opts)
242    }
243
244    // The precedence order is: cli > config file > environment variables > default values.
245    pub fn merge_with_cli_options(
246        &self,
247        global_options: &GlobalOptions,
248        opts: &mut StandaloneOptions,
249    ) -> Result<()> {
250        if let Some(dir) = &global_options.log_dir {
251            opts.logging.dir.clone_from(dir);
252        }
253
254        if global_options.log_level.is_some() {
255            opts.logging.level.clone_from(&global_options.log_level);
256        }
257
258        opts.tracing = TracingOptions {
259            #[cfg(feature = "tokio-console")]
260            tokio_console_addr: global_options.tokio_console_addr.clone(),
261        };
262
263        let tls_opts = TlsOption::new(
264            self.tls_mode,
265            self.tls_cert_path.clone(),
266            self.tls_key_path.clone(),
267            self.tls_watch,
268        );
269
270        if let Some(addr) = &self.http_addr {
271            opts.http.addr.clone_from(addr);
272        }
273
274        if let Some(data_home) = &self.data_home {
275            opts.storage.data_home.clone_from(data_home);
276        }
277
278        // If the logging dir is not set, use the default logs dir in the data home.
279        if opts.logging.dir.is_empty() {
280            opts.logging.dir = Path::new(&opts.storage.data_home)
281                .join(DEFAULT_LOGGING_DIR)
282                .to_string_lossy()
283                .to_string();
284        }
285
286        if let Some(addr) = &self.rpc_bind_addr {
287            // frontend grpc addr conflict with datanode default grpc addr
288            let datanode_grpc_addr = DatanodeOptions::default().grpc.bind_addr;
289            if addr.eq(&datanode_grpc_addr) {
290                return error::IllegalConfigSnafu {
291                    msg: format!(
292                        "gRPC listen address conflicts with datanode reserved gRPC addr: {datanode_grpc_addr}",
293                    ),
294                }.fail();
295            }
296            opts.grpc.bind_addr.clone_from(addr);
297            opts.grpc.tls = merge_tls_option(&opts.grpc.tls, tls_opts.clone());
298        }
299
300        if let Some(addr) = &self.mysql_addr {
301            opts.mysql.enable = true;
302            opts.mysql.addr.clone_from(addr);
303            opts.mysql.tls = merge_tls_option(&opts.mysql.tls, tls_opts.clone());
304        }
305
306        if let Some(addr) = &self.postgres_addr {
307            opts.postgres.enable = true;
308            opts.postgres.addr.clone_from(addr);
309            opts.postgres.tls = merge_tls_option(&opts.postgres.tls, tls_opts.clone());
310        }
311
312        if self.influxdb_enable {
313            opts.influxdb.enable = self.influxdb_enable;
314        }
315
316        if let Some(user_provider) = &self.user_provider {
317            opts.user_provider = Some(user_provider.clone());
318        }
319
320        Ok(())
321    }
322
323    #[allow(unreachable_code)]
324    #[allow(unused_variables)]
325    #[allow(clippy::diverging_sub_expression)]
326    /// Build GreptimeDB instance with the loaded options.
327    pub async fn build(&self, opts: GreptimeOptions<StandaloneOptions>) -> Result<Instance> {
328        common_runtime::init_global_runtimes(&opts.runtime);
329
330        let guard = common_telemetry::init_global_logging(
331            APP_NAME,
332            &opts.component.logging,
333            &opts.component.tracing,
334            None,
335            Some(&opts.component.slow_query),
336        );
337
338        log_versions(verbose_version(), short_version(), APP_NAME);
339        maybe_activate_heap_profile(&opts.component.memory);
340        create_resource_limit_metrics(APP_NAME);
341
342        info!("Standalone start command: {:#?}", self);
343        info!("Standalone options: {opts:#?}");
344
345        let mut plugins = Plugins::new();
346        let plugin_opts = opts.plugins;
347        let mut opts = opts.component;
348        set_default_prefix(opts.default_column_prefix.as_deref())
349            .map_err(BoxedError::new)
350            .context(error::BuildCliSnafu)?;
351
352        opts.grpc.detect_server_addr();
353        let fe_opts = opts.frontend_options();
354        let dn_opts = opts.datanode_options();
355
356        plugins::setup_frontend_plugins(&mut plugins, &plugin_opts, &fe_opts)
357            .await
358            .context(error::StartFrontendSnafu)?;
359
360        plugins::setup_datanode_plugins(&mut plugins, &plugin_opts, &dn_opts)
361            .await
362            .context(error::StartDatanodeSnafu)?;
363
364        set_default_timezone(fe_opts.default_timezone.as_deref())
365            .context(error::InitTimezoneSnafu)?;
366
367        let data_home = &dn_opts.storage.data_home;
368        // Ensure the data_home directory exists.
369        fs::create_dir_all(path::Path::new(data_home))
370            .context(error::CreateDirSnafu { dir: data_home })?;
371
372        let metadata_dir = metadata_store_dir(data_home);
373        let kv_backend = standalone::build_metadata_kvbackend(metadata_dir, opts.metadata_store)
374            .context(error::BuildMetadataKvbackendSnafu)?;
375        let procedure_manager =
376            standalone::build_procedure_manager(kv_backend.clone(), opts.procedure);
377
378        plugins::setup_standalone_plugins(&mut plugins, &plugin_opts, &opts, kv_backend.clone())
379            .await
380            .context(error::SetupStandalonePluginsSnafu)?;
381
382        // Builds cache registry
383        let layered_cache_builder = LayeredCacheRegistryBuilder::default();
384        let fundamental_cache_registry = build_fundamental_cache_registry(kv_backend.clone());
385        let layered_cache_registry = Arc::new(
386            with_default_composite_cache_registry(
387                layered_cache_builder.add_cache_registry(fundamental_cache_registry),
388            )
389            .context(error::BuildCacheRegistrySnafu)?
390            .build(),
391        );
392
393        let mut builder = DatanodeBuilder::new(dn_opts, plugins.clone(), kv_backend.clone());
394        builder.with_cache_registry(layered_cache_registry.clone());
395        let datanode = builder.build().await.context(error::StartDatanodeSnafu)?;
396
397        let information_extension = Arc::new(StandaloneInformationExtension::new(
398            datanode.region_server(),
399            procedure_manager.clone(),
400        ));
401
402        plugins.insert::<InformationExtensionRef>(information_extension.clone());
403
404        let process_manager = Arc::new(ProcessManager::new(opts.grpc.server_addr.clone(), None));
405
406        // for standalone not use grpc, but get a handler to frontend grpc client without
407        // actually make a connection
408        let (frontend_client, frontend_instance_handler) =
409            FrontendClient::from_empty_grpc_handler(opts.query.clone());
410        let frontend_client = Arc::new(frontend_client);
411
412        let builder = KvBackendCatalogManagerBuilder::new(
413            information_extension.clone(),
414            kv_backend.clone(),
415            layered_cache_registry.clone(),
416        )
417        .with_procedure_manager(procedure_manager.clone())
418        .with_process_manager(process_manager.clone());
419        let builder = if let Some(configurator) =
420            plugins.get::<CatalogManagerConfiguratorRef<CatalogManagerConfigureContext>>()
421        {
422            let ctx = StandaloneCatalogManagerConfigureContext {
423                fe_client: frontend_client.clone(),
424            };
425            let ctx = CatalogManagerConfigureContext::Standalone(ctx);
426            configurator
427                .configure(builder, ctx)
428                .await
429                .context(OtherSnafu)?
430        } else {
431            builder
432        };
433        let catalog_manager = builder.build();
434
435        let table_metadata_manager =
436            Self::create_table_metadata_manager(kv_backend.clone()).await?;
437
438        let flow_metadata_manager = Arc::new(FlowMetadataManager::new(kv_backend.clone()));
439        let flownode_options = FlownodeOptions {
440            flow: opts.flow.clone(),
441            ..Default::default()
442        };
443
444        let flow_builder = FlownodeBuilder::new(
445            flownode_options,
446            plugins.clone(),
447            table_metadata_manager.clone(),
448            catalog_manager.clone(),
449            flow_metadata_manager.clone(),
450            frontend_client.clone(),
451        );
452        let flownode = flow_builder
453            .build()
454            .await
455            .map_err(BoxedError::new)
456            .context(error::OtherSnafu)?;
457
458        // set the ref to query for the local flow state
459        {
460            information_extension
461                .set_flow_engine(flownode.flow_engine())
462                .await;
463        }
464
465        let node_manager = Arc::new(StandaloneDatanodeManager {
466            region_server: datanode.region_server(),
467            flow_server: flownode.flow_engine(),
468        });
469
470        let table_id_allocator = Arc::new(
471            SequenceBuilder::new(TABLE_ID_SEQ, kv_backend.clone())
472                .initial(MIN_USER_TABLE_ID as u64)
473                .step(10)
474                .build(),
475        );
476        let flow_id_sequence = Arc::new(
477            SequenceBuilder::new(FLOW_ID_SEQ, kv_backend.clone())
478                .initial(MIN_USER_FLOW_ID as u64)
479                .step(10)
480                .build(),
481        );
482        let kafka_options = opts
483            .wal
484            .clone()
485            .try_into()
486            .context(error::InvalidWalProviderSnafu)?;
487        let wal_provider = build_wal_provider(&kafka_options, kv_backend.clone())
488            .await
489            .context(error::BuildWalProviderSnafu)?;
490        let wal_provider = Arc::new(wal_provider);
491        let table_metadata_allocator = Arc::new(TableMetadataAllocator::new(
492            table_id_allocator,
493            wal_provider.clone(),
494        ));
495        let flow_metadata_allocator = Arc::new(FlowMetadataAllocator::with_noop_peer_allocator(
496            flow_id_sequence,
497        ));
498
499        let ddl_context = DdlContext {
500            node_manager: node_manager.clone(),
501            cache_invalidator: layered_cache_registry.clone(),
502            memory_region_keeper: Arc::new(MemoryRegionKeeper::default()),
503            leader_region_registry: Arc::new(LeaderRegionRegistry::default()),
504            table_metadata_manager: table_metadata_manager.clone(),
505            table_metadata_allocator: table_metadata_allocator.clone(),
506            flow_metadata_manager: flow_metadata_manager.clone(),
507            flow_metadata_allocator: flow_metadata_allocator.clone(),
508            region_failure_detector_controller: Arc::new(NoopRegionFailureDetectorControl),
509        };
510
511        let ddl_manager = DdlManager::try_new(
512            ddl_context,
513            procedure_manager.clone(),
514            Arc::new(StandaloneRepartitionProcedureFactory),
515            true,
516        )
517        .context(error::InitDdlManagerSnafu)?;
518
519        let ddl_manager = if let Some(configurator) =
520            plugins.get::<DdlManagerConfiguratorRef<DdlManagerConfigureContext>>()
521        {
522            let ctx = DdlManagerConfigureContext {
523                kv_backend: kv_backend.clone(),
524                fe_client: frontend_client.clone(),
525                catalog_manager: catalog_manager.clone(),
526            };
527            configurator
528                .configure(ddl_manager, ctx)
529                .await
530                .context(OtherSnafu)?
531        } else {
532            ddl_manager
533        };
534
535        let procedure_executor = Arc::new(LocalProcedureExecutor::new(
536            Arc::new(ddl_manager),
537            procedure_manager.clone(),
538        ));
539
540        let fe_instance = FrontendBuilder::new(
541            fe_opts.clone(),
542            kv_backend.clone(),
543            layered_cache_registry.clone(),
544            catalog_manager.clone(),
545            node_manager.clone(),
546            procedure_executor.clone(),
547            process_manager,
548        )
549        .with_plugin(plugins.clone())
550        .try_build()
551        .await
552        .context(error::StartFrontendSnafu)?;
553        let fe_instance = Arc::new(fe_instance);
554
555        // set the frontend client for flownode
556        let grpc_handler = fe_instance.clone() as Arc<dyn GrpcQueryHandlerWithBoxedError>;
557        let weak_grpc_handler = Arc::downgrade(&grpc_handler);
558        frontend_instance_handler
559            .set_handler(weak_grpc_handler)
560            .await;
561
562        // set the frontend invoker for flownode
563        let flow_streaming_engine = flownode.flow_engine().streaming_engine();
564        // flow server need to be able to use frontend to write insert requests back
565        let invoker = FrontendInvoker::build_from(
566            flow_streaming_engine.clone(),
567            catalog_manager.clone(),
568            kv_backend.clone(),
569            layered_cache_registry.clone(),
570            procedure_executor,
571            node_manager,
572        )
573        .await
574        .context(StartFlownodeSnafu)?;
575        flow_streaming_engine.set_frontend_invoker(invoker).await;
576
577        let servers = Services::new(opts, fe_instance.clone(), plugins.clone())
578            .build()
579            .context(error::StartFrontendSnafu)?;
580
581        let frontend = Frontend {
582            instance: fe_instance,
583            servers,
584            heartbeat_task: None,
585        };
586
587        Ok(Instance {
588            datanode,
589            frontend,
590            flownode,
591            procedure_manager,
592            wal_provider,
593            _guard: guard,
594        })
595    }
596
597    pub async fn create_table_metadata_manager(
598        kv_backend: KvBackendRef,
599    ) -> Result<TableMetadataManagerRef> {
600        let table_metadata_manager = Arc::new(TableMetadataManager::new(kv_backend));
601
602        table_metadata_manager
603            .init()
604            .await
605            .context(error::InitMetadataSnafu)?;
606
607        Ok(table_metadata_manager)
608    }
609}
610
611#[cfg(test)]
612mod tests {
613    use std::default::Default;
614    use std::io::Write;
615    use std::time::Duration;
616
617    use auth::{Identity, Password, UserProviderRef};
618    use common_base::readable_size::ReadableSize;
619    use common_config::ENV_VAR_SEP;
620    use common_test_util::temp_dir::create_named_temp_file;
621    use common_wal::config::DatanodeWalConfig;
622    use frontend::frontend::FrontendOptions;
623    use object_store::config::{FileConfig, GcsConfig};
624    use servers::grpc::GrpcOptions;
625
626    use super::*;
627    use crate::options::GlobalOptions;
628
629    #[tokio::test]
630    async fn test_try_from_start_command_to_anymap() {
631        let fe_opts = FrontendOptions {
632            user_provider: Some("static_user_provider:cmd:test=test".to_string()),
633            ..Default::default()
634        };
635
636        let mut plugins = Plugins::new();
637        plugins::setup_frontend_plugins(&mut plugins, &[], &fe_opts)
638            .await
639            .unwrap();
640
641        let provider = plugins.get::<UserProviderRef>().unwrap();
642        let result = provider
643            .authenticate(
644                Identity::UserId("test", None),
645                Password::PlainText("test".to_string().into()),
646            )
647            .await;
648        let _ = result.unwrap();
649    }
650
651    #[test]
652    fn test_toml() {
653        let opts = StandaloneOptions::default();
654        let toml_string = toml::to_string(&opts).unwrap();
655        let _parsed: StandaloneOptions = toml::from_str(&toml_string).unwrap();
656    }
657
658    #[test]
659    fn test_read_from_config_file() {
660        let mut file = create_named_temp_file();
661        let toml_str = r#"
662            enable_memory_catalog = true
663
664            [wal]
665            provider = "raft_engine"
666            dir = "./greptimedb_data/test/wal"
667            file_size = "1GB"
668            purge_threshold = "50GB"
669            purge_interval = "10m"
670            read_batch_size = 128
671            sync_write = false
672
673            [storage]
674            data_home = "./greptimedb_data/"
675            type = "File"
676
677            [[storage.providers]]
678            type = "Gcs"
679            bucket = "foo"
680            endpoint = "bar"
681
682            [[storage.providers]]
683            type = "S3"
684            access_key_id = "access_key_id"
685            secret_access_key = "secret_access_key"
686
687            [storage.compaction]
688            max_inflight_tasks = 3
689            max_files_in_level0 = 7
690            max_purge_tasks = 32
691
692            [storage.manifest]
693            checkpoint_margin = 9
694            gc_duration = '7s'
695
696            [http]
697            addr = "127.0.0.1:4000"
698            timeout = "33s"
699            body_limit = "128MB"
700
701            [opentsdb]
702            enable = true
703
704            [logging]
705            level = "debug"
706            dir = "./greptimedb_data/test/logs"
707        "#;
708        write!(file, "{}", toml_str).unwrap();
709        let cmd = StartCommand {
710            config_file: Some(file.path().to_str().unwrap().to_string()),
711            user_provider: Some("static_user_provider:cmd:test=test".to_string()),
712            ..Default::default()
713        };
714
715        let options = cmd
716            .load_options(&GlobalOptions::default())
717            .unwrap()
718            .component;
719        let fe_opts = options.frontend_options();
720        let dn_opts = options.datanode_options();
721        let logging_opts = options.logging;
722        assert_eq!("127.0.0.1:4000".to_string(), fe_opts.http.addr);
723        assert_eq!(Duration::from_secs(33), fe_opts.http.timeout);
724        assert_eq!(ReadableSize::mb(128), fe_opts.http.body_limit);
725        assert_eq!("127.0.0.1:4001".to_string(), fe_opts.grpc.bind_addr);
726        assert!(fe_opts.mysql.enable);
727        assert_eq!("127.0.0.1:4002", fe_opts.mysql.addr);
728        assert_eq!(2, fe_opts.mysql.runtime_size);
729        assert_eq!(None, fe_opts.mysql.reject_no_database);
730        assert!(fe_opts.influxdb.enable);
731        assert!(fe_opts.opentsdb.enable);
732
733        let DatanodeWalConfig::RaftEngine(raft_engine_config) = dn_opts.wal else {
734            unreachable!()
735        };
736        assert_eq!(
737            "./greptimedb_data/test/wal",
738            raft_engine_config.dir.unwrap()
739        );
740
741        assert!(matches!(
742            &dn_opts.storage.store,
743            object_store::config::ObjectStoreConfig::File(FileConfig { .. })
744        ));
745        assert_eq!(dn_opts.storage.providers.len(), 2);
746        assert!(matches!(
747            dn_opts.storage.providers[0],
748            object_store::config::ObjectStoreConfig::Gcs(GcsConfig { .. })
749        ));
750        match &dn_opts.storage.providers[1] {
751            object_store::config::ObjectStoreConfig::S3(s3_config) => {
752                assert_eq!(
753                    "SecretBox<alloc::string::String>([REDACTED])".to_string(),
754                    format!("{:?}", s3_config.connection.access_key_id)
755                );
756            }
757            _ => {
758                unreachable!()
759            }
760        }
761
762        assert_eq!("debug", logging_opts.level.as_ref().unwrap());
763        assert_eq!("./greptimedb_data/test/logs".to_string(), logging_opts.dir);
764    }
765
766    #[test]
767    fn test_load_log_options_from_cli() {
768        let cmd = StartCommand {
769            user_provider: Some("static_user_provider:cmd:test=test".to_string()),
770            mysql_addr: Some("127.0.0.1:4002".to_string()),
771            postgres_addr: Some("127.0.0.1:4003".to_string()),
772            ..Default::default()
773        };
774
775        let opts = cmd
776            .load_options(&GlobalOptions {
777                log_dir: Some("./greptimedb_data/test/logs".to_string()),
778                log_level: Some("debug".to_string()),
779
780                #[cfg(feature = "tokio-console")]
781                tokio_console_addr: None,
782            })
783            .unwrap()
784            .component;
785
786        assert_eq!("./greptimedb_data/test/logs", opts.logging.dir);
787        assert_eq!("debug", opts.logging.level.unwrap());
788    }
789
790    #[test]
791    fn test_config_precedence_order() {
792        let mut file = create_named_temp_file();
793        let toml_str = r#"
794            [http]
795            addr = "127.0.0.1:4000"
796
797            [logging]
798            level = "debug"
799        "#;
800        write!(file, "{}", toml_str).unwrap();
801
802        let env_prefix = "STANDALONE_UT";
803        temp_env::with_vars(
804            [
805                (
806                    // logging.dir = /other/log/dir
807                    [
808                        env_prefix.to_string(),
809                        "logging".to_uppercase(),
810                        "dir".to_uppercase(),
811                    ]
812                    .join(ENV_VAR_SEP),
813                    Some("/other/log/dir"),
814                ),
815                (
816                    // logging.level = info
817                    [
818                        env_prefix.to_string(),
819                        "logging".to_uppercase(),
820                        "level".to_uppercase(),
821                    ]
822                    .join(ENV_VAR_SEP),
823                    Some("info"),
824                ),
825                (
826                    // http.addr = 127.0.0.1:24000
827                    [
828                        env_prefix.to_string(),
829                        "http".to_uppercase(),
830                        "addr".to_uppercase(),
831                    ]
832                    .join(ENV_VAR_SEP),
833                    Some("127.0.0.1:24000"),
834                ),
835            ],
836            || {
837                let command = StartCommand {
838                    config_file: Some(file.path().to_str().unwrap().to_string()),
839                    http_addr: Some("127.0.0.1:14000".to_string()),
840                    env_prefix: env_prefix.to_string(),
841                    ..Default::default()
842                };
843
844                let opts = command.load_options(&Default::default()).unwrap().component;
845
846                // Should be read from env, env > default values.
847                assert_eq!(opts.logging.dir, "/other/log/dir");
848
849                // Should be read from config file, config file > env > default values.
850                assert_eq!(opts.logging.level.as_ref().unwrap(), "debug");
851
852                // Should be read from cli, cli > config file > env > default values.
853                let fe_opts = opts.frontend_options();
854                assert_eq!(fe_opts.http.addr, "127.0.0.1:14000");
855                assert_eq!(ReadableSize::mb(64), fe_opts.http.body_limit);
856
857                // Should be default value.
858                assert_eq!(fe_opts.grpc.bind_addr, GrpcOptions::default().bind_addr);
859            },
860        );
861    }
862
863    #[test]
864    fn test_load_default_standalone_options() {
865        let options =
866            StandaloneOptions::load_layered_options(None, "GREPTIMEDB_STANDALONE").unwrap();
867        let default_options = StandaloneOptions::default();
868        assert_eq!(options.enable_telemetry, default_options.enable_telemetry);
869        assert_eq!(options.http, default_options.http);
870        assert_eq!(options.grpc, default_options.grpc);
871        assert_eq!(options.mysql, default_options.mysql);
872        assert_eq!(options.postgres, default_options.postgres);
873        assert_eq!(options.opentsdb, default_options.opentsdb);
874        assert_eq!(options.influxdb, default_options.influxdb);
875        assert_eq!(options.prom_store, default_options.prom_store);
876        assert_eq!(options.wal, default_options.wal);
877        assert_eq!(options.metadata_store, default_options.metadata_store);
878        assert_eq!(options.procedure, default_options.procedure);
879        assert_eq!(options.logging, default_options.logging);
880        assert_eq!(options.region_engine, default_options.region_engine);
881    }
882
883    #[test]
884    fn test_cache_config() {
885        let toml_str = r#"
886            [storage]
887            data_home = "test_data_home"
888            type = "S3"
889            [storage.cache_config]
890            enable_read_cache = true
891        "#;
892        let mut opts: StandaloneOptions = toml::from_str(toml_str).unwrap();
893        opts.sanitize();
894        assert!(opts.storage.store.cache_config().unwrap().enable_read_cache);
895        assert_eq!(
896            opts.storage.store.cache_config().unwrap().cache_path,
897            "test_data_home"
898        );
899    }
900}