Linux support in ci (#15)

* extended output on failed verapdf execution

* fixed error message creation code

* fixed linux testsetup

* nonfunctional changes

* dropped things that didnt do anything

* dropped unused variable

* Added notes about dependencies

* Moved forward to async implementation,
Fixed some compile warnings

* Updated ubuntu 20.04 cook book

* Major version increased

.editorconfig

@@ -0,0 +1,198 @@
+# Remove the line below if you want to inherit .editorconfig settings from higher directories
+root = true
+
+# C# files
+[*.cs]
+
+#### Core EditorConfig Options ####
+
+# Indentation and spacing
+indent_size = 4
+indent_style = space
+tab_width = 4
+
+# New line preferences
+end_of_line = crlf
+insert_final_newline = false
+
+#### .NET Coding Conventions ####
+
+# Organize usings
+dotnet_separate_import_directive_groups = false
+dotnet_sort_system_directives_first = false
+
+# this. and Me. preferences
+dotnet_style_qualification_for_event = false:silent
+dotnet_style_qualification_for_field = false:silent
+dotnet_style_qualification_for_method = false:silent
+dotnet_style_qualification_for_property = false:silent
+
+# Language keywords vs BCL types preferences
+dotnet_style_predefined_type_for_locals_parameters_members = true:silent
+dotnet_style_predefined_type_for_member_access = true:silent
+
+# Parentheses preferences
+dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
+dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
+
+# Modifier preferences
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
+
+# Expression-level preferences
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_prefer_auto_properties = true:silent
+dotnet_style_prefer_compound_assignment = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+dotnet_style_prefer_conditional_expression_over_return = true:silent
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+dotnet_style_prefer_simplified_interpolation = true:suggestion
+
+# Field preferences
+dotnet_style_readonly_field = true:suggestion
+
+# Parameter preferences
+dotnet_code_quality_unused_parameters = all:suggestion
+
+#### C# Coding Conventions ####
+
+# var preferences
+csharp_style_var_elsewhere = true:silent
+csharp_style_var_for_built_in_types = true:silent
+csharp_style_var_when_type_is_apparent = true:silent
+
+# Expression-bodied members
+csharp_style_expression_bodied_accessors = true:silent
+csharp_style_expression_bodied_constructors = false:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_lambdas = true:silent
+csharp_style_expression_bodied_local_functions = false:silent
+csharp_style_expression_bodied_methods = false:silent
+csharp_style_expression_bodied_operators = false:silent
+csharp_style_expression_bodied_properties = true:silent
+
+# Pattern matching preferences
+csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
+csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
+csharp_style_prefer_switch_expression = true:suggestion
+
+# Null-checking preferences
+csharp_style_conditional_delegate_call = true:suggestion
+
+# Modifier preferences
+csharp_prefer_static_local_function = true:suggestion
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:silent
+
+# Code-block preferences
+csharp_prefer_braces = true:silent
+csharp_prefer_simple_using_statement = true:suggestion
+
+# Expression-level preferences
+csharp_prefer_simple_default_expression = true:suggestion
+csharp_style_deconstructed_variable_declaration = true:suggestion
+csharp_style_inlined_variable_declaration = true:suggestion
+csharp_style_pattern_local_over_anonymous_function = true:suggestion
+csharp_style_prefer_index_operator = true:suggestion
+csharp_style_prefer_range_operator = true:suggestion
+csharp_style_throw_expression = true:suggestion
+csharp_style_unused_value_assignment_preference = discard_variable:suggestion
+csharp_style_unused_value_expression_statement_preference = discard_variable:silent
+
+# 'using' directive preferences
+csharp_using_directive_placement = outside_namespace:silent
+
+#### C# Formatting Rules ####
+
+# New line preferences
+csharp_new_line_before_catch = true
+csharp_new_line_before_else = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_open_brace = all
+csharp_new_line_between_query_expression_clauses = true
+
+# Indentation preferences
+csharp_indent_block_contents = true
+csharp_indent_braces = false
+csharp_indent_case_contents = true
+csharp_indent_case_contents_when_block = true
+csharp_indent_labels = one_less_than_current
+csharp_indent_switch_labels = true
+
+# Space preferences
+csharp_space_after_cast = false
+csharp_space_after_colon_in_inheritance_clause = true
+csharp_space_after_comma = true
+csharp_space_after_dot = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_after_semicolon_in_for_statement = true
+csharp_space_around_binary_operators = before_and_after
+csharp_space_around_declaration_statements = false
+csharp_space_before_colon_in_inheritance_clause = true
+csharp_space_before_comma = false
+csharp_space_before_dot = false
+csharp_space_before_open_square_brackets = false
+csharp_space_before_semicolon_in_for_statement = false
+csharp_space_between_empty_square_brackets = false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+csharp_space_between_method_declaration_name_and_open_parenthesis = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_parentheses = false
+csharp_space_between_square_brackets = false
+
+# Wrapping preferences
+csharp_preserve_single_line_blocks = true
+csharp_preserve_single_line_statements = true
+
+#### Naming styles ####
+
+# Naming rules
+
+dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
+dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
+dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
+
+dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.types_should_be_pascal_case.symbols = types
+dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
+dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
+
+# Symbol specifications
+
+dotnet_naming_symbols.interface.applicable_kinds = interface
+dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.interface.required_modifiers = 
+
+dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
+dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.types.required_modifiers = 
+
+dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
+dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.non_field_members.required_modifiers = 
+
+# Naming styles
+
+dotnet_naming_style.pascal_case.required_prefix = 
+dotnet_naming_style.pascal_case.required_suffix = 
+dotnet_naming_style.pascal_case.word_separator = 
+dotnet_naming_style.pascal_case.capitalization = pascal_case
+
+dotnet_naming_style.begins_with_i.required_prefix = I
+dotnet_naming_style.begins_with_i.required_suffix = 
+dotnet_naming_style.begins_with_i.word_separator = 
+dotnet_naming_style.begins_with_i.capitalization = pascal_case

PdfAValidator.sln

@@ -11,12 +11,13 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PdfAValidatorWebApi", "PdfA
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{49D9D2CB-EF79-4962-B4C3-2F1BAFD9DCC8}"
 	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
 		appveyor.yml = appveyor.yml
 		LICENSE = LICENSE
 		README.md = README.md
 	EndProjectSection
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PdfAValidatorWebApiTest", "PdfAValidatorWebApiTest\PdfAValidatorWebApiTest.csproj", "{92E8D03D-F39B-46BD-98BF-1F2BB0AE21BA}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PdfAValidatorWebApiTest", "PdfAValidatorWebApiTest\PdfAValidatorWebApiTest.csproj", "{92E8D03D-F39B-46BD-98BF-1F2BB0AE21BA}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

PdfAValidator/IPdfAValidator.cs

@@ -0,0 +1,25 @@
+using System;
+using System.Threading.Tasks;
+
+namespace Codeuctivity
+{
+    /// <summary>
+    /// PdfAValidator is a VeraPdf wrapper
+    /// </summary>
+    public interface IPdfAValidator : IDisposable
+    {
+        /// <summary>
+        /// Validates a pdf to be compliant with the pdfa standard claimed by its meta data
+        /// </summary>
+        /// <param name="pathToPdfFile"></param>
+        /// <returns>True for compliant PdfA Files</returns>
+        Task<bool> ValidateAsync(string pathToPdfFile);
+
+        /// <summary>
+        /// Validates a pdf and returns a detailed compliance report
+        /// </summary>
+        /// <param name="pathToPdfFile"></param>
+        /// <returns></returns>
+        Task<Report> ValidateWithDetailedReportAsync(string pathToPdfFile);
+    }
+}

PdfAValidator/PdfAValidator.cs

@@ -1,26 +1,28 @@
-using System;
+using Codeuctivity.Properties;
+using System;
 using System.Diagnostics;
 using System.IO;
 using System.IO.Compression;
 using System.Reflection;
 using System.Runtime.InteropServices;
+using System.Threading;
 using System.Threading.Tasks;
 using System.Xml;
 using System.Xml.Serialization;
 
-namespace PdfAValidator
+namespace Codeuctivity
 {
     /// <summary>
     /// PdfAValidator is a VeraPdf wrapper
     /// </summary>
-    public class PdfAValidator : IDisposable
+
+    public class PdfAValidator : IPdfAValidator
     {
         private const string maskedQuote = "\"";
         private const int maxLengthTempdirectoryThatVeraPdfFitsIn = 206;
-        private const string OsNotSupportedMessage = "Sorry, only supporting linux and windows.";
-        private readonly object lockObject = new object();
         private string? pathVeraPdfDirectory;
         private bool disposed;
+        private static readonly SemaphoreSlim semaphore = new SemaphoreSlim(1, 1);
 
         /// <summary>
         /// Path to java jre used by windows
@@ -57,12 +59,9 @@ protected virtual void Dispose(bool disposing)
                 return;
             }
 
-            if (disposing)
+            if (disposing && !customVerapdfAndJavaLocations && Directory.Exists(pathVeraPdfDirectory))
             {
-                if (!customVerapdfAndJavaLocations && Directory.Exists(pathVeraPdfDirectory))
-                {
-                    Directory.Delete(pathVeraPdfDirectory, true);
-                }
+                Directory.Delete(pathVeraPdfDirectory, true);
             }
             disposed = true;
         }
@@ -84,26 +83,27 @@ public PdfAValidator(string pathToVeraPdfBin, string pathToJava)
         /// Use this constructor to use the embedded veraPdf binaries
         /// </summary>
         public PdfAValidator()
-        { }
+        {
+        }
 
         /// <summary>
         /// Validates a pdf to be compliant with the pdfa standard claimed by its meta data
         /// </summary>
         /// <param name="pathToPdfFile"></param>
         /// <returns>True for compliant PdfA Files</returns>
-        public bool Validate(string pathToPdfFile)
+        public async Task<bool> ValidateAsync(string pathToPdfFile)
         {
-            return ValidateWithDetailedReport(pathToPdfFile).BatchSummary.ValidationReports.Compliant == "1";
+            return (await ValidateWithDetailedReportAsync(pathToPdfFile).ConfigureAwait(false)).BatchSummary.ValidationReports.Compliant == "1";
         }
 
         /// <summary>
         /// Validates a pdf and returns a detailed compliance report
         /// </summary>
         /// <param name="pathToPdfFile"></param>
         /// <returns></returns>
-        public Report ValidateWithDetailedReport(string pathToPdfFile)
+        public async Task<Report> ValidateWithDetailedReportAsync(string pathToPdfFile)
         {
-            IntiPathToVeraPdfBinAndJava();
+            await IntiPathToVeraPdfBinAndJava().ConfigureAwait(false);
             var absolutePathToPdfFile = Path.GetFullPath(pathToPdfFile);
 
             if (!File.Exists(absolutePathToPdfFile))
@@ -172,9 +172,10 @@ private static T DeserializeXml<T>(string sourceXML) where T : class
             return (T)serializer.Deserialize(xmlReader);
         }
 
-        private void IntiPathToVeraPdfBinAndJava()
+        private async Task IntiPathToVeraPdfBinAndJava()
         {
-            lock (lockObject)
+            await semaphore.WaitAsync().ConfigureAwait(false);
+            try
             {
                 if (IsInitialized)
                 {
@@ -191,24 +192,28 @@ private void IntiPathToVeraPdfBinAndJava()
 
                 if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
                 {
-                    ExtractBinaryFromManifest("PdfAValidator.VeraPdf.Windows.zip");
+                    await ExtractBinaryFromManifest("Codeuctivity.VeraPdf.Windows.zip").ConfigureAwait(false);
                     VeraPdfStartScript = Path.Combine(pathVeraPdfDirectory, "verapdf", "verapdf.bat");
                     // took from https://adoptopenjdk.net/releases.html?variant=openjdk8&jvmVariant=hotspot#x64_win
                     PathJava = Path.Combine(pathVeraPdfDirectory, "verapdf", "jdk8u202-b08-jre", "bin", "java");
                 }
                 else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
                 {
-                    ExtractBinaryFromManifest("PdfAValidator.VeraPdf.Linux.zip");
+                    await ExtractBinaryFromManifest("Codeuctivity.VeraPdf.Linux.zip").ConfigureAwait(false);
                     VeraPdfStartScript = Path.Combine(pathVeraPdfDirectory, "verapdf", "verapdf");
                     SetLinuxFileExecuteable(VeraPdfStartScript);
                 }
                 else
                 {
-                    throw new NotImplementedException(OsNotSupportedMessage);
+                    throw new NotImplementedException(Resources.OsNotSupportedMessage);
                 }
 
                 IsInitialized = true;
             }
+            finally
+            {
+                semaphore.Release();
+            }
         }
 
         private static void SetLinuxFileExecuteable(string filePath)
@@ -232,15 +237,15 @@ private static void SetLinuxFileExecuteable(string filePath)
             process.WaitForExit();
         }
 
-        private void ExtractBinaryFromManifest(string resourceName)
+        private async Task ExtractBinaryFromManifest(string resourceName)
         {
             var pathZipVeraPdf = Path.Combine(pathVeraPdfDirectory, "VeraPdf.zip");
             var assembly = Assembly.GetExecutingAssembly();
             using (var stream = assembly.GetManifestResourceStream(resourceName))
             using (var fileStream = File.Create(pathZipVeraPdf))
             {
                 stream.Seek(0, SeekOrigin.Begin);
-                stream.CopyTo(fileStream);
+                await stream.CopyToAsync(fileStream).ConfigureAwait(false);
             }
 
             ZipFile.ExtractToDirectory(pathZipVeraPdf, pathVeraPdfDirectory);