Support target framework specific NuGet PowerShell scripts.

mrward · mrward · commit b83ab81abfa3 · 2014-12-14T18:33:46.000Z
Fix AutoMapper NuGet PowerShell scripts not being run.

A NuGet package can have install.ps1 and uninstall.ps1 PowerShell
scripts that target a particular framework based on the tools
subdirectory where they can be placed:

    tools\net40\install.ps1
    tools\net40\uninstall.ps1

Previously SharpDevelop would only look in the tools directory for
these scripts. Now it will use the project's target framework to find
the most compatible PowerShell install or uninstall script.

Note that NuGet does not support init.ps1 being target framework
specific and it will only be run if it exists in the tools directory
inside the NuGet package.
diff --git a/src/AddIns/Misc/PackageManagement/Project/Src/Design/FakeFileSystem.cs b/src/AddIns/Misc/PackageManagement/Project/Src/Design/FakeFileSystem.cs
@@ -59,7 +59,12 @@ public IEnumerable<string> GetDirectories(string path)
 		
 		public string GetFullPath(string path)
 		{
-			return PathToReturnFromGetFullPath;
+			if (PathToReturnFromGetFullPath != null) {
+				return PathToReturnFromGetFullPath;
+			} else if (Root == null) {
+				return null;
+			}
+			return Path.Combine(Root, path);
 		}
 		
 		public void DeleteFile(string path)
@@ -70,9 +75,16 @@ public void DeleteFile(string path)
 		public bool FileExists(string path)
 		{
 			PathPassedToFileExists = path;
+			
+			if (ExistingFiles.Contains(path)) {
+				return true;
+			}
+			
 			return FileExistsReturnValue;
 		}
 		
+		public List<string> ExistingFiles = new List<string>();
+		
 		public bool DirectoryExists(string path)
 		{
 			PathPassedToDirectoryExists = path;
diff --git a/src/AddIns/Misc/PackageManagement/Project/Src/Design/FakePackageManagementProject.cs b/src/AddIns/Misc/PackageManagement/Project/Src/Design/FakePackageManagementProject.cs
@@ -20,6 +20,7 @@
 using System.Collections.Generic;
 using System.Linq;
 
+using System.Runtime.Versioning;
 using ICSharpCode.PackageManagement;
 using ICSharpCode.PackageManagement.EnvDTE;
 using NuGet;
@@ -41,6 +42,7 @@ public FakePackageManagementProject(string name)
 			this.Name = name;
 			
 			ConstraintProvider = NullConstraintProvider.Instance;
+			TargetFramework = new FrameworkName(".NETFramework", new Version("4.0"));
 		}
 		
 		private FakeInstallPackageAction FakeInstallPackageAction;
@@ -283,5 +285,7 @@ public void UpdatePackageReference(IPackage package, IUpdatePackageSettings sett
 		}
 		
 		public IPackageConstraintProvider ConstraintProvider { get; set; }
+		
+		public FrameworkName TargetFramework { get; set; }
 	}
 }
diff --git a/src/AddIns/Misc/PackageManagement/Project/Src/IPackageManagementProject.cs b/src/AddIns/Misc/PackageManagement/Project/Src/IPackageManagementProject.cs
@@ -20,6 +20,7 @@
 using System.Collections.Generic;
 using System.Linq;
 
+using System.Runtime.Versioning;
 using ICSharpCode.PackageManagement.EnvDTE;
 using NuGet;
 
@@ -33,6 +34,7 @@ public interface IPackageManagementProject
 		event EventHandler<PackageOperationEventArgs> PackageReferenceRemoving;
 		
 		string Name { get; }
+		FrameworkName TargetFramework { get; }
 		ILogger Logger { get; set; }
 		IPackageRepository SourceRepository { get; }
 		
