Skip to content

Convert: Returns 1 if conversion failed; 2 if bad args #302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
goneall merged 8 commits into from
Jul 19, 2026
Merged

Convert: Returns 1 if conversion failed; 2 if bad args #302

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
83fabbe
Extract Verify main() logic into testable run() method
bact Jul 16, 2026
cf4b163
Add distinct exit code for Verify CLI usage errors
bact Jul 16, 2026
f2ca04a
Add shared ExitCode class, adopt in Verify
bact Jul 16, 2026
8113cc9
Convert: Returns 1 if conversion failed; 2 if bad args
bact Jul 16, 2026
d133c61
Remove ERROR_STATUS
bact Jul 19, 2026
a955e09
Remove ERROR_STATUS
bact Jul 19, 2026
5b5be00
Update Verify.java
bact Jul 19, 2026
eb4632f
Merge branch 'spdx:master' into exit-code-convert
bact Jul 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 27 additions & 10 deletions src/main/java/org/spdx/tools/SpdxConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,28 +47,44 @@
* arg[4] excludeLicenseDetails If present, listed license and listed exception properties will not be included in the output file
*
* the <code>covert(...)</code> methods can be called programmatically to convert files
* <br/>
* Exit codes:
* <ul>
* <li>0 - the conversion succeeded</li>
* <li>1 - the conversion failed</li>
* <li>2 - the command was invoked incorrectly (missing/invalid arguments)</li>
* </ul>
* @author Gary O'Neall
*/
public class SpdxConverter {
static final Logger logger = LoggerFactory.getLogger(SpdxConverter.class);

static final int ERROR_STATUS = 1;


static final int MIN_ARGS = 2;
static final int MAX_ARGS = 5;

/**
* Main entry point for the SpdxConverter tool.
* Delegates to {@link #run(String[])} and terminates the JVM with its exit status.
* @param args
*/
public static void main(String[] args) {

System.exit(run(args));
}

/**
* Runs the SpdxConverter command logic and reports results to standard
* out/error, without terminating the JVM - allows the logic to be unit tested.
* @param args
* @return process exit status, see {@link ExitCode}
*/
static int run(String[] args) {
SpdxToolsHelper.initialize();
if (args.length < MIN_ARGS) {

System.err
.println("Invalid number of arguments");
usage();
System.exit(ERROR_STATUS);
return ExitCode.USAGE_ERROR;
}
if (args.length > MAX_ARGS) {
System.out.printf("Warning: Extra arguments will be ignored");
Expand All @@ -85,7 +101,7 @@ public static void main(String[] args) {
convert(args[0], args[1]);
} catch (SpdxConverterException e) {
System.err.println("Error converting: "+e.getMessage());
System.exit(ERROR_STATUS);
return ExitCode.ERROR;
}
} else {
SerFileType fromFileType = null;
Expand All @@ -95,7 +111,7 @@ public static void main(String[] args) {
System.err
.println("From file type is not a valid SPDX file type: "+args[2]);
usage();
System.exit(ERROR_STATUS);
return ExitCode.USAGE_ERROR;
}
SerFileType toFileType = null;
try {
Expand All @@ -104,15 +120,16 @@ public static void main(String[] args) {
System.err
.println("To file type is not a valid SPDX file type: "+args[3]);
usage();
System.exit(ERROR_STATUS);
return ExitCode.USAGE_ERROR;
}
try {
convert(args[0], args[1], fromFileType, toFileType, excludeLicenseDetails);
} catch (SpdxConverterException e) {
System.err.println("Error converting: "+e.getMessage());
System.exit(ERROR_STATUS);
return ExitCode.ERROR;
}
}
return ExitCode.SUCCESS;
}

/**
Expand Down
Loading