biovault 0.1.91

A bioinformatics data vault CLI tool
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
use anyhow::{Context, Result};
use rusqlite::{params, OptionalExtension};
use serde::{Deserialize, Serialize};
use std::path::Path;

use super::BioVaultDb;

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct Project {
    pub id: i64,
    pub name: String,
    pub version: String,
    pub author: String,
    pub workflow: String,
    pub template: String,
    pub project_path: String,
    pub created_at: String,
}

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct ProjectYaml {
    pub name: String,
    #[serde(default = "default_version")]
    pub version: String,
    pub author: String,
    pub workflow: String,
    pub template: String,
    pub assets: Vec<String>,
}

fn default_version() -> String {
    "1.0.0".to_string()
}

pub struct UpdateProjectParams<'a> {
    pub name: &'a str,
    pub version: &'a str,
    pub author: &'a str,
    pub workflow: &'a str,
    pub template: &'a str,
    pub project_path: &'a Path,
}

impl BioVaultDb {
    /// List all projects
    pub fn list_projects(&self) -> Result<Vec<Project>> {
        let mut stmt = self.conn.prepare(
            "SELECT id, name, version, author, workflow, template, project_path, created_at
             FROM projects
             ORDER BY created_at DESC",
        )?;

        let projects = stmt
            .query_map([], |row| {
                Ok(Project {
                    id: row.get(0)?,
                    name: row.get(1)?,
                    version: row.get(2)?,
                    author: row.get(3)?,
                    workflow: row.get(4)?,
                    template: row.get(5)?,
                    project_path: row.get(6)?,
                    created_at: row.get(7)?,
                })
            })?
            .collect::<Result<Vec<_>, _>>()?;

        Ok(projects)
    }

    /// Get project by name, name@version, or ID
    pub fn get_project(&self, identifier: &str) -> Result<Option<Project>> {
        // Try parsing as ID first
        if let Ok(id) = identifier.parse::<i64>() {
            let mut stmt = self.conn.prepare(
                "SELECT id, name, version, author, workflow, template, project_path, created_at
                 FROM projects
                 WHERE id = ?1",
            )?;

            let project = stmt
                .query_row([id], |row| {
                    Ok(Project {
                        id: row.get(0)?,
                        name: row.get(1)?,
                        version: row.get(2)?,
                        author: row.get(3)?,
                        workflow: row.get(4)?,
                        template: row.get(5)?,
                        project_path: row.get(6)?,
                        created_at: row.get(7)?,
                    })
                })
                .optional()?;

            return Ok(project);
        }

        // Check if identifier includes version (name@version)
        if let Some((name, version)) = identifier.split_once('@') {
            let mut stmt = self.conn.prepare(
                "SELECT id, name, version, author, workflow, template, project_path, created_at
                 FROM projects
                 WHERE name = ?1 AND version = ?2",
            )?;

            let project = stmt
                .query_row([name, version], |row| {
                    Ok(Project {
                        id: row.get(0)?,
                        name: row.get(1)?,
                        version: row.get(2)?,
                        author: row.get(3)?,
                        workflow: row.get(4)?,
                        template: row.get(5)?,
                        project_path: row.get(6)?,
                        created_at: row.get(7)?,
                    })
                })
                .optional()?;

            return Ok(project);
        }

        // Otherwise treat as name, get latest version
        let mut stmt = self.conn.prepare(
            "SELECT id, name, version, author, workflow, template, project_path, created_at
             FROM projects
             WHERE name = ?1
             ORDER BY created_at DESC
             LIMIT 1",
        )?;

        let project = stmt
            .query_row([identifier], |row| {
                Ok(Project {
                    id: row.get(0)?,
                    name: row.get(1)?,
                    version: row.get(2)?,
                    author: row.get(3)?,
                    workflow: row.get(4)?,
                    template: row.get(5)?,
                    project_path: row.get(6)?,
                    created_at: row.get(7)?,
                })
            })
            .optional()?;

        Ok(project)
    }

    /// Register a project in the database
    pub fn register_project(
        &self,
        name: &str,
        version: &str,
        author: &str,
        workflow: &str,
        template: &str,
        project_path: &Path,
    ) -> Result<i64> {
        let path_str = project_path
            .to_str()
            .ok_or_else(|| anyhow::anyhow!("Invalid project path"))?;

        // Check if project with this name and version already exists
        let identifier = format!("{}@{}", name, version);
        if let Some(existing) = self.get_project(&identifier)? {
            anyhow::bail!(
                "Project '{}' version {} already exists (id: {}). Use --overwrite to replace.",
                name,
                version,
                existing.id
            );
        }

        self.conn.execute(
            "INSERT INTO projects (name, version, author, workflow, template, project_path)
             VALUES (?1, ?2, ?3, ?4, ?5, ?6)",
            params![name, version, author, workflow, template, path_str],
        )?;

        Ok(self.conn.last_insert_rowid())
    }

