bmputil 1.1.0

Black Magic Probe companion utility
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

// SPDX-License-Identifier: MIT OR Apache-2.0
// SPDX-FileCopyrightText: 2025 1BitSquared <info@1bitsquared.com>
// SPDX-FileContributor: Written by P-Storm <pauldeman@gmail.com>
// SPDX-FileContributor: Modified by Rachel Mant <git@dragonmux.network>

#[cfg(test)]
mod tests
{
	use bmputil::metadata::structs::Probe;
	use bmputil::probe_identity::{GitVersion, ProbeIdentity, VersionKind, VersionNumber, VersionParts};
	use color_eyre::eyre::Result;

	#[test]
	fn extract_native() -> Result<()>
	{
		let result: ProbeIdentity = "Black Magic Probe v2.0.0-rc2".try_into()?;

		assert_eq!(result.variant(), Some(Probe::Native));
		assert_eq!(
			result.version,
			VersionNumber::FullVersion(VersionParts::from_parts(2, 0, 0, VersionKind::ReleaseCandidate(2), false))
		);
		Ok(())
	}

	#[test]
	fn extract_old() -> Result<()>
	{
		let result: ProbeIdentity = "Black Magic Probe".try_into()?;

		assert_eq!(result.variant(), Some(Probe::Native));
		assert_eq!(result.version, VersionNumber::Unknown);
		Ok(())
	}

	#[test]
	fn extract_without_parathesis() -> Result<()>
	{
		let result: ProbeIdentity = "Black Magic Probe v2.0.0-rc2-65-g221c3031f".try_into()?;

		assert_eq!(result.variant(), Some(Probe::Native));
		assert_eq!(
			result.version,
			VersionNumber::FullVersion(VersionParts::from_parts(
				2,
				0,
				0,
				VersionKind::Development(GitVersion::from_parts(Some(2), 65, "g221c3031f".into())),
				false
			))
		);
		Ok(())
	}

	#[test]
	fn extract_version_only_hash() -> Result<()>
	{
		let result: ProbeIdentity = "Black Magic Probe g221c3031f".try_into()?;

		assert_eq!(result.variant(), Some(Probe::Native));
		assert_eq!(result.version, VersionNumber::GitHash("221c3031f".into()));
		Ok(())
	}

	#[test]
	fn extract_st_link() -> Result<()>
	{
		let result: ProbeIdentity = "Black Magic Probe (ST-Link/v2) v1.10.0-1273-g2b1ce9aee".try_into()?;

		assert_eq!(result.variant(), Some(Probe::Stlink));
		assert_eq!(
			result.version,
			VersionNumber::FullVersion(VersionParts::from_parts(
				1,
				10,
				0,
				VersionKind::Development(GitVersion::from_parts(None, 1273, "g2b1ce9aee".into())),
				false
			))
		);
		Ok(())
	}

	#[test]
	fn extract_without_closing()
	{
		let result: Result<ProbeIdentity> = "Black Magic Probe (ST-Link".try_into();

		assert!(result.is_err());
		if let Err(err) = result {
			assert_eq!(
				err.to_string(),
				"Error while parsing probe string: Not a matching pair of parenthesis found."
			);
		}
	}

	#[test]
	fn extract_bootloader() -> Result<()>
	{
		let result: ProbeIdentity = "Black Magic Probe DFU v1.8.0".try_into()?;

		assert_eq!(result.variant(), None);
		assert_eq!(result.version, VersionNumber::Unknown);
		assert!(result.is_bootloader());

		let result: ProbeIdentity = "dragonBoot DFU bootloader".try_into()?;

		assert_eq!(result.variant(), None);
		assert_eq!(result.version, VersionNumber::Unknown);
		assert!(result.is_bootloader());
		Ok(())
	}

	#[test]
	fn unknown()
	{
		let result: Result<ProbeIdentity> = "Something (v1.2.3)".try_into();

		assert!(result.is_err());
		if let Err(err) = result {
			assert_eq!(err.to_string(), "Product string doesn't start with 'Black Magic Probe'");
		}
	}
}