Harden repo validation and smoke checks

Author: lucasbellesi

CONTRIBUTING.md

@@ -54,6 +54,8 @@ Run multi-language smoke checks with:
 - `./scripts/smoke-languages.ps1` (PowerShell)
 - `bash ./scripts/smoke-languages.sh` (Bash)
 
+These smoke checks also compile standalone C# exercises by generating temporary validation projects during the check.
+
 4. Update related README files when behavior or structure changes.
 5. Open a pull request with a clear description of what changed and why.
 

README.md

@@ -126,6 +126,8 @@ bash ./scripts/verify-repo.sh
 
 GitHub Actions validates links, README structure, module completeness, checkpoint completeness, C++ build, and multi-language smoke checks on Linux and Windows.
 
+The multi-language smoke scripts also compile standalone C# exercises by generating temporary validation projects during the check.
+
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution workflow and documentation requirements.

scripts/check-module-completeness.ps1

@@ -20,6 +20,17 @@ $languageExtensions = @{
     python = "py"
 }
 
+function Get-HeadingLineNumber([string[]]$lines, [string]$heading) {
+    $escapedHeading = [regex]::Escape($heading)
+    for ($i = 0; $i -lt $lines.Count; $i++) {
+        if ($lines[$i] -match "^[ ]{0,3}$escapedHeading[ ]*$") {
+            return $i + 1
+        }
+    }
+
+    return -1
+}
+
 $failures = @()
 $moduleCount = 0
 
@@ -71,15 +82,15 @@ foreach ($language in $languageExtensions.Keys) {
                 $failures += "$($module.FullName): missing exercises/02.$ext"
             }
 
