public void Generate_LicenseAcceptanceNotRequestedIfNoAnalysers()
{
// No point in asking the user to accept licenses for packages that don't contain analyzers
// Arrange
string outputDir = TestUtils.CreateTestDirectory(TestContext, ".out");
string dummyContentFile = TestUtils.CreateTextFile("dummy.txt", outputDir, "non-analyzer content file");
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(TestContext);
// Parent only: requires license
remoteRepoBuilder.CreatePackage("non-analyzer.requireAccept.id", "1.0", dummyContentFile, License.Required);
TestLogger logger = new TestLogger();
AnalyzerPluginGenerator apg = CreateTestSubjectWithFakeRemoteRepo(remoteRepoBuilder, logger);
// 1. User does not accept, but no analyzers so no license prompt -> fails due absence of analyzers
ProcessedArgs args = CreateArgs("non-analyzer.requireAccept.id", "1.0", "cs", false /* accept licenses */,
false, outputDir);
bool result = apg.Generate(args);
result.Should().BeFalse("Expecting generator to fail");
logger.AssertSingleWarningExists(String.Format(UIResources.APG_NoAnalyzersFound, "non-analyzer.requireAccept.id"));
logger.AssertSingleWarningExists(UIResources.APG_NoAnalyzersInTargetSuggestRecurse);
logger.AssertWarningsLogged(2);
logger.AssertErrorsLogged(0);
}
public void Generate_NoAnalyzersFoundInPackage_GenerateFails()
{
// Arrange
string outputDir = TestUtils.CreateTestDirectory(TestContext, ".out");
TestLogger logger = new TestLogger();
// Create a fake remote repo containing a package that does not contain analyzers
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(TestContext);
remoteRepoBuilder.CreatePackage("no.analyzers.id", "0.9", TestUtils.CreateTextFile("dummy.txt", outputDir), License.NotRequired /* no dependencies */);
NuGetPackageHandler nuGetHandler = new NuGetPackageHandler(remoteRepoBuilder.FakeRemoteRepo, GetLocalNuGetDownloadDir(), logger);
AnalyzerPluginGenerator apg = new AnalyzerPluginGenerator(nuGetHandler, logger);
ProcessedArgs args = CreateArgs("no.analyzers.id", "0.9", "cs", false, false, outputDir);
// Act
bool result = apg.Generate(args);
// Assert
result.Should().BeFalse("Expecting generation to fail");
logger.AssertSingleWarningExists(String.Format(UIResources.APG_NoAnalyzersFound, "no.analyzers.id"));
logger.AssertSingleWarningExists(UIResources.APG_NoAnalyzersInTargetSuggestRecurse);
logger.AssertWarningsLogged(2);
AssertRuleTemplateDoesNotExist(outputDir);
}
public void Generate_ValidSqaleFileSpecified_TemplateFileNotCreated()
{
// Arrange
string outputDir = TestUtils.CreateTestDirectory(this.TestContext, ".out");
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(this.TestContext);
AnalyzerPluginGenerator apg = CreateTestSubjectWithFakeRemoteRepo(remoteRepoBuilder);
CreatePackageInFakeRemoteRepo(remoteRepoBuilder, "dummy.id", "1.1");
// Create a dummy sqale file
string dummySqaleFilePath = Path.Combine(outputDir, "inputSqale.xml");
SqaleModel dummySqale = new SqaleModel();
Serializer.SaveModel(dummySqale, dummySqaleFilePath);
ProcessedArgs args = CreateArgs("dummy.id", "1.1", "cs", dummySqaleFilePath, false, false, outputDir);
// Act
bool result = apg.Generate(args);
// Assert
Assert.IsTrue(result, "Expecting generation to have succeeded");
AssertSqaleTemplateDoesNotExist(outputDir);
}
public void Generate_InvalidRuleFileSpecified_GeneratorError()
{
// Arrange
var outputDir = TestUtils.CreateTestDirectory(this.TestContext, ".out");
var logger = new TestLogger();
var remoteRepoBuilder = new RemoteRepoBuilder(this.TestContext);
CreatePackageInFakeRemoteRepo(remoteRepoBuilder, "dummy.id", "1.1");
var nuGetHandler = new NuGetPackageHandler(remoteRepoBuilder.FakeRemoteRepo, GetLocalNuGetDownloadDir(), logger);
// Create an invalid rule file
var dummyRuleFilePath = Path.Combine(outputDir, "invalidRule.xml");
File.WriteAllText(dummyRuleFilePath, "not valid xml");
AnalyzerPluginGenerator apg = new AnalyzerPluginGenerator(nuGetHandler, logger);
var args = new ProcessedArgsBuilder("dummy.id", outputDir)
.SetLanguage("cs")
.SetPackageVersion("1.1")
.SetRuleFilePath(dummyRuleFilePath)
.Build();
// Act
bool result = apg.Generate(args);
// Assert
result.Should().BeFalse();
AssertRuleTemplateDoesNotExist(outputDir);
logger.AssertSingleErrorExists("invalidRule.xml"); // expecting an error containing the invalid rule file name
}
public void Generate_Recursive_Succeeds()
{
// Arrange
string outputDir = TestUtils.CreateTestDirectory(TestContext, ".out");
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(TestContext);
// Multi-level dependencies: no package requires license acceptence
IPackage grandchild = CreatePackageWithAnalyzer(remoteRepoBuilder, "grandchild.id", "1.2", License.NotRequired /* no dependencies */);
IPackage child = CreatePackageWithAnalyzer(remoteRepoBuilder, "child.id", "1.1", License.NotRequired, grandchild);
CreatePackageWithAnalyzer(remoteRepoBuilder, "parent.id", "1.0", License.NotRequired, child);
TestLogger logger = new TestLogger();
AnalyzerPluginGenerator apg = CreateTestSubjectWithFakeRemoteRepo(remoteRepoBuilder, logger);
// Act
ProcessedArgs args = CreateArgs("parent.id", "1.0", "cs", false, true /* /recurse = true */, outputDir);
bool result = apg.Generate(args);
// Assert
result.Should().BeTrue("Generator should succeed if there are no licenses to accept");
logger.AssertWarningNotLogged("parent.id"); // not expecting warnings about packages that don't require acceptance
logger.AssertWarningNotLogged("child.id");
logger.AssertWarningNotLogged("grandchild.id");
logger.AssertErrorsLogged(0);
AssertJarsGenerated(outputDir, 3);
}
public void RoslynPlugin_GenerateForDependencyAnalyzers_Succeeds()
{
// Arrange
TestLogger logger = new TestLogger();
string outputDir = TestUtils.CreateTestDirectory(TestContext, ".out");
string dummyContentFile = TestUtils.CreateTextFile("dummy.txt", outputDir, "non-analyzer content file");
// Create a valid analyzer package
RoslynAnalyzer11.CSharpAnalyzer analyzer = new RoslynAnalyzer11.CSharpAnalyzer();
string fakeRemoteNuGetDir = TestUtils.CreateTestDirectory(TestContext, ".fakeRemoteNuGet");
IPackageManager fakeRemotePkgMgr = CreatePackageManager(fakeRemoteNuGetDir);
IPackage child1 = AddPackage(fakeRemotePkgMgr, "Analyzer.Child1", "1.1.0", analyzer.GetType().Assembly.Location);
IPackage child2 = AddPackage(fakeRemotePkgMgr, "Analyzer.Child2", "1.2.0", analyzer.GetType().Assembly.Location);
IPackage targetPkg = AddPackage(fakeRemotePkgMgr, "Empty.Parent", "1.0.0", dummyContentFile, child1, child2);
string localPackageDestination = TestUtils.CreateTestDirectory(TestContext, ".localpackages");
// Act
NuGetPackageHandler nuGetHandler = new NuGetPackageHandler(fakeRemotePkgMgr.LocalRepository, localPackageDestination, logger);
AnalyzerPluginGenerator apg = new AnalyzerPluginGenerator(nuGetHandler, logger);
ProcessedArgs args = new ProcessedArgs(targetPkg.Id, targetPkg.Version, "cs", null, false,
true /* generate plugins for dependencies with analyzers*/, outputDir);
bool result = apg.Generate(args);
// Assert
result.Should().BeTrue();
// Expecting one plugin per dependency with analyzers
CheckJarGeneratedForPackage(outputDir, analyzer, child1);
CheckJarGeneratedForPackage(outputDir, analyzer, child2);
AssertJarsGenerated(outputDir, 2);
}
public void Generate_NoAnalyzersFoundInPackage_GenerateFails()
{
// Arrange
string outputDir = TestUtils.CreateTestDirectory(this.TestContext, ".out");
TestLogger logger = new TestLogger();
// Create a fake remote repo containing a package that does not contain analyzers
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(this.TestContext);
remoteRepoBuilder.CreatePackage("no.analyzers.id", "0.9", TestUtils.CreateTextFile("dummy.txt", outputDir), License.NotRequired /* no dependencies */ );
NuGetPackageHandler nuGetHandler = new NuGetPackageHandler(remoteRepoBuilder.FakeRemoteRepo, GetLocalNuGetDownloadDir(), logger);
AnalyzerPluginGenerator apg = new AnalyzerPluginGenerator(nuGetHandler, logger);
ProcessedArgs args = CreateArgs("no.analyzers.id", "0.9", "cs", null, false, false, outputDir);
// Act
bool result = apg.Generate(args);
// Assert
Assert.IsFalse(result, "Expecting generation to fail");
logger.AssertSingleWarningExists(String.Format(UIResources.APG_NoAnalyzersFound, "no.analyzers.id"));
logger.AssertSingleWarningExists(UIResources.APG_NoAnalyzersInTargetSuggestRecurse);
logger.AssertWarningsLogged(2);
AssertSqaleTemplateDoesNotExist(outputDir);
}
public void RoslynPlugin_GenerateForValidAnalyzer_Succeeds()
{
// Arrange
TestLogger logger = new TestLogger();
string outputDir = TestUtils.CreateTestDirectory(TestContext, ".out");
// Create a valid analyzer package
RoslynAnalyzer11.CSharpAnalyzer analyzer = new RoslynAnalyzer11.CSharpAnalyzer();
string packageId = "Analyzer1.Pkgid1"; // package id is not all lowercase
string fakeRemoteNuGetDir = TestUtils.CreateTestDirectory(TestContext, ".fakeRemoteNuGet");
IPackageManager fakeRemotePkgMgr = CreatePackageManager(fakeRemoteNuGetDir);
IPackage analyzerPkg = AddPackage(fakeRemotePkgMgr, packageId, "1.0.2", analyzer.GetType().Assembly.Location);
string localPackageDestination = TestUtils.CreateTestDirectory(TestContext, ".localpackages");
// Act
NuGetPackageHandler nuGetHandler = new NuGetPackageHandler(fakeRemotePkgMgr.LocalRepository, localPackageDestination, logger);
AnalyzerPluginGenerator apg = new AnalyzerPluginGenerator(nuGetHandler, logger);
ProcessedArgs args = new ProcessedArgs(packageId, new SemanticVersion("1.0.2"), "cs", null, false, false, outputDir);
bool result = apg.Generate(args);
// Assert
result.Should().BeTrue();
// Expecting one plugin per dependency with analyzers
CheckJarGeneratedForPackage(outputDir, analyzer, analyzerPkg);
AssertJarsGenerated(outputDir, 1);
}
private void CheckCanGenerateForThirdPartyAssembly(string packageId, SemanticVersion version)
{
// Arrange
var logger = new TestLogger();
var outputDir = TestUtils.CreateTestDirectory(TestContext, ".out");
var localPackageDestination = TestUtils.CreateTestDirectory(TestContext, ".localpackages");
var localRepoWithRemotePackage = InstallRemotePackageLocally(packageId, version);
// Act
var nuGetHandler = new NuGetPackageHandler(localRepoWithRemotePackage, localPackageDestination, logger);
var apg = new AnalyzerPluginGenerator(nuGetHandler, logger);
var args = new ProcessedArgs(packageId, version, "cs", null, false, false, outputDir);
var result = apg.Generate(args);
// Assert
result.Should().BeTrue();
// Expecting one plugin per dependency with analyzers
AssertJarsGenerated(outputDir, 1);
var jarFilePath = Directory.GetFiles(outputDir, "*.jar", SearchOption.TopDirectoryOnly).Single();
var jarChecker = new ZipFileChecker(TestContext, jarFilePath);
var actualManifestFilePath = jarChecker.AssertFileExists("META-INF\\MANIFEST.MF");
JarManifestReader reader = new JarManifestReader(File.ReadAllText(actualManifestFilePath));
AssertFixedValuesInManifest(reader);
}
public void Generate_InvalidSqaleFileSpecified_GeneratorError()
{
// Arrange
string outputDir = TestUtils.CreateTestDirectory(this.TestContext, ".out");
TestLogger logger = new TestLogger();
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(this.TestContext);
CreatePackageInFakeRemoteRepo(remoteRepoBuilder, "dummy.id", "1.1");
NuGetPackageHandler nuGetHandler = new NuGetPackageHandler(remoteRepoBuilder.FakeRemoteRepo, GetLocalNuGetDownloadDir(), logger);
// Create an invalid sqale file
string dummySqaleFilePath = Path.Combine(outputDir, "invalidSqale.xml");
File.WriteAllText(dummySqaleFilePath, "not valid xml");
AnalyzerPluginGenerator apg = new AnalyzerPluginGenerator(nuGetHandler, logger);
ProcessedArgs args = CreateArgs("dummy.id", "1.1", "cs", dummySqaleFilePath, false, false, outputDir);
// Act
bool result = apg.Generate(args);
// Assert
Assert.IsFalse(result, "Expecting generation to have failed");
AssertSqaleTemplateDoesNotExist(outputDir);
logger.AssertSingleErrorExists("invalidSqale.xml"); // expecting an error containing the invalid sqale file name
}
public void Generate_SqaleFileNotSpecified_TemplateFileCreated()
{
// Arrange
string outputDir = TestUtils.CreateTestDirectory(this.TestContext, ".out");
TestLogger logger = new TestLogger();
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(this.TestContext);
IPackage child1 = CreatePackageWithAnalyzer(remoteRepoBuilder, "child1.requiredAccept.id", "2.1", License.NotRequired);
IPackage child2 = CreatePackageWithAnalyzer(remoteRepoBuilder, "child2.id", "2.2", License.NotRequired);
IPackage parent = CreatePackageWithAnalyzer(remoteRepoBuilder, "parent.id", "1.0", License.NotRequired, child1, child2);
NuGetPackageHandler nuGetHandler = new NuGetPackageHandler(remoteRepoBuilder.FakeRemoteRepo, GetLocalNuGetDownloadDir(), logger);
AnalyzerPluginGenerator apg = new AnalyzerPluginGenerator(nuGetHandler, logger);
// 1. Generate a plugin for the target package only. Expecting a plugin and a template SQALE file.
ProcessedArgs args = CreateArgs("parent.id", "1.0", "cs", null, false, false, outputDir);
bool result = apg.Generate(args);
Assert.IsTrue(result, "Expecting generation to have succeeded");
AssertSqaleFileExistsForPackage(logger, outputDir, parent);
// 2. Generate a plugin for target package and all dependencies. Expecting three plugins and associated SQALE files.
logger.Reset();
args = CreateArgs("parent.id", "1.0", "cs", null, false, true /* /recurse = true */, outputDir);
result = apg.Generate(args);
Assert.IsTrue(result, "Expecting generation to have succeeded");
logger.AssertSingleWarningExists(UIResources.APG_RecurseEnabled_SQALENotEnabled);
AssertSqaleFileExistsForPackage(logger, outputDir, parent);
AssertSqaleFileExistsForPackage(logger, outputDir, child1);
AssertSqaleFileExistsForPackage(logger, outputDir, child2);
}
public void Generate_LicenseAcceptanceNotRequired_NoAnalyzersInTarget()
{
// If there are:
// No required licenses
// No analyzers in the targeted package, but analyzers in the dependencies
// We should fail due to the absence of analyzers if we are only generating a plugin for the targeted package
// We should succeed if we are generating plugins for the targeted package and its dependencies
// Arrange
string outputDir = TestUtils.CreateTestDirectory(TestContext, ".out");
string dummyContentFile = TestUtils.CreateTextFile("dummy.txt", outputDir, "non-analyzer content file");
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(TestContext);
// Multi-level dependencies: no package requires license acceptence
// Parent has no analyzers, but dependencies do
IPackage grandchild = CreatePackageWithAnalyzer(remoteRepoBuilder, "grandchild.id", "1.2", License.NotRequired /* no dependencies */);
IPackage child = CreatePackageWithAnalyzer(remoteRepoBuilder, "child.id", "1.1", License.NotRequired, grandchild);
remoteRepoBuilder.CreatePackage("parent.id", "1.0", dummyContentFile, License.NotRequired, child);
TestLogger logger = new TestLogger();
AnalyzerPluginGenerator apg = CreateTestSubjectWithFakeRemoteRepo(remoteRepoBuilder, logger);
// 1. a) Only target package. Acceptance not required -> fails due to absence of analyzers
ProcessedArgs args = CreateArgs("parent.id", "1.0", "cs", false /* accept licenses */,
false, outputDir);
bool result = apg.Generate(args);
result.Should().BeFalse("Expecting generator to fail");
logger.AssertSingleWarningExists(String.Format(UIResources.APG_NoAnalyzersFound, "parent.id"));
logger.AssertSingleWarningExists(UIResources.APG_NoAnalyzersInTargetSuggestRecurse);
logger.AssertWarningsLogged(2);
logger.AssertErrorsLogged(0);
// 1. b) Target package and dependencies. Acceptance not required -> succeeds if generate dependencies = true
logger.Reset();
args = CreateArgs("parent.id", "1.0", "cs", false /* accept licenses */,
true /* generate plugins for dependencies */, outputDir);
result = apg.Generate(args);
result.Should().BeTrue("Generator should succeed if there are no licenses to accept");
logger.AssertSingleWarningExists(String.Format(UIResources.APG_NoAnalyzersFound, "parent.id"));
logger.AssertWarningNotLogged("child.id");
logger.AssertWarningNotLogged("grandchild.id");
logger.AssertWarningsLogged(2);
logger.AssertErrorsLogged(0);
}
public void RoslynPlugin_GenerateForValidAnalyzer_Succeeds()
{
// Arrange
TestLogger logger = new TestLogger();
string outputDir = TestUtils.CreateTestDirectory(this.TestContext, ".out");
PluginInspector inspector = CreatePluginInspector(logger);
// Create a valid analyzer package
ExampleAnalyzer1.CSharpAnalyzer analyzer = new ExampleAnalyzer1.CSharpAnalyzer();
string packageId = "analyzer1.id1";
string localNuGetDir = TestUtils.CreateTestDirectory(this.TestContext, ".localNuGet");
IPackageManager localNuGetStore = CreatePackageManager(localNuGetDir);
AddPackage(localNuGetStore, packageId, "1.0", analyzer.GetType().Assembly.Location);
// Act
NuGetPackageHandler nuGetHandler = new NuGetPackageHandler(localNuGetDir, logger);
AnalyzerPluginGenerator apg = new AnalyzerPluginGenerator(nuGetHandler, logger);
bool result = apg.Generate(new Roslyn.CommandLine.NuGetReference(packageId, new SemanticVersion("1.0")), "cs", null, outputDir);
// Assert
Assert.IsTrue(result);
string jarFilePath = AssertPluginJarExists(outputDir);
JarInfo jarInfo = inspector.GetPluginDescription(jarFilePath);
if (jarInfo != null)
{
this.TestContext.AddResultFile(jarInfo.FileName);
}
Assert.IsNotNull(jarInfo, "Failed to process the generated jar successfully");
AssertPropertyDefinitionExists(packageId + "_sarif.AnalyzerId", jarInfo);
AssertPropertyDefinitionExists(packageId + "_sarif.RuleNamespace", jarInfo);
AssertPropertyDefinitionExists(packageId + "_sarif.nuget.packageId", jarInfo);
AssertPropertyDefinitionExists(packageId + "_sarif.nuget.packageVersion", jarInfo);
JarInfo.RulesDefinition rulesDefn = AssertRulesDefinitionExists(jarInfo);
AssertRepositoryIsValid(rulesDefn.Repository);
AssertExpectedRulesExist(analyzer, rulesDefn.Repository);
Assert.AreEqual(5, jarInfo.Extensions.Count, "Unexpected number of extensions");
}
public void CreatePluginManifest_Owners_NotAvailable()
{
// When the package.Owners field is null, we should fallback to Authors for setting the organization.
// Arrange
DataServicePackage testPackage = CreateTestDataServicePackage();
testPackage.Owners = null;
testPackage.Authors = "Foo,Bar,Test";
// Act
PluginManifest actualPluginManifest = AnalyzerPluginGenerator.CreatePluginManifest(testPackage);
// Assert
actualPluginManifest.Should().NotBeNull();
actualPluginManifest.Organization.Should().Be(testPackage.Authors);
}
public void CreatePluginManifest_FriendlyLicenseName_NotAvailable()
{
// When a short licensename is not assigned by NuGet.org, we should try to use the license URL instead.
// Arrange
DataServicePackage testPackage = CreateTestDataServicePackage();
testPackage.LicenseNames = null;
testPackage.LicenseUrl = new Uri("http://foo.bar");
// Act
PluginManifest actualPluginManifest = AnalyzerPluginGenerator.CreatePluginManifest(testPackage);
// Assert
actualPluginManifest.Should().NotBeNull();
actualPluginManifest.License.Should().Be(testPackage.LicenseUrl.ToString());
}
public void CreatePluginManifest_FromLocalPackage()
{
// We should also be able to create a plugin manifest from an IPackage that is not a DataServicePackage
// Arrange
string outputDir = TestUtils.CreateTestDirectory(TestContext, ".out");
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(TestContext);
IPackage testPackage = remoteRepoBuilder.CreatePackage("Foo.Bar", "1.0.0", TestUtils.CreateTextFile("dummy.txt", outputDir), License.NotRequired);
// Act
PluginManifest actualPluginManifest = AnalyzerPluginGenerator.CreatePluginManifest(testPackage);
// Assert
actualPluginManifest.Should().NotBeNull();
actualPluginManifest.License.Should().Be(testPackage.LicenseUrl.ToString());
}
public void CreatePluginManifest_TitleMissing()
{
// When no title is available, ID should be used as a fallback, removing the dot separators for legibility.
// Arrange
DataServicePackage testPackage = CreateTestDataServicePackage();
testPackage.Title = null;
testPackage.Id = "Foo.Bar.Test";
// Act
PluginManifest actualPluginManifest = AnalyzerPluginGenerator.CreatePluginManifest(testPackage);
// Assert
actualPluginManifest.Should().NotBeNull();
actualPluginManifest.Name.Should().Be("Foo Bar Test");
}
public void CreatePluginManifest_FriendlyLicenseName_Available()
{
// When available, a short licensename assigned by NuGet.org should be used.
// The license url is a fallback only.
// Arrange
DataServicePackage testPackage = CreateTestDataServicePackage();
testPackage.LicenseNames = "Foo Bar License";
testPackage.LicenseUrl = new Uri("http://foo.bar");
// Act
PluginManifest actualPluginManifest = AnalyzerPluginGenerator.CreatePluginManifest(testPackage);
// Assert
actualPluginManifest.Should().NotBeNull();
actualPluginManifest.License.Should().Be(testPackage.LicenseNames);
}
public void Generate_LicenseAcceptanceRequired_ByParentAndDependencies()
{
// Arrange
string outputDir = TestUtils.CreateTestDirectory(TestContext, ".out");
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(TestContext);
// Multi-level: parent and some but not all dependencies require license acceptance
IPackage grandchild1 = CreatePackageWithAnalyzer(remoteRepoBuilder, "grandchild1.requiredAccept.id", "3.0", License.Required);
IPackage child1 = CreatePackageWithAnalyzer(remoteRepoBuilder, "child1.requiredAccept.id", "2.1", License.Required);
IPackage child2 = CreatePackageWithAnalyzer(remoteRepoBuilder, "child2.id", "2.2", License.NotRequired, grandchild1);
CreatePackageWithAnalyzer(remoteRepoBuilder, "parent.requiredAccept.id", "1.0", License.Required, child1, child2);
TestLogger logger = new TestLogger();
AnalyzerPluginGenerator apg = CreateTestSubjectWithFakeRemoteRepo(remoteRepoBuilder, logger);
// 1. a) Only target package. User does not accept -> fails with error
ProcessedArgs args = CreateArgs("parent.requiredAccept.id", "1.0", "cs", false /* accept licenses */,
false, outputDir);
bool result = apg.Generate(args);
result.Should().BeFalse("Generator should fail because license has not been accepted");
logger.AssertSingleErrorExists("parent.requiredAccept.id", "1.0"); // error referring to the main package
logger.AssertSingleWarningExists("grandchild1.requiredAccept.id", "3.0"); // warning for each licensed package
logger.AssertSingleWarningExists("child1.requiredAccept.id", "2.1");
logger.AssertSingleWarningExists("parent.requiredAccept.id", "1.0");
// 2. User accepts -> succeeds with warnings
logger.Reset();
args = CreateArgs("parent.requiredAccept.id", "1.0", "cs", true /* accept licenses */,
false, outputDir);
result = apg.Generate(args);
result.Should().BeTrue("Generator should succeed if licenses are accepted");
logger.AssertSingleWarningExists(UIResources.APG_NGAcceptedPackageLicenses); // warning that licenses have been accepted
logger.AssertSingleWarningExists("grandchild1.requiredAccept.id", "3.0"); // warning for each licensed package
logger.AssertSingleWarningExists("child1.requiredAccept.id", "2.1");
logger.AssertSingleWarningExists("parent.requiredAccept.id", "1.0");
logger.AssertWarningsLogged(4);
}
public void Generate_RulesFileNotSpecified_TemplateFileCreated()
{
// Arrange
string outputDir = TestUtils.CreateTestDirectory(this.TestContext, ".out");
var logger = new TestLogger();
var remoteRepoBuilder = new RemoteRepoBuilder(this.TestContext);
var child1 = CreatePackageWithAnalyzer(remoteRepoBuilder, "child1.requiredAccept.id", "2.1", License.NotRequired);
var child2 = CreatePackageWithAnalyzer(remoteRepoBuilder, "child2.id", "2.2", License.NotRequired);
var parent = CreatePackageWithAnalyzer(remoteRepoBuilder, "parent.id", "1.0", License.NotRequired, child1, child2);
var nuGetHandler = new NuGetPackageHandler(remoteRepoBuilder.FakeRemoteRepo, GetLocalNuGetDownloadDir(), logger);
var testSubject = new AnalyzerPluginGenerator(nuGetHandler, logger);
// 1. Generate a plugin for the target package only. Expecting a plugin and a template rule file.
var args = new ProcessedArgsBuilder("parent.id", outputDir)
.SetLanguage("cs")
.SetPackageVersion("1.0")
.SetRecurseDependencies(true)
.Build();
bool result = testSubject.Generate(args);
result.Should().BeTrue();
AssertRuleTemplateFileExistsForPackage(logger, outputDir, parent);
// 2. Generate a plugin for target package and all dependencies. Expecting three plugins and associated rule files.
logger.Reset();
args = CreateArgs("parent.id", "1.0", "cs", false, true /* /recurse = true */, outputDir);
result = testSubject.Generate(args);
result.Should().BeTrue();
logger.AssertSingleWarningExists(UIResources.APG_RecurseEnabled_RuleCustomizationNotEnabled);
AssertRuleTemplateFileExistsForPackage(logger, outputDir, parent);
AssertRuleTemplateFileExistsForPackage(logger, outputDir, child1);
AssertRuleTemplateFileExistsForPackage(logger, outputDir, child2);
}
public void CreatePluginManifest_AllProperties()
{
// All properties present, all properties expected.
// Arrange
DataServicePackage testPackage = CreateTestDataServicePackage();
testPackage.Description = "Test Description";
testPackage.Authors = "TestAuthor1,TestAuthor2";
testPackage.ProjectUrl = new Uri("http://test.project.url");
testPackage.Id = "Test.Id";
testPackage.Title = "Test Title";
testPackage.Owners = "TestOwner1,TestOwner2";
testPackage.Version = "1.1.1-RC5";
testPackage.LicenseUrl = new Uri("http://test.license.url");
testPackage.LicenseNames = "Test License1;Test License2";
// Act
PluginManifest actualPluginManifest = AnalyzerPluginGenerator.CreatePluginManifest(testPackage);
// Assert
actualPluginManifest.Should().NotBeNull();
actualPluginManifest.Description.Should().Be(testPackage.Description);
actualPluginManifest.Developers.Should().Be(testPackage.Authors);
actualPluginManifest.Homepage.Should().Be(testPackage.ProjectUrl.ToString());
actualPluginManifest.Key.Should().Be(PluginKeyUtilities.GetValidKey(testPackage.Id));
actualPluginManifest.Name.Should().Be(testPackage.Title);
actualPluginManifest.Organization.Should().Be(testPackage.Owners);
actualPluginManifest.Version.Should().Be(testPackage.Version);
actualPluginManifest.TermsConditionsUrl.Should().Be(testPackage.LicenseUrl.ToString());
actualPluginManifest.License.Should().Be(testPackage.LicenseNames);
}
public void Generate_LicenseAcceptanceRequiredByDependency()
{
// Arrange
string outputDir = TestUtils.CreateTestDirectory(TestContext, ".out");
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(TestContext);
// Parent and child: only child requires license
IPackage child = CreatePackageWithAnalyzer(remoteRepoBuilder, "child.requiredAccept.id", "2.0", License.Required);
CreatePackageWithAnalyzer(remoteRepoBuilder, "parent.id", "1.0", License.NotRequired, child);
TestLogger logger = new TestLogger();
AnalyzerPluginGenerator apg = CreateTestSubjectWithFakeRemoteRepo(remoteRepoBuilder, logger);
// 1. User does not accept -> fails with error
ProcessedArgs args = CreateArgs("parent.id", "1.0", "cs", false /* accept licenses */,
false, outputDir);
bool result = apg.Generate(args);
result.Should().BeFalse("Generator should fail because license has not been accepted");
logger.AssertSingleErrorExists("parent.id", "1.0"); // error listing the main package
logger.AssertSingleWarningExists("child.requiredAccept.id", "2.0"); // warning for each licensed package
logger.AssertWarningsLogged(1);
// 2. User accepts -> succeeds with warnings
logger.Reset();
args = CreateArgs("parent.id", "1.0", "cs", true /* accept licenses */,
false, outputDir);
result = apg.Generate(args);
result.Should().BeTrue("Generator should succeed if licenses are accepted");
logger.AssertSingleWarningExists(UIResources.APG_NGAcceptedPackageLicenses); // warning that licenses have been accepted
logger.AssertSingleWarningExists("child.requiredAccept.id", "2.0"); // warning for each licensed package
logger.AssertWarningsLogged(2);
logger.AssertErrorsLogged(0);
}
public void Generate_LicenseAcceptanceRequired_NoAnalysersInTarget()
{
// If there are:
// Required licenses
// No analyzers in the targeted package, but analyzers in the dependencies
// We should fail due to the absence of analyzers if we are only generating a plugin for the targeted package
// We should fail with an error due to licenses if we are generating plugins for the targeted package and dependencies
// Arrange
string outputDir = TestUtils.CreateTestDirectory(TestContext, ".out");
string dummyContentFile = TestUtils.CreateTextFile("dummy.txt", outputDir, "non-analyzer content file");
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(TestContext);
// Multi-level: parent and some but not all dependencies require license acceptance
// Parent has no analyzers, but dependencies do
IPackage child1 = CreatePackageWithAnalyzer(remoteRepoBuilder, "child1.requiredAccept.id", "2.1", License.Required);
IPackage child2 = CreatePackageWithAnalyzer(remoteRepoBuilder, "child2.id", "2.2", License.NotRequired);
remoteRepoBuilder.CreatePackage("non-analyzer.parent.requireAccept.id", "1.0", dummyContentFile, License.Required, child1, child2);
TestLogger logger = new TestLogger();
AnalyzerPluginGenerator apg = CreateTestSubjectWithFakeRemoteRepo(remoteRepoBuilder, logger);
// 1. a) Only target package. User does not accept, but no analyzers so no license prompt -> fails due to absence of analyzers
ProcessedArgs args = CreateArgs("non-analyzer.parent.requireAccept.id", "1.0", "cs", false /* accept licenses */,
false, outputDir);
bool result = apg.Generate(args);
result.Should().BeFalse("Expecting generator to fail");
logger.AssertSingleWarningExists(String.Format(UIResources.APG_NoAnalyzersFound, "non-analyzer.parent.requireAccept.id"));
logger.AssertSingleWarningExists(UIResources.APG_NoAnalyzersInTargetSuggestRecurse);
logger.AssertWarningsLogged(2);
logger.AssertErrorsLogged(0);
// 1. b) Target package and dependencies. User does not accept.
// No analyzers in the target package, but analyzers in the dependencies -> fails with error
logger.Reset();
args = CreateArgs("non-analyzer.parent.requireAccept.id", "1.0", "cs", false /* accept licenses */,
true /* generate plugins for dependencies */, outputDir);
result = apg.Generate(args);
result.Should().BeFalse("Generator should fail because license has not been accepted");
logger.AssertSingleWarningExists(String.Format(UIResources.APG_NoAnalyzersFound, "non-analyzer.parent.requireAccept.id"));
logger.AssertSingleWarningExists("non-analyzer.parent.requireAccept.id", "1.0"); // warning for each licensed package
logger.AssertSingleWarningExists(child1.Id, child1.Version.ToString());
logger.AssertWarningsLogged(3);
logger.AssertSingleErrorExists("non-analyzer.parent.requireAccept.id", "1.0"); // error listing the main package
logger.AssertErrorsLogged(1);
// 2. b) Target package and dependencies. User accepts.
// No analyzers in the target package, but analyzers in the dependencies -> succeeds with warnings
logger.Reset();
args = CreateArgs("non-analyzer.parent.requireAccept.id", "1.0", "cs", true /* accept licenses */,
true /* generate plugins for dependencies */, outputDir);
result = apg.Generate(args);
result.Should().BeTrue("Generator should succeed if licenses are accepted");
logger.AssertSingleWarningExists(String.Format(UIResources.APG_NoAnalyzersFound, "non-analyzer.parent.requireAccept.id"));
logger.AssertSingleWarningExists(UIResources.APG_NGAcceptedPackageLicenses); // warning that licenses have been accepted
logger.AssertSingleWarningExists("non-analyzer.parent.requireAccept.id", "1.0"); // warning for each licensed package
logger.AssertSingleWarningExists(child1.Id, child1.Version.ToString());
logger.AssertWarningsLogged(5);
logger.AssertErrorsLogged(0);
}
public void Generate_InvalidSqaleFileSpecified_GeneratorError()
{
// Arrange
string outputDir = TestUtils.CreateTestDirectory(this.TestContext, ".out");
TestLogger logger = new TestLogger();
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(this.TestContext);
CreatePackageInFakeRemoteRepo(remoteRepoBuilder, "dummy.id", "1.1");
NuGetPackageHandler nuGetHandler = new NuGetPackageHandler(remoteRepoBuilder.FakeRemoteRepo, GetLocalNuGetDownloadDir(), logger);
// Create an invalid sqale file
string dummySqaleFilePath = Path.Combine(outputDir, "invalidSqale.xml");
File.WriteAllText(dummySqaleFilePath, "not valid xml");
AnalyzerPluginGenerator apg = new AnalyzerPluginGenerator(nuGetHandler, logger);
ProcessedArgs args = CreateArgs("dummy.id", "1.1", "cs", dummySqaleFilePath, false, outputDir);
// Act
bool result = apg.Generate(args);
// Assert
Assert.IsFalse(result, "Expecting generation to have failed");
AssertSqaleTemplateDoesNotExist(outputDir);
logger.AssertSingleErrorExists("invalidSqale.xml"); // expecting an error containing the invalid sqale file name
}
public void Generate_SqaleFileNotSpecified_TemplateFileCreated()
{
// Arrange
string outputDir = TestUtils.CreateTestDirectory(this.TestContext, ".out");
TestLogger logger = new TestLogger();
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(this.TestContext);
CreatePackageInFakeRemoteRepo(remoteRepoBuilder, "dummy.id", "1.1");
NuGetPackageHandler nuGetHandler = new NuGetPackageHandler(remoteRepoBuilder.FakeRemoteRepo, GetLocalNuGetDownloadDir(), logger);
string expectedTemplateSqaleFilePath = Path.Combine(outputDir, "dummy.id.1.1.sqale.template.xml");
AnalyzerPluginGenerator apg = new AnalyzerPluginGenerator(nuGetHandler, logger);
ProcessedArgs args = CreateArgs("dummy.id", "1.1", "cs", null, false, outputDir);
// Act
bool result = apg.Generate(args);
// Assert
Assert.IsTrue(result, "Expecting generation to have succeeded");
Assert.IsTrue(File.Exists(expectedTemplateSqaleFilePath), "Expecting a template sqale file to have been created");
this.TestContext.AddResultFile(expectedTemplateSqaleFilePath);
logger.AssertSingleInfoMessageExists(expectedTemplateSqaleFilePath); // should be a message about the generated file
}
public void Generate_SqaleFileNotSpecified_TemplateFileCreated()
{
// Arrange
string outputDir = TestUtils.CreateTestDirectory(this.TestContext, ".out");
TestLogger logger = new TestLogger();
RemoteRepoBuilder remoteRepoBuilder = new RemoteRepoBuilder(this.TestContext);
IPackage child1 = CreatePackageWithAnalyzer(remoteRepoBuilder, "child1.requiredAccept.id", "2.1", License.NotRequired);
IPackage child2 = CreatePackageWithAnalyzer(remoteRepoBuilder, "child2.id", "2.2", License.NotRequired);
IPackage parent = CreatePackageWithAnalyzer(remoteRepoBuilder, "parent.id", "1.0", License.NotRequired, child1, child2);
NuGetPackageHandler nuGetHandler = new NuGetPackageHandler(remoteRepoBuilder.FakeRemoteRepo, GetLocalNuGetDownloadDir(), logger);
AnalyzerPluginGenerator apg = new AnalyzerPluginGenerator(nuGetHandler, logger);
// 1. Generate a plugin for the target package only. Expecting a plugin and a template SQALE file.
ProcessedArgs args = CreateArgs("parent.id", "1.0", "cs", null, false, false, outputDir);
bool result = apg.Generate(args);
Assert.IsTrue(result, "Expecting generation to have succeeded");
AssertSqaleFileExistsForPackage(logger, outputDir, parent);
// 2. Generate a plugin for target package and all dependencies. Expecting three plugins and associated SQALE files.
logger.Reset();
args = CreateArgs("parent.id", "1.0", "cs", null, false, true /* /recurse = true */, outputDir);
result = apg.Generate(args);
Assert.IsTrue(result, "Expecting generation to have succeeded");
logger.AssertSingleWarningExists(UIResources.APG_RecurseEnabled_SQALENotEnabled);
AssertSqaleFileExistsForPackage(logger, outputDir, parent);
AssertSqaleFileExistsForPackage(logger, outputDir, child1);
AssertSqaleFileExistsForPackage(logger, outputDir, child2);
}