    /// Update an existing project
    pub fn update_project(
        &self,
        name: &str,
        version: &str,
        author: &str,
        workflow: &str,
        template: &str,
        project_path: &Path,
    ) -> Result<()> {
        let path_str = project_path
            .to_str()
            .ok_or_else(|| anyhow::anyhow!("Invalid project path"))?;

        let rows_affected = self.conn.execute(
            "UPDATE projects
             SET author = ?1, workflow = ?2, template = ?3, project_path = ?4
             WHERE name = ?5 AND version = ?6",
            params![author, workflow, template, path_str, name, version],
        )?;

        if rows_affected == 0 {
            anyhow::bail!("Project '{}' version {} not found", name, version);
        }

        Ok(())
    }

    /// Update an existing project by ID
    pub fn update_project_by_id(
        &self,
        project_id: i64,
        params: UpdateProjectParams<'_>,
    ) -> Result<()> {
        let name = params.name;
        let version = params.version;
        let author = params.author;
        let workflow = params.workflow;
        let template = params.template;
        let project_path = params.project_path;
        let path_str = project_path
            .to_str()
            .ok_or_else(|| anyhow::anyhow!("Invalid project path"))?;

        // Check if another project has the same (name, version) combination
        let mut stmt = self
            .conn
            .prepare("SELECT id FROM projects WHERE name = ?1 AND version = ?2 AND id != ?3")
            .context("Failed to prepare project uniqueness query")?;

        let conflict = stmt
            .query_row(params![name, version, project_id], |row| {
                row.get::<_, i64>(0)
            })
            .optional()?;

        if conflict.is_some() {
            anyhow::bail!(
                "Project '{}' version {} is already used by a different project",
                name,
                version
            );
        }

        let rows_affected = self
            .conn
            .execute(
                "UPDATE projects
                 SET name = ?1, version = ?2, author = ?3, workflow = ?4, template = ?5, project_path = ?6
                 WHERE id = ?7",
                params![name, version, author, workflow, template, path_str, project_id],
            )
            .context("Failed to update project record")?;

        if rows_affected == 0 {
            anyhow::bail!("Project id {} not found", project_id);
        }

        Ok(())
    }

