frameassembly 1.3.0

Declarative Rust DSL and compiler to generate deterministic .pcap/.pcapng packet captures across 81 L2-L7 protocols for Wireshark, IDS & CI testing.
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

//! Unit tests for the FrameAssembly `logos` lexical analyzer (`src/lexer/mod.rs`).
//!
//! Verifies regex priority disambiguation between 4-octet IPv4 addresses (`Token::IpAddress`),
//! dotted ASN.1 Object Identifiers (`Token::OidStr`), signed/unsigned integer and hexadecimal
//! numeric literals (`Token::Number`), IEEE 802.3 MAC addresses (`Token::MacAddress`), IPv6
//! colons, case-insensitive time suffixes (`ns`/`NS`, `us`/`US`, `ms`/`MS`, `s`/`S`, `m`/`M`),
//! and all 640 case-insensitive protocol keywords (`host`/`HOST`/`Host`, etc.).

use super::*;

    /// Verifies that 4-octet IPv4 addresses are tokenized as `Token::IpAddress` rather than `Token::OidStr`.
    #[test]
    fn test_ip_address_not_shadowed_by_oid() {
        let input = "192.168.1.1 10.0.0.1";
        let tokens = lex(input).unwrap();
        assert_eq!(tokens.len(), 2);
        assert_eq!(tokens[0].0, Token::IpAddress("192.168.1.1"));
        assert_eq!(tokens[1].0, Token::IpAddress("10.0.0.1"));
    }

    /// Verifies tokenization of leading-dot and multi-arc OIDs alongside positive and negative numbers.
    #[test]
    fn test_oid_leading_dot_and_numbers() {
        let input = ".1.3.6.1.4.1 1.3.6.1.2.1.1.1.0 100 -42";
        let tokens = lex(input).unwrap();
        assert_eq!(tokens.len(), 4);
        assert_eq!(tokens[0].0, Token::OidStr(".1.3.6.1.4.1"));
        assert_eq!(tokens[1].0, Token::OidStr("1.3.6.1.2.1.1.1.0"));
        assert_eq!(tokens[2].0, Token::Number("100"));
        assert_eq!(tokens[3].0, Token::Number("-42"));
    }

    /// Verifies tokenization of IPv6 addresses and colon-delimited MAC addresses.
    #[test]
    fn test_ipv6_and_mac_addresses() {
        let input = "fe80::1 ::1 2001:db8::1 00:11:22:33:44:55";
        let tokens = lex(input).unwrap();
        assert_eq!(tokens.len(), 4);
        assert_eq!(tokens[0].0, Token::IpAddress("fe80::1"));
        assert_eq!(tokens[1].0, Token::IpAddress("::1"));
        assert_eq!(tokens[2].0, Token::IpAddress("2001:db8::1"));
        assert_eq!(tokens[3].0, Token::MacAddress("00:11:22:33:44:55"));
    }

    /// Verifies tokenization of `HEXPAYLOAD` and duration time unit suffixes.
    #[test]
    fn test_hexpayload_and_time_units() {
        let input = "HEXPAYLOAD 5ns 10us 20ms 1s 2m";
        let tokens = lex(input).unwrap();
        assert_eq!(tokens.len(), 11);
        assert_eq!(tokens[0].0, Token::HexPayload);
        assert_eq!(tokens[1].0, Token::Number("5"));
        assert_eq!(tokens[2].0, Token::Ns);
        assert_eq!(tokens[3].0, Token::Number("10"));
        assert_eq!(tokens[4].0, Token::Us);
        assert_eq!(tokens[5].0, Token::Number("20"));
        assert_eq!(tokens[6].0, Token::Ms);
        assert_eq!(tokens[7].0, Token::Number("1"));
        assert_eq!(tokens[8].0, Token::Sec);
        assert_eq!(tokens[9].0, Token::Number("2"));
        assert_eq!(tokens[10].0, Token::Min);
    }

    /// Verifies tokenization of escaped string literals.
    #[test]
    fn test_string_escapes_tokenization() {
        let input = r#""hello\r\n\x41\u0042\"world\\""#;
        let tokens = lex(input).unwrap();
        assert_eq!(tokens.len(), 1);
        assert_eq!(tokens[0].0, Token::StringLit(input));
    }

    /// Verifies ASCII case-insensitive tokenization of keywords, protocols, flags, and time units.
    #[test]
    fn test_case_insensitive_keywords_and_time_units() {
        let upper = "HOST FLOW COMPILE LOOP WAIT TCP SYN ACK HTTP GET DNS QUERY 5NS 10US 20MS 1S 2M";
        let lower = "host flow compile loop wait tcp syn ack http get dns query 5ns 10us 20ms 1s 2m";
        let mixed = "Host Flow Compile Loop Wait Tcp Syn Ack Http Get Dns Query 5Ns 10uS 20Ms 1s 2M";

        let upper_tokens: Vec<Token<'_>> = lex(upper).unwrap().into_iter().map(|(t, _)| t).collect();
        let lower_tokens: Vec<Token<'_>> = lex(lower).unwrap().into_iter().map(|(t, _)| t).collect();
        let mixed_tokens: Vec<Token<'_>> = lex(mixed).unwrap().into_iter().map(|(t, _)| t).collect();

        assert_eq!(upper_tokens, lower_tokens);
        assert_eq!(upper_tokens, mixed_tokens);
    }

    /// Verifies native tokenization of colon-separated, hyphen-separated, and Cisco dotted-quad MAC addresses.
    #[test]
    fn test_multi_format_mac_tokenization() {
        let input = "00:1a:2b:3c:4d:5e 00-1A-2B-3C-4D-5E 001a.2b3c.4d5e";
        let tokens = lex(input).unwrap();
        assert_eq!(tokens.len(), 3);
        assert_eq!(tokens[0].0, Token::MacAddress("00:1a:2b:3c:4d:5e"));
        assert_eq!(tokens[1].0, Token::MacAddress("00-1A-2B-3C-4D-5E"));
        assert_eq!(tokens[2].0, Token::MacAddress("001a.2b3c.4d5e"));
    }

    /// Verifies that common non-programmer lexical mistakes produce plain-English hints without compiler jargon.
    #[test]
    fn test_plain_english_lexer_error_hints() {
        use miette::Diagnostic;

        let cases = [
            ("# router config", "comments in .fasm start with '//'"),
            ("/* block */", "block comments are not supported"),
            ("HOST a { IP '10.0.0.1' }", "single quotes are not used"),
            ("HOST a { IP 10.0.0.1/24 }", "subnet masks (CIDR notation) are not used"),
            ("HOST a = { IP 10.0.0.1 }", "assignment symbol '=' is not used"),
            ("HOST a { IP: 10.0.0.1 }", "assignment symbol ':' is not used"),
            ("a -> b TCP [SYN]", "square brackets '[' and ']' are not used"),
            ("HOST a { IP 10.0.0.1; }", "semicolons are not needed"),
            ("+5ms a -> b TCP SYN", "relative delay prefixes like '+5ms' are not used"),
        ];

        for (src, expected_hint) in cases {
            let err = lex(src).unwrap_err();
            let combined = format!(
                "{} {}",
                err,
                err.help().map(|h| h.to_string()).unwrap_or_default()
            );
            assert!(
                combined.contains(expected_hint),
                "For input `{src}`, expected diagnostic containing `{expected_hint}`, got `{combined}`"
            );
            assert!(!combined.contains("AST"));
        }
    }