Added option to use custom connectors (#63)

* Added CustomOutProcReqnrollConnector

* Updated CHANGELOG

Author: gasparnagy

.editorconfig

@@ -0,0 +1,97 @@
+
+[*.proto]
+indent_style=tab
+indent_size=tab
+tab_width=4
+
+[*.{asax,ascx,aspx,cs,cshtml,css,htm,html,js,json,jsx,master,razor,resjson,skin,ts,tsx,vb,xaml,xamlx,xoml}]
+indent_style=space
+indent_size=4
+tab_width=4
+
+[*.{appxmanifest,build,config,csproj,dbml,discomap,dtd,jsproj,lsproj,njsproj,nuspec,proj,props,resw,resx,StyleCop,targets,tasks,vbproj,xml,xsd,json}]
+indent_style=space
+indent_size=2
+tab_width=2
+
+[*]
+
+# Microsoft .NET properties
+csharp_new_line_before_members_in_object_initializers=false
+csharp_preferred_modifier_order=public, private, protected, internal, new, abstract, virtual, sealed, override, static, readonly, extern, unsafe, volatile, async:suggestion
+csharp_space_after_cast=false
+csharp_style_var_elsewhere=true:hint
+csharp_style_var_for_built_in_types=true:hint
+csharp_style_var_when_type_is_apparent=true:hint
+dotnet_style_predefined_type_for_locals_parameters_members=true:hint
+dotnet_style_predefined_type_for_member_access=true:hint
+dotnet_style_qualification_for_event=false:warning
+dotnet_style_qualification_for_field=false:warning
+dotnet_style_qualification_for_method=false:warning
+dotnet_style_qualification_for_property=false:warning
+dotnet_style_require_accessibility_modifiers=for_non_interface_members:hint
+
+# ReSharper properties
+resharper_align_linq_query=true
+resharper_align_multiline_argument=true
+resharper_align_multiline_calls_chain=true
+resharper_align_multiline_extends_list=true
+resharper_align_multiline_for_stmt=true
+resharper_align_multline_type_parameter_constrains=true
+resharper_align_multline_type_parameter_list=true
+resharper_blank_lines_around_single_line_auto_property=1
+resharper_blank_lines_around_single_line_property=1
+resharper_blank_lines_before_single_line_comment=1
+resharper_braces_for_for=required
+resharper_braces_for_foreach=required
+resharper_braces_for_ifelse=required
+resharper_braces_for_while=required
+resharper_csharp_align_multiple_declaration=true
+resharper_csharp_blank_lines_around_single_line_invocable=1
+resharper_csharp_insert_final_newline=true
+resharper_csharp_max_line_length=200
+resharper_csharp_wrap_arguments_style=chop_if_long
+resharper_csharp_wrap_before_binary_opsign=true
+resharper_csharp_wrap_chained_binary_expressions=chop_if_long
+resharper_csharp_wrap_extends_list_style=chop_if_long
+resharper_csharp_wrap_parameters_style=chop_if_long
+resharper_for_built_in_types=use_var_when_evident
+resharper_indent_nested_fixed_stmt=true
+resharper_indent_nested_foreach_stmt=true
+resharper_indent_nested_for_stmt=true
+resharper_indent_nested_lock_stmt=true
+resharper_indent_nested_usings_stmt=true
+resharper_indent_nested_while_stmt=true
+resharper_indent_switch_labels=true
+resharper_instance_members_qualify_declared_in=base_class
+resharper_js_brace_style=next_line
+resharper_js_wrap_before_binary_opsign=true
+resharper_keep_blank_lines_between_declarations=1
+resharper_keep_blank_lines_in_code=1
+resharper_keep_blank_lines_in_declarations=1
+resharper_keep_existing_embedded_arrangement=false
+resharper_local_function_body=expression_body
+resharper_method_or_operator_body=expression_body
+resharper_new_line_before_catch=true
+resharper_new_line_before_else=true
+resharper_new_line_before_finally=true
+resharper_new_line_before_while=true
+resharper_place_accessorholder_attribute_on_same_line=False
+resharper_place_field_attribute_on_same_line=if_owner_is_single_line
+resharper_place_simple_case_statement_on_same_line=if_owner_is_single_line
+resharper_space_within_single_line_array_initializer_braces=true
+resharper_wrap_after_declaration_lpar=true
+resharper_wrap_after_invocation_lpar=true
+resharper_wrap_before_arrow_with_expressions=true
+resharper_wrap_before_extends_colon=true
+resharper_wrap_chained_binary_expressions=chop_if_long
+resharper_wrap_chained_method_calls=chop_if_long
+resharper_wrap_linq_expressions=chop_always
+resharper_wrap_multiple_type_parameter_constraints_style=chop_always
+
+# ReSharper inspection severities
+resharper_convert_to_static_class_highlighting=none
+resharper_function_complexity_overflow_highlighting=warning
+resharper_member_can_be_made_static_global_highlighting=none
+resharper_member_can_be_made_static_local_highlighting=none
+resharper_redundant_base_qualifier_highlighting=warning

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 * Suggestion for adding [FluentAssertions](https://github.com/fluentassertions/fluentassertions) on the new project wizard screen has been removed to avoid confusions, because FluentAssertion does not offer free use for commercial projects anymore. (#60)
 * Show regex options list e.g. '(option1|option2|option3)' parameter in step completion instead of a generic `[string]` placeholder (#55)
+* Added option to use custom binding discovery connectors using the configuration option `ide/bindingDiscovery/connectorPath` setting in `reqnroll.json` config file where a custom connector path can be specified. (#63)
 
 ## Bug fixes:
 

Connectors/Reqnroll.VisualStudio.ReqnrollConnector.Models/ConnectorResult.cs

@@ -3,6 +3,7 @@ namespace Reqnroll.VisualStudio.ReqnrollConnector.Models;
 
 public abstract class ConnectorResult
 {
+    public string ConnectorType { get; set; }
     public string ReqnrollVersion { get; set; }
     public string ErrorMessage { get; set; }
     public bool IsFailed => !string.IsNullOrWhiteSpace(ErrorMessage);

Reqnroll.VisualStudio.Package/ProjectSystem/NullVsIdeScope.cs

@@ -191,8 +191,7 @@ public void MonitorCommandRenameStepExecuted(RenameStepCommandContext ctx)
         {
         }
 
-        public void MonitorReqnrollDiscovery(bool isFailed, string errorMessage, int stepDefinitionCount,
-            ProjectSettings projectSettings)
+        public void MonitorReqnrollDiscovery(bool isFailed, string errorMessage, int stepDefinitionCount, ProjectSettings projectSettings, string connectorType)
         {
         }
 

Reqnroll.VisualStudio/Configuration/BindingDiscoveryConfiguration.cs

@@ -0,0 +1,39 @@
+namespace Reqnroll.VisualStudio.Configuration;
+
+public class BindingDiscoveryConfiguration
+{
+    public string? ConnectorPath { get; set; } = null;
+
+    private void FixEmptyContainers()
+    {
+    }
+
+    public void CheckConfiguration()
+    {
+        FixEmptyContainers();
+    }
+
+    #region Equality
+
+    protected bool Equals(BindingDiscoveryConfiguration other)
+    {
+        return ConnectorPath == other.ConnectorPath;
+    }
+
+    public override bool Equals(object? obj)
+    {
+        if (obj is null) return false;
+        if (ReferenceEquals(this, obj)) return true;
+        if (obj.GetType() != GetType()) return false;
+        return Equals((BindingDiscoveryConfiguration)obj);
+    }
+
+    // ReSharper disable NonReadonlyMemberInGetHashCode
+    public override int GetHashCode()
+    {
+        return (ConnectorPath != null ? ConnectorPath.GetHashCode() : 0);
+    }
+    // ReSharper restore NonReadonlyMemberInGetHashCode
+
+    #endregion
+}

Reqnroll.VisualStudio/Configuration/DeveroomConfiguration.cs

@@ -12,6 +12,7 @@ public class DeveroomConfiguration
     public SpecFlowConfiguration SpecFlow { get; set; } = new();
     public TraceabilityConfiguration Traceability { get; set; } = new();
     public EditorConfiguration Editor { get; set; } = new();
+    public BindingDiscoveryConfiguration BindingDiscovery { get; set; } = new();
 
     // old settings to be reviewed
     public ProcessorArchitectureSetting ProcessorArchitecture { get; set; } = ProcessorArchitectureSetting.AutoDetect;
@@ -28,6 +29,7 @@ private void FixEmptyContainers()
         SpecFlow ??= new SpecFlowConfiguration();
         Traceability ??= new TraceabilityConfiguration();
         Editor ??= new EditorConfiguration();
+        BindingDiscovery ??= new BindingDiscoveryConfiguration();
     }
 
     public void CheckConfiguration()
@@ -38,6 +40,7 @@ public void CheckConfiguration()
         SpecFlow.CheckConfiguration();
         Traceability.CheckConfiguration();
         Editor.CheckConfiguration();
+        BindingDiscovery.CheckConfiguration();
     }
 
     #region Equality
@@ -46,7 +49,9 @@ protected bool Equals(DeveroomConfiguration other) =>
         string.Equals(ConfigurationBaseFolder, other.ConfigurationBaseFolder) && 
         Equals(Reqnroll, other.Reqnroll) &&
         Equals(SpecFlow, other.SpecFlow) &&
-        Equals(Traceability, other.Traceability) && Equals(Editor, other.Editor) &&
+        Equals(Traceability, other.Traceability) && 
+        Equals(Editor, other.Editor) &&
+        Equals(BindingDiscovery, other.BindingDiscovery) &&
         ProcessorArchitecture == other.ProcessorArchitecture && DebugConnector == other.DebugConnector &&
         string.Equals(DefaultFeatureLanguage, other.DefaultFeatureLanguage) &&
         string.Equals(ConfiguredBindingCulture, other.ConfiguredBindingCulture);
@@ -68,6 +73,7 @@ public override int GetHashCode()
             hashCode = (hashCode * 397) ^ (SpecFlow != null ? SpecFlow.GetHashCode() : 0);
             hashCode = (hashCode * 397) ^ (Traceability != null ? Traceability.GetHashCode() : 0);
             hashCode = (hashCode * 397) ^ (Editor != null ? Editor.GetHashCode() : 0);
+            hashCode = (hashCode * 397) ^ (BindingDiscovery != null ? BindingDiscovery.GetHashCode() : 0);
             hashCode = (hashCode * 397) ^ (int) ProcessorArchitecture;
             hashCode = (hashCode * 397) ^ DebugConnector.GetHashCode();
             hashCode = (hashCode * 397) ^ (DefaultFeatureLanguage != null ? DefaultFeatureLanguage.GetHashCode() : 0);

Reqnroll.VisualStudio/Connectors/CustomOutProcReqnrollConnector.cs

@@ -0,0 +1,18 @@
+namespace Reqnroll.VisualStudio.Connectors;
+
+public class CustomOutProcReqnrollConnector : OutProcReqnrollConnector
+{
+    public CustomOutProcReqnrollConnector(DeveroomConfiguration configuration, IDeveroomLogger logger, TargetFrameworkMoniker targetFrameworkMoniker, string extensionFolder, ProcessorArchitectureSetting processorArchitecture, ProjectSettings projectSettings, IMonitoringService monitoringService) : base(configuration, logger, targetFrameworkMoniker, extensionFolder, processorArchitecture, projectSettings, monitoringService)
+    {
+    }
+
+    protected override string GetConnectorPath(List<string> arguments)
+    {
+        var connectorPath = Path.Combine(GetConnectorsFolder(), Environment.ExpandEnvironmentVariables(_configuration.BindingDiscovery.ConnectorPath ?? "<not specified>"));
+
+        if (".dll".Equals(Path.GetExtension(connectorPath), StringComparison.OrdinalIgnoreCase))
+            connectorPath = GetDotNetExecCommand(arguments, Path.GetDirectoryName(connectorPath), Path.GetFileName(connectorPath));
+
+        return connectorPath;
+    }
+}

Reqnroll.VisualStudio/Connectors/OutProcReqnrollConnector.cs

@@ -31,6 +31,11 @@ protected OutProcReqnrollConnector(DeveroomConfiguration configuration, IDeveroo
     private bool DebugConnector => _configuration.DebugConnector ||
                                    Environment.GetEnvironmentVariable("DEVEROOM_DEBUGCONNECTOR") == "1";
 
+    protected virtual string GetConnectorType()
+    {
+        return GetType().Name.Replace(nameof(OutProcReqnrollConnector), "");
+    }
+
     public DiscoveryResult RunDiscovery(string testAssemblyPath, string configFilePath)
     {
         var workingDirectory = Path.GetDirectoryName(testAssemblyPath);
@@ -42,11 +47,12 @@ public DiscoveryResult RunDiscovery(string testAssemblyPath, string configFilePa
         if (DebugConnector)
             arguments.Add("--debug");
 
-        if (!File.Exists(connectorPath))
+        if (connectorPath == null || !File.Exists(connectorPath))
             return new DiscoveryResult
             {
                 ErrorMessage = $"Error during binding discovery. Unable to find connector: {connectorPath}",
-                AnalyticsProperties = new Dictionary<string, object>()
+                AnalyticsProperties = new Dictionary<string, object>(),
+                ConnectorType = GetConnectorType()
             };
 
         var result = ProcessHelper.RunProcess(workingDirectory, connectorPath, arguments, encoding: Encoding.UTF8);
@@ -60,19 +66,23 @@ public DiscoveryResult RunDiscovery(string testAssemblyPath, string configFilePa
         _logger.LogVerbose(result.StandardOut);
 #endif
 
+        DiscoveryResult discoveryResult;
         if (result.ExitCode != 0)
         {
             var errorMessage = result.HasErrors ? result.StandardError : "Unknown error.";
 
-            return Deserialize(result,
+            discoveryResult = Deserialize(
+                result,
                 dr => GetDetailedErrorMessage(result, errorMessage + dr.ErrorMessage, BindingDiscoveryCommandName));
         }
+        else
+        {
+            discoveryResult = Deserialize(
+                result,
+                dr => dr.IsFailed ? GetDetailedErrorMessage(result, dr.ErrorMessage, BindingDiscoveryCommandName) : dr.ErrorMessage);
+        }
 
-        var discoveryResult = Deserialize(result, dr => dr.IsFailed
-            ? GetDetailedErrorMessage(result, dr.ErrorMessage, BindingDiscoveryCommandName)
-            : dr.ErrorMessage
-        );
-
+        discoveryResult.ConnectorType = GetConnectorType();
         return discoveryResult;
     }
 
@@ -85,14 +95,16 @@ private DiscoveryResult Deserialize(ProcessHelper.RunProcessResult result,
             discoveryResult = JsonSerialization.DeserializeObjectWithMarker<DiscoveryResult>(result.StandardOut)
                               ?? new DiscoveryResult
                               {
-                                  ErrorMessage = $"Cannot deserialize: {result.StandardOut}"
+                                  ErrorMessage = $"Cannot deserialize: {result.StandardOut}",
+                                  ConnectorType = GetConnectorType()
                               };
         }
         catch (Exception e)
         {
             discoveryResult = new DiscoveryResult
             {
-                ErrorMessage = e.ToString()
+                ErrorMessage = e.ToString(),
+                ConnectorType = GetConnectorType()
             };
         }
 

Reqnroll.VisualStudio/Connectors/OutProcReqnrollConnectorFactory.cs

@@ -2,6 +2,28 @@ namespace Reqnroll.VisualStudio.Connectors;
 
 public static class OutProcReqnrollConnectorFactory
 {
+    public static bool UseCustomConnector(IProjectScope projectScope)
+    {
+        var deveroomConfiguration = projectScope.GetDeveroomConfiguration();
+        return deveroomConfiguration.BindingDiscovery.ConnectorPath != null;
+    }
+
+    public static OutProcReqnrollConnector CreateCustom(IProjectScope projectScope)
+    {
+        var ideScope = projectScope.IdeScope;
+        var projectSettings = projectScope.GetProjectSettings();
+        var deveroomConfiguration = projectScope.GetDeveroomConfiguration();
+        var processorArchitecture = GetProcessorArchitecture(deveroomConfiguration, projectSettings);
+        return new CustomOutProcReqnrollConnector(
+            deveroomConfiguration,
+            ideScope.Logger,
+            projectSettings.TargetFrameworkMoniker,
+            projectScope.IdeScope.GetExtensionFolder(),
+            processorArchitecture,
+            projectSettings,
+            ideScope.MonitoringService);
+    }
+
     public static OutProcReqnrollConnector CreateGeneric(IProjectScope projectScope)
     {
         var ideScope = projectScope.IdeScope;

Reqnroll.VisualStudio/Discovery/DiscoveryInvoker.cs

@@ -149,8 +149,8 @@ public IDiscovery ThenImportBindings(string projectName)
 
         public ProjectBindingRegistry AndCreateBindingRegistry(IMonitoringService monitoringService)
         {
-            monitoringService.MonitorReqnrollDiscovery(_stepDefinitions.IsEmpty, _discoveryResult.ErrorMessage,
-                _stepDefinitions.Length, _projectSettings);
+            monitoringService.MonitorReqnrollDiscovery(_discoveryResult.IsFailed, _discoveryResult.ErrorMessage,
+                _stepDefinitions.Length, _projectSettings, _discoveryResult.ConnectorType);
 
             var projectHash = _invoker.CreateProjectHash(_projectSettings, _testAssemblySource);