stmo-cli 0.6.1

CLI for version controlling Redash queries and dashboards
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
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
#![allow(clippy::missing_errors_doc)]
#![allow(clippy::missing_panics_doc)]

mod common;

use common::*;
use stmo_cli::api::RedashClient;
use wiremock::matchers::{method, path, query_param};
use wiremock::{Mock, MockServer, ResponseTemplate};

#[tokio::test]
async fn test_refresh_query_success() {
    let mock_server = MockServer::start().await;

    mock_refresh_query(123, "test-job-id")
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let job = client.refresh_query(123, None).await.unwrap();

    assert_eq!(job.id, "test-job-id");
    assert_eq!(job.status, 1);
    assert!(job.query_result_id.is_none());
}

#[tokio::test]
async fn test_refresh_query_with_parameters() {
    let mock_server = MockServer::start().await;

    Mock::given(method("POST"))
        .and(path("/api/queries/123/results"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "job": {
                "id": "test-job-id",
                "status": 1,
                "query_result_id": null,
                "error": null
            }
        })))
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let mut params = std::collections::HashMap::new();
    params.insert("start_date".to_string(), serde_json::json!("2025-01-01"));
    params.insert(
        "channels".to_string(),
        serde_json::json!(["release", "beta"]),
    );

    let job = client.refresh_query(123, Some(params)).await.unwrap();

    assert_eq!(job.id, "test-job-id");
    assert_eq!(job.status, 1);
}

#[tokio::test]
async fn test_poll_job_pending() {
    let mock_server = MockServer::start().await;

    mock_poll_job_pending("test-job-id")
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let job = client.poll_job("test-job-id").await.unwrap();

    assert_eq!(job.id, "test-job-id");
    assert_eq!(job.status, 1);
    assert!(job.query_result_id.is_none());
}

#[tokio::test]
async fn test_poll_job_success() {
    let mock_server = MockServer::start().await;

    mock_poll_job_success("test-job-id", 456)
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let job = client.poll_job("test-job-id").await.unwrap();

    assert_eq!(job.id, "test-job-id");
    assert_eq!(job.status, 3);
    assert_eq!(job.query_result_id, Some(456));
}

#[tokio::test]
async fn test_poll_job_failure() {
    let mock_server = MockServer::start().await;

    mock_poll_job_failure("test-job-id", "Query execution failed")
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let job = client.poll_job("test-job-id").await.unwrap();

    assert_eq!(job.id, "test-job-id");
    assert_eq!(job.status, 4);
    assert_eq!(job.error, Some("Query execution failed".to_string()));
}

#[tokio::test]
async fn test_get_query_result_success() {
    let mock_server = MockServer::start().await;

    mock_get_query_result(123, 456).mount(&mock_server).await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.get_query_result(123, 456).await.unwrap();

    assert_eq!(result.id, 456);
    assert_eq!(result.data.columns.len(), 2);
    assert_eq!(result.data.columns[0].name, "col1");
    assert_eq!(result.data.rows.len(), 2);
    assert!((result.runtime - 1.5).abs() < f64::EPSILON);
}

#[tokio::test]
async fn test_execute_query_with_polling_success() {
    let mock_server = MockServer::start().await;

    mock_refresh_query(123, "test-job-id")
        .expect(1)
        .mount(&mock_server)
        .await;

    mock_poll_job_success("test-job-id", 456)
        .expect(1)
        .mount(&mock_server)
        .await;

    mock_get_query_result(123, 456)
        .expect(1)
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client
        .execute_query_with_polling(123, None, 10, 100)
        .await
        .unwrap();

    assert_eq!(result.id, 456);
    assert_eq!(result.data.columns.len(), 2);
    assert_eq!(result.data.rows.len(), 2);
}