diff --git a/src/AddIns/Misc/PackageManagement/Project/Src/PackageManagementProject.cs b/src/AddIns/Misc/PackageManagement/Project/Src/PackageManagementProject.cs
@@ -20,6 +20,7 @@
 using System.Collections.Generic;
 using System.Linq;
 
+using System.Runtime.Versioning;
 using ICSharpCode.PackageManagement.EnvDTE;
 using ICSharpCode.SharpDevelop.Project;
 using NuGet;
@@ -32,6 +33,7 @@ public class PackageManagementProject : IPackageManagementProject
 		ISharpDevelopProjectManager projectManager;
 		IPackageManagementEvents packageManagementEvents;
 		MSBuildBasedProject msbuildProject;
+		ProjectTargetFramework targetFramework;
 		
 		public PackageManagementProject(
 			IPackageRepository sourceRepository,
@@ -41,6 +43,7 @@ public PackageManagementProject(
 		{
 			SourceRepository = sourceRepository;
 			msbuildProject = project;
+			targetFramework = new ProjectTargetFramework(project);
 			this.packageManagementEvents = packageManagementEvents;
 			
 			packageManager = packageManagerFactory.CreatePackageManager(sourceRepository, project);
@@ -51,6 +54,10 @@ public string Name {
 			get { return msbuildProject.Name; }
 		}
 		
+		public FrameworkName TargetFramework {
+			get { return targetFramework.TargetFrameworkName; }
+		}
+		
 		public IPackageRepository SourceRepository { get; private set; }
 		
 		public ILogger Logger {
diff --git a/src/AddIns/Misc/PackageManagement/Project/Src/Scripting/IPackageScriptFileName.cs b/src/AddIns/Misc/PackageManagement/Project/Src/Scripting/IPackageScriptFileName.cs
@@ -17,6 +17,8 @@
 // DEALINGS IN THE SOFTWARE.
 
 using System;
+using System.Runtime.Versioning;
+using NuGet;
 
 namespace ICSharpCode.PackageManagement.Scripting
 {
@@ -27,5 +29,6 @@ public interface IPackageScriptFileName
 		bool ScriptDirectoryExists();
 		bool FileExists();
 		string GetScriptDirectory();
+		void UseTargetSpecificFileName(IPackage package, FrameworkName frameworkName);
 	}
 }
diff --git a/src/AddIns/Misc/PackageManagement/Project/Src/Scripting/PackageInstallScript.cs b/src/AddIns/Misc/PackageManagement/Project/Src/Scripting/PackageInstallScript.cs
@@ -26,6 +26,7 @@ public class PackageInstallScript : PackageScript
 		public PackageInstallScript(IPackage package, IPackageScriptFileName fileName)
 			: base(package, fileName)
 		{
+			UseTargetSpecificScript = true;
 		}
 	}
 }
diff --git a/src/AddIns/Misc/PackageManagement/Project/Src/Scripting/PackageScript.cs b/src/AddIns/Misc/PackageManagement/Project/Src/Scripting/PackageScript.cs
@@ -17,13 +17,18 @@
 // DEALINGS IN THE SOFTWARE.
 
 using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Runtime.Versioning;
 using ICSharpCode.PackageManagement.EnvDTE;
 using NuGet;
 
 namespace ICSharpCode.PackageManagement.Scripting
 {
 	public class PackageScript : IPackageScript
 	{
+		bool lookedForTargetSpecificScript;
+		
 		public PackageScript(IPackage package, IPackageScriptFileName fileName)
 		{
 			this.Package = package;
@@ -32,12 +37,14 @@ public PackageScript(IPackage package, IPackageScriptFileName fileName)
 		
 		protected IPackageScriptFileName ScriptFileName { get; private set; }
 		protected IPackageScriptSession Session { get; private set; }
+		protected bool UseTargetSpecificScript { get; set; }
 		
 		public IPackage Package { get; set; }
 		public IPackageManagementProject Project { get; set; }
 		
 		public bool Exists()
 		{
+			FindTargetSpecificScriptFileName();
 			return ScriptFileName.FileExists();
 		}
 		
@@ -97,5 +104,18 @@ void RemoveSessionVariables()
 			Session.RemoveVariable("__package");
 			Session.RemoveVariable("__project");
 		}
+		
+		void FindTargetSpecificScriptFileName()
+		{
+			if (UseTargetSpecificScript && !lookedForTargetSpecificScript) {
+				ScriptFileName.UseTargetSpecificFileName(Package, GetTargetFramework());
+				lookedForTargetSpecificScript = true;
+			}
+		}
+		
+		FrameworkName GetTargetFramework()
+		{
+			return Project.TargetFramework;
+		}
 	}
 }
diff --git a/src/AddIns/Misc/PackageManagement/Project/Src/Scripting/PackageScriptFileName.cs b/src/AddIns/Misc/PackageManagement/Project/Src/Scripting/PackageScriptFileName.cs
@@ -17,7 +17,10 @@
 // DEALINGS IN THE SOFTWARE.
 
 using System;
+using System.Collections.Generic;
 using System.IO;
+using System.Linq;
+using System.Runtime.Versioning;
 using NuGet;
 
 namespace ICSharpCode.PackageManagement.Scripting
@@ -68,5 +71,16 @@ public string GetScriptDirectory()
 		{
 			return fileSystem.GetFullPath("tools");
 		}
+		
+		public void UseTargetSpecificFileName(IPackage package, FrameworkName targetFramework)
+		{
+			IEnumerable<IPackageFile> files;
+			if (VersionUtility.TryGetCompatibleItems(targetFramework, package.GetToolFiles(), out files)) {
+				IPackageFile matchingScriptFile = files.FirstOrDefault(file => file.EffectivePath.Equals(Name, StringComparison.OrdinalIgnoreCase));
+				if (matchingScriptFile != null) {
+					relativeScriptFilePath = matchingScriptFile.Path;
+				}
+			}
+		}
 	}
 }