-            $content = Get-Content -Path $readmePath -Raw
+            $lines = Get-Content -Path $readmePath
             $positions = @{}
             $missingHeadings = @()
             foreach ($heading in $requiredHeadings) {
-                $index = $content.IndexOf($heading)
-                if ($index -lt 0) {
+                $lineNumber = Get-HeadingLineNumber -lines $lines -heading $heading
+                if ($lineNumber -lt 0) {
                     $missingHeadings += $heading
                 } else {
-                    $positions[$heading] = $index
+                    $positions[$heading] = $lineNumber
                 }
             }
 

scripts/check-module-completeness.sh

@@ -25,6 +25,12 @@ ext_for_language() {
   esac
 }
 
+heading_line_number() {
+  local heading="$1"
+  local file="$2"
+  grep -nE "^[[:space:]]{0,3}${heading}[[:space:]]*$" "$file" | head -n1 | cut -d: -f1 || true
+}
+
 failures=0
 module_count=0
 
@@ -77,7 +83,7 @@ for language in cpp csharp go python; do
       missing=()
       lines=()
       for heading in "${required_headings[@]}"; do
-        line="$(grep -nF "$heading" "$readme" | head -n1 | cut -d: -f1 || true)"
+        line="$(heading_line_number "$heading" "$readme")"
         if [[ -z "$line" ]]; then
           missing+=("$heading")
         else

scripts/check-readme-structure.ps1

@@ -15,6 +15,17 @@ $requiredHeadings = @(
 $languageNames = @("cpp", "csharp", "go", "python")
 $levelNames = @("01-foundations", "02-core", "03-advanced", "04-expert")
 
+function Get-HeadingLineNumber([string[]]$lines, [string]$heading) {
+    $escapedHeading = [regex]::Escape($heading)
+    for ($i = 0; $i -lt $lines.Count; $i++) {
+        if ($lines[$i] -match "^[ ]{0,3}$escapedHeading[ ]*$") {
+            return $i + 1
+        }
+    }
+
+    return -1
+}
+
 $moduleReadmes = foreach ($language in $languageNames) {
     foreach ($level in $levelNames) {
         $levelPath = Join-Path $root "languages/$language/$level"
@@ -38,16 +49,16 @@ if ($moduleReadmes.Count -eq 0) {
 $failures = @()
 
 foreach ($file in $moduleReadmes) {
-    $content = Get-Content -Path $file -Raw
+    $lines = Get-Content -Path $file
     $missing = @()
     $positions = @{}
 
     foreach ($heading in $requiredHeadings) {
-        $index = $content.IndexOf($heading)
-        if ($index -lt 0) {
+        $lineNumber = Get-HeadingLineNumber -lines $lines -heading $heading
+        if ($lineNumber -lt 0) {
             $missing += $heading
         } else {
-            $positions[$heading] = $index
+            $positions[$heading] = $lineNumber
         }
     }
 

scripts/check-readme-structure.sh

@@ -16,6 +16,12 @@ required_headings=(
 languages=("cpp" "csharp" "go" "python")
 levels=("01-foundations" "02-core" "03-advanced" "04-expert")
 
+heading_line_number() {
+  local heading="$1"
+  local file="$2"
+  grep -nE "^[[:space:]]{0,3}${heading}[[:space:]]*$" "$file" | head -n1 | cut -d: -f1 || true
+}
+
 module_readmes=()
 for language in "${languages[@]}"; do
   for level in "${levels[@]}"; do
@@ -40,7 +46,7 @@ for file in "${module_readmes[@]}"; do
   lines=()
 
   for heading in "${required_headings[@]}"; do
-    line="$(grep -nF "$heading" "$file" | head -n1 | cut -d: -f1 || true)"
+    line="$(heading_line_number "$heading" "$file")"
     if [[ -z "$line" ]]; then
       missing+=("$heading")
     else

scripts/smoke-languages.ps1

@@ -3,6 +3,34 @@ $ErrorActionPreference = "Stop"
 $root = Split-Path -Parent $PSScriptRoot
 Set-Location $root
 
+function Convert-ToXmlAttributeValue([string]$value) {
+    return $value.Replace("&", "&amp;").Replace('"', "&quot;").Replace("<", "&lt;").Replace(">", "&gt;")
+}
+
+function Test-CSharpExerciseFile([string]$exercisePath, [string]$tempRoot, [int]$index) {
+    $projectDir = Join-Path $tempRoot ("exercise-" + $index)
+    New-Item -Path $projectDir -ItemType Directory | Out-Null
+
+    $escapedExercisePath = Convert-ToXmlAttributeValue ([System.IO.Path]::GetFullPath($exercisePath))
+    $projectPath = Join-Path $projectDir "exercise-check.csproj"
+    @"
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>disable</ImplicitUsings>
+    <Nullable>disable</Nullable>
+    <EnableDefaultCompileItems>false</EnableDefaultCompileItems>
+  </PropertyGroup>
+  <ItemGroup>
+    <Compile Include="$escapedExercisePath" Link="Program.cs" />
+  </ItemGroup>
+</Project>
+"@ | Set-Content -Path $projectPath
+
+    dotnet build $projectPath --nologo --verbosity quiet | Out-Null
+}
+
 Write-Host "[1/6] Python syntax check..."
 python -m compileall -q languages/python
 
@@ -149,6 +177,25 @@ foreach ($project in $projects) {
     dotnet build $project.FullName --nologo --verbosity quiet
 }
 
+$csharpExerciseTempRoot = Join-Path $env:TEMP ("csharp-exercise-smoke-" + [Guid]::NewGuid().ToString("N"))
+New-Item -Path $csharpExerciseTempRoot -ItemType Directory | Out-Null
+try {
+    $exerciseIndex = 0
+    $exerciseFiles = Get-ChildItem -Path languages/csharp -Recurse -Filter *.cs |
+        Where-Object { $_.FullName -like "*\exercises\*" } |
+        Sort-Object FullName
+
+    foreach ($exercise in $exerciseFiles) {
+        Test-CSharpExerciseFile -exercisePath $exercise.FullName -tempRoot $csharpExerciseTempRoot -index $exerciseIndex
+        $exerciseIndex++
+    }
+}
+finally {
+    if (Test-Path $csharpExerciseTempRoot) {
+        Remove-Item -Path $csharpExerciseTempRoot -Recurse -Force
+    }
+}
+
 Write-Host "[6/6] C# runtime smoke..."
 dotnet run --project languages/csharp/01-foundations/functions/example/functions-example.csproj | Out-Null
 dotnet run --project languages/csharp/01-foundations/formatted-output-and-iomanip/example/formatted-output-and-iomanip-example.csproj | Out-Null

scripts/smoke-languages.sh

@@ -12,6 +12,43 @@ require_cmd() {
   fi
 }
 
+xml_escape() {
+  local value="$1"
+  value="${value//&/&}"
+  value="${value//\"/"}"
+  value="${value//</&lt;}"
+  value="${value//>/&gt;}"
+  printf '%s' "$value"
+}
+
+build_csharp_exercise() {
+  local exercise_path="$1"
+  local temp_root="$2"
+  local index="$3"
+  local project_dir="$temp_root/exercise-$index"
+  local escaped_path
+
+  escaped_path="$(xml_escape "$(realpath "$exercise_path")")"
+  mkdir -p "$project_dir"
+
+  cat > "$project_dir/exercise-check.csproj" <<EOF
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>disable</ImplicitUsings>
+    <Nullable>disable</Nullable>
+    <EnableDefaultCompileItems>false</EnableDefaultCompileItems>
+  </PropertyGroup>
+  <ItemGroup>
+    <Compile Include="$escaped_path" Link="Program.cs" />
+  </ItemGroup>
+</Project>
+EOF
+
+  dotnet build "$project_dir/exercise-check.csproj" --nologo --verbosity quiet >/dev/null
+}
+
 if command -v python >/dev/null 2>&1; then
   PYTHON_BIN="python"
 elif command -v python3 >/dev/null 2>&1; then
@@ -23,6 +60,15 @@ fi
 
 require_cmd go
 require_cmd dotnet
+require_cmd realpath
+
+tmp_dir=""
+csharp_exercise_tmp_dir=""
+cleanup() {
+  [[ -n "${tmp_dir:-}" ]] && rm -rf "$tmp_dir"
+  [[ -n "${csharp_exercise_tmp_dir:-}" ]] && rm -rf "$csharp_exercise_tmp_dir"
+}
+trap cleanup EXIT
 
 echo "[1/6] Python syntax check..."
 "$PYTHON_BIN" -m compileall -q languages/python
@@ -62,10 +108,6 @@ EOF
 
 echo "[3/6] Go compile check..."
 tmp_dir="$(mktemp -d)"
-cleanup() {
-  rm -rf "$tmp_dir"
-}
-trap cleanup EXIT
 
 idx=0
 while IFS= read -r file; do
@@ -111,6 +153,13 @@ while IFS= read -r project; do
   dotnet build "$project" --nologo --verbosity quiet
 done < <(find languages/csharp -type f -name "*.csproj" | sort)
 
+csharp_exercise_tmp_dir="$(mktemp -d)"
+exercise_idx=0
+while IFS= read -r exercise; do
+  build_csharp_exercise "$exercise" "$csharp_exercise_tmp_dir" "$exercise_idx"
+  exercise_idx=$((exercise_idx + 1))
+done < <(find languages/csharp -type f -path "*/exercises/*.cs" | sort)
+
 echo "[6/6] C# runtime smoke..."
 dotnet run --project languages/csharp/01-foundations/functions/example/functions-example.csproj >/dev/null
 dotnet run --project languages/csharp/01-foundations/formatted-output-and-iomanip/example/formatted-output-and-iomanip-example.csproj >/dev/null