feat(cdk): prebuild artifacts for publish and deploy (#3252)

Abstracts the build command used for `build`, `test`, `deploy` and `publish` and then
makes sure commands relying on binaries from build process output (Artifacts) are present
by spawning the `build` process before proceeding.

crates/cdk/src/build.rs

@@ -3,9 +3,10 @@ use std::fmt::Debug;
 use anyhow::Result;
 use clap::Parser;
 
-use cargo_builder::{package::PackageInfo, cargo::Cargo};
+use cargo_builder::package::PackageInfo;
 
 use crate::cmd::PackageCmd;
+use crate::utils::build::{BuildOpts, build_connector};
 
 /// Build the Connector in the current working directory
 #[derive(Debug, Parser)]
@@ -21,15 +22,14 @@ pub struct BuildCmd {
 impl BuildCmd {
     pub(crate) fn process(self) -> Result<()> {
         let opt = self.package.as_opt();
-        let p = PackageInfo::from_options(&opt)?;
-        let cargo = Cargo::build()
-            .profile(opt.release)
-            .lib(false)
-            .package(p.package_name())
-            .target(p.arch_target())
-            .extra_arguments(self.extra_arguments)
-            .build()?;
+        let package_info = PackageInfo::from_options(&opt)?;
 
-        cargo.run()
+        build_connector(
+            &package_info,
+            BuildOpts {
+                release: opt.release,
+                extra_arguments: self.extra_arguments,
+            },
+        )
     }
 }

crates/cdk/src/deploy.rs

@@ -15,6 +15,7 @@ use fluvio_connector_package::metadata::ConnectorMetadata;
 use tracing::{debug, trace};
 
 use crate::cmd::PackageCmd;
+use crate::utils::build::{BuildOpts, build_connector};
 
 const CONNECTOR_METADATA_FILE_NAME: &str = "Connector.toml";
 
@@ -158,9 +159,14 @@ fn deploy_local(
     secrets: Option<PathBuf>,
     ipkg_file: Option<PathBuf>,
 ) -> Result<()> {
+    let opt = package_cmd.as_opt();
+    let package_info = PackageInfo::from_options(&opt)?;
+
+    build_connector(&package_info, BuildOpts::with_release(opt.release.as_str()))?;
+
     let (executable, connector_metadata) = match ipkg_file {
         Some(ipkg_file) => from_ipkg_file(ipkg_file).context("Failed to deploy from ipkg file")?,
-        None => from_cargo_package(package_cmd)
+        None => from_cargo_package(&package_info)
             .context("Failed to deploy from within cargo package directory")?,
     };
 
@@ -181,14 +187,15 @@ fn deploy_local(
     local_index::store(result)
 }
 
-pub(crate) fn from_cargo_package(package_cmd: PackageCmd) -> Result<(PathBuf, ConnectorMetadata)> {
+pub(crate) fn from_cargo_package(
+    package_info: &PackageInfo,
+) -> Result<(PathBuf, ConnectorMetadata)> {
     debug!("reading connector metadata from cargo package");
 
-    let opt = package_cmd.as_opt();
-    let p = PackageInfo::from_options(&opt)?;
-    let connector_metadata =
-        ConnectorMetadata::from_toml_file(p.package_relative_path(CONNECTOR_METADATA_FILE_NAME))?;
-    let executable_path = p.target_bin_path()?;
+    let connector_metadata = ConnectorMetadata::from_toml_file(
+        package_info.package_relative_path(CONNECTOR_METADATA_FILE_NAME),
+    )?;
+    let executable_path = package_info.target_bin_path()?;
     Ok((executable_path, connector_metadata))
 }
 

crates/cdk/src/main.rs

@@ -6,6 +6,8 @@ mod deploy;
 mod publish;
 mod set_public;
 
+pub(crate) mod utils;
+
 fn main() -> anyhow::Result<()> {
     use clap::Parser;
 

crates/cdk/src/publish.rs

@@ -21,6 +21,7 @@ use hubutil::packagename_validate;
 use tracing::{debug, info};
 
 use crate::cmd::PackageCmd;
+use crate::utils::build::{BuildOpts, build_connector};
 
 pub const CONNECTOR_TOML: &str = "Connector.toml";
 
@@ -70,6 +71,7 @@ impl PublishCmd {
             remove_dir_all(&hubdir)?;
         }
 
+        build_connector(&package_info, BuildOpts::with_release(opt.release.as_str()))?;
         init_package_template(&package_info, &self.readme)?;
         check_package_meta_visiblity(&package_info)?;
 

crates/cdk/src/test.rs

@@ -3,10 +3,12 @@ use std::{fmt::Debug, path::PathBuf};
 use anyhow::{Result, Context};
 use clap::Parser;
 
-use cargo_builder::{package::PackageInfo, cargo::Cargo};
+use cargo_builder::package::PackageInfo;
 use fluvio_connector_deployer::{Deployment, DeploymentType};
 
-use crate::{cmd::PackageCmd, deploy::from_cargo_package};
+use crate::cmd::PackageCmd;
+use crate::deploy::from_cargo_package;
+use crate::utils::build::{build_connector, BuildOpts};
 
 /// Build and run the Connector in the current working directory
 #[derive(Debug, Parser)]
@@ -30,19 +32,15 @@ pub struct TestCmd {
 impl TestCmd {
     pub(crate) fn process(self) -> Result<()> {
         let opt = self.package.as_opt();
-        let p = PackageInfo::from_options(&opt)?;
+        let package_info = PackageInfo::from_options(&opt)?;
+        let build_options = BuildOpts {
+            release: opt.release,
+            extra_arguments: self.extra_arguments,
+        };
 
-        let cargo = Cargo::build()
-            .profile(opt.release)
-            .target(opt.target)
-            .lib(false)
-            .package(p.package_name())
-            .extra_arguments(self.extra_arguments)
-            .build()?;
+        build_connector(&package_info, build_options)?;
 
-        cargo.run()?;
-
-        let (executable, connector_metadata) = from_cargo_package(self.package)
+        let (executable, connector_metadata) = from_cargo_package(&package_info)
             .context("Failed to deploy from within cargo package directory")?;
 
         let mut builder = Deployment::builder();

crates/cdk/src/utils.rs

@@ -0,0 +1,33 @@
+pub mod build {
+    use anyhow::Result;
+
+    use cargo_builder::package::PackageInfo;
+    use cargo_builder::cargo::Cargo;
+
+    pub struct BuildOpts {
+        pub(crate) release: String,
+        pub(crate) extra_arguments: Vec<String>,
+    }
+
+    impl BuildOpts {
+        pub fn with_release(release: &str) -> Self {
+            Self {
+                release: release.to_string(),
+                extra_arguments: Vec::default(),
+            }
+        }
+    }
+
+    /// Builds a Connector given it's package info and Cargo Build options
+    pub fn build_connector(package_info: &PackageInfo, opts: BuildOpts) -> Result<()> {
+        let cargo = Cargo::build()
+            .profile(opts.release)
+            .lib(false)
+            .package(package_info.package_name())
+            .target(package_info.arch_target())
+            .extra_arguments(opts.extra_arguments)
+            .build()?;
+
+        cargo.run()
+    }
+}