subunit 0.3.1

A subunit v2 protocol implementation 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

// 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.

#![deny(missing_docs)]

//! Implementation of the Subunit protocol in Rust. For the protocol definition,
//! see the [Subunit Protocol
//! Specification](https://github.com/testing-cabal/subunit/blob/main/README.rst).
//! This crate contains both a v1 and v2 implementation of the protocol. v1 is
//! disabled by default but can be enabled via the `v1` feature.

/// Types representing the Subunit protocol
pub mod types {
    pub mod event;
    pub mod eventfeatures;
    pub mod file;
    pub mod number;
    pub mod stream;
    pub mod teststatus;
    pub mod timestamp;
}

pub mod deserialize;
pub mod io;
pub mod serialize;

/// Constants defined by the Subunit protocol
pub mod constants {
    /// The Subunit v2 protocol signature
    pub static V2_SIGNATURE: u8 = 0xb3;

    /// Maximum packet length
    pub static MAX_PACKET_LENGTH: u32 = 4 * 1024 * 1024;

    /// Maximum value for a number
    pub static MAX_NUMBER_VALUE: u32 = 0x3fffffff;

    /// Mask for a number kind
    pub static NUMBER_KIND_MASK: u8 = 0xc0;

    /// Mask for a number value
    pub static NUMBER_VALUE_MASK: u8 = 0x3f;

    /// The Subunit v2 protocol version
    pub static VERSION2: u16 = 0x2000;
}
#[cfg(feature = "v1")]
pub mod v1;

use std::fmt::Debug;

use thiserror::Error as ThisError;

#[derive(ThisError)]
// Allow missing docs, because #[error] will generate them
#[allow(missing_docs)]
/// Error type for parsing and serializing Subunit packets
pub enum Error {
    #[error("Value is too large to encode")]
    TooLarge,
    #[error("Invalid packet header: size {} < header size {}", _0, _1)]
    LengthTooSmall(u32, u32),
    #[error("Internal logic error {}", _0)]
    Internal(String),
    #[error("Invalid UTF8")]
    InvalidUTF8Sequence,
    #[error("Not enough bytes")]
    NotEnoughBytes,
    #[error("Invalid signature")]
    InvalidSignature,
    #[error("Bad version {:#x}", _0)]
    BadVersion(u16),
    #[error("CRC32 Mismatch measured: {:#02x} != stored: {:#02x}", _0, _1)]
    CRC32Mismatch(u32, u32),
    #[error("Invalid timestamp secs: {} nsecs: {}", _0, _1)]
    InvalidTimestamp(u32, u32),
    #[error("IO Error: {}", _0)]
    IO(#[from] std::io::Error),
    #[cfg(feature = "v1")]
    #[error("V1 Parsing error: {:?}", _0)]
    V1Parse(String),
}

#[cfg(feature = "v1")]
impl<I, O> From<winnow::error::ParseError<I, O>> for Error
where
    I: std::fmt::Debug,
    O: std::fmt::Debug,
{
    fn from(err: winnow::error::ParseError<I, O>) -> Self {
        Error::V1Parse(format!("{:?}", err))
    }
}

impl Debug for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self)
    }
}

type GenError = Box<dyn std::error::Error>;
type GenResult<T> = Result<T, GenError>;