row 1.0.0

Row is a command line tool that helps you manage workflows on HPC resources.
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

// Copyright (c) 2024-2025 The Regents of the University of Michigan.
// Part of row, released under the BSD 3-Clause License.

use clap::Args;
use log::{debug, info, warn};
use std::error::Error;
use std::{fs, io};

use crate::MultiProgressContainer;
use crate::cli::GlobalOptions;
use crate::project::Project;
use crate::{
    COMPLETED_CACHE_FILE_NAME, DATA_DIRECTORY_NAME, DIRECTORY_CACHE_FILE_NAME,
    SUBMITTED_CACHE_FILE_NAME,
};

#[derive(Args, Debug)]
pub struct Arguments {
    #[command(flatten)]
    selection: Option<Selection>,

    /// Force removal of the completed and/or submitted cache when there are submitted jobs.
    #[arg(long, display_order = 0)]
    force: bool,
}

#[derive(Args, Debug)]
#[group(multiple = true)]
pub struct Selection {
    /// Remove the directory cache.
    #[arg(long, display_order = 0)]
    directory: bool,

    /// Remove the submitted cache.
    #[arg(long, display_order = 0)]
    submitted: bool,

    /// Remove the completed cache.
    #[arg(long, display_order = 0)]
    completed: bool,
}

/// Remove row cache files.
pub fn clean(
    options: &GlobalOptions,
    args: &Arguments,
    multi_progress: &mut MultiProgressContainer,
) -> Result<(), Box<dyn Error>> {
    debug!("Cleaning cache files.");
    let mut project = Project::open(options.io_threads, &options.cluster, multi_progress)?;

    // Delete all existing completion staging files.
    project.close(multi_progress)?;

    let selection = args.selection.as_ref().unwrap_or(&Selection {
        directory: true,
        submitted: true,
        completed: true,
    });

    let num_submitted = project.state().num_submitted();
    if num_submitted > 0 {
        let force_needed = selection.completed || selection.submitted;

        if force_needed {
            warn!("There are {num_submitted} directories with submitted jobs.");
        }
        if selection.submitted {
            warn!("The submitted cache is not recoverable. Row may resubmit running jobs.");
        }
        if selection.completed {
            warn!("These jobs may add to the completed cache after it is cleaned.");
        }
        if force_needed && !args.force {
            warn!("You should wait for these jobs to complete.");
            return Err(Box::new(crate::Error::ForceCleanNeeded));
        }
    }

    let data_directory = project.workflow().root.join(DATA_DIRECTORY_NAME);

    if selection.submitted {
        let path = data_directory.join(SUBMITTED_CACHE_FILE_NAME);
        info!("Removing '{}'.", path.display());
        if let Err(error) = fs::remove_file(&path) {
            match error.kind() {
                io::ErrorKind::NotFound => (),
                _ => return Err(Box::new(crate::Error::FileRemove(path.clone(), error))),
            }
        }
    }
    if selection.completed {
        let path = data_directory.join(COMPLETED_CACHE_FILE_NAME);
        info!("Removing '{}'.", path.display());
        if let Err(error) = fs::remove_file(&path) {
            match error.kind() {
                io::ErrorKind::NotFound => (),
                _ => return Err(Box::new(crate::Error::FileRemove(path.clone(), error))),
            }
        }
    }
    if selection.directory {
        let path = data_directory.join(DIRECTORY_CACHE_FILE_NAME);
        info!("Removing '{}'.", path.display());
        if let Err(error) = fs::remove_file(&path) {
            match error.kind() {
                io::ErrorKind::NotFound => (),
                _ => return Err(Box::new(crate::Error::FileRemove(path.clone(), error))),
            }
        }
    }

    Ok(())
}