public void AnalysisConfGen_Simple()
{
// Arrange
string analysisDir = TestUtils.CreateTestSpecificFolder(this.TestContext);
TestLogger logger = new TestLogger();
ListPropertiesProvider propertyProvider = new ListPropertiesProvider();
propertyProvider.AddProperty(SonarProperties.HostUrl, "http://foo");
ProcessedArgs args = new ProcessedArgs("valid.key", "valid.name", "1.0", false, EmptyPropertyProvider.Instance, propertyProvider);
TeamBuildSettings tbSettings = TeamBuildSettings.CreateNonTeamBuildSettingsForTesting(analysisDir);
Dictionary <string, string> serverSettings = new Dictionary <string, string>();
serverSettings.Add("server.key.1", "server.value.1");
AnalyzerSettings analyzerSettings = new AnalyzerSettings();
analyzerSettings.RuleSetFilePath = "c:\\xxx.ruleset";
analyzerSettings.AdditionalFilePaths = new List <string>();
analyzerSettings.AdditionalFilePaths.Add("f:\\additionalPath1.txt");
analyzerSettings.AnalyzerAssemblyPaths = new List <string>();
analyzerSettings.AnalyzerAssemblyPaths.Add("f:\\temp\\analyzer1.dll");
List <AnalyzerSettings> analyzersSettings = new List <AnalyzerSettings>();
analyzersSettings.Add(analyzerSettings);
Directory.CreateDirectory(tbSettings.SonarConfigDirectory); // config directory needs to exist
// Act
AnalysisConfig actualConfig = AnalysisConfigGenerator.GenerateFile(args, tbSettings, serverSettings, analyzersSettings, logger);
// Assert
AssertConfigFileExists(actualConfig);
logger.AssertErrorsLogged(0);
logger.AssertWarningsLogged(0);
Assert.AreEqual("valid.key", actualConfig.SonarProjectKey);
Assert.AreEqual("valid.name", actualConfig.SonarProjectName);
Assert.AreEqual("1.0", actualConfig.SonarProjectVersion);
Assert.AreEqual("http://foo", actualConfig.SonarQubeHostUrl);
Assert.AreEqual(tbSettings.SonarBinDirectory, actualConfig.SonarBinDir);
Assert.AreEqual(tbSettings.SonarConfigDirectory, actualConfig.SonarConfigDir);
Assert.AreEqual(tbSettings.SonarOutputDirectory, actualConfig.SonarOutputDir);
Assert.AreEqual(tbSettings.SonarScannerWorkingDirectory, actualConfig.SonarScannerWorkingDirectory);
Assert.AreEqual(tbSettings.BuildUri, actualConfig.GetBuildUri());
Assert.AreEqual(tbSettings.TfsUri, actualConfig.GetTfsUri());
Assert.IsNotNull(actualConfig.ServerSettings);
Property serverProperty = actualConfig.ServerSettings.SingleOrDefault(s => string.Equals(s.Id, "server.key.1", System.StringComparison.Ordinal));
Assert.IsNotNull(serverProperty);
Assert.AreEqual("server.value.1", serverProperty.Value);
Assert.AreSame(analyzerSettings, actualConfig.AnalyzersSettings[0]);
}
public void GenerateFile_WhenBuildSettingsNull_ThrowArgumentNullException()
{
// Arrange
Action act = () => AnalysisConfigGenerator.GenerateFile(new ProcessedArgs("key", "name", "version", "org", false,
EmptyPropertyProvider.Instance, EmptyPropertyProvider.Instance, EmptyPropertyProvider.Instance), null,
new Dictionary <string, string>(), new List <AnalyzerSettings>(), new MockSonarQubeServer(), new TestLogger());
// Act & Assert
act.Should().ThrowExactly <ArgumentNullException>().And.ParamName.Should().Be("buildSettings");
}
public void GenerateFile_WhenLocalSettingsNull_ThrowArgumentNullException()
{
// Arrange
var analysisDir = TestUtils.CreateTestSpecificFolderWithSubPaths(TestContext);
var tbSettings = TeamBuildSettings.CreateNonTeamBuildSettingsForTesting(analysisDir);
Action act = () => AnalysisConfigGenerator.GenerateFile(null, tbSettings, new Dictionary <string, string>(),
new List <AnalyzerSettings>(), new MockSonarQubeServer(), new TestLogger());
// Act & Assert
act.Should().ThrowExactly <ArgumentNullException>().And.ParamName.Should().Be("localSettings");
}
public void AnalysisConfGen_FileProperties()
{
// File properties should not be copied to the file.
// Instead, a pointer to the file should be created.
// Arrange
var analysisDir = TestUtils.CreateTestSpecificFolderWithSubPaths(TestContext);
var logger = new TestLogger();
// The set of file properties to supply
var fileProperties = new AnalysisProperties
{
new Property()
{
Id = SonarProperties.HostUrl, Value = "http://myserver"
},
new Property()
{
Id = "file.only", Value = "file value"
}
};
var settingsFilePath = Path.Combine(analysisDir, "settings.txt");
fileProperties.Save(settingsFilePath);
var fileProvider = FilePropertyProvider.Load(settingsFilePath);
var args = new ProcessedArgs("key", "name", "version", "organization", false, EmptyPropertyProvider.Instance, fileProvider, EmptyPropertyProvider.Instance, logger);
var settings = TeamBuildSettings.CreateNonTeamBuildSettingsForTesting(analysisDir);
Directory.CreateDirectory(settings.SonarConfigDirectory); // config directory needs to exist
// Act
var actualConfig = AnalysisConfigGenerator.GenerateFile(args, settings, new Dictionary <string, string>(), new List <AnalyzerSettings>(), new MockSonarQubeServer(), logger);
// Assert
AssertConfigFileExists(actualConfig);
logger.AssertErrorsLogged(0);
logger.AssertWarningsLogged(0);
var actualSettingsFilePath = actualConfig.GetSettingsFilePath();
actualSettingsFilePath.Should().Be(settingsFilePath, "Unexpected settings file path");
// Check the file setting value do not appear in the config file
AssertFileDoesNotContainText(actualConfig.FileName, "file.only");
actualConfig.SourcesDirectory.Should().Be(settings.SourcesDirectory);
actualConfig.SonarScannerWorkingDirectory.Should().Be(settings.SonarScannerWorkingDirectory);
AssertExpectedLocalSetting(SonarProperties.Organization, "organization", actualConfig);
}
public void GenerateFile_WhenLoggerNull_ThrowArgumentNullException()
{
// Arrange
var analysisDir = TestUtils.CreateTestSpecificFolder(TestContext);
var tbSettings = TeamBuildSettings.CreateNonTeamBuildSettingsForTesting(analysisDir);
Action act = () => AnalysisConfigGenerator.GenerateFile(new ProcessedArgs("key", "name", "version", "org", false,
EmptyPropertyProvider.Instance, EmptyPropertyProvider.Instance, EmptyPropertyProvider.Instance), tbSettings,
new Dictionary <string, string>(), new List <AnalyzerSettings>(), new MockSonarQubeServer(), null);
// Act & Assert
act.Should().ThrowExactly <ArgumentNullException>().And.ParamName.Should().Be("logger");
}
public void AnalysisConfGen_FileProperties()
{
// File properties should not be copied to the file.
// Instead, a pointer to the file should be created.
// Arrange
string analysisDir = TestUtils.CreateTestSpecificFolder(this.TestContext);
TestLogger logger = new TestLogger();
// The set of file properties to supply
AnalysisProperties fileProperties = new AnalysisProperties();
fileProperties.Add(new Property()
{
Id = SonarProperties.HostUrl, Value = "http://myserver"
});
fileProperties.Add(new Property()
{
Id = "file.only", Value = "file value"
});
string settingsFilePath = Path.Combine(analysisDir, "settings.txt");
fileProperties.Save(settingsFilePath);
FilePropertyProvider fileProvider = FilePropertyProvider.Load(settingsFilePath);
ProcessedArgs args = new ProcessedArgs("key", "name", "version", false, EmptyPropertyProvider.Instance, fileProvider);
TeamBuildSettings settings = TeamBuildSettings.CreateNonTeamBuildSettingsForTesting(analysisDir);
Directory.CreateDirectory(settings.SonarConfigDirectory); // config directory needs to exist
// Act
AnalysisConfig actualConfig = AnalysisConfigGenerator.GenerateFile(args, settings, new Dictionary <string, string>(), logger);
// Assert
AssertConfigFileExists(actualConfig);
logger.AssertErrorsLogged(0);
logger.AssertWarningsLogged(0);
string actualSettingsFilePath = actualConfig.GetSettingsFilePath();
Assert.AreEqual(settingsFilePath, actualSettingsFilePath, "Unexpected settings file path");
// Check the file setting value do not appear in the config file
AssertFileDoesNotContainText(actualConfig.FileName, "file.only");
Assert.AreEqual(settings.SonarRunnerWorkingDirectory, actualConfig.SonarRunnerWorkingDirectory);
}
public void AnalysisConfGen_WhenLoginNotSpecified_DoesNotStoreThatItWasSpecified()
{
// Arrange
var analysisDir = TestUtils.CreateTestSpecificFolderWithSubPaths(TestContext);
var logger = new TestLogger();
var settings = TeamBuildSettings.CreateNonTeamBuildSettingsForTesting(analysisDir);
Directory.CreateDirectory(settings.SonarConfigDirectory); // config directory needs to exist
var args = new ProcessedArgs("valid.key", "valid.name", "1.0", null, false, EmptyPropertyProvider.Instance, EmptyPropertyProvider.Instance, EmptyPropertyProvider.Instance, logger);
// Act
var config = AnalysisConfigGenerator.GenerateFile(args, settings, new Dictionary <string, string>(), new List <AnalyzerSettings>(), new MockSonarQubeServer(), logger);
// Assert
AssertConfigFileExists(config);
config.HasBeginStepCommandLineCredentials.Should().BeFalse();
}
public void GenerateFile_WritesSonarQubeVersion()
{
// Arrange
var analysisDir = TestUtils.CreateTestSpecificFolder(TestContext);
var settings = TeamBuildSettings.CreateNonTeamBuildSettingsForTesting(analysisDir);
var args = new ProcessedArgs("valid.key", "valid.name", "1.0", null, false, EmptyPropertyProvider.Instance, EmptyPropertyProvider.Instance, EmptyPropertyProvider.Instance);
var sonarqubeServer = new MockSonarQubeServer();
sonarqubeServer.Data.SonarQubeVersion = new Version(1, 2, 3, 4);
Directory.CreateDirectory(settings.SonarConfigDirectory); // config directory needs to exist
// Act
var config = AnalysisConfigGenerator.GenerateFile(args, settings, new Dictionary <string, string>(), new List <AnalyzerSettings>(), sonarqubeServer, new TestLogger());
// Assert
config.SonarQubeVersion.Should().Be("1.2.3.4");
}
[WorkItem(127)] // Do not store the db and server credentials in the config files: http://jira.sonarsource.com/browse/SONARMSBRU-127
public void AnalysisConfGen_AnalysisConfigDoesNotContainSensitiveData()
{
// Arrange
var analysisDir = TestUtils.CreateTestSpecificFolderWithSubPaths(TestContext);
var logger = new TestLogger();
var cmdLineArgs = new ListPropertiesProvider();
// Public args - should be written to the config file
cmdLineArgs.AddProperty("sonar.host.url", "http://host");
cmdLineArgs.AddProperty("public.key", "public value");
cmdLineArgs.AddProperty("sonar.user.license.secured", "user input license");
cmdLineArgs.AddProperty("server.key.secured.xxx", "not really secure");
cmdLineArgs.AddProperty("sonar.value", "value.secured");
// Sensitive values - should not be written to the config file
cmdLineArgs.AddProperty(SonarProperties.DbPassword, "secret db password");
// Create a settings file with public and sensitive data
var fileSettings = new AnalysisProperties
{
new Property()
{
Id = "file.public.key", Value = "file public value"
},
new Property()
{
Id = SonarProperties.DbUserName, Value = "secret db user"
},
new Property()
{
Id = SonarProperties.DbPassword, Value = "secret db password"
}
};
var fileSettingsPath = Path.Combine(analysisDir, "fileSettings.txt");
fileSettings.Save(fileSettingsPath);
var fileProvider = FilePropertyProvider.Load(fileSettingsPath);
var args = new ProcessedArgs("key", "name", "1.0", null, false, cmdLineArgs, fileProvider, EmptyPropertyProvider.Instance, logger);
IDictionary <string, string> serverProperties = new Dictionary <string, string>
{
// Public server settings
{ "server.key.1", "server value 1" },
// Sensitive server settings
{ SonarProperties.SonarUserName, "secret user" },
{ SonarProperties.SonarPassword, "secret pwd" },
{ "sonar.vbnet.license.secured", "secret license" },
{ "sonar.cpp.License.Secured", "secret license 2" }
};
var settings = TeamBuildSettings.CreateNonTeamBuildSettingsForTesting(analysisDir);
Directory.CreateDirectory(settings.SonarConfigDirectory); // config directory needs to exist
// Act
var config = AnalysisConfigGenerator.GenerateFile(args, settings, serverProperties, new List <AnalyzerSettings>(), new MockSonarQubeServer(), logger);
// Assert
AssertConfigFileExists(config);
logger.AssertErrorsLogged(0);
logger.AssertWarningsLogged(0);
// Check the config
// "Public" arguments should be in the file
config.SonarProjectKey.Should().Be("key", "Unexpected project key");
config.SonarProjectName.Should().Be("name", "Unexpected project name");
config.SonarProjectVersion.Should().Be("1.0", "Unexpected project version");
AssertExpectedLocalSetting(SonarProperties.HostUrl, "http://host", config);
AssertExpectedLocalSetting("sonar.user.license.secured", "user input license", config); // we only filter out *.secured server settings
AssertExpectedLocalSetting("sonar.value", "value.secured", config);
AssertExpectedLocalSetting("server.key.secured.xxx", "not really secure", config);
AssertExpectedServerSetting("server.key.1", "server value 1", config);
AssertFileDoesNotContainText(config.FileName, "file.public.key"); // file settings values should not be in the config
AssertFileDoesNotContainText(config.FileName, "secret"); // sensitive data should not be in config
}
public void AnalysisConfGen_Simple()
{
// Arrange
var analysisDir = TestUtils.CreateTestSpecificFolderWithSubPaths(TestContext);
var logger = new TestLogger();
var propertyProvider = new ListPropertiesProvider();
propertyProvider.AddProperty(SonarProperties.HostUrl, "http://foo");
var args = new ProcessedArgs("valid.key", "valid.name", "1.0", null, false, EmptyPropertyProvider.Instance, propertyProvider, EmptyPropertyProvider.Instance, logger);
var tbSettings = TeamBuildSettings.CreateNonTeamBuildSettingsForTesting(analysisDir);
var serverSettings = new Dictionary <string, string>
{
{ "server.key.1", "server.value.1" }
};
var analyzerSettings = new AnalyzerSettings
{
RuleSetFilePath = "c:\\xxx.ruleset",
AdditionalFilePaths = new List <string>()
};
analyzerSettings.AdditionalFilePaths.Add("f:\\additionalPath1.txt");
analyzerSettings.AnalyzerPlugins = new List <AnalyzerPlugin>
{
new AnalyzerPlugin
{
AssemblyPaths = new List <string> {
"f:\\temp\\analyzer1.dll"
}
}
};
var analyzersSettings = new List <AnalyzerSettings>
{
analyzerSettings
};
Directory.CreateDirectory(tbSettings.SonarConfigDirectory); // config directory needs to exist
// Act
var actualConfig = AnalysisConfigGenerator.GenerateFile(args, tbSettings, serverSettings, analyzersSettings, new MockSonarQubeServer(), logger);
// Assert
AssertConfigFileExists(actualConfig);
logger.AssertErrorsLogged(0);
logger.AssertWarningsLogged(0);
actualConfig.SonarProjectKey.Should().Be("valid.key");
actualConfig.SonarProjectName.Should().Be("valid.name");
actualConfig.SonarProjectVersion.Should().Be("1.0");
actualConfig.SonarQubeHostUrl.Should().Be("http://foo");
actualConfig.SonarBinDir.Should().Be(tbSettings.SonarBinDirectory);
actualConfig.SonarConfigDir.Should().Be(tbSettings.SonarConfigDirectory);
actualConfig.SonarOutputDir.Should().Be(tbSettings.SonarOutputDirectory);
actualConfig.SonarScannerWorkingDirectory.Should().Be(tbSettings.SonarScannerWorkingDirectory);
actualConfig.GetBuildUri().Should().Be(tbSettings.BuildUri);
actualConfig.GetTfsUri().Should().Be(tbSettings.TfsUri);
actualConfig.ServerSettings.Should().NotBeNull();
var serverProperty = actualConfig.ServerSettings.SingleOrDefault(s => string.Equals(s.Id, "server.key.1", System.StringComparison.Ordinal));
serverProperty.Should().NotBeNull();
serverProperty.Value.Should().Be("server.value.1");
actualConfig.AnalyzersSettings[0].Should().Be(analyzerSettings);
}
[WorkItem(127)] // Do not store the db and server credentials in the config files: http://jira.sonarsource.com/browse/SONARMSBRU-127
public void AnalysisConfGen_AnalysisConfigDoesNotContainSensitiveData()
{
// Arrange
string analysisDir = TestUtils.CreateTestSpecificFolder(this.TestContext);
TestLogger logger = new TestLogger();
ListPropertiesProvider cmdLineArgs = new ListPropertiesProvider();
// Public args - should be written to the config file
cmdLineArgs.AddProperty("sonar.host.url", "http://host");
cmdLineArgs.AddProperty("public.key", "public value");
// Sensitive values - should not be written to the config file
cmdLineArgs.AddProperty(SonarProperties.DbPassword, "secret db password");
cmdLineArgs.AddProperty(SonarProperties.DbUserName, "secret db user");
// Create a settings file with public and sensitive data
AnalysisProperties fileSettings = new AnalysisProperties();
fileSettings.Add(new Property()
{
Id = "file.public.key", Value = "file public value"
});
fileSettings.Add(new Property()
{
Id = SonarProperties.DbUserName, Value = "secret db user"
});
fileSettings.Add(new Property()
{
Id = SonarProperties.DbPassword, Value = "secret db password"
});
string fileSettingsPath = Path.Combine(analysisDir, "fileSettings.txt");
fileSettings.Save(fileSettingsPath);
FilePropertyProvider fileProvider = FilePropertyProvider.Load(fileSettingsPath);
ProcessedArgs args = new ProcessedArgs("key", "name", "1.0", false, cmdLineArgs, fileProvider);
IDictionary <string, string> serverProperties = new Dictionary <string, string>();
// Public server settings
serverProperties.Add("server.key.1", "server value 1");
// Sensitive server settings
serverProperties.Add(SonarProperties.SonarUserName, "secret user");
serverProperties.Add(SonarProperties.SonarPassword, "secret pwd");
TeamBuildSettings settings = TeamBuildSettings.CreateNonTeamBuildSettingsForTesting(analysisDir);
Directory.CreateDirectory(settings.SonarConfigDirectory); // config directory needs to exist
// Act
AnalysisConfig config = AnalysisConfigGenerator.GenerateFile(args, settings, serverProperties, logger);
// Assert
AssertConfigFileExists(config);
logger.AssertErrorsLogged(0);
logger.AssertWarningsLogged(0);
// Check the config
// "Public" arguments should be in the file
Assert.AreEqual("key", config.SonarProjectKey, "Unexpected project key");
Assert.AreEqual("name", config.SonarProjectName, "Unexpected project name");
Assert.AreEqual("1.0", config.SonarProjectVersion, "Unexpected project version");
AssertExpectedLocalSetting(SonarProperties.HostUrl, "http://host", config);
AssertExpectedServerSetting("server.key.1", "server value 1", config);
AssertFileDoesNotContainText(config.FileName, "file.public.key"); // file settings values should not be in the config
// SONARMSBRU-136: TODO - uncomment the following code:
AssertFileDoesNotContainText(config.FileName, "secret"); // sensitive data should not be in config
}