diff --git a/src/AddIns/Misc/PackageManagement/Project/Src/Scripting/PackageUninstallScript.cs b/src/AddIns/Misc/PackageManagement/Project/Src/Scripting/PackageUninstallScript.cs
@@ -26,6 +26,7 @@ public class PackageUninstallScript : PackageScript
 		public PackageUninstallScript(IPackage package, IPackageScriptFileName fileName)
 			: base(package, fileName)
 		{
+			UseTargetSpecificScript = true;
 		}
 	}
 }
diff --git a/src/AddIns/Misc/PackageManagement/Test/PackageManagement.Tests.csproj b/src/AddIns/Misc/PackageManagement/Test/PackageManagement.Tests.csproj
@@ -198,6 +198,7 @@
     <Compile Include="Src\Scripting\MSBuildProjectImportsMergerTests.cs" />
     <Compile Include="Src\Scripting\MSBuildProjectPropertiesMergerTests.cs" />
     <Compile Include="Src\Scripting\PackageManagementConsoleHostLoggerTests.cs" />
+    <Compile Include="Src\Scripting\PackageUninstallScriptTests.cs" />
     <Compile Include="Src\SettingsProviderTests.cs" />
     <Compile Include="Src\UpdatedPackagesTests.cs" />
     <Compile Include="Src\UpdatePackagesActionTests.cs" />
diff --git a/src/AddIns/Misc/PackageManagement/Test/Src/Helpers/FakePackageScriptFileName.cs b/src/AddIns/Misc/PackageManagement/Test/Src/Helpers/FakePackageScriptFileName.cs
@@ -17,7 +17,9 @@
 // DEALINGS IN THE SOFTWARE.
 
 using System;
+using System.Runtime.Versioning;
 using ICSharpCode.PackageManagement.Scripting;
