pywatt_sdk 0.5.3

Standardized SDK for building PyWatt modules in Rust
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
use crate::model_manager::{
    Error, Result,
    adapters::DatabaseAdapter,
    definitions::{Constraint, ModelDescriptor},
    errors::sql_generation_error,
};

/// Service for generating SQL from model definitions
pub struct ModelGenerator {
    /// The database adapter to use for SQL generation
    adapter: Box<dyn DatabaseAdapter<Error = Error>>,
}

impl ModelGenerator {
    /// Create a new ModelGenerator with the given adapter
    pub fn new(adapter: Box<dyn DatabaseAdapter<Error = Error>>) -> Self {
        Self { adapter }
    }

    /// Generate the complete SQL script to create a table
    pub fn generate_create_table_script(&self, model: &ModelDescriptor) -> Result<String> {
        let mut script = String::new();

        // For PostgreSQL, we might need to create enum types first
        // (This will be implemented in the PostgreSQL adapter during milestone 2)

        // Generate the CREATE TABLE statement
        let create_table_sql = self.adapter.generate_create_table_sql(model)?;
        script.push_str(&create_table_sql);
        script.push_str(";\n\n");

        // Generate CREATE INDEX statements for each index
        for index in &model.indexes {
            let index_sql = self.adapter.generate_index_sql(index, &model.name)?;
            script.push_str(&index_sql);
            script.push_str(";\n");
        }

        // PostgreSQL-specific: Generate constraints that couldn't be inline
        // (Will be handled by the adapter in future implementations)

        Ok(script)
    }

    /// Generate the SQL script to drop a table
    pub fn generate_drop_table_script(
        &self,
        table_name: &str,
        schema_name: Option<&str>,
    ) -> Result<String> {
        self.adapter
            .generate_drop_table_sql(table_name, schema_name)
    }

    /// Generate the SQL to add a column to an existing table
    pub fn generate_add_column_script(
        &self,
        table_name: &str,
        column: &crate::model_manager::definitions::ColumnDescriptor,
        schema_name: Option<&str>,
    ) -> Result<String> {
        self.adapter
            .generate_add_column_sql(table_name, column, schema_name)
    }

    /// Generate the SQL to drop a column from an existing table
    pub fn generate_drop_column_script(
        &self,
        table_name: &str,
        column_name: &str,
        schema_name: Option<&str>,
    ) -> Result<String> {
        self.adapter
            .generate_drop_column_sql(table_name, column_name, schema_name)
    }

    /// Generate SQL for a foreign key constraint
    pub fn generate_foreign_key_script(&self, table_name: &str, fk: &Constraint) -> Result<String> {
        match fk {
            Constraint::ForeignKey { .. } => self.adapter.generate_foreign_key_sql(fk, table_name),
            _ => Err(sql_generation_error("Not a foreign key constraint")),
        }
    }

    /// Get the database adapter used by this generator
    pub fn adapter(&self) -> &dyn DatabaseAdapter<Error = Error> {
        &*self.adapter
    }

    /// Get a mutable reference to the database adapter
    pub fn adapter_mut(&mut self) -> &mut dyn DatabaseAdapter<Error = Error> {
        &mut *self.adapter
    }

