duplicati/Duplicati/CommandLine/ServerUtil/Program.cs
Marcelo C. d15e398e81 Added machine-readable output for serverutil commands
This comes from suggestion on issue https://github.com/duplicati/duplicati/issues/6056

The chosen argument was --json which produces a json that wraps the result with extended properties such as in example:

``
{
  "Timestamp": "2025-03-28T15:47:01.3368160-03:00",
  "UnixTimestamp": 1743187621,
  "Command": "import",
  "Success": true,
  "ExitCode": 0,
  "Messages": [
    "Importing backup configuration from ../2-firstbacku.json",
    "Connecting to http://127.0.0.1:8200/...",
    "No database found in../data/",
    "Imported \"firstbackup (5)\" with ID 8"
  ],
  "Exceptions": [],
  "Imported": {
    "Id": "8",
    "Name": "firstbackup (5)"
  }
}
``

The documentation will reflect all commands and schemas as this makes its way into Canary
2025-03-28 16:08:45 -03:00

100 lines
No EOL
4 KiB
C#

// Copyright (C) 2025, The Duplicati Team
// https://duplicati.com, hello@duplicati.com
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
using System.CommandLine;
using System.CommandLine.Builder;
using System.CommandLine.Parsing;
using Duplicati.CommandLine.ServerUtil.Commands;
using Duplicati.Library.AutoUpdater;
using Duplicati.Library.Utility;
namespace Duplicati.CommandLine.ServerUtil;
/// <summary>
/// The entry point of the application
/// </summary>
public static class Program
{
/// <summary>
/// Invokes the builder
/// </summary>
/// <param name="args"></param>
/// <returns>The return code</returns>
public static async Task<int> Main(string[] args)
{
PreloadSettingsLoader.ConfigurePreloadSettings(ref args, PackageHelper.NamedExecutable.ServerUtil);
var rootCmd = new RootCommand("Server CLI tool for Duplicati")
{
Pause.Create(),
Resume.Create(),
ListBackups.Create(),
RunBackup.Create(),
Login.Create(),
ChangePassword.Create(),
Logout.Create(),
Import.Create(),
Export.Create(),
Health.Create(),
IssueForeverToken.Create(),
ServerStatus.Create()
};
rootCmd = SettingsBinder.AddGlobalOptions(rootCmd);
return await new CommandLineBuilder(rootCmd)
.UseDefaults()
.UseExceptionHandler((ex, context) =>
{
OutputInterceptorBinder.Instance?.SetResult(false);
if (ex is UserReportedException ure)
{
OutputInterceptorBinder.Instance?.AppendExceptionMessage(ure.Message);
context.ExitCode = 2;
}
else
{
OutputInterceptorBinder.Instance?.AppendExceptionMessage(ex.ToString());
context.ExitCode = 1;
}
if (OutputInterceptorBinder.Instance != null)
{
OutputInterceptorBinder.Instance.ExitCode = context.ExitCode;
Console.WriteLine(OutputInterceptorBinder.Instance.GetSerializedResult());
}
})
.AddMiddleware(async (context, next) =>
{
// Inject settings with custom binder
if (context.ParseResult.CommandResult.Command is { } cmd)
context.BindingContext.AddService(_ => SettingsBinder.GetSettings(context.BindingContext));
context.BindingContext.AddService(_ => OutputInterceptorBinder.GetConsoleInterceptor(context.BindingContext));
await next(context);
Console.WriteLine(OutputInterceptorBinder.Instance?.GetSerializedResult());
})
.UseAdditionalHelpAliases()
.Build().InvokeAsync(args);
}
}