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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
use std::cell::RefCell;

use ahash::AHashMap;

use crate::core::config::Value;
use crate::core::rules::base::{Erased, ErasedRule, LintResult, Rule};
use crate::core::rules::context::RuleContext;
use crate::core::rules::crawlers::{Crawler, SegmentSeekerCrawler};
use crate::helpers::IndexMap;
use crate::utils::analysis::query::Query;

#[derive(Debug, Default, Clone)]
pub struct RuleST03 {}

impl Rule for RuleST03 {
    fn load_from_config(&self, _config: &AHashMap<String, Value>) -> ErasedRule {
        RuleST03::default().erased()
    }

    fn name(&self) -> &'static str {
        "structure.unused_cte"
    }

    fn description(&self) -> &'static str {
        "Query defines a CTE (common-table expression) but does not use it."
    }

    fn eval(&self, context: RuleContext) -> Vec<LintResult> {
        let mut result = Vec::new();
        let query: Query<'_, ()> = Query::from_root(context.segment.clone(), context.dialect);

        let mut remaining_ctes: IndexMap<_, _> = RefCell::borrow(&query.inner)
            .ctes
            .keys()
            .map(|it| (it.to_uppercase(), it.clone()))
            .collect();

        for reference in context.segment.recursive_crawl(
            &["table_reference"],
            true,
            Some("with_compound_statement"),
            true,
        ) {
            remaining_ctes.shift_remove(&reference.get_raw_upper().unwrap());
        }

        for name in remaining_ctes.values() {
            let tmp = RefCell::borrow(&query.inner);
            let cte = RefCell::borrow(&tmp.ctes[name].inner);
            result.push(LintResult::new(
                cte.cte_name_segment.clone(),
                Vec::new(),
                None,
                Some(format!(
                    "Query defines CTE \"{}\" but does not use it.",
                    cte.cte_name_segment.as_ref().unwrap().get_raw().unwrap()
                )),
                None,
            ));
        }

        result
    }

    fn crawl_behaviour(&self) -> Crawler {
        SegmentSeekerCrawler::new(["with_compound_statement"].into()).into()
    }
}

#[cfg(test)]
mod tests {
    use pretty_assertions::assert_eq;

    use crate::api::simple::lint;
    use crate::core::rules::base::{Erased, ErasedRule};
    use crate::rules::structure::ST03::RuleST03;

    fn rules() -> Vec<ErasedRule> {
        vec![RuleST03::default().erased()]
    }

