Merge pull request #26 from dmnyu/release-v0.2.5-alpha

Release v0.2.5 alpha

Author: dmnyu

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: BagIt.NET CI
 
 on:
   push:
-    branches: ["*"]
+    branches: ["release-v*"]
   pull_request:
     branches: [ main ]
 

README.md

@@ -4,7 +4,7 @@
 It allows you to create **BagIt bags**—structured file collections with checksums for reliable storage and transfer of digital content.  
 It currently consists of a core library (`bagit.net`) and a CLI application (`bagit.net.cli`) for Linux, MacOS, and Windows.
 
-[![Release](https://img.shields.io/badge/release-v0.2.3--alpha-blue)](https://github.com/dmnyu/bagit.net/releases/v0.2.3-alpha)
+[![Release](https://img.shields.io/badge/release-v0.2.5--alpha-blue)](https://github.com/dmnyu/bagit.net/releases/v0.2.5-alpha)
 ![BagIt.NET CI](https://github.com/dmnyu/bagit.net/actions/workflows/ci.yml/badge.svg)
 
 > ⚠️ **Note:** This project is in early development. It currently supports the creation and validation of **BagIt-formatted bags**.
@@ -80,8 +80,8 @@ bagit.net help
 
 ### Linux
 ```bash
-wget https://github.com/dmnyu/bagit.net/releases/download/v0.2.4-alpha/bagit.net.cli-v0.2.4-alpha-linux-x64.tgz
-tar xvzf bagit.net.cli-v0.2.4-alpha-linux-x64.tgz
+wget https://github.com/dmnyu/bagit.net/releases/download/v0.2.5-alpha/bagit.net.cli-v0.2.5-alpha-linux-x64.tgz
+tar xvzf bagit.net.cli-v0.2.5-alpha-linux-x64.tgz
 cd bagit.net
 sudo ./install.sh
 bagit.net --help
@@ -95,8 +95,8 @@ On RHEL/CentOS systems with SELinux or `noexec` restrictions on `/tmp`, these bi
 
 ### Windows
 ```powershell
-Invoke-WebRequest -Uri https://github.com/dmnyu/bagit.net/releases/download/v0.2.4-alpha/bagit.net.cli-v0.2.4-alpha-win-x64.zip -OutFile bagit.net.cli-v0.2.4-alpha-win-x64.zip
-Expand-Archive bagit.net.cli-v0.2.4-alpha-win-x64.zip -DestinationPath .
+Invoke-WebRequest -Uri https://github.com/dmnyu/bagit.net/releases/download/v0.2.5-alpha/bagit.net.cli-v0.2.5-alpha-win-x64.zip -OutFile bagit.net.cli-v0.2.5-alpha-win-x64.zip
+Expand-Archive bagit.net.cli-v0.2.5-alpha-win-x64.zip -DestinationPath .
 cd .\bagit.net
 .\bagit.net.exe --help
 .\install.ps1
@@ -108,8 +108,8 @@ cd .\bagit.net
 
 ### MacOS
 ```bash
-wget https://github.com/dmnyu/bagit.net/releases/download/0.2.4-alpha/bagit.net.cli-v0.2.4-alpha-macos-arm64.tgz
-tar xvzf bagit.net.cli-v0.2.4-alpha-macos-arm64.tgz
+wget https://github.com/dmnyu/bagit.net/releases/download/v0.2.5-alpha/bagit.net.cli-v0.2.5-alpha-macos-arm64.tgz
+tar xvzf bagit.net.cli-v0.2.5-alpha-macos-arm64.tgz
 cd bagit.net
 sudo ./install.sh
 bagit.net --help

bagit.net.cli/Commands/BagCommand.cs

@@ -18,6 +18,9 @@ public class Settings : CommandSettings
         [CommandOption("--log")]
         public string? logFile { get; set; }
 
+        [CommandOption("--quiet")]
+        public bool Quiet { get; set; }
+
         [CommandArgument(0, "[directory]")]
         [Description("Path to the directory to bag.")]
         public string? Directory { get; set; }
@@ -30,7 +33,7 @@ public override int Execute(CommandContext context, Settings settings, Cancellat
         {
             var serviceProvider = ServiceConfigurator.BuildServiceProvider<Bagger>(settings.logFile);
             var bagger = serviceProvider.GetRequiredService<Bagger>();
-            bagger.CreateBag(settings.Directory, settings.Algorithm, settings.logFile, cancellationToken);
+            bagger.CreateBag(settings.Directory, settings.Algorithm, settings.Quiet, settings.logFile, cancellationToken);
         }
         catch (Exception ex) {
             AnsiConsole.MarkupLine($"[red][bold]ERROR:[/] {ex.Message}");

bagit.net.cli/Commands/ValidateCommand.cs

@@ -1,5 +1,4 @@
 using bagit.net.cli.lib;
-using bagit.net.domain;
 using Microsoft.Extensions.DependencyInjection;
 using Spectre.Console;
 using Spectre.Console.Cli;
@@ -20,6 +19,9 @@ public class Settings : CommandSettings
             [CommandOption("--complete")]
             public bool Completeness { get; set; }
 
+            [CommandOption("--quiet")]
+            public bool Quiet { get; set; }
+
             [CommandArgument(0, "[directory]")]
             [Description("Path to the bag directory to validate.")]
             public string? Directory { get; set; }
@@ -31,7 +33,7 @@ public override int Execute(CommandContext context, Settings settings, Cancellat
             {
                 var serviceProvider = ServiceConfigurator.BuildServiceProvider<Validator>(settings.logFile);
                 var validator = serviceProvider.GetRequiredService<Validator>();
-                validator.ValidateBag(settings.Directory, settings.Fast, settings.Completeness, settings.logFile, cancellationToken);
+                validator.ValidateBag(settings.Directory, settings.Fast, settings.Completeness, settings.Quiet, settings.logFile, cancellationToken);
             }
             catch (Exception ex) {
                 AnsiConsole.MarkupLine($"[red][bold]ERROR:[/] {ex.Message}");

bagit.net.cli/dist/install scripts/install.sh

@@ -3,7 +3,7 @@
 # Usage: sudo ./install.sh
 
 BINARY_NAME="bagit.net"
-TARGET_DIR="/usr/local/bin"
+TARGET_DIR="$HOME/bin"
 TARGET_PATH="$TARGET_DIR/bagit.net"
 
 # Check if the binary exists in the current directory

bagit.net.cli/lib/Bagger.cs

@@ -9,15 +9,18 @@ public class Bagger
     {
         readonly ICreationService _creationService;
         readonly ILogger _logger;
+        readonly IMessageService _messageService;
 
-        public Bagger(ILogger<Bagger> logger, ICreationService creationService)
+        public Bagger(ILogger<Bagger> logger, ICreationService creationService, IMessageService messageService)
         {
             _logger = logger;
             _creationService = creationService;
+            _messageService = messageService;
         }
 
-        public int CreateBag(string? dirLocation, string? checkSumAlgorithm, string? logFile, CancellationToken cancellationToken)
+        public int CreateBag(string? dirLocation, string? checkSumAlgorithm, bool quiet, string? logFile, CancellationToken cancellationToken)
         {
+            _messageService.Add(new MessageRecord(MessageLevel.INFO, $"using bagit.net v{Bagit.VERSION}"));
             if (string.IsNullOrWhiteSpace(dirLocation))
             {
                 AnsiConsole.MarkupLine("[red][bold]ERROR:[/][/]");
@@ -61,6 +64,8 @@ public int CreateBag(string? dirLocation, string? checkSumAlgorithm, string? log
             }
 
             _creationService.CreateBag(bagPath, algorithm);
+            var messages = _messageService.GetAll();
+            Logging.LogEvents(messages, quiet, _logger);
             return 0;
         }
     }

bagit.net.cli/lib/Logging.cs

@@ -1,5 +1,8 @@
 using Serilog.Events;
 using Serilog.Formatting;
+using bagit.net.domain;
+using Microsoft.Extensions.Logging;
+using Spectre.Console;
 
 namespace bagit.net.cli.lib;
 
@@ -30,4 +33,56 @@ public void Format(LogEvent logEvent, TextWriter output)
     }
 }
 
+public static class Logging
+{
+    public static void LogEvent(MessageRecord messageRecord, ILogger logger)
+    {
+        switch(messageRecord.GetLevel()) {
+            case MessageLevel.INFO: 
+            {
+                logger.LogInformation(messageRecord.GetMessage());
+                break;
+            }
+            case MessageLevel.ERROR:
+            {
+                logger.LogError(messageRecord.GetMessage());
+                break;
+             }
+            case MessageLevel.WARNING:
+            {
+                logger.LogWarning(messageRecord.GetMessage());
+                break;
+            }
+            default: throw new InvalidDataException("Unknown message level");
+        }
+    }
+
+    public static void LogEvents(IEnumerable<MessageRecord> records, bool quiet, ILogger logger) {
+
+        foreach (var messageRecord in records)
+        {
+            switch (messageRecord.GetLevel())
+            {
+                case MessageLevel.INFO:
+                    {
+                        if (!quiet)
+                            logger.LogInformation(messageRecord.GetMessage());
+                        break;
+                    }
+                case MessageLevel.ERROR:
+                    {
+                        logger.LogError(messageRecord.GetMessage());
+                        break;
+                    }
+                case MessageLevel.WARNING:
+                    {
+                        logger.LogWarning(messageRecord.GetMessage());
+                        break;
+                    }
+                default: throw new InvalidDataException("Unknown message level");
+            }
+        }
+    }
+} 
+
 

bagit.net.cli/lib/ServiceConfigurator.cs

@@ -22,7 +22,7 @@ public static ServiceProvider BuildServiceProvider<TWorker>(string? logFile = ""
             }
             else
             {
-                loggerConfig = loggerConfig.WriteTo.File(logFile);
+                loggerConfig = loggerConfig.WriteTo.File(new ShortLevelFormatter(), logFile);
             }
 
             Log.Logger = loggerConfig.CreateLogger();
@@ -35,6 +35,7 @@ public static ServiceProvider BuildServiceProvider<TWorker>(string? logFile = ""
             services.AddSingleton<IFileManagerService, FileManagerService>();
             services.AddSingleton<IValidationService, ValidationService>();
             services.AddSingleton<ICreationService, CreationService>();
+            services.AddSingleton<IMessageService, MessageService>();
             services.AddTransient<TWorker>();
             return services.BuildServiceProvider();
         }

bagit.net.cli/lib/Validator.cs

@@ -9,14 +9,17 @@ public class Validator
     {
         private readonly ILogger _logger;
         private readonly IValidationService _validationService;
-        public Validator(ILogger<Validator> logger, IValidationService validationService)
+        private readonly IMessageService _messageService;
+        public Validator(ILogger<Validator> logger, IValidationService validationService, IMessageService messageService)
         {
             _logger = logger;
             _validationService = validationService;
+            _messageService = messageService;
         }
-        public int ValidateBag(string? bagPath, bool fast, bool complete, string? logFile, CancellationToken cancellationToken)
+
+        public int ValidateBag(string? bagPath, bool fast, bool complete, bool quiet, string? logFile, CancellationToken cancellationToken)
         {
-            _logger.LogInformation($"Using bagit.net v{Bagit.VERSION}");
+            _messageService.Add(new MessageRecord(MessageLevel.INFO, $"using bagit.net v{Bagit.VERSION}"));
 
             if (fast && complete)
             {
@@ -25,7 +28,7 @@ public int ValidateBag(string? bagPath, bool fast, bool complete, string? logFil
                 return 1;
             }
 
-                try
+            try
             {
 
                 if (string.IsNullOrWhiteSpace(bagPath))
@@ -51,23 +54,38 @@ public int ValidateBag(string? bagPath, bool fast, bool complete, string? logFil
                     AnsiConsole.MarkupLine($"Logging to {logFile}");
                 }
 
+                List<MessageRecord> messages;
+
                 if (complete)
                 {
-                    _validationService.ValidateCompleteness(bagPath);
-                    _logger.LogInformation($"{bagPath} is complete according to manifests files");
-                    return 0;
-                }
+                    _validationService.ValidateBagCompleteness(bagPath);
+                    messages = _messageService.GetAll().ToList();
 
-                if (fast)
-                {  
+                    if(MessageHelpers.HasError(messages))
+                    {
+                       messages.Add(new MessageRecord(MessageLevel.ERROR, $"{bagPath} is not complete."));
+                    } else
+                    {
+                        messages.Add(new MessageRecord(MessageLevel.INFO, $"{bagPath} is complete."));
+                    }
+                }
+                else if (fast)
+                {
                     _validationService.ValidateBagFast(bagPath);
-                    _logger.LogInformation($"{bagPath} is valid according to Payload-Oxum");
-                    return 0;
+                    messages = _messageService.GetAll().ToList(); 
                 }
-
-                _validationService.ValidateBag(bagPath);
-                _logger.LogInformation($"{bagPath} is valid");
+                else
+                {
+                    _validationService.ValidateBag(bagPath);
+                    messages = _messageService.GetAll().ToList();
+                    if(!MessageHelpers.HasError(messages))
+                    {
+                       messages.Add(new MessageRecord(MessageLevel.INFO, "bag is valid"));    
+                    }
+                }
+                Logging.LogEvents(messages, quiet, _logger);
                 return 0;
+
             } catch (Exception ex) {
                 _logger.LogCritical(ex, "Failed to validate bag at {Path}", bagPath);
                 AnsiConsole.MarkupLine("[red][bold]ERROR:[/][/]");

bagit.net.tests/TestServiceProviders.cs

@@ -17,6 +17,7 @@ public static ServiceProvider BuildServiceProvider()
             var logger = DefaultLogger.GetDefaultLogger();
             services.AddLogging(builder => builder.AddSerilog(logger, dispose: true));
             services.AddSingleton<IChecksumService, ChecksumService>();
+            services.AddSingleton<IMessageService, MessageService>();
             return services.BuildServiceProvider();
         }
     }
@@ -30,6 +31,7 @@ public static ServiceProvider BuildServiceProvider()
             services.AddLogging(builder => builder.AddSerilog(logger, dispose: true));
             services.AddSingleton<IManifestService, ManifestService>();
             services.AddSingleton<IChecksumService, ChecksumService>();
+            services.AddSingleton<IMessageService, MessageService>();
             return services.BuildServiceProvider();
         }
     }
@@ -43,6 +45,7 @@ public static ServiceProvider BuildServiceProvider()
             services.AddLogging(builder => builder.AddSerilog(logger, dispose: true));
             services.AddSingleton<ITagFileService, TagFileService>();
             services.AddSingleton<IFileManagerService, FileManagerService>();
+            services.AddSingleton<IMessageService, MessageService>();
             return services.BuildServiceProvider();
         }
     }
@@ -55,6 +58,7 @@ public static ServiceProvider BuildServiceProvider()
             var logger = DefaultLogger.GetDefaultLogger();
             services.AddLogging(builder => builder.AddSerilog(logger, dispose: true));
             services.AddSingleton<IFileManagerService, FileManagerService>();
+            services.AddSingleton<IMessageService, MessageService>();
             return services.BuildServiceProvider();
         }
     }
@@ -71,6 +75,7 @@ public static ServiceProvider BuildServiceProvider()
             services.AddSingleton<IFileManagerService, FileManagerService>();
             services.AddSingleton<IManifestService, ManifestService>();
             services.AddSingleton<IChecksumService, ChecksumService>();
+            services.AddSingleton<IMessageService, MessageService>();
             return services.BuildServiceProvider();
         }
     }
@@ -88,6 +93,7 @@ public static ServiceProvider BuildServiceProvider()
             services.AddSingleton<IFileManagerService, FileManagerService>();
             services.AddSingleton<IManifestService, ManifestService>();
             services.AddSingleton<IChecksumService, ChecksumService>();
+            services.AddSingleton<IMessageService, MessageService>();
             return services.BuildServiceProvider();
         }
     }