Introduced Error response codes when conversion fails.

Author: paulius-petkus

ConvertApi.Cli.Tests/CliTests.cs

@@ -5,7 +5,7 @@ namespace ConvertApi.Cli.Tests;
 [TestFixture]
 public class CliTests
 {
-    private const string ApiToken = "token_6yNouyuY"; // Provide your API token
+    private const string ApiToken = "api_token"; // Provide your API token
     private static readonly string TestOutputDir = Path.Combine(Directory.GetCurrentDirectory(), "test_output");
 
     [SetUp]
@@ -50,7 +50,7 @@ public void TestCompareDocx()
         var inputFile2 = Path.Combine(Directory.GetCurrentDirectory(), "../../../../", "test_files", "demo-changed.docx");
         var process = RunCli($"{ApiToken} {outputFile} {inputFile1} docx compare CompareFile={inputFile2} storeFile=true");
 
-        Assert.AreEqual(0, process.ExitCode, "CLI did not exit cleanly.");
+        Assert.AreEqual(1, process.ExitCode, "StoreFile parameter is not allowed");
         Assert.IsTrue(!File.Exists(outputFile), "Output file should not be not created.");
     }
 
@@ -100,12 +100,9 @@ private Process RunCli(string arguments)
         if (!process.WaitForExit(20000))
         {
             process.Kill();
-            throw new TimeoutException("The CLI process did not exit within 2 minutes.");
+            throw new TimeoutException("The CLI process did not exit within 20 s.");
         }
 
-        if (process.ExitCode != 0)
-            throw new Exception($"CLI process exited with code {process.ExitCode}");
-        
         return process;
     }
 

ConvertApi.Cli.Tests/DirectCallTests.cs

@@ -3,7 +3,7 @@ namespace ConvertApi.Cli.Tests;
 [TestFixture]
 public class DirectCallTests
 {
-    private const string ApiToken = "token_6yNouyuY"; // Provide your API token
+    private const string ApiToken = "api_token"; // Provide your API token
     private static readonly string TestOutputDir = Path.Combine(Directory.GetCurrentDirectory(), "test_output");
 
     [SetUp]
@@ -121,29 +121,6 @@ public async Task TestPdfToExtractImages()
         var outputFiles = Directory.GetFiles(TestOutputDir);
         Assert.That(outputFiles, Has.Length.EqualTo(1), "Output file was not created.");
     }
-    
-    [Test]
-    public async Task TestPdfToExtractImagesError()
-    {
-        var inputFile = Path.Combine(Directory.GetCurrentDirectory(), "../../../../", "test_files", "22pages.pdf");
-    
-        await Program.Main([ApiToken, TestOutputDir, inputFile, "pdf", "extract-images"]);
-        
-        var outputFiles = Directory.GetFiles(TestOutputDir);
-        Assert.That(outputFiles, Has.Length.EqualTo(0), "There should not be any converted files.");
-    }
-    
-    [Test]
-    public async Task TestPdfToDocxWithMixedUpInputs()
-    {
-        var inputFile = Path.Combine(Directory.GetCurrentDirectory(), "../../../../", "test_files", "simple.pdf");
-    
-        // pdf and docx are mixed on purpose!
-        await Program.Main([ApiToken, TestOutputDir, inputFile, "docx", "pdf"]);
-        
-        var outputFiles = Directory.GetFiles(TestOutputDir);
-        Assert.That(outputFiles, Has.Length.EqualTo(0), "There should not be any converted files.");
-    }
 
     [Test]
     public async Task TestWebToPdf()

ConvertApi.Cli/Program.cs

@@ -51,6 +51,7 @@ public static async Task Main(string[] args)
         if (dynamicProperties.Any(x => x.Key.ToLower() == "storefile" && x.Value.ToLower() == "true"))
         {
             Console.WriteLine("Error: StoreFile parameter is not allowed in cli tool. Please use our API directly if you need this parameter.");
+            Environment.Exit(1);
             return;
         }
 
@@ -69,6 +70,7 @@ private static void ValidateInputFiles(string[] inputFiles, string fromFormat)
         if (inputFiles.Length == 0)
         {
             Console.WriteLine("Error: At least one input file is required.");
+            Environment.Exit(1);
             return;
         }
 
@@ -77,6 +79,7 @@ private static void ValidateInputFiles(string[] inputFiles, string fromFormat)
             if (!File.Exists(file))
             {
                 Console.WriteLine($"Error: Input file not found: {file}");
+                Environment.Exit(1);
                 return;
             }
         }
@@ -107,6 +110,11 @@ static void DisplayHelp()
         Console.WriteLine("Dynamic Properties:");
         Console.WriteLine("  Specify additional parameters using key=value pairs, such as UserPassword, OwnerPassword, or WatermarkText, depending on the API being used.");
         Console.WriteLine();
+        Console.WriteLine("Exit Codes:");
+        Console.WriteLine("  0 - Success");
+        Console.WriteLine("  1 - Error in arguments/parameters validation");
+        Console.WriteLine("  2 - API response error");
+        Console.WriteLine();
         Console.WriteLine("For more information, visit: https://www.convertapi.com/");
     }
 
@@ -184,6 +192,7 @@ static async Task ConvertFiles(string apiToken, string fromFormat, string toForm
             {
                 var errorContent = await response.Content.ReadAsStringAsync();
                 Console.WriteLine($"Error: {response.StatusCode}. Response message: {errorContent}");
+                Environment.Exit(2);
             }
         }
     }

README.md

@@ -129,6 +129,16 @@ Add watermark-overlay to a PDF:
 convertapi-cli.exe YOUR_API_TOKEN output_directory input.pdf pdf watermark-overlay OverlayFile=overlay-file.pdf FileName=watermarkResult
 ```
 
+## Exit Codes
+
+The ConvertAPI CLI uses exit codes to indicate the outcome of a command execution:
+
+- **0** - Success: The command completed without errors.
+- **1** - Argument/Parameter Validation Error: This occurs when there are issues with the arguments, such as insufficient parameters or invalid file paths.
+- **2** - API Response Error: This occurs when the API call fails.
+
+Use these exit codes to programmatically detect failures and handle them appropriately in scripts or integrations.
+
 
 ### Issues & Comments
 Please leave all comments, bugs, requests, and issues on the Issues page. We'll respond to your request ASAP!