android-15.0.0_r3/s

// Copyright (C) 2023 The Android Open Source Project
//
// 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.

use std::{
    fs::{read_dir, remove_dir_all},
    path::{Path, PathBuf},
    process::{Command, Output},
    str::from_utf8,
};

use anyhow::{anyhow, Context, Result};
use cargo::{
    core::{Manifest, SourceId},
    util::toml::read_manifest,
    Config,
};
use semver::Version;

use crate::{
    copy_dir, ensure_exists_and_empty, name_and_version::IsUpgradableTo, CrateError,
    NameAndVersionRef, NamedAndVersioned, RepoPath,
};

#[derive(Debug)]
pub struct Crate {
    manifest: Manifest,

    path: RepoPath,

    patch_output: Vec<Output>,
    generate_android_bp_output: Option<Output>,
    android_bp_diff: Option<Output>,
}

impl NamedAndVersioned for Crate {
    fn name(&self) -> &str {
        self.manifest.name().as_str()
    }
    fn version(&self) -> &Version {
        self.manifest.version()
    }
    fn key<'k>(&'k self) -> NameAndVersionRef<'k> {
        NameAndVersionRef::new(self.name(), self.version())
    }
}

impl IsUpgradableTo for Crate {}

impl Crate {
    pub fn new<P: Into<PathBuf>, Q: Into<PathBuf>>(
        manifest: Manifest,
        root: P,
        relpath: Q,
    ) -> Crate {
        let root: PathBuf = root.into();
        Crate {
            manifest,
            path: RepoPath::new(root.clone(), relpath),
            patch_output: Vec::new(),
            generate_android_bp_output: None,
            android_bp_diff: None,
        }
    }
    pub fn from<P: Into<PathBuf>>(cargo_toml: &impl AsRef<Path>, root: P) -> Result<Crate> {
        let root: PathBuf = root.into();
        let manifest_dir = cargo_toml.as_ref().parent().ok_or(anyhow!(
            "Failed to get parent directory of manifest at {}",
            cargo_toml.as_ref().display()
        ))?;
        let relpath = manifest_dir.strip_prefix(&root)?.to_path_buf();
        let source_id = SourceId::for_path(manifest_dir)?;
        let (manifest, _nested) =
            read_manifest(cargo_toml.as_ref(), source_id, &Config::default()?)?;
        match manifest {
            cargo::core::EitherManifest::Real(r) => Ok(Crate::new(r, root, relpath)),
            cargo::core::EitherManifest::Virtual(_) => {
                Err(anyhow!(CrateError::VirtualCrate(cargo_toml.as_ref().to_path_buf())))
            }
        }
    }

    pub fn path(&self) -> &RepoPath {
        &self.path
    }
    pub fn android_bp(&self) -> RepoPath {
        self.path.join(&"Android.bp")
    }
    pub fn cargo_embargo_json(&self) -> RepoPath {
        self.path.join(&"cargo_embargo.json")
    }
    pub fn staging_path(&self) -> RepoPath {
        self.path.with_same_root(
            Path::new("out/rust-crate-temporary-build").join(self.staging_dir_name()),
        )
    }
    pub fn patch_dir(&self) -> RepoPath {
        self.staging_path().join(&"patches")
    }
    pub fn staging_dir_name(&self) -> String {
        if let Some(dirname) = self.path.rel().file_name().and_then(|x| x.to_str()) {
            if dirname == self.name() {
                return dirname.to_string();
            }
        }
        format!("{}-{}", self.name(), self.version().to_string())
    }

    pub fn aosp_url(&self) -> Option<String> {
        if self.path.rel().starts_with("external/rust/crates") {
            if self.path.rel().ends_with(self.name()) {
                Some(format!(
                    "https://android.googlesource.com/platform/{}/+/refs/heads/main",
                    self.path()
                ))
            } else if self.path.rel().parent()?.ends_with(self.name()) {
                Some(format!(
                    "https://android.googlesource.com/platform/{}/+/refs/heads/main/{}",
                    self.path().rel().parent()?.display(),
                    self.path().rel().file_name()?.to_str()?
                ))
            } else {
                None
            }
        } else {
            None
        }
    }
    pub fn crates_io_url(&self) -> String {
        format!("https://crates.io/crates/{}", self.name())
    }

