Add command sentry-cli debug-files bundle-jvm for bundling Java (an…

…d other JVM based languages) sources (#1551)

src/commands/debug_files/bundle_jvm.rs

@@ -0,0 +1,110 @@
+use std::fs;
+use std::path::{PathBuf};
+use std::str::FromStr;
+use anyhow::{bail, Context, Result};
+use clap::{Arg, ArgMatches, Command};
+use sentry::types::DebugId;
+use symbolic::debuginfo::sourcebundle::{SourceFileType};
+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)
+                .value_parser(clap::builder::PathBufValueParser::new())
+                .help("The directory containing source files to bundle."),
+        )
+        .arg(
+            Arg::new("output")
+                .long("output")
+                .value_name("PATH")
+                .required(true)
+                .value_parser(clap::builder::PathBufValueParser::new())
+                .help("The path to the output folder."),
+        )
+        .arg(
+            Arg::new("debug_id")
+                .long("debug-id")
+                .value_name("UUID")
+                .required(true)
+                .value_parser(DebugId::from_str)
+                .help("Debug ID (UUID) 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 = matches.get_one::<PathBuf>("path").unwrap();
+    let output_path = matches.get_one::<PathBuf>("output").unwrap();
+    let debug_id = matches.get_one::<DebugId>("debug_id").unwrap();
+    let out = output_path.join(format!("{debug_id}.zip"));
+
+    if !path.exists() {
+        bail!("Given path does not exist: {}", path.display())
+    }
+
+    if !path.is_dir() {
+        bail!("Given path is not a directory: {}", path.display())
+    }
+
+    if !output_path.exists() {
+        fs::create_dir_all(output_path).context(format!("Failed to create output directory {}", output_path.display()))?;
+    }
+
+    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 tempfile = FileUpload::new(context)
+        .files(&files)
+        .build_jvm_bundle(Some(*debug_id))
+        .context("Unable to create source bundle")?;
+
+    fs::copy(tempfile.path(), &out).context("Unable to write source bundle")?;
+    println!("Created {}", out.display());
+
+    Ok(())
+}

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::Jvm => find_ids_for_sourcebundle(&dirent, &remaining),
                 DifType::Wasm => None,
             })
             .flatten()

src/commands/debug_files/mod.rs

@@ -1,6 +1,7 @@
 use anyhow::Result;
 use clap::{ArgMatches, Command};
 
+pub mod bundle_jvm;
 pub mod bundle_sources;
 pub mod check;
 pub mod find;
@@ -11,6 +12,7 @@ macro_rules! each_subcommand {
     ($mac:ident) => {
         $mac!(bundle_sources);
         $mac!(check);
+        $mac!(bundle_jvm);
         $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)),
+            "jvm" => 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,
+    Jvm,
 }
 
 impl DifType {
@@ -35,6 +36,7 @@ impl DifType {
             DifType::Breakpad => "breakpad",
             DifType::Proguard => "proguard",
             DifType::Wasm => "wasm",
+            DifType::Jvm => "jvm",
         }
     }
 
@@ -49,6 +51,7 @@ impl DifType {
             DifType::Breakpad,
             DifType::Proguard,
             DifType::Wasm,
+            DifType::Jvm,
         ]
     }
 
@@ -63,6 +66,7 @@ impl DifType {
             "breakpad",
             "proguard",
             "wasm",
+            "jvm",
         ]
     }
 }
@@ -87,6 +91,7 @@ impl str::FromStr for DifType {
             "breakpad" => Ok(DifType::Breakpad),
             "proguard" => Ok(DifType::Proguard),
             "wasm" => Ok(DifType::Wasm),
+            "jvm" => Ok(DifType::Jvm),
             _ => 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::Jvm) => 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_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}",
@@ -410,7 +418,9 @@ fn build_artifact_bundle(context: &UploadContext, files: &SourceFiles) -> Result
     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());