#[tokio::test]
async fn test_execute_query_with_polling_failure() {
    let mock_server = MockServer::start().await;

    mock_refresh_query(123, "test-job-id")
        .mount(&mock_server)
        .await;

    mock_poll_job_failure("test-job-id", "Syntax error in SQL")
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.execute_query_with_polling(123, None, 10, 100).await;

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("Query execution failed"));
    assert!(err.to_string().contains("Syntax error in SQL"));
}

#[tokio::test]
async fn test_execute_query_with_polling_timeout() {
    let mock_server = MockServer::start().await;

    mock_refresh_query(123, "test-job-id")
        .mount(&mock_server)
        .await;

    mock_poll_job_pending("test-job-id")
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.execute_query_with_polling(123, None, 1, 100).await;

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("timed out"));
}

#[tokio::test]
async fn test_list_my_queries_pagination() {
    let mock_server = MockServer::start().await;

    Mock::given(method("GET"))
        .and(path("/api/queries/my"))
        .and(query_param("page", "1"))
        .and(query_param("page_size", "100"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "results": [],
            "count": 0,
            "page": 1,
            "page_size": 100
        })))
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let response = client.list_my_queries(1, 100).await.unwrap();

    assert_eq!(response.count, 0);
    assert_eq!(response.page, 1);
    assert_eq!(response.page_size, 100);
}

#[tokio::test]
async fn test_list_data_sources_success() {
    let mock_server = MockServer::start().await;

    mock_list_data_sources().mount(&mock_server).await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let data_sources = client.list_data_sources().await.unwrap();

    assert_eq!(data_sources.len(), 2);
    assert_eq!(data_sources[0].id, 63);
    assert_eq!(data_sources[0].name, "Telemetry (BigQuery)");
    assert_eq!(data_sources[0].ds_type, "bigquery");
    assert_eq!(data_sources[1].id, 10);
    assert_eq!(data_sources[1].name, "Redash metadata");
    assert_eq!(data_sources[1].ds_type, "pg");
}

#[tokio::test]
async fn test_list_data_sources_empty() {
    let mock_server = MockServer::start().await;

    mock_list_data_sources_empty().mount(&mock_server).await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let data_sources = client.list_data_sources().await.unwrap();

    assert_eq!(data_sources.len(), 0);
}

#[tokio::test]
async fn test_get_data_source_success() {
    let mock_server = MockServer::start().await;

    mock_get_data_source(63).mount(&mock_server).await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let data_source = client.get_data_source(63).await.unwrap();

    assert_eq!(data_source.id, 63);
    assert_eq!(data_source.name, "Test Data Source");
    assert_eq!(data_source.ds_type, "bigquery");
    assert_eq!(
        data_source.description,
        Some("Test description".to_string())
    );
}

#[tokio::test]
async fn test_get_data_source_not_found() {
    let mock_server = MockServer::start().await;

    mock_get_data_source_not_found(999)
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.get_data_source(999).await;

    assert!(result.is_err());
}

#[tokio::test]
async fn test_get_data_source_schema_success() {
    let mock_server = MockServer::start().await;

    mock_get_data_source_schema(63).mount(&mock_server).await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let schema = client.get_data_source_schema(63, false).await.unwrap();

    assert_eq!(schema.schema.len(), 2);
    assert_eq!(schema.schema[0].name, "table1");
    assert_eq!(schema.schema[0].columns.len(), 3);
    assert_eq!(schema.schema[0].columns[0].name, "col1");
    assert_eq!(schema.schema[0].columns[0].column_type, "STRING");
    assert_eq!(schema.schema[1].name, "table2");
    assert_eq!(schema.schema[1].columns.len(), 2);
    assert_eq!(schema.schema[1].columns[0].name, "id");
    assert_eq!(schema.schema[1].columns[0].column_type, "INTEGER");
}

#[tokio::test]
async fn test_get_data_source_schema_unauthorized() {
    let mock_server = MockServer::start().await;

    mock_get_data_source_schema_unauthorized(63)
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.get_data_source_schema(63, false).await;

    assert!(result.is_err());
}