    pub fn is_crates_io(&self) -> bool {
        const NOT_CRATES_IO: &'static [&'static str] = &[
            "external/rust/beto-rust/",                 // Google crates
            "external/rust/pica/",                      // Google crate
            "external/rust/crates/webpki/third-party/", // Internal/example code
            "external/rust/cxx/third-party/",           // Internal/example code
            "external/rust/cxx/demo/",                  // Internal/example code
        ];
        !NOT_CRATES_IO.iter().any(|prefix| self.path().rel().starts_with(prefix))
    }
    pub fn is_migration_denied(&self) -> bool {
        const MIGRATION_DENYLIST: &'static [&'static str] = &[
            "external/rust/crates/openssl/", // It's complicated.
            "external/rust/cxx/",            // It's REALLY complicated.
        ];
        MIGRATION_DENYLIST.iter().any(|prefix| self.path().rel().starts_with(prefix))
    }
    pub fn is_android_bp_healthy(&self) -> bool {
        !self.is_migration_denied()
            && self.android_bp().abs().exists()
            && self.cargo_embargo_json().abs().exists()
            && self.generate_android_bp_success()
            && self.android_bp_unchanged()
    }
    pub fn patch_success(&self) -> bool {
        self.patch_output.iter().all(|output| output.status.success())
    }
    pub fn generate_android_bp_success(&self) -> bool {
        self.generate_android_bp_output.as_ref().is_some_and(|output| output.status.success())
    }
    pub fn android_bp_unchanged(&self) -> bool {
        self.android_bp_diff.as_ref().is_some_and(|output| output.status.success())
    }

    pub fn print(&self) -> Result<()> {
        println!("{} {} {}", self.name(), self.version(), self.path());
        if let Some(output) = &self.generate_android_bp_output {
            println!("generate Android.bp exit status: {}", output.status);
            println!("{}", from_utf8(&output.stdout)?);
            println!("{}", from_utf8(&output.stderr)?);
        }
        if let Some(output) = &self.android_bp_diff {
            println!("diff exit status: {}", output.status);
            println!("{}", from_utf8(&output.stdout)?);
            println!("{}", from_utf8(&output.stderr)?);
        }
        Ok(())
    }

    // Make a clean copy of the crate in out/
    pub fn stage_crate(&self) -> Result<()> {
        let staging_path_absolute = self.staging_path().abs();
        ensure_exists_and_empty(&staging_path_absolute)?;
        remove_dir_all(&staging_path_absolute)
            .context(format!("Failed to remove {}", staging_path_absolute.display()))?;
        copy_dir(&self.path().abs(), &staging_path_absolute).context(format!(
            "Failed to copy {} to {}",
            self.path(),
            self.staging_path()
        ))?;
        if staging_path_absolute.join(".git").is_dir() {
            remove_dir_all(staging_path_absolute.join(".git"))
                .with_context(|| "Failed to remove .git".to_string())?;
        }
        Ok(())
    }

    pub fn diff_android_bp(&mut self) -> Result<()> {
        self.set_diff_output(
            diff_android_bp(
                &self.android_bp().rel(),
                &self.staging_path().join(&"Android.bp").rel(),
                &self.path.root(),
            )
            .context("Failed to diff Android.bp".to_string())?,
        );
        Ok(())
    }

    pub fn apply_patches(&mut self) -> Result<()> {
        let patch_dir_absolute = self.patch_dir().abs();
        if patch_dir_absolute.exists() {
            for entry in read_dir(&patch_dir_absolute)
                .context(format!("Failed to read_dir {}", patch_dir_absolute.display()))?
            {
                let entry = entry?;
                if entry.file_name() == "Android.bp.patch"
                    || entry.file_name() == "Android.bp.diff"
                    || entry.file_name() == "rules.mk.diff"
                {
                    continue;
                }
                let entry_path = entry.path();
                let output = Command::new("patch")
                    .args(["-p1", "-l", "--no-backup-if-mismatch", "-i"])
                    .arg(&entry_path)
                    .current_dir(self.staging_path().abs())
                    .output()?;
                if !output.status.success() {
                    println!(
                        "Failed to apply {}\nstdout:\n{}\nstderr:\n:{}",
                        entry_path.display(),
                        from_utf8(&output.stdout)?,
                        from_utf8(&output.stderr)?
                    );
                }
                self.patch_output.push(output);
            }
        }
        Ok(())
    }

    pub fn android_bp_diff(&self) -> Option<&Output> {
        self.android_bp_diff.as_ref()
    }
    pub fn generate_android_bp_output(&self) -> Option<&Output> {
        self.generate_android_bp_output.as_ref()
    }
    pub fn set_generate_android_bp_output(&mut self, c2a_output: Output) {
        self.generate_android_bp_output.replace(c2a_output);
    }
    pub fn set_diff_output(&mut self, diff_output: Output) {
        self.android_bp_diff.replace(diff_output);
    }
    pub fn set_patch_output(&mut self, patch_output: Vec<Output>) {
        self.patch_output = patch_output;
    }
}

