-
-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provide sink validation for StatsD (#997)
- Loading branch information
1 parent
135b49d
commit 58aca6d
Showing
10 changed files
with
213 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
src/Promitor.Agents.Scraper/Validation/Steps/Sinks/StatsDMetricSinkValidationStep.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
using Microsoft.Extensions.Logging; | ||
using Microsoft.Extensions.Logging.Abstractions; | ||
using Microsoft.Extensions.Options; | ||
using Promitor.Agents.Scraper.Validation.Interfaces; | ||
using Promitor.Core.Configuration.Model; | ||
|
||
namespace Promitor.Agents.Scraper.Validation.Steps.Sinks | ||
{ | ||
public class StatsDMetricSinkValidationStep : ValidationStep, IValidationStep | ||
{ | ||
private readonly IOptions<RuntimeConfiguration> _runtimeConfiguration; | ||
|
||
public StatsDMetricSinkValidationStep(IOptions<RuntimeConfiguration> runtimeConfiguration) | ||
: this(runtimeConfiguration, NullLogger.Instance) | ||
{ | ||
} | ||
|
||
public StatsDMetricSinkValidationStep(IOptions<RuntimeConfiguration> runtimeConfiguration, ILogger validationLogger) | ||
: base(validationLogger) | ||
{ | ||
_runtimeConfiguration = runtimeConfiguration; | ||
} | ||
|
||
public string ComponentName { get; } = "StatsD Metric Sink"; | ||
|
||
public ValidationResult Run() | ||
{ | ||
var currentRuntimeConfiguration = _runtimeConfiguration.Value; | ||
var statsDConfiguration = currentRuntimeConfiguration?.MetricSinks?.Statsd; | ||
if (statsDConfiguration == null) | ||
{ | ||
return ValidationResult.Successful(ComponentName); | ||
} | ||
|
||
if (string.IsNullOrWhiteSpace(statsDConfiguration.Host)) | ||
{ | ||
var errorMessage = "No host of StatsD server is configured"; | ||
return ValidationResult.Failure(ComponentName, errorMessage); | ||
} | ||
|
||
if (statsDConfiguration.Port <= 0) | ||
{ | ||
var errorMessage = $"StatsD port {statsDConfiguration.Port} is not allowed"; | ||
return ValidationResult.Failure(ComponentName, errorMessage); | ||
} | ||
|
||
return ValidationResult.Successful(ComponentName); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
112 changes: 112 additions & 0 deletions
112
src/Promitor.Tests.Unit/Validation/Metrics/Sinks/StatsDMetricSinkValidationStepTests.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
using System.ComponentModel; | ||
using Microsoft.Extensions.Options; | ||
using Promitor.Agents.Scraper.Validation.Steps.Sinks; | ||
using Promitor.Core.Configuration.Model; | ||
using Promitor.Tests.Unit.Generators.Config; | ||
using Xunit; | ||
|
||
namespace Promitor.Tests.Unit.Validation.Metrics.Sinks | ||
{ | ||
[Category("Unit")] | ||
public class StatsDMetricSinkValidationStepTests | ||
{ | ||
[Fact] | ||
public void Validate_StatsDIsFullyConfigured_Success() | ||
{ | ||
// Arrange | ||
var runtimeConfiguration = CreateRuntimeConfiguration(); | ||
|
||
// Act | ||
var azureAuthenticationValidationStep = new StatsDMetricSinkValidationStep(runtimeConfiguration); | ||
var validationResult = azureAuthenticationValidationStep.Run(); | ||
|
||
// Assert | ||
Assert.True(validationResult.IsSuccessful); | ||
} | ||
|
||
[Fact] | ||
public void Validate_StatsDIsNotConfigured_Success() | ||
{ | ||
// Arrange | ||
var runtimeConfiguration = CreateRuntimeConfiguration(); | ||
runtimeConfiguration.Value.MetricSinks.Statsd = null; | ||
|
||
// Act | ||
var azureAuthenticationValidationStep = new StatsDMetricSinkValidationStep(runtimeConfiguration); | ||
var validationResult = azureAuthenticationValidationStep.Run(); | ||
|
||
// Assert | ||
Assert.True(validationResult.IsSuccessful); | ||
} | ||
[Fact] | ||
public void Validate_NoSinksConfigured_Success() | ||
{ | ||
// Arrange | ||
var runtimeConfiguration = CreateRuntimeConfiguration(); | ||
runtimeConfiguration.Value.MetricSinks = null; | ||
|
||
// Act | ||
var azureAuthenticationValidationStep = new StatsDMetricSinkValidationStep(runtimeConfiguration); | ||
var validationResult = azureAuthenticationValidationStep.Run(); | ||
|
||
// Assert | ||
Assert.True(validationResult.IsSuccessful); | ||
} | ||
|
||
[Fact] | ||
public void Validate_StatsDWithNegativePort_Fails() | ||
{ | ||
// Arrange | ||
var runtimeConfiguration = CreateRuntimeConfiguration(); | ||
runtimeConfiguration.Value.MetricSinks.Statsd.Port = -1; | ||
|
||
// Act | ||
var azureAuthenticationValidationStep = new StatsDMetricSinkValidationStep(runtimeConfiguration); | ||
var validationResult = azureAuthenticationValidationStep.Run(); | ||
|
||
// Assert | ||
Assert.False(validationResult.IsSuccessful); | ||
} | ||
|
||
[Theory] | ||
[InlineData("")] | ||
[InlineData(null)] | ||
public void Validate_StatsDWithoutHost_Fails(string host) | ||
{ | ||
// Arrange | ||
var runtimeConfiguration = CreateRuntimeConfiguration(); | ||
runtimeConfiguration.Value.MetricSinks.Statsd.Host = host; | ||
|
||
// Act | ||
var azureAuthenticationValidationStep = new StatsDMetricSinkValidationStep(runtimeConfiguration); | ||
var validationResult = azureAuthenticationValidationStep.Run(); | ||
|
||
// Assert | ||
Assert.False(validationResult.IsSuccessful); | ||
} | ||
|
||
[Theory] | ||
[InlineData("")] | ||
[InlineData(null)] | ||
public void Validate_StatsDWithoutMetricPrefix_Succeeds(string metricPrefix) | ||
{ | ||
// Arrange | ||
var runtimeConfiguration = CreateRuntimeConfiguration(); | ||
runtimeConfiguration.Value.MetricSinks.Statsd.MetricPrefix = metricPrefix; | ||
|
||
// Act | ||
var azureAuthenticationValidationStep = new StatsDMetricSinkValidationStep(runtimeConfiguration); | ||
var validationResult = azureAuthenticationValidationStep.Run(); | ||
|
||
// Assert | ||
Assert.True(validationResult.IsSuccessful); | ||
} | ||
|
||
private IOptions<RuntimeConfiguration> CreateRuntimeConfiguration() | ||
{ | ||
var bogusRuntimeConfiguration = BogusRuntimeConfigurationGenerator.Generate(); | ||
|
||
return Options.Create(bogusRuntimeConfiguration); | ||
} | ||
} | ||
} |