mongo-task-generator 0.6.5

Dynamically split evergreen tasks into subtasks for testing the mongodb/mongo project.
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

//! Utilities for working with task names.

use crate::evergreen_names::ENTERPRISE_MODULE;
const GEN_SUFFIX: &str = "_gen";

/// Generate a name for a generated task.
///
/// # Arguments
///
/// * `display_name` - Name of parent task being generated.
/// * `sub_task_index` - Index of sub-task being named.
/// * `total_tasks` - Total number of sub-tasks generated for this parent task.
/// * `is_enterprise` - Whether the task is for an enterprise build variant.
/// * `platform` - Platform that task will run on.
pub fn name_generated_task(
    display_name: &str,
    sub_task_index: usize,
    total_tasks: usize,
    is_enterprise: bool,
    platform: Option<&str>,
) -> String {
    let mut suffix = if is_enterprise {
        format!("-{}", ENTERPRISE_MODULE)
    } else {
        "".to_string()
    };

    if let Some(platform) = platform {
        suffix = format!("-{}{}", platform, suffix)
    }

    let alignment = (total_tasks as f64).log10().ceil() as usize;
    format!(
        "{}_{:0fill$}{}",
        display_name,
        sub_task_index,
        suffix,
        fill = alignment
    )
}

/// Remove the '_gen' from end of the given task name if it exists.
///
/// # Arguments
///
/// * `task_name` - Name of task.
///
/// # Returns
///
/// Name of task with `_gen` stripped off.
pub fn remove_gen_suffix(task_name: &str) -> &str {
    if task_name.ends_with(GEN_SUFFIX) {
        let end = task_name.len() - GEN_SUFFIX.len();
        &task_name[..end]
    } else {
        task_name
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use rstest::*;

    #[rstest]
    #[case("task", 0, 10, false, None, "task_0")]
    #[case("task", 0, 10, false, Some("linux"), "task_0-linux")]
    #[case("task", 42, 1001, false, None, "task_0042")]
    #[case("task", 42, 1001, false, Some("linux"), "task_0042-linux")]
    #[case("task", 0, 10, true, None, "task_0-enterprise")]
    #[case("task", 0, 10, true, Some("linux"), "task_0-linux-enterprise")]
    #[case("task", 42, 1001, true, None, "task_0042-enterprise")]
    #[case("task", 42, 1001, true, Some("linux"), "task_0042-linux-enterprise")]
    fn test_name_generated_task_should_not_include_suffix(
        #[case] name: &str,
        #[case] index: usize,
        #[case] total: usize,
        #[case] is_enterprise: bool,
        #[case] platform: Option<&str>,
        #[case] expected: &str,
    ) {
        let task_name = name_generated_task(name, index, total, is_enterprise, platform);

        assert_eq!(task_name, expected);
    }

    #[rstest]
    #[case("task_name", "task_name")]
    #[case("task_name_gen", "task_name")]
    #[case("task_name_", "task_name_")]
    fn test_remove_gen_suffix(#[case] original_task: &str, #[case] expected_task: &str) {
        assert_eq!(remove_gen_suffix(original_task), expected_task);
    }
}