Print the configurations of ConfigOptions in an ordered way so that we can directly compare the equality of two ConfigOptions by their debug strings (apache#3953)

Co-authored-by: yangzhong <yangzhong@ebay.com>

Author: yahoNanJing

datafusion/core/src/config.rs

@@ -22,8 +22,9 @@ use datafusion_common::ScalarValue;
 use itertools::Itertools;
 use log::warn;
 use parking_lot::RwLock;
-use std::collections::HashMap;
+use std::collections::{BTreeMap, HashMap};
 use std::env;
+use std::fmt::{Debug, Formatter};
 use std::sync::Arc;
 
 /// Configuration option "datafusion.optimizer.filter_null_join_keys"
@@ -274,11 +275,23 @@ impl BuiltInConfigs {
 }
 
 /// Configuration options struct. This can contain values for built-in and custom options
-#[derive(Debug, Clone)]
+#[derive(Clone)]
 pub struct ConfigOptions {
     options: HashMap<String, ScalarValue>,
 }
 
+/// Print the configurations in an ordered way so that we can directly compare the equality of two ConfigOptions by their debug strings
+impl Debug for ConfigOptions {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        f.debug_struct("ConfigOptions")
+            .field(
+                "options",
+                &format!("{:?}", BTreeMap::from_iter(self.options.iter())),
+            )
+            .finish()
+    }
+}
+
 impl Default for ConfigOptions {
     fn default() -> Self {
         Self::new()