diff --git a/README.md b/README.md
index 489a5da..b06788a 100644
--- a/README.md
+++ b/README.md
@@ -43,4 +43,19 @@ Run executable
```bash
./Chksum
-```
\ No newline at end of file
+```
+
+## Enabling verbose output for troubleshooting
+
+1. Open the file called chksum.cs with your editor of choice.
+2. At the top there will be the logger configuration which you can change. Should look like this.
+```cs
+private ILogger logger = new LoggerConfiguration()
+ .MinimumLevel.Debug()
+ .WriteTo.Console(restrictedToMinimumLevel: LogEventLevel.Error)
+ .WriteTo.File("chksum.log")
+ .CreateLogger();
+```
+3. Change the minimum level of the logger to Verbose.
+4. Compile the program
+5. Profit. Now you will be able to see how what the program is doing in detail.
\ No newline at end of file
diff --git a/src/Chksum/Chksum.csproj b/src/Chksum/Chksum.csproj
index fc84e00..c583bd8 100644
--- a/src/Chksum/Chksum.csproj
+++ b/src/Chksum/Chksum.csproj
@@ -18,6 +18,9 @@
+
+
+
diff --git a/src/Chksum/chksum.cs b/src/Chksum/chksum.cs
index 40a0694..928e160 100644
--- a/src/Chksum/chksum.cs
+++ b/src/Chksum/chksum.cs
@@ -2,11 +2,20 @@ using System.Collections.Concurrent;
using System.Reflection;
using System.Security.Cryptography;
using Microsoft.Data.Sqlite;
+using Serilog;
+using Serilog.Events;
+
namespace Chksum.Utils;
public class ChksumUtils {
+ private ILogger logger = new LoggerConfiguration()
+ .MinimumLevel.Debug()
+ .WriteTo.Console(restrictedToMinimumLevel: LogEventLevel.Error)
+ .WriteTo.File("chksum.log")
+ .CreateLogger();
private int getTotalFileCount() {
int totalFileCount = Directory.GetFiles(Directory.GetCurrentDirectory(), "*", SearchOption.AllDirectories).Length;
+ logger.Debug("Total file count is {totalFileCount}", totalFileCount);
return totalFileCount - 3; // Remove the program, datbase and library from the totalFileCount
}
@@ -14,12 +23,14 @@ public class ChksumUtils {
string[] indexedFiles = Directory.GetFiles(Directory.GetCurrentDirectory(), "*", SearchOption.AllDirectories);
string[] filesToExclude = { "Chksum", "chksum.db", "libe_sqlite3.so" };
indexedFiles = indexedFiles.Where(file => !filesToExclude.Contains(Path.GetFileName(file))).ToArray();
+ logger.Information("All files were indexed");
return indexedFiles;
}
public string DatabaseRoot { get; set; } = string.Empty;
public void getBaseDir() {
DatabaseRoot = AppDomain.CurrentDomain.BaseDirectory;
+ logger.Debug("DatabaseRoot is {DatabaseRoot}", DatabaseRoot);
}
public string libraryPath { get; set; } = string.Empty;
@@ -31,7 +42,9 @@ public class ChksumUtils {
byte[] buffer = new byte[resourceStream.Length];
resourceStream.Read(buffer, 0, buffer.Length);
File.WriteAllBytes(libraryPath, buffer);
+ logger.Debug("libe_sqlite3.so was successfully created");
} else {
+ logger.Error("libe_sqlite3.so could not be loaded");
throw new Exception(libraryPath + " could not be loaded");
}
}
@@ -39,6 +52,7 @@ public class ChksumUtils {
public void initializeDB() {
if (File.Exists("chksum.db")) {
+ logger.Information("A database already exits");
return;
}
@@ -57,6 +71,7 @@ public class ChksumUtils {
);
";
command.ExecuteNonQuery();
+ logger.Information("Database was successfully created");
}
}
@@ -68,6 +83,7 @@ public class ChksumUtils {
vacuum;
";
command.ExecuteNonQuery();
+ logger.Debug("Database was successfully vacuumed");
}
}
@@ -87,12 +103,14 @@ public class ChksumUtils {
}
});
+ logger.Debug("All files were checksummed");
return new Dictionary(checksums);
}
public void doTheThing() {
using (var connection = new SqliteConnection("Data Source=" + DatabaseRoot + "chksum.db;Mode=ReadWrite")) {
if (getTotalFileCount() < 1) {
+ logger.Information("There were no files to checksum");
return;
}
connection.Open();
@@ -115,8 +133,10 @@ public class ChksumUtils {
command.Parameters.AddWithValue("$filename", fileName);
command.Parameters.AddWithValue("$pathtofile", pathToFile);
command.ExecuteNonQuery();
+ logger.Verbose("{fileName} which is located at {pathToFile} relative to the database with the hash {fileHash} was successfully inserted into the database", fileName, pathToFile, fileHash);
}
}
+ logger.Information("All files were successfully written to the database");
}
}
@@ -141,9 +161,11 @@ public class ChksumUtils {
pathtofile = reader.GetString(1);
}
}
+ logger.Verbose("{pathToFile} with the hash {fileHash} was successfully loaded", pathToFile, fileHash);
}
if (fileHash == filehash) {
+ logger.Verbose("File with filehash {filehash} already exists in the database", filehash);
doesExist = true;
}
return doesExist;
@@ -186,6 +208,7 @@ public class ChksumUtils {
Console.WriteLine($"\tto \t{pathtofile}\n");
wasMoved = true;
}
+ logger.Verbose("{fileName} which is located at {pathToFile} relative to the database with the hash {fileHash} was successfully checked", fileName, pathToFile, fileHash);
}
return wasMoved;
}
@@ -207,6 +230,7 @@ public class ChksumUtils {
pathToFile = reader.GetString(0);
if (File.Exists(pathToFile)) {
+ logger.Verbose("{pathToFile} exists", pathToFile);
continue;
}
var deleteCommand = connection.CreateCommand();
@@ -220,14 +244,16 @@ public class ChksumUtils {
Console.WriteLine("File deleted:");
Console.WriteLine($"\t{pathToFile}\n");
+ logger.Verbose("File deleted: {pathToFile}", pathToFile);
}
}
+ logger.Information("All deleted files were successfully removed from the database");
}
}
private List getFilehashesFromDatabase(string connectionString) {
List filehashesFromDatabase = new List();
-
+
using (var connection = new SqliteConnection(connectionString)) {
string filehash = string.Empty;
@@ -247,10 +273,16 @@ public class ChksumUtils {
}
}
+ logger.Debug("All filehashes were successfully retrived from the database");
return filehashesFromDatabase;
}
public void compareDatabases(string filePathToOtherDatabase) {
+ if (!File.Exists(filePathToOtherDatabase)) {
+ logger.Error("No database could be found at {filePathToOtherDatabase}", filePathToOtherDatabase);
+ throw new Exception("No database could be found at " + filePathToOtherDatabase);
+ }
+
List filesThatDoNotExistsInTheRemote = getFilehashesFromDatabase("Data Source=" + DatabaseRoot + "chksum.db;Mode=ReadOnly").Except(getFilehashesFromDatabase("Data Source=" + filePathToOtherDatabase + ";Mode=ReadOnly")).ToList();
foreach (string file in filesThatDoNotExistsInTheRemote) {
@@ -272,13 +304,16 @@ public class ChksumUtils {
Console.WriteLine("File not found in remote:");
Console.WriteLine($"\t{filename}\n");
+ logger.Verbose("{filename} could not be found in the remote database", filename);
}
}
}
}
+ logger.Information("Compared both databases successfully");
}
public void cleanup() {
File.Delete(libraryPath);
+ logger.Debug("Successfully deleted libe_sqlite3.so");
}
}
\ No newline at end of file
diff --git a/src/Chksum/debugchksum.cs b/src/Chksum/debugchksum.cs
deleted file mode 100644
index e69de29..0000000