#[tokio::test]
async fn test_archive_query_success() {
    let mock_server = MockServer::start().await;

    mock_archive_query(123, "Test Query")
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let query = client.archive_query(123).await.unwrap();

    assert_eq!(query.id, 123);
    assert_eq!(query.name, "Test Query");
    assert!(query.is_archived);
}

#[tokio::test]
async fn test_archive_query_not_found() {
    let mock_server = MockServer::start().await;

    mock_archive_query_not_found(999).mount(&mock_server).await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.archive_query(999).await;

    assert!(result.is_err());
}

#[tokio::test]
async fn test_unarchive_query_success() {
    let mock_server = MockServer::start().await;

    mock_unarchive_query(123, "Test Query")
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let query = client.unarchive_query(123).await.unwrap();

    assert_eq!(query.id, 123);
    assert_eq!(query.name, "Test Query");
    assert!(!query.is_archived);
}

#[tokio::test]
async fn test_unarchive_query_forbidden() {
    let mock_server = MockServer::start().await;

    mock_unarchive_query_forbidden(123)
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.unarchive_query(123).await;

    assert!(result.is_err());
}

#[tokio::test]
async fn test_get_query_archived() {
    let mock_server = MockServer::start().await;

    mock_get_query(123, "Archived Query", true)
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let query = client.get_query(123).await.unwrap();

    assert_eq!(query.id, 123);
    assert_eq!(query.name, "Archived Query");
    assert!(query.is_archived);
}

#[tokio::test]
async fn test_get_query_not_archived() {
    let mock_server = MockServer::start().await;

    mock_get_query(123, "Active Query", false)
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let query = client.get_query(123).await.unwrap();

    assert_eq!(query.id, 123);
    assert_eq!(query.name, "Active Query");
    assert!(!query.is_archived);
}

#[tokio::test]
async fn test_list_favorite_dashboards_success() {
    let mock_server = MockServer::start().await;

    mock_list_favorite_dashboards(2).mount(&mock_server).await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let response = client.list_favorite_dashboards(1, 100).await.unwrap();

    assert_eq!(response.count, 2);
    assert_eq!(response.results.len(), 2);
    assert_eq!(response.results[0].id, 2570);
    assert_eq!(response.results[0].name, "Firefox Desktop on SteamOS");
    assert!(!response.results[0].is_archived);
}

#[tokio::test]
async fn test_list_favorite_dashboards_empty() {
    let mock_server = MockServer::start().await;

    mock_list_favorite_dashboards_empty()
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let response = client.list_favorite_dashboards(1, 100).await.unwrap();

    assert_eq!(response.count, 0);
    assert_eq!(response.results.len(), 0);
}

#[tokio::test]
async fn test_get_dashboard_success() {
    let mock_server = MockServer::start().await;

    mock_get_dashboard(2570, "Test Dashboard", false)
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let dashboard = client.get_dashboard("test-dashboard").await.unwrap();

    assert_eq!(dashboard.id, 2570);
    assert_eq!(dashboard.name, "Test Dashboard");
    assert_eq!(dashboard.user_id, 530);
    assert!(!dashboard.is_archived);
    assert!(!dashboard.is_draft);
}

#[tokio::test]
async fn test_get_dashboard_not_found() {
    let mock_server = MockServer::start().await;

    mock_get_dashboard_not_found("nonexistent-dashboard")
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.get_dashboard("nonexistent-dashboard").await;

    assert!(result.is_err());
}

#[tokio::test]
async fn test_get_dashboard_archived() {
    let mock_server = MockServer::start().await;

    mock_get_dashboard(2570, "Archived Dashboard", true)
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let dashboard = client.get_dashboard("archived-dashboard").await.unwrap();

    assert_eq!(dashboard.id, 2570);
    assert_eq!(dashboard.name, "Archived Dashboard");
    assert!(dashboard.is_archived);
}