+    let debug_id = debug_id.unwrap_or_else(|| build_debug_id(files));
+    bundle.set_attribute("debug_id", debug_id.to_string());
+
     if let Some(note) = context.note {
         bundle.set_attribute("note", note.to_owned());
     }

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

@@ -0,0 +1,26 @@
+```
+$ sentry-cli debug-files bundle-jvm --help
+? success
+Create a source bundle for the given JVM based source files (e.g. Java, Kotlin, ...)
+
+Usage: sentry-cli[EXE] debug-files bundle-jvm [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 (UUID) 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-bundle-jvm-input-dir-empty.trycmd

@@ -0,0 +1,8 @@
+```
+$ sentry-cli debug-files bundle-jvm --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-bundle-jvm-input-is-file.trycmd

@@ -0,0 +1,9 @@
+```
+$ sentry-cli debug-files bundle-jvm --output `cwd` --debug-id 59144E0E-52C4-41F8-9111-0D6F8F14905B tests/integration/_fixtures/jvm/io/sentry/sample/MainActivity.java
+? failed
+error: Given path is not a directory: tests/integration/_fixtures/jvm/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-bundle-jvm-input-not-found.trycmd

@@ -0,0 +1,9 @@
+```
+$ sentry-cli debug-files bundle-jvm --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-bundle-jvm-invalid-uuid.trycmd

@@ -0,0 +1,8 @@
+```
+$ sentry-cli debug-files bundle-jvm --output . --debug-id not-a-valid-uuid io
+? failed
+error: invalid value 'not-a-valid-uuid' for '--debug-id <UUID>': invalid debug identifier
+
+For more information, try '--help'.
+
+```

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

@@ -0,0 +1,12 @@
+```
+$ sentry-cli debug-files bundle-jvm --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
+  caused by: [..]
+
+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-bundle-jvm-output-not-found.trycmd

@@ -0,0 +1,8 @@
+```
+$ sentry-cli debug-files bundle-jvm --output i-do-not-exist --debug-id 0B693ABA-531C-4EB6-99E4-B7320C3C85DA tests/integration/_fixtures/jvm
+? success
+> Found 2 files
+> Bundled 2 files for upload
+Created i-do-not-exist/0b693aba-531c-4eb6-99e4-b7320c3c85da.zip
+
+```

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

@@ -0,0 +1,8 @@
+```
+$ sentry-cli debug-files bundle-jvm --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
+
+```

tests/integration/_cases/debug_files/debug_files-upload-help.trycmd

@@ -17,7 +17,7 @@ Options:
   -t, --type <TYPE>              Only consider debug information files of the given type.  By
                                  default, all types are considered. [possible values: bcsymbolmap,
                                  dsym, elf, pe, pdb, portablepdb, sourcebundle, breakpad, proguard,
-                                 wasm]
+                                 wasm, jvm]
       --no-unwind                Do not scan for stack unwinding information. Specify this flag for
                                  builds with disabled FPO, or when stackwalking occurs on the
                                  device. This usually excludes executables and dynamic libraries.

tests/integration/_cases/upload_dif/upload_dif-help.trycmd

@@ -17,7 +17,7 @@ Options:
   -t, --type <TYPE>              Only consider debug information files of the given type.  By
                                  default, all types are considered. [possible values: bcsymbolmap,
                                  dsym, elf, pe, pdb, portablepdb, sourcebundle, breakpad, proguard,
-                                 wasm]
+                                 wasm, jvm]
       --no-unwind                Do not scan for stack unwinding information. Specify this flag for
                                  builds with disabled FPO, or when stackwalking occurs on the
                                  device. This usually excludes executables and dynamic libraries.

tests/integration/_fixtures/jvm/io/sentry/sample/MainActivity.java

@@ -0,0 +1,4 @@
+package integration._fixtures.jvm.io.sentry.sample;
+
+public class MainActivity {
+}

tests/integration/_fixtures/jvm/io/sentry/sample/SampleActivity.kt

@@ -0,0 +1,4 @@
+package integration._fixtures.jvm.io.sentry.sample
+
+class SampleActivity {
+}