Add command sentry-cli debug-files bundle-jvm for bundling Java (and other JVM based languages) sources

src/commands/debug_files/create_jvm_based_bundle.rs

@@ -0,0 +1,112 @@
+use std::fs;
+use std::path::{Path};
+use anyhow::{bail, Result};
+use clap::{Arg, ArgMatches, Command};
+use sentry::types::DebugId;
+use symbolic::debuginfo::sourcebundle::{SourceFileType};
+use uuid::{Uuid};
+use crate::api::Api;
+use crate::config::Config;
+use crate::utils::args::ArgExt;
+use crate::utils::file_search::ReleaseFileSearch;
+use crate::utils::file_upload::{FileUpload, SourceFile, UploadContext};
+use crate::utils::fs::{path_as_url};
+
+pub fn make_command(command: Command) -> Command {
+    command
+        .hide(true) // experimental for now
+        .about("Create a source bundle for the given JVM based source files (e.g. Java, Kotlin, ...)")
+        .org_arg()
+        .project_arg(false)
+        .arg(
+            Arg::new("path")
+                .value_name("PATH")
+                .required(true)
+                .help("The directory containing source files to bundle."),
+        )
+        .arg(
+            Arg::new("output")
+                // .short('o')
+                .long("output")
+                .value_name("PATH")
+                .required(true)
+                .help("The path to the output folder."),
+        )
+        .arg(
+            Arg::new("debug_id")
+                // .short('d')
+                .long("debug-id")
+                .value_name("UUID")
+                .required(true)
+                .help("Debug ID to use for the source bundle."),
+        )
+}
+
+pub fn execute(matches: &ArgMatches) -> Result<()> {
+    let config = Config::current();
+    let org = config.get_org(matches)?;
+    let project = config.get_project(matches).ok();
+    let api = Api::current();
+    let chunk_upload_options = api.get_chunk_upload_options(&org)?;
+    let context = &UploadContext {
+        org: &org,
+        project: project.as_deref(),
+        release: None,
+        dist: None,
+        note: None,
+        wait: true,
+        dedupe: false,
+        chunk_upload_options: chunk_upload_options.as_ref(),
+    };
+    let path = Path::new(matches.get_one::<String>("path").unwrap());
+    let output_path = Path::new(matches.get_one::<String>("output").unwrap());
+    let debug_id_arg = matches.get_one::<String>("debug_id").unwrap();
+    let debug_id_uuid = Uuid::parse_str(debug_id_arg);
+    if debug_id_uuid.is_err() {
+        bail!("Given debug_id is invalid: {}", debug_id_arg)
+    }
+    let debug_id = DebugId::from_uuid(debug_id_uuid.unwrap());
+    let mut debug_id_string = debug_id.to_string();
+    debug_id_string.push_str(".zip");
+    let out = output_path.join(Path::new(&debug_id_string));
+
+    if !path.exists() {
+        bail!("Given path does not exist: {}", path.to_string_lossy())
+    }
+
+    if path.is_dir() {
+        let sources = ReleaseFileSearch::new(path.to_path_buf()).collect_files()?;
+        let files = sources
+            .iter()
+            .map(|source| {
+                let local_path = source.path.strip_prefix(&source.base_path).unwrap();
+                let local_path_jvm_ext = local_path.with_extension("jvm");
+                let url = format!("{}/{}", "~", path_as_url(&local_path_jvm_ext));
+                (
+                    url.to_string(),
+                    SourceFile {
+                        url,
+                        path: source.path.clone(),
+                        contents: source.contents.clone(),
+                        ty: SourceFileType::Source,
+                        headers: vec![],
+                        messages: vec![],
+                        already_uploaded: false,
+                    },
+                )
+            })
+            .collect();
+
+        let copy_result = match FileUpload::new(context).files(&files).build_jvm_based_bundle(Some(debug_id)) {
+            Ok(tempfile) => fs::copy(tempfile.path(), &out),
+            Err(e) => bail!("Unable to create source bundle: {}", e),
+        };
+        match copy_result {
+            Ok(_) => println!("Created {}", out.to_string_lossy()),
+            Err(e) => bail!("Unable to write source bundle: {}", e)
+        }
+        Ok(())
+    } else {
+        bail!("Given path is not a directory: {}", path.to_string_lossy())
+    }
+}

src/commands/debug_files/find.rs

