GH16: Detect Existence of SpecFlow for Visual Studio Extension and sh…

…ow a dialog box warning about conflicting instances. (#26)
reqnroll · Jun 20, 2024 · 6d80e62 · 6d80e62
1 parent 9774c95
commit 6d80e62
Show file tree

Hide file tree

Showing 11 changed files with 91 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## Improvements:
 
 * Find Unused Step Definitions Command: Improved handling of Step Definitions decorated with the 'StepDefinition' attribute. If a Step Definition is used in any Given/Then/When step in a Feature file, the step will no longer show in the 'Find Unused Step Definitions' context menu. (#24)
+* Detects Existence of SpecFlow for Visual Studio extension and show a warning (GH#16)
 
 ## Bug fixes:
 

diff --git a/Reqnroll.VisualStudio/Editor/Services/DeveroomTaggerProvider.cs b/Reqnroll.VisualStudio/Editor/Services/DeveroomTaggerProvider.cs
@@ -1,3 +1,5 @@
+using Reqnroll.VisualStudio.SpecFlowExtensionDetection;
+
 namespace Reqnroll.VisualStudio.Editor.Services;
 
 [Export(typeof(ITaggerProvider))]
@@ -7,15 +9,19 @@ namespace Reqnroll.VisualStudio.Editor.Services;
 public class DeveroomTaggerProvider : IDeveroomTaggerProvider
 {
     private readonly IIdeScope _ideScope;
+    private readonly SpecFlowExtensionDetectionService _detectionService;
 
     [ImportingConstructor]
-    public DeveroomTaggerProvider(IIdeScope ideScope)
+    public DeveroomTaggerProvider(IIdeScope ideScope, SpecFlowExtensionDetectionService specFlowExtensionDetectionService)
     {
+        _detectionService = specFlowExtensionDetectionService;
         _ideScope = ideScope;
     }
 
     public ITagger<T> CreateTagger<T>(ITextBuffer buffer) where T : ITag
     {
+        _detectionService?.CheckForSpecFlowExtensionOnce();
+
         if (buffer is not ITextBuffer2 buffer2)
             throw new InvalidOperationException($"Cannot assign {buffer.GetType()} to {typeof(ITextBuffer2)}");
 

diff --git a/Reqnroll.VisualStudio/Reqnroll.VisualStudio.csproj b/Reqnroll.VisualStudio/Reqnroll.VisualStudio.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>net481</TargetFramework>

diff --git a/Reqnroll.VisualStudio/SpecFlowExtensionDetection/SpecFlowExtensionDetectionClassifier.cs b/Reqnroll.VisualStudio/SpecFlowExtensionDetection/SpecFlowExtensionDetectionClassifier.cs
@@ -0,0 +1,26 @@
+using Microsoft.VisualStudio.Text.Classification;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Reqnroll.VisualStudio.SpecFlowExtensionDetection
+{
+    [Export(typeof(IClassifierProvider))]
+    [ContentType("gherkin")]
+    public class SpecFlowExtensionDetectionClassifierProvider : IClassifierProvider
+    {
+        private readonly SpecFlowExtensionDetectionService _detectionService;
+
+        public SpecFlowExtensionDetectionClassifierProvider(SpecFlowExtensionDetectionService detectionService)
+        {
+            _detectionService = detectionService;
+        }
+        public IClassifier GetClassifier(ITextBuffer textBuffer)
+        {
+            _detectionService.CheckForSpecFlowExtension();
+            return null;
+        }
+    }
+}
diff --git a/Reqnroll.VisualStudio/SpecFlowExtensionDetection/SpecFlowExtensionDetectionService.cs b/Reqnroll.VisualStudio/SpecFlowExtensionDetection/SpecFlowExtensionDetectionService.cs
@@ -0,0 +1,48 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Reqnroll.VisualStudio.SpecFlowExtensionDetection
+{
+    [Export]
+    public class SpecFlowExtensionDetectionService
+    {
+        private readonly IIdeScope _ideScope;
+        private bool _extensionExistenceChecked = false;
+        private bool _compatibilityAlertShown = false;
+
+        [ImportingConstructor]
+        public SpecFlowExtensionDetectionService(IIdeScope ideScope)
+        {
+            _ideScope = ideScope;
+        }
+
+        public void CheckForSpecFlowExtensionOnce()
+        {
+            if (_extensionExistenceChecked)
+                return;
+
+            CheckForSpecFlowExtension();
+        }
+
+        public void CheckForSpecFlowExtension()
+        {
+            if (_compatibilityAlertShown)
+                return;
+
+            _extensionExistenceChecked = true;
+            var specFlowExtensionDetected = AppDomain.CurrentDomain.GetAssemblies().Any(a =>
+                a.FullName.StartsWith("SpecFlow.VisualStudio"));
+
+            if (specFlowExtensionDetected && !_compatibilityAlertShown)
+            {
+                _compatibilityAlertShown = true;
+                _ideScope.Actions.ShowProblem(
+                                        $"We detected that both the 'Reqnroll for Visual Studio 2022' and the 'SpecFlow for Visual Studio 2022' extension have been installed in this Visual Studio instance.{Environment.NewLine}For the proper behavior you need to uninstall or disable one of these extensions in the 'Extensions / Manage Extensions' dialog.");
+
+            }
+        }
+    }
+}
diff --git a/Tests/Reqnroll.VisualStudio.Specs/StepDefinitions/ProjectSystemSteps.cs b/Tests/Reqnroll.VisualStudio.Specs/StepDefinitions/ProjectSystemSteps.cs
@@ -495,7 +495,7 @@ private void PerformCommand(string commandName, string parameter = null,
 
     private IDeveroomTaggerProvider CreateTaggerProvider()
     {
-        var taggerProvider = new DeveroomTaggerProvider(_ideScope);
+        var taggerProvider = new DeveroomTaggerProvider(_ideScope, new SpecFlowExtensionDetection.SpecFlowExtensionDetectionService(_ideScope));
         var tagger = taggerProvider.CreateTagger<DeveroomTag>(_ideScope.CurrentTextView.TextBuffer);
         var span = new SnapshotSpan(_ideScope.CurrentTextView.TextSnapshot, 0, 0);
         tagger.GetUpToDateDeveroomTagsForSpan(span);

diff --git a/Tests/Reqnroll.VisualStudio.Tests/Editor/Commands/AutoFormatDocumentCommandTests.cs b/Tests/Reqnroll.VisualStudio.Tests/Editor/Commands/AutoFormatDocumentCommandTests.cs
@@ -9,7 +9,7 @@ public class AutoFormatDocumentCommandTests
     public AutoFormatDocumentCommandTests(ITestOutputHelper testOutputHelper)
     {
         _ideScope = new StubIdeScope(testOutputHelper);
-        _deveroomTaggerProvider = new DeveroomTaggerProvider(_ideScope);
+        _deveroomTaggerProvider = new DeveroomTaggerProvider(_ideScope, new SpecFlowExtensionDetection.SpecFlowExtensionDetectionService(_ideScope));
     }
 
     private AutoFormatDocumentCommand CreateSUT() => new(

diff --git a/Tests/Reqnroll.VisualStudio.Tests/Editor/Commands/AutoFormatTableCommandTests.cs b/Tests/Reqnroll.VisualStudio.Tests/Editor/Commands/AutoFormatTableCommandTests.cs
@@ -26,7 +26,7 @@ public class AutoFormatTableCommandTests
     public AutoFormatTableCommandTests(ITestOutputHelper testOutputHelper)
     {
         _ideScope = new StubIdeScope(testOutputHelper);
-        _taggerProvider = new DeveroomTaggerProvider(_ideScope);
+        _taggerProvider = new DeveroomTaggerProvider(_ideScope, new SpecFlowExtensionDetection.SpecFlowExtensionDetectionService(_ideScope));
     }
 
     private StubWpfTextView CreateTextView(TestText inputText, string newLine) =>

diff --git a/Tests/Reqnroll.VisualStudio.Tests/Editor/EditorTestBase.cs b/Tests/Reqnroll.VisualStudio.Tests/Editor/EditorTestBase.cs
@@ -171,7 +171,7 @@ protected async Task BindingRegistryIsModified(string expression)
 
     protected static DeveroomTaggerProvider CreateTaggerProvider(IIdeScope ideScope)
     {
-        var taggerProvider = new DeveroomTaggerProvider(ideScope);
+        var taggerProvider = new DeveroomTaggerProvider(ideScope, new SpecFlowExtensionDetection.SpecFlowExtensionDetectionService(ideScope));
 
         return taggerProvider;
     }

diff --git a/Tests/Reqnroll.VisualStudio.Tests/Editor/Services/TaggerSut.cs b/Tests/Reqnroll.VisualStudio.Tests/Editor/Services/TaggerSut.cs
@@ -55,7 +55,7 @@ public ITagger<DeveroomTag> BuildInitializedFeatureFileTagger()
     public ITagger<DeveroomTag> BuildFeatureFileTagger()
     {
         ProjectScope.Properties.AddProperty(typeof(IDeveroomTagParser), TagParser.Object);
-        var taggerProvider = new DeveroomTaggerProvider(IdeScope);
+        var taggerProvider = new DeveroomTaggerProvider(IdeScope, new SpecFlowExtensionDetection.SpecFlowExtensionDetectionService(IdeScope));
 
         var tagger = BuildTagger<FeatureFileTagger>(taggerProvider);
         tagger.TagsChanged += DeveroomTagger_TagsChanged;

diff --git a/Tests/Reqnroll.VisualStudio.VsxStubs/ProjectSystem/InMemoryStubProjectBuilder.cs b/Tests/Reqnroll.VisualStudio.VsxStubs/ProjectSystem/InMemoryStubProjectBuilder.cs
@@ -1,3 +1,5 @@
+using Reqnroll.VisualStudio.SpecFlowExtensionDetection;
+
 namespace Reqnroll.VisualStudio.VsxStubs.ProjectSystem;
 
 public class InMemoryStubProjectBuilder : IDisposable
@@ -15,7 +17,7 @@ public InMemoryStubProjectBuilder(InMemoryStubProjectScope project)
         bindingRegistryCache = project.Properties.GetProperty<IDiscoveryService>(typeof(IDiscoveryService))
             .BindingRegistryCache;
 
-        var taggerProvider = new DeveroomTaggerProvider(project.IdeScope);
+        var taggerProvider = new DeveroomTaggerProvider(project.IdeScope, new SpecFlowExtensionDetectionService(project.IdeScope));
         _tagger = taggerProvider.CreateTagger<DeveroomTag>(VisibleTextBuffer);
 
         _bindingRegistryChanged = new AsyncManualResetEvent();