    fn runs_project_reference_column(&self) -> Result<Option<&'static str>> {
        if self.table_has_column("runs", "project_id")? {
            Ok(Some("project_id"))
        } else if self.table_has_column("runs", "step_id")? {
            Ok(Some("step_id"))
        } else {
            Ok(None)
        }
    }

    fn table_has_column(&self, table: &str, column: &str) -> Result<bool> {
        // table/column names are controlled internally, so simple escaping is sufficient
        let table = table.replace('\'', "''");
        let column = column.replace('\'', "''");
        let sql = format!(
            "SELECT COUNT(*) FROM pragma_table_info('{}') WHERE name='{}'",
            table, column
        );

        let count: i64 = self.conn.query_row(&sql, [], |row| row.get(0))?;
        Ok(count > 0)
    }

    /// Delete a project from the database
    pub fn delete_project(&self, identifier: &str) -> Result<Project> {
        // Get the project first
        let project = self
            .get_project(identifier)?
            .ok_or_else(|| anyhow::anyhow!("Project '{}' not found", identifier))?;

        if let Some(column) = self.runs_project_reference_column()? {
            let query = format!("SELECT COUNT(*) FROM runs WHERE {} = ?1", column);
            let run_count: i64 = self
                .conn
                .query_row(&query, params![project.id], |row| row.get(0))?;

            if run_count > 0 {
                anyhow::bail!(
                    "Cannot delete project '{}': {} associated run(s) exist. Delete runs first.",
                    project.name,
                    run_count
                );
            }
        }

        // Delete the project
        self.conn
            .execute("DELETE FROM projects WHERE id = ?1", params![project.id])?;

        Ok(project)
    }

    /// Count runs for a project
    pub fn count_project_runs(&self, project_id: i64) -> Result<i64> {
        if let Some(column) = self.runs_project_reference_column()? {
            let query = format!("SELECT COUNT(*) FROM runs WHERE {} = ?1", column);
            let count: i64 = self
                .conn
                .query_row(&query, params![project_id], |row| row.get(0))?;
            Ok(count)
        } else {
            Ok(0)
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::fs;
    use tempfile::TempDir;

    fn setup_test_db() -> (TempDir, BioVaultDb) {
        let tmp = TempDir::new().unwrap();
        crate::config::set_test_biovault_home(tmp.path());
        let db = BioVaultDb::new().unwrap();
        (tmp, db)
    }

    fn teardown_test() {
        crate::config::clear_test_biovault_home();
    }

    #[test]
    fn test_register_and_list_projects() {
        let (tmp, db) = setup_test_db();
        let project_path = tmp.path().join("test-project");
        fs::create_dir_all(&project_path).unwrap();

        let id = db
            .register_project(
                "test",
                "1.0.0",
                "author@example.com",
                "workflow.nf",
                "default",
                &project_path,
            )
            .unwrap();
        assert!(id > 0);

        let projects = db.list_projects().unwrap();
        assert_eq!(projects.len(), 1);
        assert_eq!(projects[0].name, "test");
        assert_eq!(projects[0].version, "1.0.0");
        assert_eq!(projects[0].author, "author@example.com");

        teardown_test();
    }

    #[test]
    fn test_get_project_by_name() {
        let (tmp, db) = setup_test_db();
        let project_path = tmp.path().join("test-project");
        fs::create_dir_all(&project_path).unwrap();

        db.register_project(
            "test",
            "1.0.0",
            "author@example.com",
            "workflow.nf",
            "default",
            &project_path,
        )
        .unwrap();

        let project = db.get_project("test").unwrap();
        assert!(project.is_some());
        let p = project.unwrap();
        assert_eq!(p.name, "test");
        assert_eq!(p.version, "1.0.0");

        teardown_test();
    }

    #[test]
    fn test_get_project_by_id() {
        let (tmp, db) = setup_test_db();
        let project_path = tmp.path().join("test-project");
        fs::create_dir_all(&project_path).unwrap();

        let id = db
            .register_project(
                "test",
                "1.0.0",
                "author@example.com",
                "workflow.nf",
                "default",
                &project_path,
            )
            .unwrap();

        let project = db.get_project(&id.to_string()).unwrap();
        assert!(project.is_some());
        assert_eq!(project.unwrap().id, id);

        teardown_test();
    }

    #[test]
    fn test_duplicate_project_fails() {
        let (tmp, db) = setup_test_db();
        let project_path = tmp.path().join("test-project");
        fs::create_dir_all(&project_path).unwrap();

        db.register_project(
            "test",
            "1.0.0",
            "author@example.com",
            "workflow.nf",
            "default",
            &project_path,
        )
        .unwrap();

        let result = db.register_project(
            "test",
            "1.0.0",
            "other@example.com",
            "workflow.nf",
            "default",
            &project_path,
        );
        assert!(result.is_err());
        assert!(result.unwrap_err().to_string().contains("already exists"));

        teardown_test();
    }

    #[test]
    fn test_update_project() {
        let (tmp, db) = setup_test_db();
        let project_path = tmp.path().join("test-project");
        fs::create_dir_all(&project_path).unwrap();

        db.register_project(
            "test",
            "1.0.0",
            "old@example.com",
            "old.nf",
            "old",
            &project_path,
        )
        .unwrap();

        db.update_project(
            "test",
            "1.0.0",
            "new@example.com",
            "new.nf",
            "new",
            &project_path,
        )
        .unwrap();

        let project = db.get_project("test").unwrap().unwrap();
        assert_eq!(project.author, "new@example.com");
        assert_eq!(project.workflow, "new.nf");

        teardown_test();
    }

    #[test]
    fn test_delete_project() {
        let (tmp, db) = setup_test_db();
        let project_path = tmp.path().join("test-project");
        fs::create_dir_all(&project_path).unwrap();

        db.register_project(
            "test",
            "1.0.0",
            "author@example.com",
            "workflow.nf",
            "default",
            &project_path,
        )
        .unwrap();

        let deleted = db.delete_project("test").unwrap();
        assert_eq!(deleted.name, "test");
        assert_eq!(deleted.version, "1.0.0");

        let project = db.get_project("test").unwrap();
        assert!(project.is_none());

        teardown_test();
    }

    #[test]
    fn test_delete_nonexistent_project_fails() {
        let (_tmp, db) = setup_test_db();

        let result = db.delete_project("nonexistent");
        assert!(result.is_err());
        assert!(result.unwrap_err().to_string().contains("not found"));

        teardown_test();
    }
}