DemesneGH commented on code in PR #263: URL: https://github.com/apache/teaclave-trustzone-sdk/pull/263#discussion_r2630031089
########## cargo-optee/src/ca_builder.rs: ########## @@ -0,0 +1,281 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you 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 anyhow::{bail, Result}; +use std::path::PathBuf; +use std::process::Command; + +use crate::common::{ + find_target_directory, get_target_and_cross_compile, print_cargo_command, + print_output_and_bail, read_uuid_from_file, Arch, ChangeDirectoryGuard, +}; + +#[derive(Clone)] +pub struct CaBuildConfig { + pub arch: Arch, // Architecture + pub optee_client_export: PathBuf, // Path to OP-TEE client export + pub debug: bool, // Debug mode (default false = release) + pub path: PathBuf, // Path to CA directory + pub plugin: bool, // Build as plugin (shared library) + pub uuid_path: Option<PathBuf>, // Path to UUID file (for plugins) + // Customized variables + pub env: Vec<(String, String)>, // Custom environment variables for cargo build + pub no_default_features: bool, // Disable default features + pub features: Option<String>, // Additional features to enable +} + +// Main function to build the CA, optionally installing to a target directory +pub fn build_ca(config: CaBuildConfig, install_dir: Option<&std::path::Path>) -> Result<()> { + // Change to the CA directory + let _guard = ChangeDirectoryGuard::new(&config.path)?; + + let component_type = if config.plugin { "Plugin" } else { "CA" }; + // Get the absolute path for better clarity + let absolute_path = std::fs::canonicalize(&config.path).unwrap_or_else(|_| config.path.clone()); + println!( + "Building {} in directory: {}", + component_type, + absolute_path.display() + ); + + // Step 1: Run clippy for code quality checks + run_clippy(&config)?; + + // Step 2: Build the CA + build_binary(&config)?; + + // Step 3: Post-build processing (strip for binaries, copy for plugins) + let final_binary = post_build(&config)?; + + // Print the final binary path with descriptive prompt + let absolute_final_binary = final_binary + .canonicalize() + .unwrap_or_else(|_| final_binary.clone()); + if config.plugin { + println!("Plugin copied to: {}", absolute_final_binary.display()); + } else { + println!( + "CA binary stripped and saved to: {}", + absolute_final_binary.display() + ); + } + + // Step 4: Install if requested + if let Some(install_dir) = install_dir { + use std::fs; + + // Check if install directory exists + if !install_dir.exists() { + bail!("Install directory does not exist: {:?}", install_dir); + } + + // Get package name from the final binary path + let package_name = final_binary + .file_name() + .and_then(|name| name.to_str()) + .ok_or_else(|| anyhow::anyhow!("Could not get binary name"))?; + + // Copy binary to install directory + let dest_path = install_dir.join(package_name); + fs::copy(&final_binary, &dest_path)?; + + println!( + "{} installed to: {:?}", + component_type, + dest_path.canonicalize().unwrap_or(dest_path) + ); + } + + println!("{} build successfully!", component_type); + + Ok(()) +} + +fn run_clippy(config: &CaBuildConfig) -> Result<()> { + println!("Running cargo fmt and clippy..."); + + // Run cargo fmt + let fmt_output = Command::new("cargo").arg("fmt").output()?; + + if !fmt_output.status.success() { + print_output_and_bail("cargo fmt", &fmt_output)?; + } + + // Determine target based on arch + let (target, _cross_compile) = get_target_and_cross_compile(config.arch); + + let mut clippy_cmd = Command::new("cargo"); + clippy_cmd.arg("clippy"); + clippy_cmd.arg("--target").arg(&target); + + // Set OPTEE_CLIENT_EXPORT environment variable for build scripts + clippy_cmd.env("OPTEE_CLIENT_EXPORT", &config.optee_client_export); + + clippy_cmd.arg("--"); + clippy_cmd.arg("-D").arg("warnings"); + clippy_cmd.arg("-D").arg("clippy::unwrap_used"); + clippy_cmd.arg("-D").arg("clippy::expect_used"); + clippy_cmd.arg("-D").arg("clippy::panic"); + + let clippy_output = clippy_cmd.output()?; + + if !clippy_output.status.success() { + print_output_and_bail("clippy", &clippy_output)?; + } + + Ok(()) +} + +fn build_binary(config: &CaBuildConfig) -> Result<()> { + let component_type = if config.plugin { "Plugin" } else { "CA" }; + println!("Building {} binary...", component_type); + + // Determine target and cross-compile based on arch + let (target, cross_compile) = get_target_and_cross_compile(config.arch); + + let mut build_cmd = Command::new("cargo"); + build_cmd.arg("build"); + build_cmd.arg("--target").arg(&target); + + // Add --no-default-features if specified + if config.no_default_features { + build_cmd.arg("--no-default-features"); + } + + // Add additional features if specified + if let Some(ref features) = config.features { + build_cmd.arg("--features").arg(features); + } + + if !config.debug { + build_cmd.arg("--release"); + } + + // Configure linker + let linker = format!("{}gcc", cross_compile); + let linker_cfg = format!("target.{}.linker=\"{}\"", target, linker); + build_cmd.arg("--config").arg(&linker_cfg); + + // Set OPTEE_CLIENT_EXPORT environment variable + build_cmd.env("OPTEE_CLIENT_EXPORT", &config.optee_client_export); + + // Apply custom environment variables + for (key, value) in &config.env { + build_cmd.env(key, value); + } + + // Print the full cargo build command for debugging + print_cargo_command(&build_cmd, "Building CA binary"); + + let build_output = build_cmd.output()?; + + if !build_output.status.success() { + print_output_and_bail("build", &build_output)?; + } + + Ok(()) +} + +fn post_build(config: &CaBuildConfig) -> Result<PathBuf> { + if config.plugin { + copy_plugin(config) + } else { + strip_binary(config) + } +} + +fn copy_plugin(config: &CaBuildConfig) -> Result<PathBuf> { + println!("Processing plugin..."); + + // Determine target based on arch + let (target, _cross_compile) = get_target_and_cross_compile(config.arch); + + let profile = if config.debug { "debug" } else { "release" }; + + // Use Cargo's workspace discovery strategy to find target directory + let workspace_target_dir = find_target_directory()?; + let target_dir = workspace_target_dir.join(target).join(profile); + + // Get the library name from Cargo.toml + let cargo_toml = std::fs::read_to_string("Cargo.toml")?; + let lib_name = cargo_toml + .lines() + .find(|line| line.trim().starts_with("name")) + .and_then(|line| line.split('=').nth(1)) + .map(|s| s.trim().trim_matches('"')) + .ok_or_else(|| anyhow::anyhow!("Could not find package name in Cargo.toml"))?; Review Comment: Please help to fix this ########## cargo-optee/src/ca_builder.rs: ########## @@ -0,0 +1,281 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you 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 anyhow::{bail, Result}; +use std::path::PathBuf; +use std::process::Command; + +use crate::common::{ + find_target_directory, get_target_and_cross_compile, print_cargo_command, + print_output_and_bail, read_uuid_from_file, Arch, ChangeDirectoryGuard, +}; + +#[derive(Clone)] +pub struct CaBuildConfig { + pub arch: Arch, // Architecture + pub optee_client_export: PathBuf, // Path to OP-TEE client export + pub debug: bool, // Debug mode (default false = release) + pub path: PathBuf, // Path to CA directory + pub plugin: bool, // Build as plugin (shared library) + pub uuid_path: Option<PathBuf>, // Path to UUID file (for plugins) + // Customized variables + pub env: Vec<(String, String)>, // Custom environment variables for cargo build + pub no_default_features: bool, // Disable default features + pub features: Option<String>, // Additional features to enable +} + +// Main function to build the CA, optionally installing to a target directory +pub fn build_ca(config: CaBuildConfig, install_dir: Option<&std::path::Path>) -> Result<()> { + // Change to the CA directory + let _guard = ChangeDirectoryGuard::new(&config.path)?; + + let component_type = if config.plugin { "Plugin" } else { "CA" }; + // Get the absolute path for better clarity + let absolute_path = std::fs::canonicalize(&config.path).unwrap_or_else(|_| config.path.clone()); + println!( + "Building {} in directory: {}", + component_type, + absolute_path.display() + ); + + // Step 1: Run clippy for code quality checks + run_clippy(&config)?; + + // Step 2: Build the CA + build_binary(&config)?; + + // Step 3: Post-build processing (strip for binaries, copy for plugins) + let final_binary = post_build(&config)?; + + // Print the final binary path with descriptive prompt + let absolute_final_binary = final_binary + .canonicalize() + .unwrap_or_else(|_| final_binary.clone()); + if config.plugin { + println!("Plugin copied to: {}", absolute_final_binary.display()); + } else { + println!( + "CA binary stripped and saved to: {}", + absolute_final_binary.display() + ); + } + + // Step 4: Install if requested + if let Some(install_dir) = install_dir { + use std::fs; + + // Check if install directory exists + if !install_dir.exists() { + bail!("Install directory does not exist: {:?}", install_dir); + } + + // Get package name from the final binary path + let package_name = final_binary + .file_name() + .and_then(|name| name.to_str()) + .ok_or_else(|| anyhow::anyhow!("Could not get binary name"))?; + + // Copy binary to install directory + let dest_path = install_dir.join(package_name); + fs::copy(&final_binary, &dest_path)?; + + println!( + "{} installed to: {:?}", + component_type, + dest_path.canonicalize().unwrap_or(dest_path) + ); + } + + println!("{} build successfully!", component_type); + + Ok(()) +} + +fn run_clippy(config: &CaBuildConfig) -> Result<()> { + println!("Running cargo fmt and clippy..."); + + // Run cargo fmt + let fmt_output = Command::new("cargo").arg("fmt").output()?; + + if !fmt_output.status.success() { + print_output_and_bail("cargo fmt", &fmt_output)?; + } + + // Determine target based on arch + let (target, _cross_compile) = get_target_and_cross_compile(config.arch); + + let mut clippy_cmd = Command::new("cargo"); + clippy_cmd.arg("clippy"); + clippy_cmd.arg("--target").arg(&target); + + // Set OPTEE_CLIENT_EXPORT environment variable for build scripts + clippy_cmd.env("OPTEE_CLIENT_EXPORT", &config.optee_client_export); + + clippy_cmd.arg("--"); + clippy_cmd.arg("-D").arg("warnings"); + clippy_cmd.arg("-D").arg("clippy::unwrap_used"); + clippy_cmd.arg("-D").arg("clippy::expect_used"); + clippy_cmd.arg("-D").arg("clippy::panic"); + + let clippy_output = clippy_cmd.output()?; + + if !clippy_output.status.success() { + print_output_and_bail("clippy", &clippy_output)?; + } + + Ok(()) +} + +fn build_binary(config: &CaBuildConfig) -> Result<()> { + let component_type = if config.plugin { "Plugin" } else { "CA" }; + println!("Building {} binary...", component_type); + + // Determine target and cross-compile based on arch + let (target, cross_compile) = get_target_and_cross_compile(config.arch); + + let mut build_cmd = Command::new("cargo"); + build_cmd.arg("build"); + build_cmd.arg("--target").arg(&target); + + // Add --no-default-features if specified + if config.no_default_features { + build_cmd.arg("--no-default-features"); + } + + // Add additional features if specified + if let Some(ref features) = config.features { + build_cmd.arg("--features").arg(features); + } + + if !config.debug { + build_cmd.arg("--release"); + } + + // Configure linker + let linker = format!("{}gcc", cross_compile); + let linker_cfg = format!("target.{}.linker=\"{}\"", target, linker); + build_cmd.arg("--config").arg(&linker_cfg); + + // Set OPTEE_CLIENT_EXPORT environment variable + build_cmd.env("OPTEE_CLIENT_EXPORT", &config.optee_client_export); + + // Apply custom environment variables + for (key, value) in &config.env { + build_cmd.env(key, value); + } + + // Print the full cargo build command for debugging + print_cargo_command(&build_cmd, "Building CA binary"); + + let build_output = build_cmd.output()?; + + if !build_output.status.success() { + print_output_and_bail("build", &build_output)?; + } + + Ok(()) +} + +fn post_build(config: &CaBuildConfig) -> Result<PathBuf> { + if config.plugin { + copy_plugin(config) + } else { + strip_binary(config) + } +} + +fn copy_plugin(config: &CaBuildConfig) -> Result<PathBuf> { + println!("Processing plugin..."); + + // Determine target based on arch + let (target, _cross_compile) = get_target_and_cross_compile(config.arch); + + let profile = if config.debug { "debug" } else { "release" }; + + // Use Cargo's workspace discovery strategy to find target directory + let workspace_target_dir = find_target_directory()?; + let target_dir = workspace_target_dir.join(target).join(profile); + + // Get the library name from Cargo.toml + let cargo_toml = std::fs::read_to_string("Cargo.toml")?; + let lib_name = cargo_toml + .lines() + .find(|line| line.trim().starts_with("name")) + .and_then(|line| line.split('=').nth(1)) + .map(|s| s.trim().trim_matches('"')) + .ok_or_else(|| anyhow::anyhow!("Could not find package name in Cargo.toml"))?; Review Comment: Please help to fix this @asir66 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
