MMF-3869: [Visual Studio] Connected mode setup UI helps users discover the value of Sonar solution and connected mode

src/ConnectedMode.UnitTests/Binding/BindingProcessFactoryTests.cs

@@ -23,6 +23,7 @@
 using SonarLint.VisualStudio.ConnectedMode.QualityProfiles;
 using SonarLint.VisualStudio.Core;
 using SonarLint.VisualStudio.Core.Analysis;
+using SonarLint.VisualStudio.Core.Binding;
 using SonarLint.VisualStudio.TestInfrastructure;
 using SonarQube.Client;
 using SonarQube.Client.Models;
@@ -45,7 +46,7 @@ public void MefCtor_CheckIsExported()
         [TestMethod]
         public void Create_ReturnsProcessImpl()
         {
-            var bindingArgs = new BindCommandArgs("proj key", "proj name", new ConnectionInformation(new Uri("http://localhost")));
+            var bindingArgs = new BindCommandArgs(new BoundServerProject("any", "any", new ServerConnection.SonarCloud("any")));
 
             var testSubject = CreateTestSubject();
 

src/ConnectedMode.UnitTests/Binding/BindingProcessImplTests.cs

@@ -43,7 +43,7 @@ public class BindingProcessImplTests
         [TestMethod]
         public void Ctor_ArgChecks()
         {
-            var bindingArgs = CreateBindCommandArgs(connection: new ConnectionInformation(new Uri("http://server")));
+            var bindingArgs = CreateBindCommandArgs();
             var exclusionSettingsStorage = Mock.Of<IExclusionSettingsStorage>();
             var qpDownloader = Mock.Of<IQualityProfileDownloader>();
             var sonarQubeService = Mock.Of<ISonarQubeService>();
@@ -150,9 +150,7 @@ public async Task DownloadQualityProfile_CreatesBoundProjectAndCallsQPDownloader
             var qpDownloader = new Mock<IQualityProfileDownloader>();
             var progress = Mock.Of<IProgress<FixedStepsProgress>>();
 
-            var connectionInfo = new ConnectionInformation(new Uri("http://theServer"));
-            connectionInfo.Organization = new SonarQubeOrganization("the org key", "the org name");
-            var bindingArgs = CreateBindCommandArgs("the project key", "the project name", connectionInfo);
+            var bindingArgs = CreateBindCommandArgs("the project key", "http://theServer");
 
             var testSubject = CreateTestSubject(bindingArgs,
                 qpDownloader: qpDownloader.Object);
@@ -162,61 +160,15 @@ public async Task DownloadQualityProfile_CreatesBoundProjectAndCallsQPDownloader
 
             result.Should().BeTrue();
 
-            qpDownloader.Verify(x => x.UpdateAsync(It.IsAny<BoundSonarQubeProject>(), progress, It.IsAny<CancellationToken>()),
+            qpDownloader.Verify(x => x.UpdateAsync(It.IsAny<BoundServerProject>(), progress, It.IsAny<CancellationToken>()),
                 Times.Once);
 
-            var actualProject = (BoundSonarQubeProject)qpDownloader.Invocations[0].Arguments[0];
+            var actualProject = (BoundServerProject)qpDownloader.Invocations[0].Arguments[0];
 
             // Check the bound project was correctly constructed from the BindCommandArgs
             actualProject.Should().NotBeNull();
-            actualProject.ServerUri.Should().Be("http://theServer");
-            actualProject.ProjectKey.Should().Be("the project key");
-            actualProject.ProjectName.Should().Be("the project name");
-            actualProject.Organization.Key.Should().Be("the org key");
-            actualProject.Organization.Name.Should().Be("the org name");
-        }
-
-        [TestMethod]
-        [DataRow("the user name", null)]
-        [DataRow("the user name", "a password")]
-        [DataRow(null, null)]
-        [DataRow(null, "should be ignored")]
-        public async Task DownloadQualityProfile_HandlesBoundProjectCredentialsCorrectly(string userName, string rawPassword)
-        {
-            var qpDownloader = new Mock<IQualityProfileDownloader>();
-            var password = rawPassword == null ?  null : rawPassword.ToSecureString();
-
-            var connectionInfo = new ConnectionInformation(new Uri("http://any"), userName, password);
-            var bindingArgs = CreateBindCommandArgs(connection: connectionInfo);
-
-            var testSubject = CreateTestSubject(bindingArgs,
-                qpDownloader: qpDownloader.Object);
-
-            // Act
-            var result = await testSubject.DownloadQualityProfileAsync(Mock.Of<IProgress<FixedStepsProgress>>(), CancellationToken.None);
-
-            result.Should().BeTrue();
-
-            qpDownloader.Verify(x => x.UpdateAsync(It.IsAny<BoundSonarQubeProject>(),
-                It.IsAny<IProgress<FixedStepsProgress>>(),
-                It.IsAny<CancellationToken>()),
-                Times.Once);
-
-            var actualProject = (BoundSonarQubeProject)qpDownloader.Invocations[0].Arguments[0];
-
-            // Check the credentials were handled correctly
-            if (userName == null)
-            {
-                actualProject.Credentials.Should().BeNull();
-            }
-            else
-            {
-                actualProject.Credentials.Should().BeOfType<BasicAuthCredentials>();
-                var actualCreds = (BasicAuthCredentials)actualProject.Credentials;
-
-                actualCreds.UserName.Should().Be(userName);
-                CheckIsExpectedPassword(rawPassword, actualCreds.Password);
-            }
+            actualProject.ServerConnection.ServerUri.Should().Be("http://theServer");
+            actualProject.ServerProjectKey.Should().Be("the project key");
         }
 
         [TestMethod] 
@@ -225,7 +177,7 @@ public async Task DownloadQualityProfile_HandlesInvalidOperationException()
             var qpDownloader = new Mock<IQualityProfileDownloader>();
             qpDownloader
                 .Setup(x =>
-                    x.UpdateAsync(It.IsAny<BoundSonarQubeProject>(),
+                    x.UpdateAsync(It.IsAny<BoundServerProject>(),
                         It.IsAny<IProgress<FixedStepsProgress>>(),
                         It.IsAny<CancellationToken>()))
                 .Throws(new InvalidOperationException());
@@ -238,7 +190,7 @@ public async Task DownloadQualityProfile_HandlesInvalidOperationException()
                 await testSubject.DownloadQualityProfileAsync(Mock.Of<IProgress<FixedStepsProgress>>(), CancellationToken.None);
 
             result.Should().BeFalse();
-            qpDownloader.Verify(x => x.UpdateAsync(It.IsAny<BoundSonarQubeProject>(),
+            qpDownloader.Verify(x => x.UpdateAsync(It.IsAny<BoundServerProject>(),
                     It.IsAny<IProgress<FixedStepsProgress>>(),
                     It.IsAny<CancellationToken>()),
                 Times.Once);
@@ -267,10 +219,9 @@ private BindingProcessImpl CreateTestSubject(BindCommandArgs bindingArgs = null,
                 logger);
         }
 
-        private BindCommandArgs CreateBindCommandArgs(string projectKey = "key", string projectName = "name", ConnectionInformation connection = null)
+        private BindCommandArgs CreateBindCommandArgs(string projectKey = "key", string serverUri = "http://any")
         {
-            connection = connection ?? new ConnectionInformation(new Uri("http://connected"));
-            return new BindCommandArgs(projectKey, projectName, connection);
+            return new BindCommandArgs(new BoundServerProject("any", projectKey, new ServerConnection.SonarQube(new Uri(serverUri))));
         }
 
         private static void CheckIsExpectedPassword(string expectedRawPassword, SecureString actualPassword)

src/ConnectedMode.UnitTests/Binding/CSharpVBBindingConfigProviderTests.cs

@@ -185,7 +185,6 @@ public async Task GetConfig_ReturnsCorrectAdditionalFile()
         public async Task GetConfig_HasActiveInactiveAndUnsupportedRules_ReturnsValidBindingConfig()
         {
             // Arrange
-            const string expectedProjectName = "my project";
             const string expectedServerUrl = "http://myhost:123/";
 
             var properties = new SonarQubeProperty[]
@@ -207,7 +206,7 @@ public async Task GetConfig_HasActiveInactiveAndUnsupportedRules_ReturnsValidBin
                     InactiveRuleWithUnsupportedSeverity
                 };
 
-            var builder = new TestEnvironmentBuilder(validQualityProfile, Language.CSharp, expectedProjectName, expectedServerUrl)
+            var builder = new TestEnvironmentBuilder(validQualityProfile, Language.CSharp, expectedServerUrl)
             {
                 ActiveRulesResponse = activeRules,
                 InactiveRulesResponse = inactiveRules,
@@ -278,17 +277,14 @@ private class TestEnvironmentBuilder
 
             private readonly SonarQubeQualityProfile profile;
             private readonly Language language;
-            private readonly string projectName;
             private readonly string serverUrl;
 
             private const string ExpectedProjectKey = "fixed.project.key";
 
-            public TestEnvironmentBuilder(SonarQubeQualityProfile profile, Language language,
-                string projectName = "any", string serverUrl = "http://any")
+            public TestEnvironmentBuilder(SonarQubeQualityProfile profile, Language language, string serverUrl = "http://any")
             {
                 this.profile = profile;
                 this.language = language;
-                this.projectName = projectName;
                 this.serverUrl = serverUrl;
 
                 Logger = new TestLogger();
@@ -342,8 +338,10 @@ public CSharpVBBindingConfigProvider CreateTestSubject()
                         CapturedRulesPassedToGlobalConfigGenerator = rules;
                     });
 
-                BindingConfiguration = new BindingConfiguration(new BoundSonarQubeProject(new Uri(serverUrl), ExpectedProjectKey, projectName),
-                    SonarLintMode.Connected, "c:\\test\\");
+                BindingConfiguration = new BindingConfiguration(
+                    new BoundServerProject("solution", ExpectedProjectKey, new ServerConnection.SonarQube(new Uri(serverUrl))),
+                    SonarLintMode.Connected, 
+                    "c:\\test\\");
 
                 var sonarProperties = PropertiesResponse.ToDictionary(x => x.Key, y => y.Value);
                 sonarLintConfigGeneratorMock

src/ConnectedMode.UnitTests/Binding/CompositeBindingConfigProviderTests.cs

@@ -129,7 +129,8 @@ public DummyProvider(IBindingConfig configToReturn = null, params Language[] sup
 
             #region IBindingConfigProvider implementation
 
-            public Task<IBindingConfig> GetConfigurationAsync(SonarQubeQualityProfile qualityProfile, Language language, BindingConfiguration bindingConfiguration, CancellationToken cancellationToken)
+            public Task<IBindingConfig> GetConfigurationAsync(SonarQubeQualityProfile qualityProfile, Language language,
+                BindingConfiguration bindingConfiguration, CancellationToken cancellationToken)
             {
                 return Task.FromResult(ConfigToReturn);
             }

src/ConnectedMode.UnitTests/Binding/NonRoslynBindingConfigProviderTests.cs

@@ -129,7 +129,7 @@ public async Task GetRules_Success()
             serviceMock.Setup(x => x.GetRulesAsync(true, It.IsAny<string>(), It.IsAny<CancellationToken>()))
                 .ReturnsAsync(() => rules);
 
-            var bindingConfiguration = new BindingConfiguration(new BoundSonarQubeProject { ProjectKey = "test" }, SonarLintMode.Connected, "c:\\");
+            var bindingConfiguration = new BindingConfiguration(new BoundServerProject("any", "any", new ServerConnection.SonarCloud("any")), SonarLintMode.Connected, "c:\\");
 
             var testSubject = CreateTestSubject(serviceMock, testLogger);
 
@@ -176,7 +176,7 @@ public async Task GetRules_NoData_EmptyResultReturned()
             serviceMock.Setup(x => x.GetRulesAsync(It.IsAny<bool>(), It.IsAny<string>(), It.IsAny<CancellationToken>()))
                 .ReturnsAsync(() => new List<SonarQubeRule>());
 
-            var bindingConfiguration = new BindingConfiguration(new BoundSonarQubeProject { ProjectKey = "test" }, SonarLintMode.Connected, "c:\\");
+            var bindingConfiguration = new BindingConfiguration(new BoundServerProject("any", "any", new ServerConnection.SonarCloud("any")), SonarLintMode.Connected, "c:\\");
 
             var testSubject = CreateTestSubject(serviceMock, testLogger);
 

src/ConnectedMode.UnitTests/Binding/UnintrusiveBindingControllerTests.cs

@@ -18,81 +18,118 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
-using System;
-using System.Collections.Generic;
-using System.Threading;
+using System.Security;
+using SonarLint.VisualStudio.ConnectedMode.Binding;
+using SonarLint.VisualStudio.ConnectedMode.Persistence;
+using SonarLint.VisualStudio.Core;
 using SonarLint.VisualStudio.Core.Binding;
 using SonarLint.VisualStudio.TestInfrastructure;
+using SonarQube.Client;
+using SonarQube.Client.Helpers;
+using SonarQube.Client.Models;
 using Task = System.Threading.Tasks.Task;
 
-namespace SonarLint.VisualStudio.ConnectedMode.Binding.UnitTests
+namespace SonarLint.VisualStudio.ConnectedMode.UnitTests.Binding;
+
+[TestClass]
+public class UnintrusiveBindingControllerTests
 {
-    [TestClass]
-    public class UnintrusiveBindingControllerTests
-    {
-        private static readonly BoundSonarQubeProject AnyBoundProject = new BoundSonarQubeProject(new Uri("http://localhost:9000"), "any-key", "any-name");
+    private static readonly CancellationToken ACancellationToken = CancellationToken.None;
+    private static readonly BasicAuthCredentials ValidToken = new ("TOKEN", new SecureString());
+    private static readonly BoundServerProject AnyBoundProject = new ("any", "any", new ServerConnection.SonarCloud("any", credentials: ValidToken));
 
-        [TestMethod]
-        public void MefCtor_CheckTypeIsNonShared()
-            => MefTestHelpers.CheckIsNonSharedMefComponent<UnintrusiveBindingController>();
+    [TestMethod]
+    public void MefCtor_CheckTypeIsNonShared()
+        => MefTestHelpers.CheckIsNonSharedMefComponent<UnintrusiveBindingController>();
 
-        [TestMethod]
-        public void MefCtor_CheckIsExported()
-        {
-            MefTestHelpers.CheckTypeCanBeImported<UnintrusiveBindingController, IUnintrusiveBindingController>(
-                MefTestHelpers.CreateExport<IBindingProcessFactory>());
-        }
+    [TestMethod]
+    public void MefCtor_IUnintrusiveBindingController_CheckIsExported()
+    {
+        MefTestHelpers.CheckTypeCanBeImported<UnintrusiveBindingController, IUnintrusiveBindingController>(
+            MefTestHelpers.CreateExport<IBindingProcessFactory>(),
+            MefTestHelpers.CreateExport<ISonarQubeService>(),
+            MefTestHelpers.CreateExport<IActiveSolutionChangedHandler>());
+    }
+
+    [TestMethod]
+    public void MefCtor_IBindingController_CheckIsExported()
+    {
+        MefTestHelpers.CheckTypeCanBeImported<UnintrusiveBindingController, IBindingController>(
+            MefTestHelpers.CreateExport<IBindingProcessFactory>(),
+            MefTestHelpers.CreateExport<ISonarQubeService>(),
+            MefTestHelpers.CreateExport<IActiveSolutionChangedHandler>());
+    }
 
-        [TestMethod]
-        public async Task BindAsnyc_GetsBindingProcessFromFactory()
-        {
-            var bindingProcessFactory = CreateBindingProcessFactory();
+    [TestMethod]
+    public async Task BindAsync_EstablishesConnection()
+    {
+        var sonarQubeService = Substitute.For<ISonarQubeService>();
+        var projectToBind = new BoundServerProject(
+            "local-key", 
+            "server-key",
+            new ServerConnection.SonarCloud("organization", credentials: ValidToken));
+        var testSubject = CreateTestSubject(sonarQubeService: sonarQubeService);
+
+        await testSubject.BindAsync(projectToBind, ACancellationToken);
+
+        await sonarQubeService
+            .Received()
+            .ConnectAsync(
+                Arg.Is<ConnectionInformation>(x => x.ServerUri.Equals("https://sonarcloud.io/") 
+                                                   && x.UserName.Equals(ValidToken.UserName)
+                                                   && string.IsNullOrEmpty(x.Password.ToUnsecureString())),
+                ACancellationToken);
+    }
+
+    [TestMethod]
+    public async Task BindAsync_NotifiesBindingChanged()
+    {
+        var activeSolutionChangedHandler = Substitute.For<IActiveSolutionChangedHandler>();
+        var testSubject = CreateTestSubject(activeSolutionChangedHandler: activeSolutionChangedHandler);
+
+        await testSubject.BindAsync(AnyBoundProject, ACancellationToken);
+
+        activeSolutionChangedHandler
+            .Received(1)
+            .HandleBindingChange(false);
+    }
 
-            var testSubject = CreateTestSubject(bindingProcessFactory: bindingProcessFactory.Object);
-            await testSubject.BindAsync(AnyBoundProject, null, CancellationToken.None);
+    [TestMethod]
+    public async Task BindAsync_CallsBindingProcessInOrder()
+    {
+        var cancellationToken = CancellationToken.None;
+        var bindingProcess = Substitute.For<IBindingProcess>();
+        var bindingProcessFactory = CreateBindingProcessFactory(bindingProcess);
+        var testSubject = CreateTestSubject(bindingProcessFactory);
 
-            var args = bindingProcessFactory.Invocations[0].Arguments[0] as BindCommandArgs;
+        await testSubject.BindAsync(AnyBoundProject, null, cancellationToken);
 
-            args.ProjectName.Should().Be(AnyBoundProject.ProjectName);
-            args.ProjectKey.Should().Be(AnyBoundProject.ProjectKey);
-            args.Connection.ServerUri.Should().Be(AnyBoundProject.ServerUri);
-
-            bindingProcessFactory.Verify(x => x.Create(It.IsAny<BindCommandArgs>()), Times.Once);
-        }
-
-        [TestMethod]
-        public async Task BindAsnyc_CallsBindingProcessInOrder()
-        {
-            var calls = new List<string>();
-            var cancellationToken = CancellationToken.None;
-
-            var bindingProcess = new Mock<IBindingProcess>();
-            bindingProcess.Setup(x => x.DownloadQualityProfileAsync(null, cancellationToken)).Callback(() => calls.Add("DownloadQualityProfiles"));
-            bindingProcess.Setup(x => x.SaveServerExclusionsAsync(cancellationToken)).Callback(() => calls.Add("SaveServerExclusionsAsync"));
-
-            var testSubject = CreateTestSubject(bindingProcessFactory: CreateBindingProcessFactory(bindingProcess.Object).Object);
-            await testSubject.BindAsync(AnyBoundProject, null, cancellationToken);
-
-            calls.Should().ContainInOrder("DownloadQualityProfiles", "SaveServerExclusionsAsync");
-        }
-
-        private UnintrusiveBindingController CreateTestSubject(IBindingProcessFactory bindingProcessFactory = null)
+        Received.InOrder(() =>
         {
-            bindingProcessFactory ??= CreateBindingProcessFactory().Object;
-
-            var testSubject = new UnintrusiveBindingController(bindingProcessFactory);
+            bindingProcessFactory.Create(Arg.Is<BindCommandArgs>(b => b.ProjectToBind == AnyBoundProject));
+            bindingProcess.DownloadQualityProfileAsync(null, cancellationToken);
+            bindingProcess.SaveServerExclusionsAsync(cancellationToken);
+        });
+    }
+
+    private UnintrusiveBindingController CreateTestSubject(IBindingProcessFactory bindingProcessFactory = null,
+        ISonarQubeService sonarQubeService = null,
+        IActiveSolutionChangedHandler activeSolutionChangedHandler = null)
+    {
+        var testSubject = new UnintrusiveBindingController(bindingProcessFactory ?? CreateBindingProcessFactory(),
+            sonarQubeService ?? Substitute.For<ISonarQubeService>(),
+            activeSolutionChangedHandler ?? Substitute.For<IActiveSolutionChangedHandler>());
 
-            return testSubject;
-        }
+        return testSubject;
+    }
 
-        private Mock<IBindingProcessFactory> CreateBindingProcessFactory(IBindingProcess bindingProcess = null)
-        {
-            bindingProcess ??= Mock.Of<IBindingProcess>();
+    private static IBindingProcessFactory CreateBindingProcessFactory(IBindingProcess bindingProcess = null)
+    {
+        bindingProcess ??= Substitute.For<IBindingProcess>();
 
-            var bindingProcessFactory = new Mock<IBindingProcessFactory>();
-            bindingProcessFactory.Setup(x => x.Create(It.IsAny<BindCommandArgs>())).Returns(bindingProcess);
+        var bindingProcessFactory = Substitute.For<IBindingProcessFactory>();
+        bindingProcessFactory.Create(Arg.Any<BindCommandArgs>()).Returns(bindingProcess);
 
-            return bindingProcessFactory;
-        }
+        return bindingProcessFactory;
     }
 }