@@ -149,6 +149,7 @@ fn find_ids(
                 DifType::SourceBundle => find_ids_for_sourcebundle(&dirent, &remaining),
                 DifType::Breakpad => find_ids_for_breakpad(&dirent, &remaining),
                 DifType::Proguard => find_ids_for_proguard(&dirent, &proguard_uuids),
+                DifType::JvmBased => find_ids_for_sourcebundle(&dirent, &remaining),
                 DifType::Wasm => None,
             })
             .flatten()

src/commands/debug_files/mod.rs

@@ -3,6 +3,7 @@ use clap::{ArgMatches, Command};
 
 pub mod bundle_sources;
 pub mod check;
+pub mod create_jvm_based_bundle;
 pub mod find;
 pub mod print_sources;
 pub mod upload;
@@ -11,6 +12,7 @@ macro_rules! each_subcommand {
     ($mac:ident) => {
         $mac!(bundle_sources);
         $mac!(check);
+        $mac!(create_jvm_based_bundle);
         $mac!(find);
         $mac!(print_sources);
         $mac!(upload);

src/commands/debug_files/upload.rs

@@ -234,6 +234,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
             "pe" => upload.filter_format(DifFormat::Object(FileFormat::Pe)),
             "sourcebundle" => upload.filter_format(DifFormat::Object(FileFormat::SourceBundle)),
             "portablepdb" => upload.filter_format(DifFormat::Object(FileFormat::PortablePdb)),
+            "jvmbased" => upload.filter_format(DifFormat::Object(FileFormat::SourceBundle)),
             "bcsymbolmap" => {
                 upload.filter_format(DifFormat::BcSymbolMap);
                 upload.filter_format(DifFormat::PList)

src/utils/dif.rs

@@ -21,6 +21,7 @@ pub enum DifType {
     Pdb,
     PortablePdb,
     Wasm,
+    JvmBased,
 }
 
 impl DifType {
@@ -35,6 +36,7 @@ impl DifType {
             DifType::Breakpad => "breakpad",
             DifType::Proguard => "proguard",
             DifType::Wasm => "wasm",
+            DifType::JvmBased => "jvmbased",
         }
     }
 
@@ -49,6 +51,7 @@ impl DifType {
             DifType::Breakpad,
             DifType::Proguard,
             DifType::Wasm,
+            DifType::JvmBased,
         ]
     }
 
@@ -63,6 +66,7 @@ impl DifType {
             "breakpad",
             "proguard",
             "wasm",
+            "jvmbased",
         ]
     }
 }
@@ -87,6 +91,7 @@ impl str::FromStr for DifType {
             "breakpad" => Ok(DifType::Breakpad),
             "proguard" => Ok(DifType::Proguard),
             "wasm" => Ok(DifType::Wasm),
+            "jvmbased" => Ok(DifType::JvmBased),
             _ => bail!("Invalid debug info file type"),
         }
     }
@@ -251,6 +256,7 @@ impl DifFile<'static> {
             Some(DifType::Wasm) => DifFile::open_object(path, FileFormat::Wasm),
             Some(DifType::Breakpad) => DifFile::open_object(path, FileFormat::Breakpad),
             Some(DifType::Proguard) => DifFile::open_proguard(path),
+            Some(DifType::JvmBased) => DifFile::open_object(path, FileFormat::SourceBundle),
             None => DifFile::try_open(path),
         }
     }

src/utils/file_upload.rs

@@ -188,6 +188,10 @@ impl<'a> FileUpload<'a> {
             .map_or(DEFAULT_CONCURRENCY, |o| usize::from(o.concurrency));
         upload_files_parallel(self.context, &self.files, concurrency)
     }
