/// <summary>
/// Will install the NuGet packages for the current managed projects.
/// The packages that will be installed will be based on the information from <see cref="Analyzer.GetRequiredNuGetPackages"/>
/// and is specific to the <see cref="RuleSet"/>.
/// </summary>
internal /*for testing purposes*/ void InstallPackages(IProgressController controller, CancellationToken token, IProgressStepExecutionEvents notificationEvents)
{
if (!this.NuGetPackages.Any())
{
return;
}
Debug.Assert(this.NuGetPackages.Count == this.NuGetPackages.Distinct().Count(), "Duplicate NuGet packages specified");
if (!this.BindingProjects.Any())
{
Debug.Fail("Not expected to be called when there are no projects");
return;
}
var projectNugets = this.BindingProjects
.SelectMany(bindingProject =>
{
var projectLanguage = Language.ForProject(bindingProject);
List <NuGetPackageInfoResponse> nugetPackages;
if (!this.NuGetPackages.TryGetValue(projectLanguage, out nugetPackages))
{
var message = string.Format(Strings.BindingProjectLanguageNotMatchingAnyQualityProfileLanguage, bindingProject.Name);
VsShellUtils.WriteToSonarLintOutputPane(this.host, Strings.SubTextPaddingFormat, message);
nugetPackages = new List <NuGetPackageInfoResponse>();
}
return(nugetPackages.Select(nugetPackage => new { Project = bindingProject, NugetPackage = nugetPackage }));
})
.ToArray();
DeterminateStepProgressNotifier progressNotifier = new DeterminateStepProgressNotifier(notificationEvents, projectNugets.Length);
foreach (var projectNuget in projectNugets)
{
if (token.IsCancellationRequested)
{
break;
}
string message = string.Format(CultureInfo.CurrentCulture, Strings.EnsuringNugetPackagesProgressMessage, projectNuget.NugetPackage.Id, projectNuget.Project.Name);
VsShellUtils.WriteToSonarLintOutputPane(this.host, Strings.SubTextPaddingFormat, message);
var isNugetInstallSuccessful = NuGetHelper.TryInstallPackage(this.host, projectNuget.Project, projectNuget.NugetPackage.Id, projectNuget.NugetPackage.Version);
if (isNugetInstallSuccessful) // NuGetHelper.TryInstallPackage already displayed the error message so only take care of the success message
{
message = string.Format(CultureInfo.CurrentCulture, Strings.SuccessfullyInstalledNugetPackageForProject, projectNuget.NugetPackage.Id, projectNuget.Project.Name);
VsShellUtils.WriteToSonarLintOutputPane(this.host, Strings.SubTextPaddingFormat, message);
}
// TODO: SVS-33 (https://jira.sonarsource.com/browse/SVS-33) Trigger a Team Explorer warning notification to investigate the partial binding in the output window.
this.AllNuGetPackagesInstalled &= isNugetInstallSuccessful;
progressNotifier.NotifyIncrementedProgress(string.Empty);
}
}
private ProgressStepDefinition[] CreateWorkflowSteps(IProgressController controller)
{
StepAttributes IndeterminateNonCancellableUIStep = StepAttributes.Indeterminate | StepAttributes.NonCancellable;
StepAttributes HiddenIndeterminateNonImpactingNonCancellableUIStep = IndeterminateNonCancellableUIStep | StepAttributes.Hidden | StepAttributes.NoProgressImpact;
StepAttributes HiddenNonImpactingBackgroundStep = StepAttributes.BackgroundThread | StepAttributes.Hidden | StepAttributes.NoProgressImpact;
return(new ProgressStepDefinition[]
{
new ProgressStepDefinition(null, HiddenNonImpactingBackgroundStep,
(token, notifications) => notifications.ProgressChanged(Strings.StartedSolutionBindingWorkflow)),
new ProgressStepDefinition(null, StepAttributes.Indeterminate | StepAttributes.Hidden,
(token, notifications) => this.PromptSaveSolutionIfDirty(controller, token)),
new ProgressStepDefinition(Strings.BindingProjectsDisplayMessage, StepAttributes.Indeterminate,
(token, notifications) => this.DiscoverProjects(controller, notifications)),
new ProgressStepDefinition(Strings.BindingProjectsDisplayMessage, StepAttributes.BackgroundThread,
(token, notifications) => this.DownloadQualityProfileAsync(controller, notifications, this.GetBindingLanguages(), token).GetAwaiter().GetResult()),
new ProgressStepDefinition(null, HiddenIndeterminateNonImpactingNonCancellableUIStep,
(token, notifications) => { NuGetHelper.LoadService(this.host); /*The service needs to be loaded on UI thread*/ }),
new ProgressStepDefinition(Strings.BindingProjectsDisplayMessage, StepAttributes.BackgroundThread,
(token, notifications) => this.InstallPackages(controller, token, notifications)),
new ProgressStepDefinition(Strings.BindingProjectsDisplayMessage, IndeterminateNonCancellableUIStep,
(token, notifications) => this.InitializeSolutionBindingOnUIThread(notifications)),
new ProgressStepDefinition(Strings.BindingProjectsDisplayMessage, StepAttributes.BackgroundThread | StepAttributes.Indeterminate,
(token, notifications) => this.PrepareSolutionBinding(token)),
new ProgressStepDefinition(null, StepAttributes.Hidden | StepAttributes.Indeterminate,
(token, notifications) => this.FinishSolutionBindingOnUIThread(controller, token)),
new ProgressStepDefinition(null, HiddenIndeterminateNonImpactingNonCancellableUIStep,
(token, notifications) => this.SilentSaveSolutionIfDirty()),
new ProgressStepDefinition(null, HiddenNonImpactingBackgroundStep,
(token, notifications) => this.EmitBindingCompleteMessage(notifications))
});
}
/// <summary>
/// Will install the NuGet packages for the current managed projects.
/// The packages that will be installed will be based on the information from <see cref="Analyzer.GetRequiredNuGetPackages"/>
/// and is specific to the <see cref="RuleSet"/>.
/// </summary>
public bool InstallPackages(ISet <Project> projectsToBind, IProgress <FixedStepsProgress> progress, CancellationToken token)
{
if (this.NuGetPackages.Count == 0)
{
return(true);
}
Debug.Assert(this.NuGetPackages.Count == this.NuGetPackages.Distinct().Count(), "Duplicate NuGet packages specified");
if (projectsToBind == null || projectsToBind.Count == 0)
{
Debug.Fail("Not expected to be called when there are no projects");
return(true);
}
var projectNugets = projectsToBind
.SelectMany(bindingProject =>
{
var projectLanguage = ProjectToLanguageMapper.GetLanguageForProject(bindingProject);
List <NuGetPackageInfo> nugetPackages;
if (!this.NuGetPackages.TryGetValue(projectLanguage, out nugetPackages))
{
var message = string.Format(Strings.BindingProjectLanguageNotMatchingAnyQualityProfileLanguage, bindingProject.Name);
this.logger.WriteLine(Strings.SubTextPaddingFormat, message);
nugetPackages = new List <NuGetPackageInfo>();
}
return(nugetPackages.Select(nugetPackage => new { Project = bindingProject, NugetPackage = nugetPackage }));
})
.ToArray();
bool overallSuccess = true;
int currentProject = 0;
foreach (var projectNuget in projectNugets)
{
if (token.IsCancellationRequested)
{
break;
}
string message = string.Format(CultureInfo.CurrentCulture, Strings.EnsuringNugetPackagesProgressMessage, projectNuget.NugetPackage.Id, projectNuget.Project.Name);
this.logger.WriteLine(Strings.SubTextPaddingFormat, message);
var isNugetInstallSuccessful = NuGetHelper.TryInstallPackage(this.serviceProvider, this.logger, projectNuget.Project, projectNuget.NugetPackage.Id, projectNuget.NugetPackage.Version);
if (isNugetInstallSuccessful) // NuGetHelper.TryInstallPackage already displayed the error message so only take care of the success message
{
message = string.Format(CultureInfo.CurrentCulture, Strings.SuccessfullyInstalledNugetPackageForProject, projectNuget.NugetPackage.Id, projectNuget.Project.Name);
this.logger.WriteLine(Strings.SubTextPaddingFormat, message);
}
// TODO: SVS-33 (https://jira.sonarsource.com/browse/SVS-33) Trigger a Team Explorer warning notification to investigate the partial binding in the output window.
overallSuccess &= isNugetInstallSuccessful;
currentProject++;
progress?.Report(new FixedStepsProgress(string.Empty, currentProject, projectNugets.Length));
}
return(overallSuccess);
}
public void PrepareOnUIThread()
{
Debug.Assert(ThreadHelper.CheckAccess(), "Expected step to be run on the UI thread");
NuGetHelper.LoadService(this.serviceProvider); /*The service needs to be loaded on UI thread*/
}