fix: Fix test issue with missing sentinel config values

smf8 · bikeshedder · commit 70e0bfa03b19 · 2024-08-29T13:00:08.000+02:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,10 +2,10 @@ name: CI
 
 on:
   push:
-    branches: ["master"]
-    tags: ["deadpool-*"]
+    branches: [ "master" ]
+    tags: [ "deadpool-*" ]
   pull_request:
-    branches: ["master"]
+    branches: [ "master" ]
 
 env:
   RUST_BACKTRACE: 1
@@ -87,8 +87,8 @@ jobs:
           toolchain: stable
 
       - run: cargo check -p deadpool
-                   --no-default-features
-                   --features ${{ matrix.feature1 }},${{ matrix.feature2 }}
+          --no-default-features
+          --features ${{ matrix.feature1 }},${{ matrix.feature2 }}
 
   check-integration:
     name: Check integration
@@ -105,7 +105,7 @@ jobs:
           - rt_tokio_1
           - rt_async-std_1
           - serde
-        include:  # additional inclusions for matrix
+        include: # additional inclusions for matrix
           - crate: diesel
             feature: mysql
           - crate: diesel
@@ -123,7 +123,7 @@ jobs:
       # We don't use `--no-default-features` here as integration crates don't
       # work with it at all.
       - run: cargo check -p deadpool-${{ matrix.crate }}
-                   --features ${{ matrix.feature }}
+          --features ${{ matrix.feature }}
 
   check-integration-wasm:
     name: Check integration (WebAssembly)
@@ -145,9 +145,9 @@ jobs:
           target: wasm32-unknown-unknown
 
       - run: cargo check -p deadpool-${{ matrix.crate }}
-                   --no-default-features
-                   ${{ matrix.feature }}
-                   --target wasm32-unknown-unknown
+          --no-default-features
+          ${{ matrix.feature }}
+          --target wasm32-unknown-unknown
 
   msrv:
     name: MSRV
@@ -210,6 +210,12 @@ jobs:
           --health-interval 10s
           --health-timeout 5s
           --health-retries 5
+      redis-sentinel:
+        image: 'bitnami/redis-sentinel:latest'
+        env:
+          ALLOW_EMPTY_PASSWORD: yes
+        ports:
+          - 26379:26379
       redis:
         image: redis:7.0-alpine
         ports:
@@ -241,6 +247,9 @@ jobs:
           PG__PASSWORD: deadpool
           PG__DBNAME: deadpool
           REDIS__URL: redis://127.0.0.1/
+          REDIS_SENTINEL__URLS: redis://127.0.0.1:26379
+          REDIS_SENTINEL__SERVER_TYPE: "master"
+          REDIS_SENTINEL__MASTER_NAME: "mymaster"
           REDIS_CLUSTER__URLS: redis://127.0.0.1:7000,redis://127.0.0.1:7001
           AMQP__URL: amqp://deadpool:deadpool@127.0.0.1/deadpool
 
diff --git a/redis/src/config.rs b/redis/src/config.rs
@@ -303,6 +303,7 @@ impl From<redis::RedisConnectionInfo> for RedisConnectionInfo {
 /// This error is returned if the configuration contains an error
 #[derive(Debug)]
 pub enum ConfigError {
+    NotEnoughInfo(String),
     /// Both url and connection were specified in the config
     UrlAndConnectionSpecified,
     /// The [`redis`] crate returned an error when parsing the config
@@ -323,6 +324,12 @@ impl fmt::Display for ConfigError {
                 "url and connection must not be specified at the same time."
             ),
             Self::Redis(e) => write!(f, "Redis: {}", e),
+            Self::NotEnoughInfo(s) => {
+                write!(
+                    f,
+                    "not enough config provided: {}", s
+                )
+            }
         }
     }
 }
diff --git a/redis/src/sentinel/config.rs b/redis/src/sentinel/config.rs
@@ -50,9 +50,9 @@ pub struct Config {
     /// ServerType
     ///
     /// [`SentinelServerType`]
-    pub server_type: SentinelServerType,
+    pub server_type: Option<SentinelServerType>,
     /// Sentinel setup master name. default value is `mymaster`
-    pub master_name: String,
+    pub master_name: Option<String>,
     /// [`redis::ConnectionInfo`] structures.
     pub connections: Option<Vec<ConnectionInfo>>,
     // SentinelNodeConnectionInfo doesn't implement debug, so we can't
@@ -100,24 +100,30 @@ impl Config {
             }
         });
 
+        if self.server_type.is_none() || self.server_type.is_none() {
+            return Err(ConfigError::NotEnoughInfo(format!(
+                "sentinel: client type '{:?}' or master name '{:?}' empty",
+                self.server_type, self.master_name)))
+        }
+
         let manager = match (&self.urls, &self.connections) {
             (Some(urls), None) => super::Manager::new(
                 urls.iter().map(|url| url.as_str()).collect(),
-                self.master_name.clone(),
+                self.master_name.clone().unwrap(),
                 sentinel_node_connection_info,
-                self.server_type,
+                self.server_type.unwrap(),
             )?,
             (None, Some(connections)) => super::Manager::new(
                 connections.clone(),
-                self.master_name.clone(),
+                self.master_name.clone().unwrap(),
                 sentinel_node_connection_info,
-                self.server_type,
+                self.server_type.unwrap(),
             )?,
             (None, None) => super::Manager::new(
                 vec![ConnectionInfo::default()],
-                self.master_name.clone(),
+                self.master_name.clone().unwrap(),
                 sentinel_node_connection_info,
-                self.server_type,
+                self.server_type.unwrap(),
             )?,
             (Some(_), Some(_)) => return Err(ConfigError::UrlAndConnectionSpecified),
         };
@@ -143,8 +149,8 @@ impl Config {
         Config {
             urls: Some(urls.into()),
             connections: None,
-            server_type,
-            master_name,
+            master_name: Some(master_name),
+            server_type: Some(server_type),
             pool: None,
             sentinel_connection_info: None,
         }
@@ -161,8 +167,8 @@ impl Default for Config {
         Self {
             urls: None,
             connections: Some(vec![default_connection_info.clone()]),
-            server_type: SentinelServerType::Master,
-            master_name: String::from("mymaster"),
+            server_type: Some(SentinelServerType::Master),
+            master_name: Some(String::from("mymaster")),
             pool: None,
             sentinel_connection_info: Some(default_connection_info),
         }
diff --git a/redis/tests/redis_sentinel.rs b/redis/tests/redis_sentinel.rs
@@ -9,7 +9,7 @@ use deadpool_redis::Runtime;
 #[derive(Debug, Default, Deserialize, Serialize)]
 struct Config {
     #[serde(default)]
-    redis: deadpool_redis::sentinel::Config,
+    redis_sentinel: deadpool_redis::sentinel::Config,
 }
 
 impl Config {
@@ -25,7 +25,10 @@ impl Config {
 
 fn create_pool() -> deadpool_redis::sentinel::Pool {
     let cfg = Config::from_env();
-    cfg.redis.create_pool(Some(Runtime::Tokio1)).unwrap()
+
+    cfg.redis_sentinel
+        .create_pool(Some(Runtime::Tokio1))
+        .unwrap()
 }
 
 #[tokio::test]