+using NuGet;
 
 namespace PackageManagement.Tests.Helpers
 {
@@ -52,5 +54,9 @@ public override string ToString()
 		{
 			return ToStringReturnValue;
 		}
+		
+		public void UseTargetSpecificFileName(IPackage package, FrameworkName frameworkName)
+		{
+		}
 	}
 }
diff --git a/src/AddIns/Misc/PackageManagement/Test/Src/PackageManagementProjectTests.cs b/src/AddIns/Misc/PackageManagement/Test/Src/PackageManagementProjectTests.cs
@@ -20,6 +20,7 @@
 using System.Collections.Generic;
 using System.Linq;
 
+using System.Runtime.Versioning;
 using ICSharpCode.PackageManagement;
 using ICSharpCode.PackageManagement.Design;
 using ICSharpCode.PackageManagement.EnvDTE;
@@ -46,17 +47,25 @@ public class PackageManagementProjectTests
 		UpdatePackagesAction updatePackagesAction;
 		
 		void CreateProject()
+		{
+			fakeMSBuildProject = ProjectHelper.CreateTestProject();
+			fakeMSBuildProject.SetProperty("TargetFrameworkIdentifier", null);
+			fakeMSBuildProject.SetProperty("TargetFrameworkVersion", "v4.0");
+			fakeMSBuildProject.SetProperty("TargetFrameworkProfile", null);
+			CreateProject(fakeMSBuildProject);
+		}
+		
+		void CreateProject(MSBuildBasedProject msbuildProject)
 		{
 			fakePackageManagerFactory = new FakePackageManagerFactory();
 			fakePackageManager = fakePackageManagerFactory.FakePackageManager;
 			fakeProjectManager = fakePackageManager.FakeProjectManager;
 			fakeSourceRepository = new FakePackageRepository();
-			fakeMSBuildProject = ProjectHelper.CreateTestProject();
 			fakePackageManagementEvents = new FakePackageManagementEvents();
 			
 			project = new PackageManagementProject(
 				fakeSourceRepository,
-				fakeMSBuildProject,
+				msbuildProject,
 				fakePackageManagementEvents,
 				fakePackageManagerFactory);
 		}
@@ -761,25 +770,40 @@ public void UpdatePackageReference_PackageAndUpdateActionPassed_BothPassedToPack
 		}
 	
 		[Test]
-		public void ConstraintProvider_LocalRepositoryDoesNotImplementIConstraintProvider_ReturnsNullConstraintProviderInstance ()
+		public void ConstraintProvider_LocalRepositoryDoesNotImplementIConstraintProvider_ReturnsNullConstraintProviderInstance()
 		{
-			CreateProject ();
+			CreateProject();
 
 			IPackageConstraintProvider provider = project.ConstraintProvider;
 
-			Assert.AreEqual (NullConstraintProvider.Instance, provider);
+			Assert.AreEqual(NullConstraintProvider.Instance, provider);
 		}
 
 		[Test]
-		public void ConstraintProvider_LocalRepositoryImplementsIConstraintProvider_ReturnsLocalRepository ()
+		public void ConstraintProvider_LocalRepositoryImplementsIConstraintProvider_ReturnsLocalRepository()
 		{
-			CreateProject ();
-			var localRepository = new FakePackageRepositoryWithConstraintProvider ();
+			CreateProject();
+			var localRepository = new FakePackageRepositoryWithConstraintProvider();
 			fakeProjectManager.FakeLocalRepository = localRepository;
 
 			IPackageConstraintProvider provider = project.ConstraintProvider;
 
-			Assert.AreEqual (localRepository, provider);
+			Assert.AreEqual(localRepository, provider);
+		}
+		
+		[Test]
+		public void TargetFramework_TargetFrameworkVersion40DefinedInProject_ReturnsFullDotNetFramework40()
+		{
+			fakeMSBuildProject = ProjectHelper.CreateTestProject();
+			fakeMSBuildProject.SetProperty("TargetFrameworkIdentifier", null);
+			fakeMSBuildProject.SetProperty("TargetFrameworkVersion", "v4.0");
+			fakeMSBuildProject.SetProperty("TargetFrameworkProfile", null);
+			CreateProject(fakeMSBuildProject);
+			var expectedName = new FrameworkName(".NETFramework, Version=v4.0");
+			
+			FrameworkName targetFramework = project.TargetFramework;
+			
+			Assert.AreEqual(expectedName, targetFramework);
 		}
 	}
 }
