From a1468cca1819fb511b6bacfbac243a7b042639ae Mon Sep 17 00:00:00 2001
From: Andrew Walbran <qwandor@google.com>
Date: Tue, 1 Aug 2023 16:47:32 +0100
Subject: [PATCH] Add more doc comments and break up parse_cargo_out function.

This is a step towards making it testable.

Bug: 293289578
Test: atest cargo_embargo.test
Change-Id: I693ea16adf82f73c73a93e8dfa5ed4f351760828
---
 tools/cargo_embargo/src/cargo_out.rs | 39 ++++++++++++++++++++--------
 tools/cargo_embargo/src/main.rs      |  1 +
 2 files changed, 29 insertions(+), 11 deletions(-)

diff --git a/tools/cargo_embargo/src/cargo_out.rs b/tools/cargo_embargo/src/cargo_out.rs
index a8d5984b2..a51a383fb 100644
--- a/tools/cargo_embargo/src/cargo_out.rs
+++ b/tools/cargo_embargo/src/cargo_out.rs
@@ -20,6 +20,8 @@ use once_cell::sync::Lazy;
 use regex::Regex;
 use serde::{Deserialize, Serialize};
 use std::collections::BTreeMap;
+use std::env;
+use std::fs::{read_to_string, File};
 use std::path::Path;
 use std::path::PathBuf;
 
@@ -72,31 +74,46 @@ pub struct Crate {
     pub main_src: PathBuf,    // relative to package_dir
 }
 
-pub fn parse_cargo_out(cargo_out_path: &str, cargo_metadata_path: &str) -> Result<Vec<Crate>> {
-    let metadata: WorkspaceMetadata = serde_json::from_str(
-        &std::fs::read_to_string(cargo_metadata_path).context("failed to read cargo.metadata")?,
+/// Reads the given `cargo.out` and `cargo.metadata` files, and generates a list of crates based on
+/// the rustc invocations.
+///
+/// Ignores crates outside the current directory and build script crates.
+pub fn parse_cargo_out(
+    cargo_out_path: impl AsRef<Path>,
+    cargo_metadata_path: impl AsRef<Path>,
+) -> Result<Vec<Crate>> {
+    let cargo_out = read_to_string(cargo_out_path).context("failed to read cargo.out")?;
+    let metadata = serde_json::from_reader(
+        File::open(cargo_metadata_path).context("failed to open cargo.metadata")?,
     )
     .context("failed to parse cargo.metadata")?;
+    parse_cargo_out_str(&cargo_out, &metadata, env::current_dir().unwrap().canonicalize().unwrap())
+}
 
-    let cargo_out = CargoOut::parse(
-        &std::fs::read_to_string(cargo_out_path).context("failed to read cargo.out")?,
-    )
-    .context("failed to parse cargo.out")?;
+/// Parses the given `cargo.out` and `cargo.metadata` file contents and generates a list of crates
+/// based on the rustc invocations.
+///
+/// Ignores crates outside `base_directory` and build script crates.
+fn parse_cargo_out_str(
+    cargo_out: &str,
+    metadata: &WorkspaceMetadata,
+    base_directory: impl AsRef<Path>,
+) -> Result<Vec<Crate>> {
+    let cargo_out = CargoOut::parse(cargo_out).context("failed to parse cargo.out")?;
 
     assert!(cargo_out.cc_invocations.is_empty(), "cc not supported yet");
     assert!(cargo_out.ar_invocations.is_empty(), "ar not supported yet");
 
     let mut crates = Vec::new();
     for rustc in cargo_out.rustc_invocations.iter() {
-        let c = Crate::from_rustc_invocation(rustc, &metadata)
+        let c = Crate::from_rustc_invocation(rustc, metadata)
             .with_context(|| format!("failed to process rustc invocation: {rustc}"))?;
         // Ignore build.rs crates.
         if c.name.starts_with("build_script_") {
             continue;
         }
-        // Ignore crates outside the current directory.
-        let cwd = std::env::current_dir().unwrap().canonicalize().unwrap();
-        if !c.package_dir.starts_with(cwd) {
+        // Ignore crates outside the base directory.
+        if !c.package_dir.starts_with(&base_directory) {
             continue;
         }
         crates.push(c);
diff --git a/tools/cargo_embargo/src/main.rs b/tools/cargo_embargo/src/main.rs
index f88ed9fc8..514717b5b 100644
--- a/tools/cargo_embargo/src/main.rs
+++ b/tools/cargo_embargo/src/main.rs
@@ -52,6 +52,7 @@ use std::process::Command;
 //  * handle errors, esp. in cargo.out parsing. they should fail the program with an error code
 //  * handle warnings. put them in comments in the android.bp, some kind of report section
 
+/// Command-line parameters for `cargo_embargo`.
 #[derive(Parser, Debug)]
 #[clap()]
 struct Args {