    /// Generate the SQL migration script to transform one model into another by adding and dropping columns
    pub fn generate_migration_script(
        &self,
        from: &ModelDescriptor,
        to: &ModelDescriptor,
    ) -> Result<String> {
        let mut script = String::new();
        // Add new columns in 'to' that are not in 'from'
        for col in &to.columns {
            if !from.columns.iter().any(|c| c.name == col.name) {
                let stmt =
                    self.adapter
                        .generate_add_column_sql(&to.name, col, to.schema.as_deref())?;
                script.push_str(&stmt);
                script.push_str(";\n");
            }
        }
        // Drop columns in 'from' that are not in 'to'
        for col in &from.columns {
            if !to.columns.iter().any(|c| c.name == col.name) {
                let stmt = self.adapter.generate_drop_column_sql(
                    &from.name,
                    &col.name,
                    from.schema.as_deref(),
                )?;
                script.push_str(&stmt);
                script.push_str(";\n");
            }
        }
        // Add new table-level constraints in 'to' not in 'from'
        for constraint in &to.constraints {
            if !from.constraints.contains(constraint) {
                if let Some(sql) = self.adapter.generate_constraint_sql(constraint, &to.name)? {
                    script.push_str(&sql);
                    script.push_str(";\n");
                }
            }
        }
        // Drop table-level constraints in 'from' not in 'to'
        for constraint in &from.constraints {
            if !to.constraints.contains(constraint) {
                // Determine base name for constraint
                let base_name = match constraint {
                    Constraint::PrimaryKey { name, .. }
                    | Constraint::Unique { name, .. }
                    | Constraint::Check { name, .. }
                    | Constraint::ForeignKey { name, .. } => name.as_deref().unwrap_or_default(),
                    _ => continue,
                };
                let constraint_name = format!("{}_{}", from.name, base_name);
                let stmt = self.adapter.generate_drop_constraint_sql(
                    &from.name,
                    &constraint_name,
                    from.schema.as_deref(),
                )?;
                script.push_str(&stmt);
                script.push_str(";\n");
            }
        }
        // Add new indexes in 'to' not in 'from'
        for index in &to.indexes {
            if !from.indexes.contains(index) {
                let stmt = self.adapter.generate_index_sql(index, &to.name)?;
                script.push_str(&stmt);
                script.push_str(";\n");
            }
        }
        // Drop indexes in 'from' not in 'to'
        for index in &from.indexes {
            if !to.indexes.contains(index) {
                let index_name = index
                    .name
                    .clone()
                    .unwrap_or_else(|| format!("{}_{}_idx", from.name, index.columns.join("_")));
                let stmt = self.adapter.generate_drop_index_sql(
                    &from.name,
                    &index_name,
                    from.schema.as_deref(),
                )?;
                script.push_str(&stmt);
                script.push_str(";\n");
            }
        }
        Ok(script)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::model_manager::adapters::SqliteAdapter;
    use crate::model_manager::definitions::{
        ColumnDescriptor, Constraint, DataType, IndexDescriptor, IntegerSize, ModelDescriptor,
    };

    #[test]
    fn test_generate_create_table_script_simple() {
        let adapter = Box::new(SqliteAdapter::new());
        let generator = ModelGenerator::new(adapter);
        let model = ModelDescriptor {
            name: "test".to_string(),
            schema: None,
            columns: vec![
                ColumnDescriptor {
                    name: "id".to_string(),
                    data_type: DataType::Integer(IntegerSize::I64),
                    is_nullable: false,
                    is_primary_key: true,
                    is_unique: false,
                    default_value: None,
                    auto_increment: true,
                    comment: None,
                    constraints: vec![],
                },
                ColumnDescriptor {
                    name: "name".to_string(),
                    data_type: DataType::Text(None),
                    is_nullable: true,
                    is_primary_key: false,
                    is_unique: false,
                    default_value: None,
                    auto_increment: false,
                    comment: None,
                    constraints: vec![],
                },
            ],
            primary_key: None,
            indexes: vec![],
            constraints: vec![],
            comment: None,
            engine: None,
            charset: None,
            collation: None,
            options: Default::default(),
        };
        let sql = generator.generate_create_table_script(&model).unwrap();
        assert!(sql.contains("CREATE TABLE \"test\""));
        assert!(sql.contains("\"id\" INTEGER PRIMARY KEY AUTOINCREMENT"));
        assert!(sql.contains("\"name\" TEXT"));
    }

    #[test]
    fn test_generate_drop_table_script_simple() {
        let adapter = Box::new(SqliteAdapter::new());
        let generator = ModelGenerator::new(adapter);
        let sql = generator.generate_drop_table_script("test", None).unwrap();
        assert_eq!(sql, "DROP TABLE IF EXISTS \"test\"");
    }

    #[test]
    fn test_generate_migration_script_add_and_drop() {
        let adapter = Box::new(SqliteAdapter::new());
        let generator = ModelGenerator::new(adapter);
        // Original model with only 'id'
        let from = ModelDescriptor {
            name: "items".to_string(),
            schema: None,
            columns: vec![ColumnDescriptor {
                name: "id".to_string(),
                data_type: DataType::Integer(IntegerSize::I64),
                is_nullable: false,
                is_primary_key: true,
                is_unique: false,
                default_value: None,
                auto_increment: true,
                comment: None,
                constraints: vec![],
            }],
            primary_key: None,
            indexes: vec![],
            constraints: vec![],
            comment: None,
            engine: None,
            charset: None,
            collation: None,
            options: Default::default(),
        };
        // New model with 'id' and 'name'
        let to = ModelDescriptor {
            name: "items".to_string(),
            schema: None,
            columns: vec![
                ColumnDescriptor {
                    name: "id".to_string(),
                    data_type: DataType::Integer(IntegerSize::I64),
                    is_nullable: false,
                    is_primary_key: true,
                    is_unique: false,
                    default_value: None,
                    auto_increment: true,
                    comment: None,
                    constraints: vec![],
                },
                ColumnDescriptor {
                    name: "name".to_string(),
                    data_type: DataType::Text(None),
                    is_nullable: true,
                    is_primary_key: false,
                    is_unique: false,
                    default_value: None,
                    auto_increment: false,
                    comment: None,
                    constraints: vec![],
                },
            ],
            primary_key: None,
            indexes: vec![],
            constraints: vec![],
            comment: None,
            engine: None,
            charset: None,
            collation: None,
            options: Default::default(),
        };
        let migration_sql = generator.generate_migration_script(&from, &to).unwrap();
        // Expect an ADD COLUMN for 'name'
        assert!(migration_sql.contains("ADD COLUMN \"name\" TEXT"));
        // Expect no DROP COLUMN for 'id'
        assert!(!migration_sql.contains("DROP COLUMN \"id\""));

        // For the reverse migration (dropping 'name' column), SQLite requires table recreation
        // Since SQLite doesn't support DROP COLUMN in older versions, we expect an error
        match generator.generate_migration_script(&to, &from) {
            Ok(_) => panic!("Expected an error for DROP COLUMN with SQLite"),
            Err(err) => {
                assert!(
                    err.to_string()
                        .contains("SQLite doesn't support DROP COLUMN")
                );
            }
        }
    }

    #[test]
    fn test_generate_migration_script_constraints() {
        let adapter = Box::new(SqliteAdapter::new());
        let generator = ModelGenerator::new(adapter);
        // No constraints in 'from'
        let from = ModelDescriptor {
            name: "users".to_string(),
            schema: None,
            columns: vec![],
            primary_key: None,
            indexes: vec![],
            constraints: vec![],
            comment: None,
            engine: None,
            charset: None,
            collation: None,
            options: Default::default(),
        };
        // Add a unique constraint in 'to'
        let to = ModelDescriptor {
            name: "users".to_string(),
            schema: None,
            columns: vec![],
            primary_key: None,
            indexes: vec![],
            constraints: vec![Constraint::Unique {
                name: Some("u1".to_string()),
                columns: vec!["email".to_string()],
            }],
            comment: None,
            engine: None,
            charset: None,
            collation: None,
            options: Default::default(),
        };
        let sql = generator.generate_migration_script(&from, &to).unwrap();
        assert!(sql.contains("CONSTRAINT \"users_u1\" UNIQUE"));

        // Reverse (dropping constraint) should now be handled as an error for SQLite
        match generator.generate_migration_script(&to, &from) {
            // 'to' has constraint, 'from' does not
            Ok(unexpected_sql) => {
                panic!(
                    "Expected an error when trying to generate DROP CONSTRAINT for SQLite, but got SQL: {}",
                    unexpected_sql
                );
            }
            Err(err) => {
                assert!(
                    err.to_string().contains(
                        "SQLite does not support DROP CONSTRAINT. Table must be recreated."
                    ),
                    "Error message mismatch, got: {}",
                    err
                );
            }
        }
    }

    #[test]
    fn test_generate_migration_script_indexes() {
        let adapter = Box::new(SqliteAdapter::new());
        let generator = ModelGenerator::new(adapter);
        // No indexes in 'from'
        let from = ModelDescriptor {
            name: "users".to_string(),
            schema: None,
            columns: vec![],
            primary_key: None,
            indexes: vec![],
            constraints: vec![],
            comment: None,
            engine: None,
            charset: None,
            collation: None,
            options: Default::default(),
        };
        // Add an index in 'to'
        let to = ModelDescriptor {
            name: "users".to_string(),
            schema: None,
            columns: vec![],
            primary_key: None,
            indexes: vec![IndexDescriptor {
                name: None,
                columns: vec!["email".to_string()],
                is_unique: true,
                index_type: None,
                condition: None,
            }],
            constraints: vec![],
            comment: None,
            engine: None,
            charset: None,
            collation: None,
            options: Default::default(),
        };
        let sql = generator.generate_migration_script(&from, &to).unwrap();
        assert!(sql.contains("CREATE UNIQUE INDEX \"users_email_idx\""));
        // Reverse should drop the index
        let reverse_sql = generator.generate_migration_script(&to, &from).unwrap();
        assert!(reverse_sql.contains("DROP INDEX \"users_email_idx\""));
    }
}