diff --git a/src/AddIns/Misc/PackageManagement/Test/Src/Scripting/PackageInstallScriptTests.cs b/src/AddIns/Misc/PackageManagement/Test/Src/Scripting/PackageInstallScriptTests.cs
@@ -17,6 +17,7 @@
 // DEALINGS IN THE SOFTWARE.
 
 using System;
+using System.Runtime.Versioning;
 using ICSharpCode.PackageManagement.Design;
 using ICSharpCode.PackageManagement.EnvDTE;
 using ICSharpCode.PackageManagement.Scripting;
@@ -34,6 +35,7 @@ public class PackageInstallScriptTests
 		PackageInstallScript script;
 		FakeFileSystem fakeFileSystem;
 		FakePackage fakePackage;
+		FakePackageManagementProject fakeProject;
 		
 		void CreateScript()
 		{
@@ -45,7 +47,10 @@ void CreateScript()
 			fakeSession = new FakePackageScriptSession();
 			fakePackage = new FakePackage();
 			
+			fakeProject = new FakePackageManagementProject();
+			
 			script = new PackageInstallScript(fakePackage, scriptFileName);
+			script.Project = fakeProject;
 		}
 		
 		void ExecuteScript()
@@ -123,5 +128,35 @@ public void Package_PackagePassedToConstructor_ReturnsPackagePassedToConstructor
 			
 			Assert.AreEqual(fakePackage, package);
 		}
+		
+		[Test]
+		public void Run_PackageHasTargetFrameworkSpecificInstallPowerShellScript_InstallPowerShellScriptIsRun()
+		{
+			CreateScript();
+			fakeFileSystem.Root = @"d:\projects\MyProject\packages\MyPackage.1.0";
+			fakePackage.AddFile(@"tools\net40\Install.ps1");
+			fakeProject.TargetFramework = new FrameworkName(".NETFramework", new Version("4.0"));
+			
+			script.Run(fakeSession);
+			
+			bool result = fakeSession.ScriptPassedToInvokeScript.StartsWith(
+				@"& 'd:\projects\MyProject\packages\MyPackage.1.0\tools\net40\Install.ps1'");
+			Assert.IsTrue(result, fakeSession.ScriptPassedToInvokeScript);
+		}
+		
+		[Test]
+		public void Exists_PackageHasTargetFrameworkSpecificInstallPowerShellScript_ReturnsTrue()
+		{
+			CreateScript();
+			fakeFileSystem.Root = @"d:\projects\MyProject\packages\MyPackage.1.0";
+			fakeFileSystem.ExistingFiles.Add(@"tools\net40\install.ps1");
+			fakeFileSystem.FileExistsReturnValue = false;
+			fakePackage.AddFile(@"tools\net40\install.ps1");
+			fakeProject.TargetFramework = new FrameworkName(".NETFramework", new Version("4.0"));
+			
+			bool exists = script.Exists();
+			
+			Assert.IsTrue(exists);
+		}
 	}
 }