#[tokio::test]
async fn test_update_dashboard_success() {
    let mock_server = MockServer::start().await;

    mock_update_dashboard(2570, "Updated Dashboard")
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();

    let dashboard = stmo_cli::models::Dashboard {
        id: 2570,
        name: "Updated Dashboard".to_string(),
        slug: "updated-dashboard".to_string(),
        user_id: 530,
        is_archived: false,
        is_draft: false,
        filters_enabled: false,
        tags: vec![],
        widgets: vec![],
    };

    let result = client.update_dashboard(&dashboard).await.unwrap();

    assert_eq!(result.id, 2570);
    assert_eq!(result.name, "Updated Dashboard");
}

#[tokio::test]
async fn test_archive_dashboard_success() {
    let mock_server = MockServer::start().await;

    mock_archive_dashboard(2570).mount(&mock_server).await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.archive_dashboard(2570).await;

    assert!(result.is_ok());
}

#[tokio::test]
async fn test_archive_dashboard_not_found() {
    let mock_server = MockServer::start().await;

    mock_archive_dashboard_not_found(9999)
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.archive_dashboard(9999).await;

    assert!(result.is_err());
}

#[tokio::test]
async fn test_unarchive_dashboard_success() {
    let mock_server = MockServer::start().await;

    mock_unarchive_dashboard(2570, "Test Dashboard")
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let dashboard = client.unarchive_dashboard(2570).await.unwrap();

    assert_eq!(dashboard.id, 2570);
    assert_eq!(dashboard.name, "Test Dashboard");
    assert!(!dashboard.is_archived);
}

#[tokio::test]
async fn test_unarchive_dashboard_forbidden() {
    let mock_server = MockServer::start().await;

    mock_unarchive_dashboard_forbidden(2570)
        .mount(&mock_server)
        .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.unarchive_dashboard(2570).await;

    assert!(result.is_err());
}

#[tokio::test]
async fn test_create_widget_success() {
    let mock_server = MockServer::start().await;

    mock_create_widget(2570, 75035).mount(&mock_server).await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();

    let widget = stmo_cli::models::CreateWidget {
        dashboard_id: 2570,
        visualization_id: None,
        text: "Test Widget".to_string(),
        width: 1,
        options: stmo_cli::models::WidgetOptions {
            position: stmo_cli::models::WidgetPosition {
                col: 0,
                row: 0,
                size_x: 3,
                size_y: 2,
            },
            parameter_mappings: None,
        },
    };

    let result = client.create_widget(&widget).await.unwrap();

    assert_eq!(result.id, 75035);
    assert_eq!(result.dashboard_id, 2570);
}

#[tokio::test]
async fn test_delete_widget_success() {
    let mock_server = MockServer::start().await;

    mock_delete_widget(75035).mount(&mock_server).await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.delete_widget(75035).await;

    assert!(result.is_ok());
}

#[tokio::test]
async fn test_delete_widget_not_found() {
    let mock_server = MockServer::start().await;

    mock_delete_widget_not_found(999).mount(&mock_server).await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.delete_widget(999).await;

    assert!(result.is_err());
}

#[tokio::test]
async fn test_refresh_query_bad_request_includes_error_body() {
    let mock_server = MockServer::start().await;

    mock_refresh_query_bad_request(
        123,
        "The following parameter values are incompatible with their definitions: worker_pool",
    )
    .mount(&mock_server)
    .await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.refresh_query(123, None).await;

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("400"));
    assert!(
        err.to_string()
            .contains("parameter values are incompatible")
    );
}

#[tokio::test]
async fn test_refresh_query_forbidden_includes_error_body() {
    let mock_server = MockServer::start().await;

    mock_refresh_query_forbidden(123).mount(&mock_server).await;

    let client = RedashClient::new(mock_server.uri(), "test-key").unwrap();
    let result = client.refresh_query(123, None).await;

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("403"));
    assert!(err.to_string().contains("Access denied"));
}