+
+    pub fn build_jvm_based_bundle(&self, debug_id: Option<DebugId>) -> Result<TempFile> {
+        build_artifact_bundle(self.context, &self.files, debug_id)
+    }
 }
 
 fn upload_files_parallel(
@@ -274,7 +278,7 @@ fn upload_files_chunked(
     files: &SourceFiles,
     options: &ChunkUploadOptions,
 ) -> Result<()> {
-    let archive = build_artifact_bundle(context, files)?;
+    let archive = build_artifact_bundle(context, files, None)?;
 
     let progress_style =
         ProgressStyle::default_spinner().template("{spinner} Optimizing bundle for upload...");
@@ -396,7 +400,11 @@ fn build_debug_id(files: &SourceFiles) -> DebugId {
     DebugId::from_uuid(uuid::Builder::from_sha1_bytes(sha1_bytes).into_uuid())
 }
 
-fn build_artifact_bundle(context: &UploadContext, files: &SourceFiles) -> Result<TempFile> {
+fn build_artifact_bundle(
+    context: &UploadContext,
+    files: &SourceFiles,
+    debug_id: Option<DebugId>,
+) -> Result<TempFile> {
     let progress_style = ProgressStyle::default_bar().template(
         "{prefix:.dim} Bundling files for upload... {msg:.dim}\
        \n{wide_bar}  {pos}/{len}",
@@ -409,8 +417,13 @@ fn build_artifact_bundle(context: &UploadContext, files: &SourceFiles) -> Result
     let archive = TempFile::create()?;
     let mut bundle = SourceBundleWriter::start(BufWriter::new(archive.open()?))?;
 
-    // artifact bundles get a random UUID as debug id
-    bundle.set_attribute("debug_id", build_debug_id(files).to_string());
+    match debug_id {
+        Some(id) => bundle.set_attribute("debug_id", id.to_string()),
+        None => {
+            // artifact bundles get a random UUID as debug id
+            bundle.set_attribute("debug_id", build_debug_id(files).to_string())
+        }
+    };
     if let Some(note) = context.note {
         bundle.set_attribute("note", note.to_owned());
     }

tests/integration/_cases/debug_files/debug_files-create-jvm-based-bundle-help-windows.trycmd

@@ -0,0 +1,26 @@
+```
+$ sentry-cli debug-files create-jvm-based-bundle --help
+? success
+Create a source bundle for the given JVM based source files (e.g. Java, Kotlin, ...)
+
+Usage: sentry-cli[EXE] debug-files create-jvm-based-bundle [OPTIONS] --output <PATH> --debug-id <UUID> <PATH>
+
+Arguments:
+  <PATH>  The directory containing source files to bundle.
+
+Options:
+  -o, --org <ORG>                The organization slug
+      --header <KEY:VALUE>       Custom headers that should be attached to all requests
+                                 in key:value format.
+  -p, --project <PROJECT>        The project slug.
+      --auth-token <AUTH_TOKEN>  Use the given Sentry auth token.
+      --output <PATH>            The path to the output folder.
+      --debug-id <UUID>          Debug ID to use for the source bundle.
+      --log-level <LOG_LEVEL>    Set the log output verbosity. [possible values: trace, debug, info,
+                                 warn, error]
+      --quiet                    Do not print any output while preserving correct exit code. This
+                                 flag is currently implemented only for selected subcommands.
+                                 [aliases: silent]
+  -h, --help                     Print help
+
+```

tests/integration/_cases/debug_files/debug_files-create-jvm-based-bundle-help.trycmd

@@ -0,0 +1,26 @@
+```
+$ sentry-cli debug-files create-jvm-based-bundle --help
+? success
+Create a source bundle for the given JVM based source files (e.g. Java, Kotlin, ...)
+
+Usage: sentry-cli debug-files create-jvm-based-bundle [OPTIONS] --output <PATH> --debug-id <UUID> <PATH>
+
+Arguments:
+  <PATH>  The directory containing source files to bundle.
+
+Options:
+  -o, --org <ORG>                The organization slug
+      --header <KEY:VALUE>       Custom headers that should be attached to all requests
+                                 in key:value format.
+  -p, --project <PROJECT>        The project slug.
+      --auth-token <AUTH_TOKEN>  Use the given Sentry auth token.
+      --output <PATH>            The path to the output folder.
+      --debug-id <UUID>          Debug ID to use for the source bundle.
+      --log-level <LOG_LEVEL>    Set the log output verbosity. [possible values: trace, debug, info,
+                                 warn, error]
+      --quiet                    Do not print any output while preserving correct exit code. This
+                                 flag is currently implemented only for selected subcommands.
+                                 [aliases: silent]
+  -h, --help                     Print help
+
+```

tests/integration/_cases/debug_files/debug_files-create-jvm-based-bundle-input-dir-empty.trycmd

@@ -0,0 +1,8 @@
+```
+$ sentry-cli debug-files create-jvm-based-bundle --output . --debug-id 48dee70b-4f3f-4a49-9223-de441738f7cd empty-dir
+? success
+> Found 0 files
+> Bundled 0 files for upload
+Created ./48dee70b-4f3f-4a49-9223-de441738f7cd.zip
+
+```

tests/integration/_cases/debug_files/debug_files-create-jvm-based-bundle-input-is-file.trycmd

@@ -0,0 +1,9 @@
+```
+$ sentry-cli debug-files create-jvm-based-bundle --output `cwd` --debug-id 59144E0E-52C4-41F8-9111-0D6F8F14905B tests/integration/_fixtures/jvmbased/io/sentry/sample/MainActivity.java
+? failed
+error: Given path is not a directory: tests/integration/_fixtures/jvmbased/io/sentry/sample/MainActivity.java
+
+Add --log-level=[info|debug] or export SENTRY_LOG_LEVEL=[info|debug] to see more output.
+Please attach the full debug log to all bug reports.
+
+```

tests/integration/_cases/debug_files/debug_files-create-jvm-based-bundle-input-not-found.trycmd

@@ -0,0 +1,9 @@
+```
+$ sentry-cli debug-files create-jvm-based-bundle --output `cwd` --debug-id 7A575F05-0585-4DB0-95DE-D0C032D7C707 tests/integration/_fixtures/i-do-not-exist
+? failed
+error: Given path does not exist: tests/integration/_fixtures/i-do-not-exist
+
+Add --log-level=[info|debug] or export SENTRY_LOG_LEVEL=[info|debug] to see more output.
+Please attach the full debug log to all bug reports.
+
+```

tests/integration/_cases/debug_files/debug_files-create-jvm-based-bundle-invalid-uuid.trycmd

@@ -0,0 +1,9 @@
+```
+$ sentry-cli debug-files create-jvm-based-bundle --output . --debug-id not-a-valid-uuid io
+? failed
+error: Given debug_id is invalid: not-a-valid-uuid
+
+Add --log-level=[info|debug] or export SENTRY_LOG_LEVEL=[info|debug] to see more output.
+Please attach the full debug log to all bug reports.
+
+```

tests/integration/_cases/debug_files/debug_files-create-jvm-based-bundle-output-is-file-windows.trycmd

@@ -0,0 +1,11 @@
+```
+$ sentry-cli debug-files create-jvm-based-bundle --output ./file.txt --debug-id D384DC3B-AB2F-4DC7-903D-2C851E27E094 tests/integration/_fixtures/jvmbased/
+? failed
+> Found 2 files
+> Bundled 2 files for upload
+error: Unable to write source bundle: The system cannot find the path specified. (os error 3)
+
+Add --log-level=[info|debug] or export SENTRY_LOG_LEVEL=[info|debug] to see more output.
+Please attach the full debug log to all bug reports.
+
+```

tests/integration/_cases/debug_files/debug_files-create-jvm-based-bundle-output-is-file.trycmd

@@ -0,0 +1,11 @@
+```
+$ sentry-cli debug-files create-jvm-based-bundle --output ./file.txt --debug-id D384DC3B-AB2F-4DC7-903D-2C851E27E094 ./io
+? failed
+> Found 2 files
+> Bundled 2 files for upload
+error: Unable to write source bundle: Not a directory (os error 20)
+
+Add --log-level=[info|debug] or export SENTRY_LOG_LEVEL=[info|debug] to see more output.
+Please attach the full debug log to all bug reports.
+
+```

tests/integration/_cases/debug_files/debug_files-create-jvm-based-bundle-output-not-found-windows.trycmd

@@ -0,0 +1,11 @@
+```
+$ sentry-cli debug-files create-jvm-based-bundle --output i-do-not-exist --debug-id 0B693ABA-531C-4EB6-99E4-B7320C3C85DA tests/integration/_fixtures/jvmbased
+? failed
+> Found 2 files
+> Bundled 2 files for upload
+error: Unable to write source bundle: The system cannot find the path specified. (os error 3)
+
+Add --log-level=[info|debug] or export SENTRY_LOG_LEVEL=[info|debug] to see more output.
+Please attach the full debug log to all bug reports.
+
+```

tests/integration/_cases/debug_files/debug_files-create-jvm-based-bundle-output-not-found.trycmd

@@ -0,0 +1,11 @@
+```
+$ sentry-cli debug-files create-jvm-based-bundle --output i-do-not-exist --debug-id 0B693ABA-531C-4EB6-99E4-B7320C3C85DA tests/integration/_fixtures/jvmbased
+? failed
+> Found 2 files
+> Bundled 2 files for upload
+error: Unable to write source bundle: No such file or directory (os error 2)
+
+Add --log-level=[info|debug] or export SENTRY_LOG_LEVEL=[info|debug] to see more output.
+Please attach the full debug log to all bug reports.
+
+```

tests/integration/_cases/debug_files/debug_files-create-jvm-based-bundle.trycmd

@@ -0,0 +1,8 @@
+```
+$ sentry-cli debug-files create-jvm-based-bundle --output . --debug-id a4368a48-0880-40d7-9a26-c9ef5a84d156 ./io
+? success
+> Found 2 files
+> Bundled 2 files for upload
+Created ./a4368a48-0880-40d7-9a26-c9ef5a84d156.zip
+
+```