ros_add 0.1.10

The Purpose of the Package is to provide the `cargo ros_add` command to add dependencies to `Cargo.toml` and the `package.xml`
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
//! A cargo subcommand for adding dependencies to both Cargo.toml and ROS package.xml files.
//!
//! This tool helps manage dependencies for ROS 2 packages written in Rust by
//! synchronizing dependencies between Cargo.toml and package.xml manifest files.

use ros_add::{DependencyType, PackageName, PathDoc, SplitRaw, XMLHelper, env_to_matches};
use std::{
    fs::{self},
    io::ErrorKind,
};
use tempfile::tempdir;

#[test]
fn test_dependency_type_cargo_toml_type() {
    assert_eq!(
        DependencyType::BuildDepend.cargo_toml_type(),
        "build-dependencies"
    );
    assert_eq!(DependencyType::Depend.cargo_toml_type(), "dependencies");
    assert_eq!(DependencyType::TestDepend.cargo_toml_type(), "dependencies");
    assert_eq!(DependencyType::ExecDepend.cargo_toml_type(), "dependencies");
}

#[test]
fn test_dependency_type_package_xml_type() {
    assert_eq!(
        DependencyType::BuildDepend.package_xml_type(),
        "build_depend"
    );
    assert_eq!(
        DependencyType::BuildExportDepend.package_xml_type(),
        "build_export_depend"
    );
    assert_eq!(
        DependencyType::BuildtoolDepend.package_xml_type(),
        "buildtool-depend"
    );
    assert_eq!(DependencyType::ExecDepend.package_xml_type(), "exec-depend");
    assert_eq!(DependencyType::Depend.package_xml_type(), "depend");
    assert_eq!(DependencyType::TestDepend.package_xml_type(), "test-depend");
    assert_eq!(DependencyType::Conflict.package_xml_type(), "conflict");
    assert_eq!(DependencyType::Replace.package_xml_type(), "replace");
}

#[test]
fn test_package_name_from_str() {
    let package = PackageName::from("serde");
    assert_eq!(package.name, "serde".into());
    assert_eq!(package.version, "*".into());

    let package = PackageName::from("serde@1.0.0");
    assert_eq!(package.name, "serde".into());
    assert_eq!(package.version, "1.0.0".into());

    let package = PackageName::from("serde@=1.0.38");
    assert_eq!(package.name, "serde".into());
    assert_eq!(package.version, "=1.0.38".into());
}

#[test]
fn test_package_name_display() {
    let package = PackageName {
        name: "serde".into(),
        version: "=1.0.38".into(),
    };
    assert_eq!(format!("{}", package), "Package:serde, Version:=1.0.38");
}

#[test]
fn test_pathdoc_new_valid_toml() -> Result<(), ErrorKind> {
    let temp_dir = tempdir().map_err(|_| ErrorKind::OutOfMemory)?;
    let toml_path = temp_dir.path().join("Cargo.toml");

    let toml_content = r#"
[package]
name = "test_package"
version = "0.1.0"
"#;

    fs::write(&toml_path, toml_content).map_err(|err| err.kind())?;

    let pathdoc = PathDoc::new(
        toml_path.to_str().ok_or(ErrorKind::NotFound)?,
        DependencyType::Depend,
    );
    assert!(pathdoc.is_ok());

    temp_dir.close().map_err(|_| ErrorKind::PermissionDenied)?;
    Ok(())
}

#[test]
fn test_pathdoc_new_invalid_toml() -> Result<(), ErrorKind> {
    let temp_dir = tempdir().map_err(|_| ErrorKind::OutOfMemory)?;
    let toml_path = temp_dir.path().join("Cargo.toml");

    let invalid_toml = "invalid toml content";
    fs::write(&toml_path, invalid_toml).map_err(|err| err.kind())?;

    let pathdoc = PathDoc::new(
        toml_path.to_str().ok_or(ErrorKind::NotFound)?,
        DependencyType::Depend,
    );
    assert!(matches!(pathdoc, Err(ErrorKind::InvalidData)));

    temp_dir.close().map_err(|_| ErrorKind::PermissionDenied)?;
    Ok(())
}

#[test]
fn test_pathdoc_add_dependency() -> Result<(), ErrorKind> {
    let temp_dir = tempdir().map_err(|_| ErrorKind::OutOfMemory)?;
    let toml_path = temp_dir.path().join("Cargo.toml");

    let toml_content = r#"
[package]
name = "test_package"
version = "0.1.0"

[dependencies]
existing_dep = "1.0.0"
"#;

    fs::write(&toml_path, toml_content).map_err(|err| err.kind())?;

    let pathdoc = PathDoc::new(
        toml_path.to_str().ok_or(ErrorKind::NotFound)?,
        DependencyType::Depend,
    )?;
    let package = PackageName::from("serde@1.0.0");

    let result = pathdoc.add_dependency_to_cargo_toml(&package);
    assert!(result.is_ok());

    // Verify the dependency was added
    let updated_content = fs::read_to_string(&toml_path).map_err(|err| err.kind())?;
    assert!(updated_content.contains("serde = \"1.0.0\""));

    temp_dir.close().map_err(|_| ErrorKind::PermissionDenied)?;
    Ok(())
}