    #[test]
    fn test_pass_no_cte_defined_1() {
        let violations =
            lint("select * from t".into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_pass_cte_defined_and_used_1() {
        let pass_str = r#"
        with cte as (
            select
                a, b
            from 
                t
        )
        select * from cte"#;

        let violations = lint(pass_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_pass_cte_defined_and_used_2() {
        let pass_str = r#"
    WITH cte1 AS (
        SELECT a
        FROM t
    ),
    cte2 AS (
        SELECT b
        FROM u
    )
    SELECT *
    FROM cte1
    JOIN cte2
    "#;

        let violations = lint(pass_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_pass_cte_defined_and_used_case_insensitive() {
        let pass_str = r#"
    WITH cte1 AS (
        SELECT a
        FROM t
    ),
    cte2 AS (
        SELECT b
        FROM u
    )
    SELECT *
    FROM cte1
    JOIN Cte2
    "#;

        let violations = lint(pass_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_fail_cte_defined_but_unused_1() {
        let fail_str = r#"
    WITH cte1 AS (
        SELECT a
        FROM t
    ),
    cte2 AS (
        SELECT b
        FROM u
    )
    SELECT *
    FROM cte1
    "#;

        let violations = lint(fail_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations[0].desc(), r#"Query defines CTE "cte2" but does not use it."#);
        assert_eq!(violations.len(), 1);
    }

    #[test]
    fn test_fail_cte_defined_but_unused_2() {
        let fail_str = r#"
    WITH cte_orders AS (
        SELECT customer_id, total
        FROM orders
    )
    SELECT *
    FROM
        orders AS cte_orders
    "#;

        let violations = lint(fail_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations[0].desc(), r#"Query defines CTE "cte_orders" but does not use it."#);
        assert_eq!(violations.len(), 1);
    }

    #[test]
    fn test_pass_cte_defined_and_used_3() {
        let pass_str = r#"
    WITH cte1 AS (
        SELECT a
        FROM t
    ),
    cte2 AS (
        SELECT b
        FROM cte1
    )
    SELECT *
    FROM cte2
    "#;

        let violations = lint(pass_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_pass_no_cte_defined_2() {
        let pass_str = "CREATE TABLE my_table (id INTEGER)";

        let violations = lint(pass_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_pass_cte_defined_and_used_4() {
        let pass_str = r#"
    WITH max_date_cte AS (
        SELECT MAX(row_updated_date) AS max_date
        FROM warehouse.loaded_monthly
    )
    SELECT stuff
    FROM warehouse.updated_weekly
    WHERE row_updated_date <= (SELECT max_date FROM max_date_cte)
    "#;

        let violations = lint(pass_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_pass_cte_defined_and_used_5() {
        let pass_str = r#"
    WITH max_date_cte AS (
      SELECT MAX(row_updated_date) AS max_date
      FROM warehouse.loaded_monthly
    ),
    uses_max_date_cte AS (
      SELECT stuff
          FROM warehouse.updated_weekly
          WHERE row_updated_date <= (SELECT max_date FROM max_date_cte)
    )
    SELECT stuff
    FROM uses_max_date_cte
    "#;

        let violations = lint(pass_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_pass_cte_defined_and_used_6() {
        let pass_str = r#"
    with pages_xf as (
      select pages.received_at
      from pages
      where pages.received_at > (select max(received_at) from pages_xf)
    ),
    final as (
      select pages_xf.received_at
      from pages_xf
    )
    select * from final
    "#;

        let violations = lint(pass_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_fail_cte_defined_but_unused_4() {
        let fail_str = r#"
    with pages_xf as (
      select pages.received_at
      from pages
      where pages.received_at > (select max(received_at) from pages_xf)
    ),
    final as (
      select pages_xf.received_at
      from pages_xf
    ),
    unused as (
      select pages.received_at from pages
    )
    select * from final
    "#;

        let violations = lint(fail_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert!(!violations.is_empty(), "Expected violations for unused CTE, but none were found.");
    }

    #[test]
    fn test_pass_cte_defined_and_used_7() {
        let pass_str = r#"
    with pages_xf as (
      select pages.received_at
      from pages
      where pages.received_at > (select max(received_at) from final)
    ),
    final as (
      select pages_xf.received_at
      from pages_xf
    )
    select * from final
    "#;

        let violations = lint(pass_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    #[ignore = "snowflake"]
    fn test_snowflake_delete_cte() {
        let fail_str = r#"
    DELETE FROM MYTABLE1
    USING (
        WITH MYCTE AS (SELECT COLUMN2 FROM MYTABLE3)
        SELECT COLUMN3 FROM MYTABLE3
    ) X
    WHERE COLUMN1 = X.COLUMN3
    "#;

        // Assume `lint` can be configured for different SQL dialects, here using
        // 'snowflake' as a parameter
        let violations = lint(fail_str.into(), "snowflake".into(), rules(), None, None).unwrap();
        assert!(
            !violations.is_empty(),
            "Expected violations for incorrect CTE usage in DELETE operation, but none were found."
        );
    }

    #[test]
    fn test_pass_nested_query() {
        let pass_str = r#"
    WITH
    foo AS (
        SELECT
            *
        FROM
            zipcode
    ),

    bar AS (
        SELECT
            *
        FROM
            county
    ),

    stage AS (
        (SELECT
            *
        FROM
            foo)

            UNION ALL

        (SELECT
            *
        FROM
            bar)
    )

    SELECT
        *
    FROM
        stage
    "#;

        let violations = lint(pass_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_fail_nested_query() {
        let fail_str = r#"
    WITH
    foo AS (
        SELECT
            *
        FROM
            zipcode
    ),

    bar AS (
        SELECT
            *
        FROM
            county
    ),

    stage AS (
        (SELECT
            *
        FROM
            foo)

            UNION ALL

        (SELECT
            *
        FROM
            foo)
    )

    SELECT
        *
    FROM
        stage
    "#;

        let violations = lint(fail_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations[0].desc(), "Query defines CTE \"bar\" but does not use it.");
        assert_eq!(violations.len(), 1);
    }

    #[test]
    fn test_pass_nested_query_in_from_clause() {
        let pass_str = r#"
    WITH
    foo AS (
        SELECT
            *
        FROM
            zipcode
    ),

    stage AS (
        SELECT
            *
        FROM
            (
                SELECT * FROM foo
            )
    )

    SELECT
        *
    FROM
        stage
    "#;

        let violations = lint(pass_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations, []);
    }

    #[test]
    fn test_fail_nested_query_in_from_clause() {
        let fail_str = r#"
    WITH
    foo AS (
        SELECT
            *
        FROM
            zipcode
    ),

    stage AS (
        SELECT
            *
        FROM
            (
                SELECT * FROM foofoo
            )
    )

    SELECT
        *
    FROM
        stage
    "#;

        let violations = lint(fail_str.into(), "ansi".into(), rules(), None, None).unwrap();
        assert_eq!(violations[0].desc(), "Query defines CTE \"foo\" but does not use it.");
        assert_eq!(violations.len(), 1);
    }
}