feat(proguard): upload-proguard → proguard upload (#3174)

Move the `sentry-cli upload-proguard` command to `sentry-cli proguard upload`.

This new API matches the API for the `debug-files upload` and `sourcemap upload` commands. This API will also enable us to add new subcommands, which will be useful for #3173.

`sentry-cli upload-proguard` is retained as an alias to `sentry-cli proguard upload`, and we intend to keep it around for the foreseeable future, so no one needs to migrate.

Author: szokeasaurusrex

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Improvements
+
+- Moved `sentry-cli upload-proguard` to `sentry-cli proguard upload`, aligning the API with similar upload commands like `debug-files upload` and `sourcemaps upload` ([#3174](https://github.com/getsentry/sentry-cli/pull/3174)). `sentry-cli upload-proguard` remains supported as an alias, so no migration is required.
+
 ## 3.2.3
 
 ### Experimental Feature 🧑‍🔬 (internal-only)

src/commands/mod.rs

@@ -32,6 +32,7 @@ mod login;
 mod logs;
 mod monitors;
 mod organizations;
+mod proguard;
 mod projects;
 mod react_native;
 mod releases;
@@ -60,6 +61,7 @@ macro_rules! each_subcommand {
         $mac!(logs);
         $mac!(monitors);
         $mac!(organizations);
+        $mac!(proguard);
         $mac!(projects);
         $mac!(react_native);
         $mac!(releases);

src/commands/proguard/mod.rs

@@ -0,0 +1,43 @@
+use anyhow::Result;
+use clap::{ArgMatches, Command};
+
+pub mod upload;
+
+macro_rules! each_subcommand {
+    ($mac:ident) => {
+        $mac!(upload);
+    };
+}
+
+pub fn make_command(mut command: Command) -> Command {
+    macro_rules! add_subcommand {
+        ($name:ident) => {{
+            command = command.subcommand(crate::commands::proguard::$name::make_command(
+                Command::new(stringify!($name).replace('_', "-")),
+            ));
+        }};
+    }
+
+    command = command
+        .about("Manage ProGuard mapping files.")
+        .subcommand_required(true)
+        .arg_required_else_help(true);
+
+    each_subcommand!(add_subcommand);
+    command
+}
+
+pub fn execute(matches: &ArgMatches) -> Result<()> {
+    macro_rules! execute_subcommand {
+        ($name:ident) => {{
+            if let Some(sub_matches) =
+                matches.subcommand_matches(&stringify!($name).replace('_', "-"))
+            {
+                return crate::commands::proguard::$name::execute(&sub_matches);
+            }
+        }};
+    }
+
+    each_subcommand!(execute_subcommand);
+    unreachable!();
+}

src/commands/upload_proguard.rs src/commands/proguard/upload.rssrc/commands/upload_proguard.rs renamed to src/commands/proguard/upload.rs

@@ -0,0 +1,11 @@
+use anyhow::Result;
+use clap::{ArgMatches, Command};
+
+pub fn make_command(command: Command) -> Command {
+    // Retained as a top-level command for backward compatibility.
+    crate::commands::proguard::upload::make_command(command)
+}
+
+pub fn execute(matches: &ArgMatches) -> Result<()> {
+    crate::commands::proguard::upload::execute(matches)
+}

src/commands/upload_proguard/mod.rs

@@ -21,6 +21,7 @@ Commands:
   logs             [BETA] Manage logs in Sentry
   monitors         Manage cron monitors on Sentry.
   organizations    Manage organizations on Sentry.
+  proguard         Manage ProGuard mapping files.
   projects         Manage projects on Sentry.
   react-native     Upload build artifacts for react-native projects.
   releases         Manage releases on Sentry.

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

@@ -21,6 +21,7 @@ Commands:
   logs             [BETA] Manage logs in Sentry
   monitors         Manage cron monitors on Sentry.
   organizations    Manage organizations on Sentry.
+  proguard         Manage ProGuard mapping files.
   projects         Manage projects on Sentry.
   react-native     Upload build artifacts for react-native projects.
   releases         Manage releases on Sentry.

tests/integration/_cases/help/help.trycmd

@@ -0,0 +1,23 @@
+```
+$ sentry-cli proguard --help
+? success
+Manage ProGuard mapping files.
+
+Usage: sentry-cli[EXE] proguard [OPTIONS] <COMMAND>
+
+Commands:
+  upload  Upload ProGuard mapping files to a project.
+  help    Print this message or the help of the given subcommand(s)
+
+Options:
+      --header <KEY:VALUE>       Custom headers that should be attached to all requests
+                                 in key:value format.
+      --auth-token <AUTH_TOKEN>  Use the given Sentry auth token.
+      --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/proguard/proguard-help.trycmd

@@ -0,0 +1,37 @@
+```
+$ sentry-cli proguard upload --help
+? success
+Upload ProGuard mapping files to a project.
+
+Usage: sentry-cli[EXE] proguard upload [OPTIONS] [PATH]...
+
+Arguments:
+  [PATH]...  The path to the mapping files.
+
+Options:
+  -o, --org <ORG>                The organization ID or slug.
+      --header <KEY:VALUE>       Custom headers that should be attached to all requests
+                                 in key:value format.
+  -p, --project <PROJECT>        The project ID or slug.
+      --auth-token <AUTH_TOKEN>  Use the given Sentry auth token.
+      --no-upload                Disable the actual upload.
+                                 This runs all steps for the processing but does not trigger the
+                                 upload.  This is useful if you just want to verify the mapping
+                                 files and write the proguard UUIDs into a properties file.
+      --log-level <LOG_LEVEL>    Set the log output verbosity. [possible values: trace, debug, info,
+                                 warn, error]
+      --write-properties <PATH>  Write the UUIDs for the processed mapping files into the given
+                                 properties file.
+      --quiet                    Do not print any output while preserving correct exit code. This
+                                 flag is currently implemented only for selected subcommands.
+                                 [aliases: --silent]
+      --require-one              Requires at least one file to upload or the command will error.
+  -u, --uuid <UUID>              Explicitly override the UUID of the mapping file with another one.
+                                 This should be used with caution as it means that you can upload
+                                 multiple mapping files if you don't take care.  This however can be
+                                 useful if you have a build process in which you need to know the
+                                 UUID of the proguard file before it was created.  If you upload a
+                                 file with a forced UUID you can only upload a single proguard file.
+  -h, --help                     Print help
+
+```

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

@@ -0,0 +1,7 @@
+```
+$ sentry-cli proguard upload tests/integration/_fixtures/proguard.txt --no-upload
+? success
+warning: ignoring proguard mapping 'tests/integration/_fixtures/proguard.txt': Proguard mapping does not contain line information
+> skipping upload.
+
+```