#[test]
fn test_pathdoc_add_duplicate_dependency() -> Result<(), ErrorKind> {
    let temp_dir = tempdir().map_err(|_| ErrorKind::OutOfMemory)?;
    let toml_path = temp_dir.path().join("Cargo.toml");

    let toml_content = r#"
[package]
name = "test_package"
version = "0.1.0"

[dependencies]
serde = "1.0.0"
"#;

    fs::write(&toml_path, toml_content).map_err(|err| err.kind())?;

    let pathdoc = PathDoc::new(
        toml_path.to_str().ok_or(ErrorKind::NotFound)?,
        DependencyType::Depend,
    )?;
    let package = PackageName::from("serde@2.0.0");

    let result = pathdoc.add_dependency_to_cargo_toml(&package);
    assert!(matches!(result, Err(ErrorKind::AlreadyExists)));

    temp_dir.close().map_err(|_| ErrorKind::PermissionDenied)?;
    Ok(())
}

#[test]
fn test_pathdoc_add_build_dependency() -> Result<(), ErrorKind> {
    let temp_dir = tempdir().map_err(|_| ErrorKind::OutOfMemory)?;
    let toml_path = temp_dir.path().join("Cargo.toml");

    let toml_content = r#"
[package]
name = "test_package"
version = "0.1.0"
"#;

    fs::write(&toml_path, toml_content).map_err(|err| err.kind())?;

    let pathdoc = PathDoc::new(
        toml_path.to_str().ok_or(ErrorKind::NotFound)?,
        DependencyType::BuildDepend,
    )?;
    let package = PackageName::from("build_helper@0.1.0");

    let result = pathdoc.add_dependency_to_cargo_toml(&package);
    assert!(result.is_ok());

    // Verify the build dependency was added to the correct section
    let updated_content = fs::read_to_string(&toml_path).unwrap();
    assert!(updated_content.contains("[build-dependencies]"));
    assert!(updated_content.contains("build_helper = \"0.1.0\""));

    temp_dir.close().map_err(|_| ErrorKind::PermissionDenied)?;
    Ok(())
}

#[test]
fn test_xml_helper_new_valid_xml() -> Result<(), ErrorKind> {
    let temp_dir = tempdir().map_err(|_| ErrorKind::OutOfMemory)?;
    let xml_path = temp_dir.path().join("package.xml");

    let xml_content = r#"<?xml version="1.0"?>
<package format="3">
  <name>test_package</name>
  <version>0.0.0</version>
  <description>Test package</description>
  <export>
    <build_type>ament_cmake</build_type>
  </export>
</package>"#;

    fs::write(&xml_path, xml_content).map_err(|err| err.kind())?;

    let xml_helper = XMLHelper::new(
        xml_path.to_str().ok_or(ErrorKind::NotFound)?,
        DependencyType::BuildDepend,
    );
    assert!(xml_helper.is_ok());

    temp_dir.close().map_err(|_| ErrorKind::PermissionDenied)?;
    Ok(())
}

#[test]
fn test_xml_helper_new_invalid_xml() -> Result<(), ErrorKind> {
    let temp_dir = tempdir().map_err(|_| ErrorKind::OutOfMemory)?;
    let xml_path = temp_dir.path().join("package.xml");

    // XMLHelper::new only checks if file exists, not if content is valid XML
    // So this test should expect success, and the XML validation should happen
    // in add_dependency_to_package_xml
    let invalid_xml = "invalid xml content";
    fs::write(&xml_path, invalid_xml).map_err(|err| err.kind())?;

    let xml_helper = XMLHelper::new(
        xml_path.to_str().ok_or(ErrorKind::NotFound)?,
        DependencyType::BuildDepend,
    );
    assert!(xml_helper.is_ok()); // This should succeed because file exists

    temp_dir.close().map_err(|_| ErrorKind::PermissionDenied)?;
    Ok(())
}

#[test]
fn test_xml_helper_add_dependency_invalid_xml() -> Result<(), ErrorKind> {
    let temp_dir = tempdir().map_err(|_| ErrorKind::OutOfMemory)?;
    let xml_path = temp_dir.path().join("package.xml");

    // Use XML that's definitely malformed (unclosed tag, invalid characters)
    let invalid_xml = r#"<?xml version="1.0"?>
<package format="3">
  <name>test_package
  <version>0.0.0</version>
  <description>Test & invalid & characters here
</package>"#;

    fs::write(&xml_path, invalid_xml).map_err(|err| err.kind())?;

    let xml_helper = XMLHelper::new(
        xml_path.to_str().ok_or(ErrorKind::NotFound)?,
        DependencyType::BuildDepend,
    )?;
    let package = PackageName::from("rclcpp");

    let result = xml_helper.add_dependency_to_package_xml(&package);
    assert!(matches!(result, Err(ErrorKind::InvalidData)));

    temp_dir.close().map_err(|_| ErrorKind::PermissionDenied)?;
    Ok(())
}

