sqlness 0.6.1

SQL integration test harness
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

// Copyright 2022 CeresDB Project Authors. Licensed under Apache-2.0.

//! Query interceptor implementations.

use std::{collections::HashMap, sync::Arc};

use crate::{
    case::QueryContext,
    error::Result,
    error::SqlnessError,
    interceptor::{
        arg::ArgInterceptorFactory, env::EnvInterceptorFactory, replace::ReplaceInterceptorFactory,
        sort_result::SortResultInterceptorFactory, template::TemplateInterceptorFactory,
    },
};

pub mod arg;
pub mod env;
pub mod replace;
pub mod sleep;
pub mod sort_result;
pub mod template;

pub type InterceptorRef = Box<dyn Interceptor + Send + Sync>;

#[async_trait::async_trait]
pub trait Interceptor {
    #[allow(unused_variables)]
    fn before_execute(&self, execute_query: &mut Vec<String>, context: &mut QueryContext) {}

    #[allow(unused_variables)]
    async fn before_execute_async(
        &self,
        execute_query: &mut Vec<String>,
        context: &mut QueryContext,
    ) {
        self.before_execute(execute_query, context)
    }

    #[allow(unused_variables)]
    fn after_execute(&self, result: &mut String) {}

    #[allow(unused_variables)]
    async fn after_execute_async(&self, result: &mut String) {
        self.after_execute(result)
    }
}

pub type InterceptorFactoryRef = Arc<dyn InterceptorFactory>;

pub trait InterceptorFactory {
    fn try_new(&self, ctx: &str) -> Result<InterceptorRef>;
}

#[derive(Clone)]
pub struct Registry {
    factories: HashMap<String, InterceptorFactoryRef>,
}

impl Default for Registry {
    fn default() -> Self {
        Self {
            factories: builtin_interceptors(),
        }
    }
}

impl Registry {
    pub fn register(&mut self, prefix: &str, factory: InterceptorFactoryRef) {
        self.factories.insert(prefix.to_string(), factory);
    }

    pub fn create(&self, ctx: &str) -> Result<InterceptorRef> {
        let mut args = ctx.trim().splitn(2, ' ');
        let prefix = args.next().ok_or_else(|| SqlnessError::MissingPrefix {
            line: ctx.to_string(),
        })?;
        let context = args.next().unwrap_or_default();
        if let Some(factory) = self.factories.get(prefix.trim()) {
            factory.try_new(context.trim())
        } else {
            Err(SqlnessError::UnknownInterceptor {
                prefix: prefix.to_string(),
            })
        }
    }
}

/// Interceptors builtin sqlness
fn builtin_interceptors() -> HashMap<String, InterceptorFactoryRef> {
    [
        (
            arg::PREFIX.to_string(),
            Arc::new(ArgInterceptorFactory {}) as _,
        ),
        (
            replace::PREFIX.to_string(),
            Arc::new(ReplaceInterceptorFactory {}) as _,
        ),
        (
            env::PREFIX.to_string(),
            Arc::new(EnvInterceptorFactory {}) as _,
        ),
        (
            sort_result::PREFIX.to_string(),
            Arc::new(SortResultInterceptorFactory {}) as _,
        ),
        (
            template::PREFIX.to_string(),
            Arc::new(TemplateInterceptorFactory {}) as _,
        ),
        (
            sleep::PREFIX.to_string(),
            Arc::new(sleep::SleepInterceptorFactory {}) as _,
        ),
    ]
    .into_iter()
    .map(|(prefix, factory)| (prefix.to_string(), factory))
    .collect()
}