pub trait Migratable {
    fn is_migration_eligible(&self) -> bool;
    fn is_migratable(&self) -> bool;
}

impl Migratable for Crate {
    fn is_migration_eligible(&self) -> bool {
        self.is_crates_io()
            && !self.is_migration_denied()
            && self.android_bp().abs().exists()
            && self.cargo_embargo_json().abs().exists()
    }
    fn is_migratable(&self) -> bool {
        self.patch_success() && self.generate_android_bp_success() && self.android_bp_unchanged()
    }
}

#[cfg(test)]
mod tests {
    use std::fs::{create_dir, write};

    use super::*;
    use anyhow::anyhow;
    use tempfile::tempdir;

    fn write_test_manifest(temp_crate_dir: &Path, name: &str, version: &str) -> Result<PathBuf> {
        let cargo_toml: PathBuf = [temp_crate_dir, &Path::new("Cargo.toml")].iter().collect();
        write(
            cargo_toml.as_path(),
            format!("[package]\nname = \"{}\"\nversion = \"{}\"\n", name, version),
        )?;
        let lib_rs: PathBuf = [temp_crate_dir, &Path::new("src/lib.rs")].iter().collect();
        create_dir(lib_rs.parent().ok_or(anyhow!("Failed to get parent"))?)?;
        write(lib_rs.as_path(), "// foo")?;
        Ok(cargo_toml)
    }

    #[test]
    fn test_from_and_properties() -> Result<()> {
        let temp_crate_dir = tempdir()?;
        let cargo_toml = write_test_manifest(temp_crate_dir.path(), "foo", "1.2.0")?;
        let krate = Crate::from(&cargo_toml, &"/")?;
        assert_eq!(krate.name(), "foo");
        assert_eq!(krate.version().to_string(), "1.2.0");
        assert!(krate.is_crates_io());
        assert_eq!(krate.android_bp().abs(), temp_crate_dir.path().join("Android.bp"));
        assert_eq!(
            krate.cargo_embargo_json().abs(),
            temp_crate_dir.path().join("cargo_embargo.json")
        );
        Ok(())
    }

    #[test]
    fn test_from_error() -> Result<()> {
        let temp_crate_dir = tempdir()?;
        let cargo_toml = write_test_manifest(temp_crate_dir.path(), "foo", "1.2.0")?;
        assert!(Crate::from(&cargo_toml, &"/blah").is_err());
        Ok(())
    }
}

pub fn diff_android_bp(
    a: &impl AsRef<Path>,
    b: &impl AsRef<Path>,
    root: &impl AsRef<Path>,
) -> Result<Output> {
    Ok(Command::new("diff")
        .args([
            "-u",
            "-w",
            "-B",
            "-I",
            "// has rustc warnings",
            "-I",
            "This file is generated by",
            "-I",
            "cargo_pkg_version:",
        ])
        .arg(a.as_ref())
        .arg(b.as_ref())
        .current_dir(root)
        .output()?)
}