#[test]
fn test_xml_helper_add_dependency() -> Result<(), ErrorKind> {
    let temp_dir = tempdir().map_err(|_| ErrorKind::OutOfMemory)?;
    let xml_path = temp_dir.path().join("package.xml");

    let xml_content = r#"<?xml version="1.0"?>
<package format="3">
  <name>test_package</name>
  <version>0.0.0</version>
  <description>Test package</description>
  <export>
    <build_type>ament_cmake</build_type>
  </export>
</package>"#;

    fs::write(&xml_path, xml_content).map_err(|err| err.kind())?;

    let xml_helper = XMLHelper::new(
        xml_path.to_str().ok_or(ErrorKind::NotFound)?,
        DependencyType::BuildDepend,
    )?;
    let package = PackageName::from("rclcpp");

    let result = xml_helper.add_dependency_to_package_xml(&package);
    assert!(result.is_ok());

    // Verify the dependency was added
    let updated_content = fs::read_to_string(&xml_path).map_err(|err| err.kind())?;
    assert!(updated_content.contains("<build_depend>rclcpp</build_depend>"));

    temp_dir.close().map_err(|_| ErrorKind::PermissionDenied)?;
    Ok(())
}

#[test]
fn test_xml_helper_add_duplicate_dependency() -> Result<(), ErrorKind> {
    let temp_dir = tempdir().map_err(|_| ErrorKind::OutOfMemory)?;
    let xml_path = temp_dir.path().join("package.xml");

    let xml_content = r#"<?xml version="1.0"?>
<package format="3">
  <name>test_package</name>
  <version>0.0.0</version>
  <description>Test package</description>
  <build_depend>rclcpp</build_depend>
  <export>
    <build_type>ament_cmake</build_type>
  </export>
</package>"#;

    fs::write(&xml_path, xml_content).map_err(|err| err.kind())?;

    let xml_helper = XMLHelper::new(
        xml_path.to_str().ok_or(ErrorKind::NotFound)?,
        DependencyType::BuildDepend,
    )?;
    let package = PackageName::from("rclcpp");

    let result = xml_helper.add_dependency_to_package_xml(&package);
    assert!(matches!(result, Err(ErrorKind::AlreadyExists)));

    temp_dir.close().map_err(|_| ErrorKind::PermissionDenied)?;
    Ok(())
}

#[test]
fn test_env_to_matches_basic() {
    let args = vec!["ros_add".to_string(), "serde".to_string()];
    let matches = env_to_matches(args);

    assert_eq!(matches.get_one::<String>("dependency").unwrap(), "serde");
    assert!(!matches.get_flag("build"));
    assert!(!matches.get_flag("test"));
}

#[test]
fn test_env_to_matches_with_flags() {
    let args = vec![
        "ros_add".to_string(),
        "serde".to_string(),
        "--build".to_string(),
        "--test".to_string(),
    ];
    let matches = env_to_matches(args);

    assert_eq!(matches.get_one::<String>("dependency").unwrap(), "serde");
    assert!(matches.get_flag("build"));
    assert!(matches.get_flag("test"));
}

#[test]
fn test_env_to_matches_cargo_subcommand() {
    // Simulate cargo subcommand args: cargo ros-add serde
    let args = vec![
        "cargo".to_string(),
        "ros-add".to_string(),
        "serde".to_string(),
    ];
    let matches = env_to_matches(args);

    assert_eq!(matches.get_one::<String>("dependency").unwrap(), "serde");
}

#[test]
fn test_dependency_type_from_arg_matches() {
    let args = vec![
        "ros_add".to_string(),
        "serde".to_string(),
        "--build".to_string(),
    ];
    let matches = env_to_matches(args);
    let dep_type: DependencyType = matches.into();

    assert_eq!(dep_type, DependencyType::BuildDepend);
}

#[test]
fn test_dependency_type_from_arg_matches_default() {
    let args = vec!["ros_add".to_string(), "serde".to_string()];
    let matches = env_to_matches(args);
    let dep_type: DependencyType = matches.into();

    assert_eq!(dep_type, DependencyType::Depend);
}

#[test]
fn test_package_name_from_split_raw() {
    let split_raw = SplitRaw::from("package@1.0.0");
    let package_name = PackageName::from(split_raw);

    assert_eq!(package_name.name, "package".into());
    assert_eq!(package_name.version, "1.0.0".into());
}

#[test]
fn test_package_name_from_split_raw_no_version() {
    let split_raw = SplitRaw::from("package");
    let package_name = PackageName::from(split_raw);

    assert_eq!(package_name.name, "package".into());
    assert_eq!(package_name.version, "*".into());
}