public void EmbeddedInstall_MissingResource_SucceedsWithWarningAndNoFiles()
{
// Arrange
string localCacheDir = TestUtils.CreateTestSpecificFolder(this.TestContext);
TestLogger logger = new TestLogger();
MockSonarQubeServer mockServer = CreateServerWithDummyPlugin("plugin1");
Plugin requestedPlugin = new Plugin()
{
Key = "missingPlugin", Version = "1.0", StaticResourceName = "could.be.anything"
};
EmbeddedAnalyzerInstaller testSubject = new EmbeddedAnalyzerInstaller(mockServer, localCacheDir, logger);
// Act
IEnumerable <string> actualFiles = testSubject.InstallAssemblies(new Plugin[] { requestedPlugin });
// Assert
Assert.IsNotNull(actualFiles, "Returned list should not be null");
AssertExpectedFilesReturned(Enumerable.Empty <string>(), actualFiles);
AssertExpectedFilesInCache(0, localCacheDir);
logger.AssertWarningsLogged(1);
}
public void EmbeddedInstall_MultiplePlugins_Succeeds()
{
// Arrange
var localCacheDir = TestUtils.CreateTestSpecificFolder(TestContext);
var logger = new TestLogger();
var request1 = new Plugin("no.matching.resource.plugin", "2.0", "non.existent.resource.zip");
var request2 = new Plugin("plugin1", "1.0", "p1.resource1.zip");
var request3 = new Plugin("plugin1", "1.0", "p1.resource2.zip"); // second resource for plugin 1
var request4 = new Plugin("plugin2", "2.0", "p2.resource1.zip");
var mockServer = new MockSonarQubeServer();
AddPlugin(mockServer, request2, "p1.resource1.file1.dll", "p1.resource1.file2.dll");
AddPlugin(mockServer, request3, "p1.resource2.file1.dll");
AddPlugin(mockServer, request4, "p2.resource1.dll");
var expectedPaths = new List <string>();
expectedPaths.AddRange(CalculateExpectedCachedFilePaths(localCacheDir, 1, "p1.resource1.file1.dll", "p1.resource1.file2.dll"));
expectedPaths.AddRange(CalculateExpectedCachedFilePaths(localCacheDir, 2, "p1.resource2.file1.dll"));
expectedPaths.AddRange(CalculateExpectedCachedFilePaths(localCacheDir, 3, "p2.resource1.dll"));
var testSubject = new EmbeddedAnalyzerInstaller(mockServer, localCacheDir, logger);
// Act
var actualFiles = testSubject.InstallAssemblies(new Plugin[] { request1, request2, request3, request4 });
// Assert
actualFiles.Should().NotBeNull("Returned list should not be null");
AssertExpectedFilesReturned(expectedPaths, actualFiles);
AssertExpectedFilesExist(expectedPaths);
// 4 = zip files + index file
AssertExpectedFilesInCache(expectedPaths.Count + 4, localCacheDir);
}
public void EmbeddedInstall_MultiplePlugins_Succeeds()
{
// Arrange
string localCacheDir = TestUtils.CreateTestSpecificFolder(this.TestContext);
TestLogger logger = new TestLogger();
Plugin request1 = new Plugin("no.matching.resource.plugin", "2.0", "non.existent.resource.zip");
Plugin request2 = new Plugin("plugin1", "1.0", "p1.resource1.zip");
Plugin request3 = new Plugin("plugin1", "1.0", "p1.resource2.zip"); // second resource for plugin 1
Plugin request4 = new Plugin("plugin2", "2.0", "p2.resource1.zip");
MockSonarQubeServer mockServer = new MockSonarQubeServer();
AddPlugin(mockServer, request2, "p1.resource1.file1.dll", "p1.resource1.file2.dll");
AddPlugin(mockServer, request3, "p1.resource2.file1.dll");
AddPlugin(mockServer, request4, "p2.resource1.dll");
List <string> expectedPaths = new List <string>();
expectedPaths.AddRange(CalculateExpectedCachedFilePaths(localCacheDir, request2, "p1.resource1.zip", "p1.resource1.file1.dll", "p1.resource1.file2.dll"));
expectedPaths.AddRange(CalculateExpectedCachedFilePaths(localCacheDir, request3, "p1.resource2.zip", "p1.resource2.file1.dll"));
expectedPaths.AddRange(CalculateExpectedCachedFilePaths(localCacheDir, request4, "p2.resource1.zip", "p2.resource1.dll"));
EmbeddedAnalyzerInstaller testSubject = new EmbeddedAnalyzerInstaller(mockServer, localCacheDir, logger);
// Act
IEnumerable <string> actualFiles = testSubject.InstallAssemblies(new Plugin[] { request1, request2, request3, request4 });
// Assert
Assert.IsNotNull(actualFiles, "Returned list should not be null");
AssertExpectedFilesReturned(expectedPaths, actualFiles);
AssertExpectedFilesExist(expectedPaths);
AssertExpectedFilesInCache(expectedPaths.Count, localCacheDir);
}
public void EmbeddedInstall_MissingResource_SucceedsWithWarningAndNoFiles()
{
// Arrange
var localCacheDir = TestUtils.CreateTestSpecificFolder(TestContext);
var logger = new TestLogger();
var mockServer = CreateServerWithDummyPlugin("plugin1");
var requestedPlugin = new Plugin()
{
Key = "missingPlugin", Version = "1.0", StaticResourceName = "could.be.anything"
};
var testSubject = new EmbeddedAnalyzerInstaller(mockServer, localCacheDir, logger);
// Act
var actualFiles = testSubject.InstallAssemblies(new Plugin[] { requestedPlugin });
// Assert
actualFiles.Should().NotBeNull("Returned list should not be null");
AssertExpectedFilesReturned(Enumerable.Empty <string>(), actualFiles);
AssertExpectedFilesInCache(1, localCacheDir); // the index file
logger.AssertWarningsLogged(1);
}
public void EmbeddedInstall_CachingScenarios()
{
// Arrange
var localCacheDir = TestUtils.CreateTestSpecificFolder(TestContext);
var logger = new TestLogger();
var requestA = new Plugin("p111", "1.0-SNAPSHOT", "p1.zip");
var requestB = new Plugin("p222", "9.1.3.0", "p2.zip");
var mockServer = new MockSonarQubeServer();
AddPlugin(mockServer, requestA, "aaa", "bbb");
AddPlugin(mockServer, requestB, "ccc");
var expectedPlugin111Paths = CalculateExpectedCachedFilePaths(localCacheDir, 0, "aaa", "bbb");
var expectedPlugin222Paths = CalculateExpectedCachedFilePaths(localCacheDir, 1, "ccc");
var allExpectedPaths = new List <string>(expectedPlugin111Paths);
allExpectedPaths.AddRange(expectedPlugin222Paths);
var testSubject = new EmbeddedAnalyzerInstaller(mockServer, localCacheDir, logger);
AssertExpectedFilesInCache(0, localCacheDir); // cache should be empty to start with
// 1. Empty cache -> cache miss -> server called
var actualFiles = testSubject.InstallAssemblies(new Plugin[] { requestA });
mockServer.AssertMethodCalled(DownloadEmbeddedFileMethodName, 1); // should have tried to download
AssertExpectedFilesReturned(expectedPlugin111Paths, actualFiles);
AssertExpectedFilesExist(expectedPlugin111Paths);
AssertExpectedFilesInCache(4, localCacheDir); // only files for the first request should exist
// 2. New request + request -> partial cache miss -> server called only for the new request
actualFiles = testSubject.InstallAssemblies(new Plugin[] { requestA, requestB });
mockServer.AssertMethodCalled(DownloadEmbeddedFileMethodName, 2); // new request
AssertExpectedFilesReturned(allExpectedPaths, actualFiles);
AssertExpectedFilesExist(allExpectedPaths);
AssertExpectedFilesInCache(6, localCacheDir); // files for both plugins should exist
// 3. Repeat the request -> cache hit -> server not called
actualFiles = testSubject.InstallAssemblies(new Plugin[] { requestA, requestB });
mockServer.AssertMethodCalled(DownloadEmbeddedFileMethodName, 2); // call count should not have changed
AssertExpectedFilesReturned(allExpectedPaths, actualFiles);
// 4. Clear the cache and request both -> cache miss -> multiple requests
Directory.Delete(localCacheDir, true);
Directory.Exists(localCacheDir).Should().BeFalse("Test error: failed to delete the local cache directory");
actualFiles = testSubject.InstallAssemblies(new Plugin[] { requestA, requestB });
mockServer.AssertMethodCalled(DownloadEmbeddedFileMethodName, 4); // two new requests
AssertExpectedFilesReturned(allExpectedPaths, actualFiles);
AssertExpectedFilesExist(allExpectedPaths);
AssertExpectedFilesInCache(6, localCacheDir); // files for both plugins should exist
}
private static IList <string> CalculateExpectedCachedFilePaths(string baseDir, Plugin plugin, params string[] fileNames)
{
List <string> files = new List <string>();
string pluginDir = EmbeddedAnalyzerInstaller.GetResourceSpecificDir(baseDir, plugin);
foreach (string fileName in fileNames)
{
string fullFilePath = Path.Combine(pluginDir, fileName);
files.Add(fullFilePath);
}
return(files);
}
public void EmbeddedInstall_NoPluginsSpecified_SucceedsButNoFiles()
{
// Arrange
string localCacheDir = TestUtils.CreateTestSpecificFolder(this.TestContext);
TestLogger logger = new TestLogger();
MockSonarQubeServer mockServer = CreateServerWithDummyPlugin("plugin1");
EmbeddedAnalyzerInstaller testSubject = new EmbeddedAnalyzerInstaller(mockServer, localCacheDir, logger);
// Act
IEnumerable <string> actualFiles = testSubject.InstallAssemblies(new Plugin[] { });
// Assert
Assert.IsNotNull(actualFiles, "Returned list should not be null");
AssertExpectedFilesReturned(Enumerable.Empty <string>(), actualFiles);
AssertExpectedFilesInCache(0, localCacheDir);
}
public void EmbeddedInstall_NoPluginsSpecified_SucceedsButNoFiles()
{
// Arrange
var localCacheDir = TestUtils.CreateTestSpecificFolderWithSubPaths(TestContext);
var logger = new TestLogger();
var mockServer = CreateServerWithDummyPlugin("plugin1");
var testSubject = new EmbeddedAnalyzerInstaller(mockServer, localCacheDir, logger);
// Act
var actualFiles = testSubject.InstallAssemblies(new Plugin[] { });
// Assert
actualFiles.Should().NotBeNull("Returned list should not be null");
AssertExpectedFilesReturned(Enumerable.Empty <string>(), actualFiles);
AssertExpectedFilesInCache(0, localCacheDir);
}
public void EmbeddedInstall_EmptyCacheDirectoryExists_CacheMissAndServerCalled()
{
// Arrange
string localCacheDir = TestUtils.CreateTestSpecificFolder(this.TestContext);
TestLogger logger = new TestLogger();
Plugin requestA = new Plugin("p111", "1.0-SNAPSHOT", "p1.zip");
MockSonarQubeServer mockServer = new MockSonarQubeServer();
AddPlugin(mockServer, requestA, "aaa.txt");
IList <string> expectedPlugin111Paths = CalculateExpectedCachedFilePaths(localCacheDir, requestA, "p1.zip", "aaa.txt");
Assert.AreNotEqual(0, expectedPlugin111Paths.Count, "Test setup error: expecting at least one file path");
// Create the expected directories, but not the files
foreach (string file in expectedPlugin111Paths)
{
string dir = Path.GetDirectoryName(file);
Directory.CreateDirectory(dir);
}
AssertExpectedFilesInCache(0, localCacheDir); // cache should be empty to start with
Assert.AreNotEqual(0, Directory.GetDirectories(localCacheDir, "*.*", SearchOption.AllDirectories)); // ... but should have directories
EmbeddedAnalyzerInstaller testSubject = new EmbeddedAnalyzerInstaller(mockServer, localCacheDir, logger);
// 1. Empty directory = cache miss -> server called
IEnumerable <string> actualFiles = testSubject.InstallAssemblies(new Plugin[] { requestA });
mockServer.AssertMethodCalled(DownloadEmbeddedFileMethodName, 1); // should have tried to download
AssertExpectedFilesReturned(expectedPlugin111Paths, actualFiles);
AssertExpectedFilesExist(expectedPlugin111Paths);
AssertExpectedFilesInCache(2, localCacheDir);
}
public void EmbeddedInstall_SinglePlugin_SingleResource_Succeeds()
{
// Arrange
string localCacheDir = TestUtils.CreateTestSpecificFolder(this.TestContext);
TestLogger logger = new TestLogger();
Plugin requestedPlugin = new Plugin("plugin1", "1.0", "embeddedFile1.zip");
MockSonarQubeServer mockServer = new MockSonarQubeServer();
AddPlugin(mockServer, requestedPlugin, "file1.dll", "file2.txt");
IList <string> expectedFilePaths = CalculateExpectedCachedFilePaths(localCacheDir, requestedPlugin, "embeddedFile1.zip", "file1.dll", "file2.txt");
EmbeddedAnalyzerInstaller testSubject = new EmbeddedAnalyzerInstaller(mockServer, localCacheDir, logger);
// Act
IEnumerable <string> actualFiles = testSubject.InstallAssemblies(new Plugin[] { requestedPlugin });
// Assert
Assert.IsNotNull(actualFiles, "Returned list should not be null");
AssertExpectedFilesReturned(expectedFilePaths, actualFiles);
AssertExpectedFilesExist(expectedFilePaths);
AssertExpectedFilesInCache(3, localCacheDir); // one zip containing two files
}
public void EmbeddedInstall_SinglePlugin_SingleResource_Succeeds()
{
// Arrange
var localCacheDir = TestUtils.CreateTestSpecificFolder(TestContext);
var logger = new TestLogger();
var requestedPlugin = new Plugin("plugin1", "1.0", "embeddedFile1.zip");
var mockServer = new MockSonarQubeServer();
AddPlugin(mockServer, requestedPlugin, "file1.dll", "file2.txt");
var expectedFilePaths = CalculateExpectedCachedFilePaths(localCacheDir, 0, "file1.dll", "file2.txt");
var testSubject = new EmbeddedAnalyzerInstaller(mockServer, localCacheDir, logger);
// Act
var actualFiles = testSubject.InstallAssemblies(new Plugin[] { requestedPlugin });
// Assert
actualFiles.Should().NotBeNull("Returned list should not be null");
AssertExpectedFilesReturned(expectedFilePaths, actualFiles);
AssertExpectedFilesExist(expectedFilePaths);
AssertExpectedFilesInCache(4, localCacheDir); // one zip containing two files
}
public void EmbeddedInstall_PluginWithNoFiles_Succeeds()
{
// Arrange
var localCacheDir = TestUtils.CreateTestSpecificFolder(TestContext);
var logger = new TestLogger();
var request1 = new Plugin("plugin1", "1.0", "p1.resource1.zip");
var request2 = new Plugin("plugin2", "2.0", "p2.resource1.zip");
var mockServer = new MockSonarQubeServer();
AddPlugin(mockServer, request1, "p1.resource1.file1.dll", "p1.resource1.file2.dll");
AddPlugin(mockServer, request2 /* no assemblies */);
var expectedPaths = new List <string>();
expectedPaths.AddRange(CalculateExpectedCachedFilePaths(localCacheDir, 0, "p1.resource1.file1.dll", "p1.resource1.file2.dll"));
var testSubject = new EmbeddedAnalyzerInstaller(mockServer, localCacheDir, logger);
// Act
IEnumerable <AnalyzerPlugin> actualPlugins;
using (new AssertIgnoreScope())
{
actualPlugins = testSubject.InstallAssemblies(new Plugin[] { request1, request2 });
}
// Assert
actualPlugins.Should().NotBeNull("Returned list should not be null");
AssertExpectedFilesReturned(expectedPaths, actualPlugins);
AssertExpectedFilesExist(expectedPaths);
// 5 = zip files + index file + content files
AssertExpectedFilesInCache(5, localCacheDir);
actualPlugins.Select(p => p.Key).Should().BeEquivalentTo(new string[] { "plugin1" }); // plugin with no resources should not be included
}
