cquill 0.0.9

Versioned CQL migrations for Cassandra and ScyllaDB
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

use std::collections::HashMap;
use std::fmt::Display;
use std::fs;
use std::io::Write;
use std::path::PathBuf;

use rand::Rng;
use scylla::Session;
use temp_dir::TempDir;

use crate::cql_file::CqlFile;
use crate::keyspace::KeyspaceOpts;
use crate::migrate::MigrateArgs;
use crate::{cql_file, queries, CassandraOpts, TABLE};

pub(crate) fn make_file(path: PathBuf, content: &str) {
    let mut f = fs::OpenOptions::new()
        .write(true)
        .create(true)
        .open(path)
        .expect("create file");
    f.write_all(content.as_bytes())
        .expect("write bytes to file");
}

pub(crate) fn error_panic(err: &dyn Display) -> ! {
    println!("{err}");
    panic!();
}

pub(crate) async fn cql_session() -> Session {
    let node_address = CassandraOpts::default().node_address();
    scylla::SessionBuilder::new()
        .known_node(node_address)
        .build()
        .await
        .expect("cql session")
}

pub(crate) async fn create_keyspace(session: &Session) -> KeyspaceOpts {
    let keyspace_opts = KeyspaceOpts::simple(keyspace_name(), 1);
    create_keyspace_from_opts(session, &keyspace_opts).await;
    keyspace_opts
}

pub(crate) async fn create_keyspace_from_opts(session: &Session, keyspace_opts: &KeyspaceOpts) {
    queries::keyspace::create(session, keyspace_opts)
        .await
        .expect("create keyspace");
}

pub(crate) async fn drop_table(session: &Session, keyspace_name: &String, table_name: &String) {
    session
        .query(format!("drop table {keyspace_name}.{table_name}"), ())
        .await
        .expect("drop table");
}

fn alphanumeric_str(len: u8) -> String {
    let mut rng = rand::thread_rng();
    (0..len)
        .map(|_| rng.sample(rand::distributions::Alphanumeric) as char)
        .map(|c| c.to_ascii_lowercase())
        .collect()
}

pub(crate) fn keyspace_name() -> String {
    format!("cquill_test_{}", alphanumeric_str(6))
}

pub(crate) struct TestHarness {
    pub session: Session,
    pub cql_dir: PathBuf,
    _directory: TempDir,
    pub cquill_keyspace: String,
    pub cquill_table: String,
    pub cql_files: Vec<CqlFile>,
}

impl TestHarness {
    pub fn builder() -> TestHarnessBuilder {
        TestHarnessBuilder::default()
    }

    pub fn cql_file_path(&self, filename: &str) -> PathBuf {
        self.cql_dir.join(filename)
    }

    pub async fn drop_keyspace(&self) {
        queries::keyspace::drop(&self.session, &self.cquill_keyspace)
            .await
            .expect("drop keyspace");
    }

    pub fn migrate_args(&self) -> MigrateArgs {
        MigrateArgs {
            cql_dir: self.cql_dir.clone(),
            history_keyspace: self.cquill_keyspace.clone(),
            history_table: self.cquill_table.clone(),
        }
    }
}

pub(crate) struct TestHarnessBuilder {
    directory: TempDir,
    cquill_keyspace: Option<KeyspaceOpts>,
    cquill_table: Option<String>,
    cql_files: HashMap<PathBuf, String>,
}

impl Default for TestHarnessBuilder {
    fn default() -> Self {
        TestHarnessBuilder {
            directory: TempDir::new().expect("make temp dir"),
            cquill_keyspace: None,
            cquill_table: None,
            cql_files: HashMap::new(),
        }
    }
}

impl TestHarnessBuilder {
    pub fn cql_file(mut self, filename: &str, content: &str) -> Self {
        self.cql_files
            .insert(self.directory.path().join(filename), content.to_string());
        self
    }

    pub fn cquill_history(mut self, keyspace_name: &str, table_name: &str) -> Self {
        self.cquill_keyspace = Some(KeyspaceOpts::simple(keyspace_name.to_string(), 1));
        self.cquill_table = Some(table_name.to_string());
        self
    }

    pub async fn initialize(self) -> TestHarness {
        for (filename, content) in self.cql_files.iter() {
            make_file(self.directory.path().join(filename), content);
        }
        let temp_dir_path = self.directory.path().canonicalize().unwrap();
        let cql_files = cql_file::files_from_dir(&temp_dir_path).unwrap_or_default();
        let cquill_keyspace = self
            .cquill_keyspace
            .unwrap_or_else(|| KeyspaceOpts::simple(keyspace_name(), 1));
        let cquill_table = self.cquill_table.unwrap_or_else(|| String::from(TABLE));
        let session = cql_session().await;
        create_keyspace_from_opts(&session, &cquill_keyspace).await;
        queries::migrated::table::create(&session, &cquill_keyspace.name, &cquill_table)
            .await
            .expect("create table");
        TestHarness {
            session,
            cql_dir: self.directory.path().to_path_buf(),
            _directory: self.directory,
            cquill_keyspace: cquill_keyspace.name,
            cquill_table,
            cql_files,
        }
    }
}