jkuehner
10 years ago
38 changed files with 698 additions and 185 deletions
@ -0,0 +1,27 @@
@@ -0,0 +1,27 @@
|
||||
// Copyright (c) 2015 AlphaSierraPapa for the SharpDevelop Team
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
// software and associated documentation files (the "Software"), to deal in the Software
|
||||
// without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
|
||||
// to whom the Software is furnished to do so, subject to the following conditions:
|
||||
//
|
||||
// The above copyright notice and this permission notice shall be included in all copies or
|
||||
// substantial portions of the Software.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
|
||||
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
||||
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
// DEALINGS IN THE SOFTWARE.
|
||||
|
||||
using System; |
||||
|
||||
namespace ICSharpCode.PackageManagement |
||||
{ |
||||
public interface IOpenPackageReadMeMonitor : IDisposable |
||||
{ |
||||
void OpenReadMeFile(); |
||||
} |
||||
} |
||||
@ -0,0 +1,86 @@
@@ -0,0 +1,86 @@
|
||||
// Copyright (c) 2015 AlphaSierraPapa for the SharpDevelop Team
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
// software and associated documentation files (the "Software"), to deal in the Software
|
||||
// without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
|
||||
// to whom the Software is furnished to do so, subject to the following conditions:
|
||||
//
|
||||
// The above copyright notice and this permission notice shall be included in all copies or
|
||||
// substantial portions of the Software.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
|
||||
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
||||
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
// DEALINGS IN THE SOFTWARE.
|
||||
|
||||
using System; |
||||
using System.IO; |
||||
using System.Linq; |
||||
using NuGet; |
||||
|
||||
namespace ICSharpCode.PackageManagement |
||||
{ |
||||
public class OpenPackageReadMeMonitor : IOpenPackageReadMeMonitor |
||||
{ |
||||
IPackageManagementProject project; |
||||
IPackageManagementFileService fileService; |
||||
|
||||
public OpenPackageReadMeMonitor(string packageId, IPackageManagementProject project) |
||||
: this(packageId, project, new PackageManagementFileService()) |
||||
{ |
||||
} |
||||
|
||||
public OpenPackageReadMeMonitor( |
||||
string packageId, |
||||
IPackageManagementProject project, |
||||
IPackageManagementFileService fileService) |
||||
{ |
||||
PackageId = packageId; |
||||
this.project = project; |
||||
this.fileService = fileService; |
||||
project.PackageInstalled += PackageInstalled; |
||||
} |
||||
|
||||
public string PackageId { get; private set; } |
||||
public bool IsDisposed { get; private set; } |
||||
|
||||
string ReadMeFile { get; set; } |
||||
|
||||
public void Dispose() |
||||
{ |
||||
if (IsDisposed) { |
||||
return; |
||||
} |
||||
|
||||
IsDisposed = true; |
||||
project.PackageInstalled -= PackageInstalled; |
||||
} |
||||
|
||||
void PackageInstalled(object sender, PackageOperationEventArgs e) |
||||
{ |
||||
if (e.Package.Id != PackageId) { |
||||
return; |
||||
} |
||||
|
||||
ReadMeFile = FindReadMeFileInPackage(e.InstallPath, e.Package); |
||||
} |
||||
|
||||
string FindReadMeFileInPackage(string installPath, IPackage package) |
||||
{ |
||||
return package.GetFiles() |
||||
.Where(file => "readme.txt".Equals(file.Path, StringComparison.OrdinalIgnoreCase)) |
||||
.Select(file => Path.Combine(installPath, file.Path)) |
||||
.FirstOrDefault(); |
||||
} |
||||
|
||||
public void OpenReadMeFile() |
||||
{ |
||||
if ((ReadMeFile != null) && fileService.FileExists(ReadMeFile)) { |
||||
fileService.OpenFile(ReadMeFile); |
||||
} |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,46 @@
@@ -0,0 +1,46 @@
|
||||
// Copyright (c) 2015 AlphaSierraPapa for the SharpDevelop Team
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
// software and associated documentation files (the "Software"), to deal in the Software
|
||||
// without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
|
||||
// to whom the Software is furnished to do so, subject to the following conditions:
|
||||
//
|
||||
// The above copyright notice and this permission notice shall be included in all copies or
|
||||
// substantial portions of the Software.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
|
||||
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
||||
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
// DEALINGS IN THE SOFTWARE.
|
||||
|
||||
using System; |
||||
using ICSharpCode.PackageManagement; |
||||
|
||||
namespace PackageManagement.Tests.Helpers |
||||
{ |
||||
public class TestableInstallPackageAction : InstallPackageAction |
||||
{ |
||||
public TestableInstallPackageAction( |
||||
IPackageManagementProject project, |
||||
IPackageManagementEvents packageManagementEvents) |
||||
: base(project, packageManagementEvents) |
||||
{ |
||||
CreateOpenPackageReadMeMonitorAction = packageId => { |
||||
IOpenPackageReadMeMonitor monitor = base.CreateOpenPackageReadMeMonitor(packageId); |
||||
OpenPackageReadMeMonitor = monitor as OpenPackageReadMeMonitor; |
||||
return monitor; |
||||
}; |
||||
} |
||||
|
||||
public OpenPackageReadMeMonitor OpenPackageReadMeMonitor; |
||||
public Func<string, IOpenPackageReadMeMonitor> CreateOpenPackageReadMeMonitorAction; |
||||
|
||||
protected override IOpenPackageReadMeMonitor CreateOpenPackageReadMeMonitor(string packageId) |
||||
{ |
||||
return CreateOpenPackageReadMeMonitorAction(packageId); |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,45 @@
@@ -0,0 +1,45 @@
|
||||
// Copyright (c) 2015 AlphaSierraPapa for the SharpDevelop Team
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
// software and associated documentation files (the "Software"), to deal in the Software
|
||||
// without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
|
||||
// to whom the Software is furnished to do so, subject to the following conditions:
|
||||
//
|
||||
// The above copyright notice and this permission notice shall be included in all copies or
|
||||
// substantial portions of the Software.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
|
||||
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
||||
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
// DEALINGS IN THE SOFTWARE.
|
||||
|
||||
using System; |
||||
using ICSharpCode.PackageManagement; |
||||
|
||||
namespace PackageManagement.Tests.Helpers |
||||
{ |
||||
public class TestableUpdatePackageAction : UpdatePackageAction |
||||
{ |
||||
public TestableUpdatePackageAction( |
||||
IPackageManagementProject project, |
||||
IPackageManagementEvents packageManagementEvents) |
||||
: base(project, packageManagementEvents) |
||||
{ |
||||
CreateOpenPackageReadMeMonitorAction = packageId => { |
||||
OpenPackageReadMeMonitor = base.CreateOpenPackageReadMeMonitor(packageId) as OpenPackageReadMeMonitor; |
||||
return OpenPackageReadMeMonitor; |
||||
}; |
||||
} |
||||
|
||||
public OpenPackageReadMeMonitor OpenPackageReadMeMonitor; |
||||
public Func<string, IOpenPackageReadMeMonitor> CreateOpenPackageReadMeMonitorAction; |
||||
|
||||
protected override IOpenPackageReadMeMonitor CreateOpenPackageReadMeMonitor(string packageId) |
||||
{ |
||||
return CreateOpenPackageReadMeMonitorAction(packageId); |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,169 @@
@@ -0,0 +1,169 @@
|
||||
// Copyright (c) 2015 AlphaSierraPapa for the SharpDevelop Team
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
// software and associated documentation files (the "Software"), to deal in the Software
|
||||
// without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
|
||||
// to whom the Software is furnished to do so, subject to the following conditions:
|
||||
//
|
||||
// The above copyright notice and this permission notice shall be included in all copies or
|
||||
// substantial portions of the Software.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
|
||||
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
||||
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
// DEALINGS IN THE SOFTWARE.
|
||||
|
||||
using System; |
||||
using System.IO; |
||||
using ICSharpCode.PackageManagement; |
||||
using ICSharpCode.PackageManagement.Design; |
||||
using NuGet; |
||||
using NUnit.Framework; |
||||
using PackageManagement.Tests.Helpers; |
||||
|
||||
namespace PackageManagement.Tests |
||||
{ |
||||
[TestFixture] |
||||
public class OpenPackageReadMeMonitorTests |
||||
{ |
||||
FakeFileService fileService; |
||||
FakePackageManagementProject project; |
||||
|
||||
OpenPackageReadMeMonitor CreateMonitor(string packageId) |
||||
{ |
||||
fileService = new FakeFileService(null); |
||||
project = new FakePackageManagementProject(); |
||||
return new OpenPackageReadMeMonitor(packageId, project, fileService); |
||||
} |
||||
|
||||
FakePackage CreatePackageWithFile(string packageId, string fileName) |
||||
{ |
||||
var package = new FakePackage(packageId); |
||||
package.AddFile(fileName); |
||||
return package; |
||||
} |
||||
|
||||
PackageOperationEventArgs CreatePackageInstallEventWithFile(string installPath, IPackage package) |
||||
{ |
||||
return new PackageOperationEventArgs(package, null, installPath); |
||||
} |
||||
|
||||
[Test] |
||||
public void OpenReadMeFile_PackageInstalledWithReadmeTxt_ReadmeTxtIsOpened() |
||||
{ |
||||
const string installPath = @"d:\projects\myproject\packages\Test.1.2.0"; |
||||
string expectedFileOpened = Path.Combine(installPath, "readme.txt"); |
||||
|
||||
using (OpenPackageReadMeMonitor monitor = CreateMonitor("Test")) { |
||||
fileService.ExistingFileNames.Add(expectedFileOpened); |
||||
FakePackage package = CreatePackageWithFile("Test", "readme.txt"); |
||||
PackageOperationEventArgs e = CreatePackageInstallEventWithFile(installPath, package); |
||||
project.FirePackageInstalledEvent(e); |
||||
monitor.OpenReadMeFile(); |
||||
} |
||||
|
||||
Assert.AreEqual(expectedFileOpened, fileService.FileNamePassedToOpenFile); |
||||
} |
||||
|
||||
[Test] |
||||
public void Dispose_PackageInstalledWithReadmeTxtButOpenReadMeFileMethodIsNotCalled_ReadmeTxtIsNotOpened() |
||||
{ |
||||
const string installPath = @"d:\projects\myproject\packages\Test.1.2.0"; |
||||
string expectedFileOpened = Path.Combine(installPath, "readme.txt"); |
||||
|
||||
using (OpenPackageReadMeMonitor monitor = CreateMonitor("Test")) { |
||||
fileService.ExistingFileNames.Add(expectedFileOpened); |
||||
FakePackage package = CreatePackageWithFile("Test", "readme.txt"); |
||||
PackageOperationEventArgs e = CreatePackageInstallEventWithFile(installPath, package); |
||||
project.FirePackageInstalledEvent(e); |
||||
} |
||||
|
||||
Assert.IsFalse(fileService.IsOpenFileCalled); |
||||
} |
||||
|
||||
[Test] |
||||
public void OpenReadMeFile_PackageDependencyIsInstalledWithReadmeTxt_ReadmeTxtIsNotOpened() |
||||
{ |
||||
const string installPath = @"d:\projects\myproject\packages\Test.Dependency.1.2.0"; |
||||
string expectedFileOpened = Path.Combine(installPath, "readme.txt"); |
||||
|
||||
using (OpenPackageReadMeMonitor monitor = CreateMonitor("Test")) { |
||||
fileService.ExistingFileNames.Add(expectedFileOpened); |
||||
FakePackage package = CreatePackageWithFile("Test.Dependency", "readme.txt"); |
||||
PackageOperationEventArgs e = CreatePackageInstallEventWithFile(installPath, package); |
||||
project.FirePackageInstalledEvent(e); |
||||
monitor.OpenReadMeFile(); |
||||
} |
||||
|
||||
Assert.IsFalse(fileService.IsOpenFileCalled); |
||||
} |
||||
|
||||
[Test] |
||||
public void OpenReadMeFile_PackageInstalledWithoutReadmeTxt_ReadmeTxtIsNotOpened() |
||||
{ |
||||
const string installPath = @"d:\projects\myproject\packages\Test.1.2.0"; |
||||
string expectedFileOpened = Path.Combine(installPath, "readme.txt"); |
||||
|
||||
using (OpenPackageReadMeMonitor monitor = CreateMonitor("Test")) { |
||||
fileService.ExistingFileNames.Add(expectedFileOpened); |
||||
var package = new FakePackage("Test"); |
||||
PackageOperationEventArgs e = CreatePackageInstallEventWithFile(installPath, package); |
||||
project.FirePackageInstalledEvent(e); |
||||
monitor.OpenReadMeFile(); |
||||
} |
||||
|
||||
Assert.IsFalse(fileService.IsOpenFileCalled); |
||||
} |
||||
|
||||
[Test] |
||||
public void OpenReadMeFile_PackageDependencyIsInstalledWithReadmeTxtWithDifferentCase_ReadmeTxtIsOpened() |
||||
{ |
||||
const string installPath = @"d:\projects\myproject\packages\Test.1.2.0"; |
||||
string expectedFileOpened = Path.Combine(installPath, "ReadMe.TXT"); |
||||
|
||||
using (OpenPackageReadMeMonitor monitor = CreateMonitor("Test")) { |
||||
fileService.ExistingFileNames.Add(expectedFileOpened); |
||||
FakePackage package = CreatePackageWithFile("Test", "ReadMe.TXT"); |
||||
PackageOperationEventArgs e = CreatePackageInstallEventWithFile(installPath, package); |
||||
project.FirePackageInstalledEvent(e); |
||||
monitor.OpenReadMeFile(); |
||||
} |
||||
|
||||
Assert.AreEqual(expectedFileOpened, fileService.FileNamePassedToOpenFile); |
||||
} |
||||
|
||||
[Test] |
||||
public void OpenReadMeFile_PackageInstalledWithReadmeTxtButFileDoesNotExistOnFileSystem_ReadmeTxtIsNotOpened() |
||||
{ |
||||
const string installPath = @"d:\projects\myproject\packages\Test.1.2.0"; |
||||
string readmeFileName = Path.Combine(installPath, "readme.txt"); |
||||
|
||||
using (OpenPackageReadMeMonitor monitor = CreateMonitor("Test")) { |
||||
FakePackage package = CreatePackageWithFile("Test", "readme.txt"); |
||||
PackageOperationEventArgs e = CreatePackageInstallEventWithFile(installPath, package); |
||||
project.FirePackageInstalledEvent(e); |
||||
monitor.OpenReadMeFile(); |
||||
} |
||||
|
||||
Assert.IsFalse(fileService.IsOpenFileCalled); |
||||
} |
||||
|
||||
[Test] |
||||
public void Constructor_PackageDependencyIsInstalledWithReadmeTxt_ReadmeTxtIsNotOpenedUntilOpenReadMeFileMethodIsCalled() |
||||
{ |
||||
const string installPath = @"d:\projects\myproject\packages\Test.1.2.0"; |
||||
string expectedFileOpened = Path.Combine(installPath, "ReadMe.TXT"); |
||||
|
||||
OpenPackageReadMeMonitor monitor = CreateMonitor("Test"); |
||||
fileService.ExistingFileNames.Add(expectedFileOpened); |
||||
FakePackage package = CreatePackageWithFile("Test", "ReadMe.TXT"); |
||||
PackageOperationEventArgs e = CreatePackageInstallEventWithFile(installPath, package); |
||||
project.FirePackageInstalledEvent(e); |
||||
|
||||
Assert.IsFalse(fileService.IsOpenFileCalled); |
||||
} |
||||
} |
||||
} |
||||
Loading…
Reference in new issue