Skip to content

Commit

Permalink
Merge pull request #995 from Noryoko/issue-233
Browse files Browse the repository at this point in the history
  • Loading branch information
@sharwell
sharwell committed Jul 20, 2015
2 parents 8b46158 + 95d4ebb commit f6caeb5
Show file tree
Hide file tree
Showing 3 changed files with 271 additions and 1 deletion.
269 changes: 269 additions & 0 deletions StyleCop.Analyzers/StyleCop.Analyzers.Test/SpacingRules/SA1025UnitTests.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,269 @@
namespace StyleCop.Analyzers.Test.SpacingRules
{
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.Diagnostics;
using StyleCop.Analyzers.SpacingRules;
using TestHelper;
using Xunit;

/// <summary>
/// Unit tests for <see cref="SA1025CodeMustNotContainMultipleWhitespaceInARow"/>
/// </summary>
public class SA1025UnitTests : DiagnosticVerifier
{
/// <summary>
/// Verifies that the analyzer will properly handle an empty source.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestEmptySourceAsync()
{
var testCode = string.Empty;
await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
}

/// <summary>
/// Verifies that the analyzer will not produce diagnostics with single whitespace characters in code.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestValidWhitespaceAsync()
{
var testCode = @"namespace TestNamespace
{
using System;
using static System.Math;
using Action = System.Action;
public class TestClass<T> : object where T : struct
{
// comment with space
public int TestMethod1(int a, int b)
{
/* comment
*/
return a + b;
}
public void TestMethod2(
int a,
int b)
{
for(var i = 0; i < a; i++)
{
}
}
}
}
";

await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
}

/// <summary>
/// Verifies that the analyzer will produce the proper diagnostics with multiple whitespace characters in namespace declaration.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestMtulipleWhitespaceInNamespaceDeclarationAsync()
{
var testCode = @"namespace TestNamespace
{
}
";

DiagnosticResult[] expected = { this.CSharpDiagnostic().WithLocation(1, 10) };

await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
}

/// <summary>
/// Verifies that the analyzer will produce the proper diagnostics with multiple whitespace characters in using statements.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestMultipleWhitespaceInUsingStatementsAsync()
{
var testCode = @"namespace TestNamespace
{
using System;
using static System.Math;
using Action = System.Action;
}
";

DiagnosticResult[] expected =
{
this.CSharpDiagnostic().WithLocation(3, 10),
this.CSharpDiagnostic().WithLocation(4, 10),
this.CSharpDiagnostic().WithLocation(4, 18),
this.CSharpDiagnostic().WithLocation(5, 10),
this.CSharpDiagnostic().WithLocation(5, 18),
this.CSharpDiagnostic().WithLocation(5, 21)
};

await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
}

/// <summary>
/// Verifies that the analyzer will produce the proper diagnostics with multiple whitespace characters in class declaration.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestMultipleWhitespaceInClassDeclarationAsync()
{
var testCode = @"namespace TestNamespace
{
public class TestClass<T> : object where T : struct
{
}
}
";

DiagnosticResult[] expected =
{
this.CSharpDiagnostic().WithLocation(3, 11),
this.CSharpDiagnostic().WithLocation(3, 18),
this.CSharpDiagnostic().WithLocation(3, 32),
this.CSharpDiagnostic().WithLocation(3, 35),
this.CSharpDiagnostic().WithLocation(3, 43),
this.CSharpDiagnostic().WithLocation(3, 50),
this.CSharpDiagnostic().WithLocation(3, 53),
this.CSharpDiagnostic().WithLocation(3, 56)
};

await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
}

/// <summary>
/// Verifies that the analyzer will produce the proper diagnostics with multiple whitespace characters in method declaration.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestMultipleWhitespaceInMethodDeclarationAsync()
{
var testCode = @"namespace TestNamespace
{
public class TestClass
{
public void TestMethod(int a, int b)
{
}
}
}
";
DiagnosticResult[] expected =
{
this.CSharpDiagnostic().WithLocation(5, 15),
this.CSharpDiagnostic().WithLocation(5, 21),
this.CSharpDiagnostic().WithLocation(5, 37),
this.CSharpDiagnostic().WithLocation(5, 46)
};

await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
}

/// <summary>
/// Verifies that the analyzer will produce the proper diagnostics with multiple whitespace characters in method declaration.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestMutlipleWhitespaceInMethodBodyAsync()
{
var testCode = @"namespace TestNamespace
{
public class TestClass
{
public int TestMethod(int a, int b)
{
var x = 10 + 20;
return TestMethod(x, 100);
}
}
}
";
DiagnosticResult[] expected =
{
this.CSharpDiagnostic().WithLocation(7, 16),
this.CSharpDiagnostic().WithLocation(7, 20),
this.CSharpDiagnostic().WithLocation(7, 23),
this.CSharpDiagnostic().WithLocation(7, 27),
this.CSharpDiagnostic().WithLocation(7, 30),
this.CSharpDiagnostic().WithLocation(8, 19)
};

await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
}

/// <summary>
/// Verifies that the analyzer will produce the proper diagnostics with multiple whitespace characters in a property.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestMutlipleWhitespaceInPropertyAsync()
{
var testCode = @"namespace TestNamespace
{
public class TestClass
{
public int TestProperty1 { get; }
public int TestProperty2 { get; private set; }
public int TestProperty3 => 10;
}
}
";
DiagnosticResult[] expected =
{
this.CSharpDiagnostic().WithLocation(5, 15),
this.CSharpDiagnostic().WithLocation(5, 20),
this.CSharpDiagnostic().WithLocation(5, 35),
this.CSharpDiagnostic().WithLocation(5, 38),
this.CSharpDiagnostic().WithLocation(6, 49),
this.CSharpDiagnostic().WithLocation(7, 33),
this.CSharpDiagnostic().WithLocation(7, 37)
};

await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
}

/// <summary>
/// Verifies that the analyzer will produce the proper diagnostics with multiple whitespace characters in for loop.
/// </summary>
/// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
[Fact]
public async Task TestMutlipleWhitespaceInForLoopAsync()
{
var testCode = @"namespace TestNamespace
{
public class TestClass
{
public void TestMethod()
{
for(var i = 0; i < 10; i++)
{
}
}
}
}
";
DiagnosticResult[] expected =
{
this.CSharpDiagnostic().WithLocation(7, 20),
this.CSharpDiagnostic().WithLocation(7, 23),
this.CSharpDiagnostic().WithLocation(7, 26),
this.CSharpDiagnostic().WithLocation(7, 33),
this.CSharpDiagnostic().WithLocation(7, 36)
};

await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
}

/// <inheritdoc/>
protected override IEnumerable<DiagnosticAnalyzer> GetCSharpDiagnosticAnalyzers()
{
yield return new SA1025CodeMustNotContainMultipleWhitespaceInARow();
}
}
}
1 change: 1 addition & 0 deletions StyleCop.Analyzers/StyleCop.Analyzers.Test/StyleCop.Analyzers.Test.csproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@
<Compile Include="SpacingRules\SA1021UnitTests.cs" />
<Compile Include="SpacingRules\SA1022UnitTests.cs" />
<Compile Include="SpacingRules\SA1024UnitTests.cs" />
<Compile Include="SpacingRules\SA1025UnitTests.cs" />
<Compile Include="SpacingRules\SA1026UnitTests.cs" />
<Compile Include="SpacingRules\SA1027UnitTests.cs" />
<Compile Include="SpacingRules\SA1028UnitTests.cs" />
Expand Down
2 changes: 1 addition & 1 deletion ...yzers/StyleCop.Analyzers/SpacingRules/SA1025CodeMustNotContainMultipleWhitespaceInARow.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public class SA1025CodeMustNotContainMultipleWhitespaceInARow : DiagnosticAnalyz
private static readonly string HelpLink = "http://www.stylecop.com/docs/SA1025.html";

private static readonly DiagnosticDescriptor Descriptor =
new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, AnalyzerCategory.SpacingRules, DiagnosticSeverity.Warning, AnalyzerConstants.DisabledNoTests, Description, HelpLink);
new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, AnalyzerCategory.SpacingRules, DiagnosticSeverity.Warning, AnalyzerConstants.EnabledByDefault, Description, HelpLink);

private static readonly ImmutableArray<DiagnosticDescriptor> SupportedDiagnosticsValue =
ImmutableArray.Create(Descriptor);
Expand Down

0 comments on commit f6caeb5

Please sign in to comment.