diff --git a/src/AddIns/Misc/PackageManagement/Test/Src/Scripting/PackageUninstallScriptTests.cs b/src/AddIns/Misc/PackageManagement/Test/Src/Scripting/PackageUninstallScriptTests.cs

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,12 @@ public IEnumerable<string> GetDirectories(string path)`
`59`	`59`
`60`	`60`	`public string GetFullPath(string path)`
`61`	`61`	`{`
`62`		`- return PathToReturnFromGetFullPath;`
	`62`	`+ if (PathToReturnFromGetFullPath != null) {`
	`63`	`+ return PathToReturnFromGetFullPath;`
	`64`	`+ } else if (Root == null) {`
	`65`	`+ return null;`
	`66`	`+ }`
	`67`	`+ return Path.Combine(Root, path);`
`63`	`68`	`}`
`64`	`69`
`65`	`70`	`public void DeleteFile(string path)`
`@@ -70,9 +75,16 @@ public void DeleteFile(string path)`
`70`	`75`	`public bool FileExists(string path)`
`71`	`76`	`{`
`72`	`77`	`PathPassedToFileExists = path;`
	`78`	`+`
	`79`	`+ if (ExistingFiles.Contains(path)) {`
	`80`	`+ return true;`
	`81`	`+ }`
	`82`	`+`
`73`	`83`	`return FileExistsReturnValue;`
`74`	`84`	`}`
`75`	`85`
	`86`	`+ public List<string> ExistingFiles = new List<string>();`
	`87`	`+`
`76`	`88`	`public bool DirectoryExists(string path)`
`77`	`89`	`{`
`78`	`90`	`PathPassedToDirectoryExists = path;`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`	`using System.Collections.Generic;`
`21`	`21`	`using System.Linq;`
`22`	`22`
	`23`	`+using System.Runtime.Versioning;`
`23`	`24`	`using ICSharpCode.PackageManagement;`
`24`	`25`	`using ICSharpCode.PackageManagement.EnvDTE;`
`25`	`26`	`using NuGet;`
`@@ -41,6 +42,7 @@ public FakePackageManagementProject(string name)`
`41`	`42`	`this.Name = name;`
`42`	`43`
`43`	`44`	`ConstraintProvider = NullConstraintProvider.Instance;`
	`45`	`+ TargetFramework = new FrameworkName(".NETFramework", new Version("4.0"));`
`44`	`46`	`}`
`45`	`47`
`46`	`48`	`private FakeInstallPackageAction FakeInstallPackageAction;`
`@@ -283,5 +285,7 @@ public void UpdatePackageReference(IPackage package, IUpdatePackageSettings sett`
`283`	`285`	`}`
`284`	`286`
`285`	`287`	`public IPackageConstraintProvider ConstraintProvider { get; set; }`
	`288`	`+`
	`289`	`+ public FrameworkName TargetFramework { get; set; }`
`286`	`290`	`}`
`287`	`291`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`	`// DEALINGS IN THE SOFTWARE.`
`18`	`18`
`19`	`19`	`using System;`
	`20`	`+using System.Runtime.Versioning;`
	`21`	`+using NuGet;`
`20`	`22`
`21`	`23`	`namespace ICSharpCode.PackageManagement.Scripting`
`22`	`24`	`{`
`@@ -27,5 +29,6 @@ public interface IPackageScriptFileName`
`27`	`29`	`bool ScriptDirectoryExists();`
`28`	`30`	`bool FileExists();`
`29`	`31`	`string GetScriptDirectory();`
	`32`	`+ void UseTargetSpecificFileName(IPackage package, FrameworkName frameworkName);`
`30`	`33`	`}`
`31`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ public class PackageInstallScript : PackageScript`
`26`	`26`	`public PackageInstallScript(IPackage package, IPackageScriptFileName fileName)`
`27`	`27`	`: base(package, fileName)`
`28`	`28`	`{`
	`29`	`+ UseTargetSpecificScript = true;`
`29`	`30`	`}`
`30`	`31`	`}`
`31`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ public class PackageUninstallScript : PackageScript`
`26`	`26`	`public PackageUninstallScript(IPackage package, IPackageScriptFileName fileName)`
`27`	`27`	`: base(package, fileName)`
`28`	`28`	`{`
	`29`	`+ UseTargetSpecificScript = true;`
`29`	`30`	`}`
`30`	`31`	`}`
`31`	`32`	`}`