ci: add codeql workflow

.github/workflows/check.yml

@@ -9,6 +9,10 @@ on:
 
 jobs:
   test-versions:
+    permissions:
+      contents: read
+      actions: write
+      checks: write
     strategy:
       matrix:
         csharpFunctionalExtensionsVersion: ["2.29.0", "2.*", "3.0.0", "3.*"]
@@ -20,6 +24,8 @@ jobs:
   check:
     runs-on: ubuntu-latest
     needs: test-versions
+    permissions:
+      contents: read
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.github/workflows/codeql.yml

@@ -0,0 +1,101 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL Advanced"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  schedule:
+    - cron: '15 1 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - language: actions
+            build-mode: none
+          - language: csharp
+            build-mode: none
+        # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
+        # Use `c-cpp` to analyze code written in C, C++ or both
+        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Add any setup steps before running the `github/codeql-action/init` action.
+      # This includes steps like installing compilers or runtimes (`actions/setup-node`
+      # or others). This is typically only required for manual builds.
+      # - name: Setup runtime (example)
+      #   uses: actions/setup-example@v1
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v4
+        with:
+          languages: ${{ matrix.language }}
+          build-mode: ${{ matrix.build-mode }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+
+          # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
+
+      # If the analyze step fails for one of the languages you are analyzing with
+      # "We were unable to automatically build your code", modify the matrix above
+      # to set the build mode to "manual" for that language. Then modify this step
+      # to build your code.
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+      - name: Run manual build steps
+        if: matrix.build-mode == 'manual'
+        shell: bash
+        run: |
+          echo 'If you are using a "manual" build mode for one or more of the' \
+            'languages you are analyzing, replace this with the commands to build' \
+            'your code, for example:'
+          echo '  make bootstrap'
+          echo '  make release'
+          exit 1
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v4
+        with:
+          category: "/language:${{matrix.language}}"

.github/workflows/publish.yml

@@ -7,6 +7,10 @@ on:
 
 jobs:
   test-versions:
+    permissions:
+      contents: read
+      actions: write
+      checks: write
     strategy:
       matrix:
         csharpFunctionalExtensionsVersion: [ '2.29.0', '2.*', '3.0.0', '3.*' ]

.github/workflows/test-version.yml

@@ -7,6 +7,11 @@ on:
         type: string
         required: true
 
+permissions:
+  contents: read
+  actions: write
+  checks: write
+
 jobs:
   test-version:
     runs-on: ubuntu-latest

CSharpFunctionalExtensions.HttpResults.Generators.Tests/ExternalAssemblyErrorTypeTests.cs

@@ -34,7 +34,9 @@ public sealed record NotFoundError(string Message);
     var emitResult = externalCompilation.Emit(ms);
     emitResult.Success.Should().BeTrue("External assembly should compile");
 
-    var externalAssemblyReference = MetadataReference.CreateFromStream(new MemoryStream(ms.ToArray()));
+    ms.Position = 0;
+
+    var externalAssemblyReference = MetadataReference.CreateFromStream(ms);
 
     // Create mapper in the main assembly that references the external error type
     var mapperCode = """
@@ -84,7 +86,9 @@ public sealed record ValidationError(string Message);
     var emitResult = externalCompilation.Emit(ms);
     emitResult.Success.Should().BeTrue();
 
-    var externalAssemblyReference = MetadataReference.CreateFromStream(new MemoryStream(ms.ToArray()));
+    ms.Position = 0;
+
+    var externalAssemblyReference = MetadataReference.CreateFromStream(ms);
 
     // Create multiple mappers
     var mappersCode = """
@@ -146,7 +150,9 @@ public sealed record NotFoundError(string Message);
     var emitResult = externalCompilation.Emit(ms);
     emitResult.Success.Should().BeTrue();
 
-    var externalAssemblyReference = MetadataReference.CreateFromStream(new MemoryStream(ms.ToArray()));
+    ms.Position = 0;
+
+    var externalAssemblyReference = MetadataReference.CreateFromStream(ms);
 
     var mapperCode = """
       using Microsoft.AspNetCore.Http;

CSharpFunctionalExtensions.HttpResults.Generators/Rules/ParameterlessConstructorRule.cs

@@ -18,15 +18,11 @@ internal class ParameterlessConstructorRule : IRule
 
   public IEnumerable<Diagnostic> Check(List<ClassDeclarationSyntax> mapperClasses)
   {
-    foreach (var mapperClass in mapperClasses)
-    {
-      if (!HasParameterlessConstructor(mapperClass))
-        yield return Diagnostic.Create(
-          RuleDescriptor,
-          mapperClass.Identifier.GetLocation(),
-          mapperClass.Identifier.Text
-        );
-    }
+    return mapperClasses
+      .Where(mapperClass => !HasParameterlessConstructor(mapperClass))
+      .Select(mapperClass =>
+        Diagnostic.Create(RuleDescriptor, mapperClass.Identifier.GetLocation(), mapperClass.Identifier.Text)
+      );
   }
 
   private static bool HasParameterlessConstructor(ClassDeclarationSyntax classDeclaration)

CSharpFunctionalExtensions.HttpResults.Tests/ResultExtensions/ToFileHttpResultByteArray.cs

@@ -16,7 +16,6 @@ public void ResultByteArray_Success_can_be_mapped_to_FileHttpResult()
     var fileDownloadName = "foo.txt";
     var lastModified = DateTimeOffset.Now;
     var entityTag = new EntityTagHeaderValue("\"fooETag\"");
-    ;
     var enableRangeProcessing = true;
 
     var result =
@@ -42,7 +41,6 @@ public async Task ResultByteArray_Success_can_be_mapped_to_FileHttpResult_Async(
     var fileDownloadName = "foo.txt";
     var lastModified = DateTimeOffset.Now;
     var entityTag = new EntityTagHeaderValue("\"fooETag\"");
-    ;
     var enableRangeProcessing = true;
 
     var result =

CSharpFunctionalExtensions.HttpResults.Tests/ResultExtensions/ToFileHttpResultByteArrayE.cs

@@ -16,7 +16,6 @@ public void ResultByteArrayE_Success_can_be_mapped_to_FileHttpResult()
     var fileDownloadName = "foo.txt";
     var lastModified = DateTimeOffset.Now;
     var entityTag = new EntityTagHeaderValue("\"fooETag\"");
-    ;
     var enableRangeProcessing = true;
 
     var result =
@@ -42,7 +41,6 @@ public async Task ResultByteArrayE_Success_can_be_mapped_to_FileHttpResult_Async
     var fileDownloadName = "foo.txt";
     var lastModified = DateTimeOffset.Now;
     var entityTag = new EntityTagHeaderValue("\"fooETag\"");
-    ;
     var enableRangeProcessing = true;
 
     var result =

CSharpFunctionalExtensions.HttpResults.Tests/ResultExtensions/ToFileStreamHttpResultStream.cs

@@ -12,8 +12,8 @@ public class ToFileStreamHttpResultStream
   public void ResultStream_Success_can_be_mapped_to_FileStreamHttpResult()
   {
     var value = "foo"u8.ToArray();
-    var stream = new MemoryStream();
-    stream.Write(value);
+    using var sourceStream = new MemoryStream();
+    sourceStream.Write(value);
     var contentType = MediaTypeNames.Text.Plain;
     var fileDownloadName = "foo.txt";
     var lastModified = DateTimeOffset.Now;
@@ -22,14 +22,14 @@ public void ResultStream_Success_can_be_mapped_to_FileStreamHttpResult()
 
     var result =
       Result
-        .Success(stream)
+        .Success(sourceStream)
         .ToFileStreamHttpResult(contentType, fileDownloadName, lastModified, entityTag, enableRangeProcessing)
         .Result as FileStreamHttpResult;
 
-    stream = new MemoryStream();
+    using var resultStream = new MemoryStream();
     result!.FileStream.Position = 0;
-    result!.FileStream.CopyTo(stream);
-    stream.ToArray().Should().BeEquivalentTo(value);
+    result!.FileStream.CopyTo(resultStream);
+    resultStream.ToArray().Should().BeEquivalentTo(value);
     result!.LastModified.Should().Be(lastModified);
     result!.FileDownloadName.Should().Be(fileDownloadName);
     result!.FileLength.Should().Be(value.Length);
@@ -42,25 +42,24 @@ public void ResultStream_Success_can_be_mapped_to_FileStreamHttpResult()
   public async Task ResultStream_Success_can_be_mapped_to_FileStreamHttpResult_Async()
   {
     var value = "foo"u8.ToArray();
-    var stream = new MemoryStream();
-    stream.Write(value);
+    await using var sourceStream = new MemoryStream();
+    sourceStream.Write(value);
     var contentType = MediaTypeNames.Text.Plain;
     var fileDownloadName = "foo.txt";
     var lastModified = DateTimeOffset.Now;
     var entityTag = new EntityTagHeaderValue("\"fooETag\"");
-    ;
     var enableRangeProcessing = true;
 
     var result =
       (
-        await Task.FromResult(Result.Success(stream))
+        await Task.FromResult(Result.Success(sourceStream))
           .ToFileStreamHttpResult(contentType, fileDownloadName, lastModified, entityTag, enableRangeProcessing)
       ).Result as FileStreamHttpResult;
 
-    stream = new MemoryStream();
+    await using var resultStream = new MemoryStream();
     result!.FileStream.Position = 0;
-    await result!.FileStream.CopyToAsync(stream);
-    stream.ToArray().Should().BeEquivalentTo(value);
+    await result!.FileStream.CopyToAsync(resultStream);
+    resultStream.ToArray().Should().BeEquivalentTo(value);
     result!.LastModified.Should().Be(lastModified);
     result!.FileDownloadName.Should().Be(fileDownloadName);
     result!.FileLength.Should().Be(value.Length);

CSharpFunctionalExtensions.HttpResults.Tests/ResultExtensions/ToFileStreamHttpResultStreamE.cs

@@ -12,25 +12,24 @@ public class ToFileStreamHttpResultStreamE
   public void ResultStreamE_Success_can_be_mapped_to_FileStreamHttpResult()
   {
     var value = "foo"u8.ToArray();
-    var stream = new MemoryStream();
-    stream.Write(value);
+    using var sourceStream = new MemoryStream();
+    sourceStream.Write(value);
     var contentType = MediaTypeNames.Text.Plain;
     var fileDownloadName = "foo.txt";
     var lastModified = DateTimeOffset.Now;
     var entityTag = new EntityTagHeaderValue("\"fooETag\"");
-    ;
     var enableRangeProcessing = true;
 
     var result =
       Result
-        .Success<Stream, DocumentMissingError>(stream)
+        .Success<Stream, DocumentMissingError>(sourceStream)
         .ToFileStreamHttpResult(contentType, fileDownloadName, lastModified, entityTag, enableRangeProcessing)
         .Result as FileStreamHttpResult;
 
-    stream = new MemoryStream();
+    using var resultStream = new MemoryStream();
     result!.FileStream.Position = 0;
-    result!.FileStream.CopyTo(stream);
-    stream.ToArray().Should().BeEquivalentTo(value);
+    result!.FileStream.CopyTo(resultStream);
+    resultStream.ToArray().Should().BeEquivalentTo(value);
     result!.LastModified.Should().Be(lastModified);
     result!.FileDownloadName.Should().Be(fileDownloadName);
     result!.FileLength.Should().Be(value.Length);
@@ -43,25 +42,24 @@ public void ResultStreamE_Success_can_be_mapped_to_FileStreamHttpResult()
   public async Task ResultStreamE_Success_can_be_mapped_to_FileStreamHttpResult_Async()
   {
     var value = "foo"u8.ToArray();
-    var stream = new MemoryStream();
-    stream.Write(value);
+    await using var sourceStream = new MemoryStream();
+    sourceStream.Write(value);
     var contentType = MediaTypeNames.Text.Plain;
     var fileDownloadName = "foo.txt";
     var lastModified = DateTimeOffset.Now;
     var entityTag = new EntityTagHeaderValue("\"fooETag\"");
-    ;
     var enableRangeProcessing = true;
 
     var result =
       (
-        await Task.FromResult(Result.Success<Stream, DocumentMissingError>(stream))
+        await Task.FromResult(Result.Success<Stream, DocumentMissingError>(sourceStream))
           .ToFileStreamHttpResult(contentType, fileDownloadName, lastModified, entityTag, enableRangeProcessing)
       ).Result as FileStreamHttpResult;
 
-    stream = new MemoryStream();
+    await using var resultStream = new MemoryStream();
     result!.FileStream.Position = 0;
-    await result!.FileStream.CopyToAsync(stream);
-    stream.ToArray().Should().BeEquivalentTo(value);
+    await result!.FileStream.CopyToAsync(resultStream);
+    resultStream.ToArray().Should().BeEquivalentTo(value);
     result!.LastModified.Should().Be(lastModified);
     result!.FileDownloadName.Should().Be(fileDownloadName);
     result!.FileLength.Should().Be(value.Length);