mirror of
https://github.com/azaion/satellite-provider.git
synced 2026-06-21 07:01:15 +00:00
[AZ-372] Add .editorconfig, Directory.Build.props, format/coverage wiring
Wires the C19 tooling baseline so dotnet format and Coverlet gate the test script and a small NetAnalyzers ruleset (CA1001, CA1051, CA1816, CA2227) at warning severity is visible from the next build. - .editorconfig (new, root=true): whitespace rules, per-extension indent sizes, C# style preferences as suggestions, initial CA rules. - Directory.Build.props (new): EnableNETAnalyzers=true, AnalysisLevel=latest, AnalysisMode=None so only rules explicitly enabled in .editorconfig fire; EnforceCodeStyleInBuild=false to keep build clean from style. - scripts/run-tests.sh: Step 0 runs dotnet format whitespace --verify-no-changes via Docker SDK; unit/integration test calls now collect XPlat Code Coverage into TestResults/. New --skip-format escape hatch. - .gitignore: TestResults/, coverage.cobertura.xml, *.coverage. - SatelliteProvider.Tests/ToolingConfigurationTests.cs (new, 6 tests): runtime assertions that the config files, script wiring, and coverlet.collector reference are all in place; mirrors the AcceptanceCriteriaRT2Tests pattern. Whitespace cleanup that the new format gate uncovers is staged for the next commit (per AZ-372 spec: "commit cleanup as a separate batch"). Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
@@ -0,0 +1,42 @@
|
|||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
indent_style = space
|
||||||
|
end_of_line = lf
|
||||||
|
charset = utf-8
|
||||||
|
trim_trailing_whitespace = true
|
||||||
|
insert_final_newline = true
|
||||||
|
|
||||||
|
[*.cs]
|
||||||
|
indent_size = 4
|
||||||
|
|
||||||
|
[*.{csproj,props,targets,nuspec,resx}]
|
||||||
|
indent_size = 2
|
||||||
|
|
||||||
|
[*.{json,yml,yaml}]
|
||||||
|
indent_size = 2
|
||||||
|
|
||||||
|
[*.{md,sql}]
|
||||||
|
trim_trailing_whitespace = false
|
||||||
|
|
||||||
|
[*.cs]
|
||||||
|
csharp_new_line_before_open_brace = all
|
||||||
|
csharp_new_line_before_else = true
|
||||||
|
csharp_new_line_before_catch = true
|
||||||
|
csharp_new_line_before_finally = true
|
||||||
|
csharp_new_line_before_members_in_object_initializers = true
|
||||||
|
csharp_new_line_before_members_in_anonymous_types = true
|
||||||
|
csharp_new_line_between_query_expression_clauses = true
|
||||||
|
|
||||||
|
csharp_style_namespace_declarations = file_scoped:suggestion
|
||||||
|
csharp_using_directive_placement = outside_namespace:suggestion
|
||||||
|
|
||||||
|
dotnet_style_qualification_for_field = false:suggestion
|
||||||
|
dotnet_style_qualification_for_property = false:suggestion
|
||||||
|
dotnet_style_qualification_for_method = false:suggestion
|
||||||
|
dotnet_style_qualification_for_event = false:suggestion
|
||||||
|
|
||||||
|
dotnet_diagnostic.CA1001.severity = warning
|
||||||
|
dotnet_diagnostic.CA1051.severity = warning
|
||||||
|
dotnet_diagnostic.CA1816.severity = warning
|
||||||
|
dotnet_diagnostic.CA2227.severity = warning
|
||||||
@@ -11,3 +11,7 @@ Content/
|
|||||||
tiles/
|
tiles/
|
||||||
ready/
|
ready/
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
TestResults/
|
||||||
|
coverage.cobertura.xml
|
||||||
|
coverage.opencover.xml
|
||||||
|
*.coverage
|
||||||
|
|||||||
@@ -0,0 +1,10 @@
|
|||||||
|
<Project>
|
||||||
|
|
||||||
|
<PropertyGroup>
|
||||||
|
<EnableNETAnalyzers>true</EnableNETAnalyzers>
|
||||||
|
<AnalysisLevel>latest</AnalysisLevel>
|
||||||
|
<AnalysisMode>None</AnalysisMode>
|
||||||
|
<EnforceCodeStyleInBuild>false</EnforceCodeStyleInBuild>
|
||||||
|
</PropertyGroup>
|
||||||
|
|
||||||
|
</Project>
|
||||||
@@ -0,0 +1,100 @@
|
|||||||
|
using FluentAssertions;
|
||||||
|
|
||||||
|
namespace SatelliteProvider.Tests;
|
||||||
|
|
||||||
|
public class ToolingConfigurationTests
|
||||||
|
{
|
||||||
|
[Fact]
|
||||||
|
public void EditorConfig_ExistsAtRoot_AZ372_AC1()
|
||||||
|
{
|
||||||
|
var path = LocateRepoFile(".editorconfig");
|
||||||
|
|
||||||
|
path.Should().NotBeNull(".editorconfig must exist at the workspace root for `dotnet format` to honor formatting rules");
|
||||||
|
|
||||||
|
var content = File.ReadAllText(path!);
|
||||||
|
content.Should().Contain("root = true");
|
||||||
|
content.Should().Contain("indent_style = space");
|
||||||
|
content.Should().Contain("end_of_line = lf");
|
||||||
|
content.Should().Contain("insert_final_newline = true");
|
||||||
|
content.Should().Contain("trim_trailing_whitespace = true");
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void EditorConfig_DefinesInitialAnalyzerRuleset_AZ372_AC3()
|
||||||
|
{
|
||||||
|
var path = LocateRepoFile(".editorconfig");
|
||||||
|
path.Should().NotBeNull();
|
||||||
|
|
||||||
|
var content = File.ReadAllText(path!);
|
||||||
|
|
||||||
|
content.Should().Contain("dotnet_diagnostic.CA1001.severity = warning");
|
||||||
|
content.Should().Contain("dotnet_diagnostic.CA1051.severity = warning");
|
||||||
|
content.Should().Contain("dotnet_diagnostic.CA1816.severity = warning");
|
||||||
|
content.Should().Contain("dotnet_diagnostic.CA2227.severity = warning");
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void DirectoryBuildProps_ExistsAtRoot_AZ372_AC3()
|
||||||
|
{
|
||||||
|
var path = LocateRepoFile("Directory.Build.props");
|
||||||
|
path.Should().NotBeNull("Directory.Build.props centralizes analyzer settings for every csproj");
|
||||||
|
|
||||||
|
var content = File.ReadAllText(path!);
|
||||||
|
|
||||||
|
content.Should().Contain("<EnableNETAnalyzers>true</EnableNETAnalyzers>");
|
||||||
|
content.Should().Contain("<AnalysisLevel>latest</AnalysisLevel>");
|
||||||
|
content.Should().Contain("<AnalysisMode>None</AnalysisMode>",
|
||||||
|
"AnalysisMode=None ensures only rules explicitly enabled in .editorconfig fire; protects against analyzer flood");
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void RunTestsScript_WiresFormatVerify_AZ372_AC1()
|
||||||
|
{
|
||||||
|
var path = LocateRepoFile(Path.Combine("scripts", "run-tests.sh"));
|
||||||
|
path.Should().NotBeNull();
|
||||||
|
|
||||||
|
var content = File.ReadAllText(path!);
|
||||||
|
|
||||||
|
content.Should().Contain("dotnet format whitespace");
|
||||||
|
content.Should().Contain("--verify-no-changes",
|
||||||
|
"AC-1 requires the script to gate on whitespace conformance via dotnet format");
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void RunTestsScript_CollectsCoverage_AZ372_AC2()
|
||||||
|
{
|
||||||
|
var path = LocateRepoFile(Path.Combine("scripts", "run-tests.sh"));
|
||||||
|
path.Should().NotBeNull();
|
||||||
|
|
||||||
|
var content = File.ReadAllText(path!);
|
||||||
|
|
||||||
|
content.Should().Contain("XPlat Code Coverage");
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void TestProject_ReferencesCoverletCollector_AZ372_AC2()
|
||||||
|
{
|
||||||
|
var path = LocateRepoFile(Path.Combine("SatelliteProvider.Tests", "SatelliteProvider.Tests.csproj"));
|
||||||
|
path.Should().NotBeNull();
|
||||||
|
|
||||||
|
var content = File.ReadAllText(path!);
|
||||||
|
|
||||||
|
content.Should().Contain("coverlet.collector",
|
||||||
|
"Coverlet collector is the data collector that produces XPlat Code Coverage reports");
|
||||||
|
}
|
||||||
|
|
||||||
|
private static string? LocateRepoFile(string relativePath)
|
||||||
|
{
|
||||||
|
var dir = new DirectoryInfo(Directory.GetCurrentDirectory());
|
||||||
|
while (dir is not null)
|
||||||
|
{
|
||||||
|
var candidate = Path.Combine(dir.FullName, relativePath);
|
||||||
|
if (File.Exists(candidate))
|
||||||
|
{
|
||||||
|
return candidate;
|
||||||
|
}
|
||||||
|
dir = dir.Parent;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
+33
-11
@@ -11,40 +11,62 @@ trap cleanup EXIT
|
|||||||
|
|
||||||
usage() {
|
usage() {
|
||||||
cat <<EOF
|
cat <<EOF
|
||||||
Usage: $(basename "$0") [--unit-only | --smoke | --full]
|
Usage: $(basename "$0") [--unit-only | --smoke | --full] [--skip-format]
|
||||||
|
|
||||||
Modes:
|
Modes:
|
||||||
--unit-only Run only the .NET unit test project (no Docker Compose, no integration tests)
|
--unit-only Run only the .NET unit test project (no Docker Compose, no integration tests)
|
||||||
--smoke Run unit tests + a fast integration subset (~2 min target, tightened timeouts)
|
--smoke Run unit tests + a fast integration subset (~2 min target, tightened timeouts)
|
||||||
--full Run unit tests + the full integration suite (default if no flag is provided)
|
--full Run unit tests + the full integration suite (default if no flag is provided)
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
--skip-format Skip the dotnet format --verify-no-changes check (use only for emergency runs)
|
||||||
|
|
||||||
Environment:
|
Environment:
|
||||||
GOOGLE_MAPS_API_KEY Required for any integration test mode (loaded from .env or shell env).
|
GOOGLE_MAPS_API_KEY Required for any integration test mode (loaded from .env or shell env).
|
||||||
EOF
|
EOF
|
||||||
}
|
}
|
||||||
|
|
||||||
mode="full"
|
mode="full"
|
||||||
case "${1:-}" in
|
skip_format="false"
|
||||||
--unit-only) mode="unit"; ;;
|
for arg in "$@"; do
|
||||||
--smoke) mode="smoke"; ;;
|
case "$arg" in
|
||||||
--full) mode="full"; ;;
|
--unit-only) mode="unit"; ;;
|
||||||
-h|--help) usage; exit 0; ;;
|
--smoke) mode="smoke"; ;;
|
||||||
"") ;;
|
--full) mode="full"; ;;
|
||||||
*) echo "Unknown argument: $1"; usage; exit 2; ;;
|
--skip-format) skip_format="true"; ;;
|
||||||
esac
|
-h|--help) usage; exit 0; ;;
|
||||||
|
"") ;;
|
||||||
|
*) echo "Unknown argument: $arg"; usage; exit 2; ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
echo "=== Satellite Provider Test Suite ==="
|
echo "=== Satellite Provider Test Suite ==="
|
||||||
echo "Mode: $mode"
|
echo "Mode: $mode"
|
||||||
echo ""
|
echo ""
|
||||||
|
|
||||||
|
if [[ "$skip_format" == "true" ]]; then
|
||||||
|
echo "Step 0: Skipping dotnet format check (--skip-format)"
|
||||||
|
else
|
||||||
|
echo "Step 0: dotnet format whitespace --verify-no-changes"
|
||||||
|
if ! docker run --rm -v "$PROJECT_ROOT:/src" -w /src mcr.microsoft.com/dotnet/sdk:8.0 \
|
||||||
|
dotnet format whitespace SatelliteProvider.sln --verify-no-changes; then
|
||||||
|
echo ""
|
||||||
|
echo "ERROR: Whitespace violations detected. Run 'dotnet format whitespace SatelliteProvider.sln' to fix."
|
||||||
|
exit 4
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
fi
|
||||||
|
|
||||||
if [[ "$mode" == "unit" ]]; then
|
if [[ "$mode" == "unit" ]]; then
|
||||||
echo "Running unit tests only..."
|
echo "Running unit tests only..."
|
||||||
docker run --rm -v "$PROJECT_ROOT:/src" -w /src mcr.microsoft.com/dotnet/sdk:8.0 \
|
docker run --rm -v "$PROJECT_ROOT:/src" -w /src mcr.microsoft.com/dotnet/sdk:8.0 \
|
||||||
dotnet test SatelliteProvider.Tests/SatelliteProvider.Tests.csproj \
|
dotnet test SatelliteProvider.Tests/SatelliteProvider.Tests.csproj \
|
||||||
--no-restore --configuration Release \
|
--no-restore --configuration Release \
|
||||||
|
--collect:"XPlat Code Coverage" \
|
||||||
|
--results-directory /src/TestResults \
|
||||||
--logger "console;verbosity=normal"
|
--logger "console;verbosity=normal"
|
||||||
echo ""
|
echo ""
|
||||||
echo "=== Unit tests complete ==="
|
echo "=== Unit tests complete (coverage written to ./TestResults/) ==="
|
||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
@@ -62,7 +84,7 @@ fi
|
|||||||
|
|
||||||
echo "Step 1: Unit tests"
|
echo "Step 1: Unit tests"
|
||||||
docker run --rm -v "$PROJECT_ROOT:/src" -w /src mcr.microsoft.com/dotnet/sdk:8.0 \
|
docker run --rm -v "$PROJECT_ROOT:/src" -w /src mcr.microsoft.com/dotnet/sdk:8.0 \
|
||||||
sh -c "dotnet restore SatelliteProvider.sln && dotnet test SatelliteProvider.Tests/SatelliteProvider.Tests.csproj --no-restore --configuration Release --logger 'console;verbosity=normal'"
|
sh -c "dotnet restore SatelliteProvider.sln && dotnet test SatelliteProvider.Tests/SatelliteProvider.Tests.csproj --no-restore --configuration Release --collect:'XPlat Code Coverage' --results-directory /src/TestResults --logger 'console;verbosity=normal'"
|
||||||
|
|
||||||
echo ""
|
echo ""
|
||||||
echo "Step 2: Integration tests (Docker Compose, mode=$mode)"
|
echo "Step 2: Integration tests (Docker Compose, mode=$mode)"
|
||||||
|
|||||||
Reference in New Issue
Block a user