bssh 2.0.1

Parallel SSH command execution tool for cluster management
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

// Copyright 2025 Lablup Inc. and Jeongkyu Shin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Error types for hostlist parsing and expansion

use thiserror::Error;

/// Errors that can occur during hostlist parsing and expansion
#[derive(Debug, Error, PartialEq, Eq)]
pub enum HostlistError {
    /// Empty bracket expression (e.g., `node[]`)
    #[error("empty bracket expression in '{expression}'")]
    EmptyBracket { expression: String },

    /// Unclosed bracket (e.g., `node[1-5`)
    #[error("unclosed bracket in '{expression}'")]
    UnclosedBracket { expression: String },

    /// Unmatched closing bracket (e.g., `node]1-5[`)
    #[error("unmatched closing bracket in '{expression}'")]
    UnmatchedBracket { expression: String },

    /// Invalid range syntax (e.g., `node[a-z]`)
    #[error("invalid range syntax '{range}' in '{expression}': {reason}")]
    InvalidRange {
        expression: String,
        range: String,
        reason: String,
    },

    /// Reversed range (e.g., `node[5-1]`)
    #[error("reversed range '{start}-{end}' in '{expression}' (start must be <= end)")]
    ReversedRange {
        expression: String,
        start: i64,
        end: i64,
    },

    /// Range produces too many hosts
    #[error(
        "range expansion would produce {count} hosts, exceeding limit of {limit} in '{expression}'"
    )]
    RangeTooLarge {
        expression: String,
        count: usize,
        limit: usize,
    },

    /// Invalid number in range
    #[error("invalid number '{value}' in range expression '{expression}'")]
    InvalidNumber { expression: String, value: String },

    /// File not found for ^ prefix
    #[error("hostfile not found: {path}")]
    FileNotFound { path: String },

    /// Error reading hostfile
    #[error("failed to read hostfile '{path}': {reason}")]
    FileReadError { path: String, reason: String },

    /// Nested brackets (e.g., `node[[1-2]]`)
    #[error("nested brackets are not supported in '{expression}'")]
    NestedBrackets { expression: String },

    /// IPv6 address disambiguation failure
    #[error("cannot distinguish IPv6 literal from range expression in '{expression}'")]
    Ipv6Ambiguity { expression: String },
}

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

    #[test]
    fn test_error_display() {
        let err = HostlistError::EmptyBracket {
            expression: "node[]".to_string(),
        };
        assert_eq!(err.to_string(), "empty bracket expression in 'node[]'");

        let err = HostlistError::UnclosedBracket {
            expression: "node[1-5".to_string(),
        };
        assert_eq!(err.to_string(), "unclosed bracket in 'node[1-5'");

        let err = HostlistError::ReversedRange {
            expression: "node[5-1]".to_string(),
            start: 5,
            end: 1,
        };
        assert_eq!(
            err.to_string(),
            "reversed range '5-1' in 'node[5-1]' (start must be <= end)"
        );
    }
}