GitHub api refactoring

Annoy-o-Bot.AcceptanceTests/AcceptanceTest.cs

@@ -1,7 +1,8 @@
 using System.Security.Cryptography;
 using System.Text;
 using Annoy_o_Bot.CosmosDB;
-using Annoy_o_Bot.GitHub;
+using Annoy_o_Bot.GitHub.Api;
+using Annoy_o_Bot.GitHub.Callbacks;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Azure.Cosmos;
 using Microsoft.Extensions.Configuration;
@@ -12,7 +13,7 @@
 namespace Annoy_o_Bot.AcceptanceTests;
 
 [Collection("CosmosDB")]
 public class AcceptanceTest(CosmosFixture cosmosFixture) : IAsyncLifetime
 {
     protected const string SignatureKey = "mysecretkey";
 
@@ -67,11 +68,11 @@
         await timeoutHandler.Run(null!, reminders, container);
     }
 
-    protected static HttpRequest CreateCallbackHttpRequest(CallbackModel callback)
+    protected static HttpRequest CreateCallbackHttpRequest(GitPushCallbackModel gitPushCallback)
     {
         var httpContext = new DefaultHttpContext();
         var request = httpContext.Request;
-        var messageContent = Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(callback, Formatting.None));
+        var messageContent = Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(gitPushCallback, Formatting.None));
         request.Body = new MemoryStream(messageContent);
         request.Headers.Add("X-GitHub-Event", "push");
         request.Headers.Add("X-Hub-Signature-256",

Annoy-o-Bot.AcceptanceTests/Fakes/CallbackModelHelper.cs

@@ -1,10 +1,12 @@
-namespace Annoy_o_Bot.AcceptanceTests.Fakes;
+using Annoy_o_Bot.GitHub.Callbacks;
+
+namespace Annoy_o_Bot.AcceptanceTests.Fakes;
 
 class CallbackModelHelper
 {
-    public static CallbackModel.CommitModel CreateCommitModel(string? added = null, string? modified = null, string? removed = null)
+    public static GitPushCallbackModel.CommitModel CreateCommitModel(string? added = null, string? modified = null, string? removed = null)
     {
-        var commit = new CallbackModel.CommitModel
+        var commit = new GitPushCallbackModel.CommitModel
         {
             Id = Guid.NewGuid().ToString(),
             Added = added != null ? new[] { added } : Array.Empty<string>(),

Annoy-o-Bot.AcceptanceTests/Fakes/FakeGitHubApi.cs

@@ -1,15 +1,11 @@
-using Annoy_o_Bot.GitHub;
+using Annoy_o_Bot.GitHub.Api;
 
 namespace Annoy_o_Bot.AcceptanceTests.Fakes;
 
 class FakeGitHubApi : IGitHubApi
 {
     private Dictionary<(long, long), IGitHubRepository> registeredRepos = new();
 
-    public FakeGitHubApi()
-    {
-    }
-
     public FakeGitHubRepository CreateNewRepository()
     {
         var repository = new FakeGitHubRepository(Random.Shared.NextInt64(), Random.Shared.NextInt64());

Annoy-o-Bot.AcceptanceTests/Fakes/FakeGitHubInstallation.cs

@@ -1,4 +1,4 @@
-using Annoy_o_Bot.GitHub;
+using Annoy_o_Bot.GitHub.Api;
 
 namespace Annoy_o_Bot.AcceptanceTests.Fakes;
 

Annoy-o-Bot.AcceptanceTests/Fakes/FakeGitHubRepository.cs

@@ -1,4 +1,4 @@
-using Annoy_o_Bot.GitHub;
+using Annoy_o_Bot.GitHub.Api;
 using Octokit;
 
 namespace Annoy_o_Bot.AcceptanceTests.Fakes;

Annoy-o-Bot.AcceptanceTests/Fakes/RepoHelperExtensions.cs

@@ -1,13 +1,13 @@
-using Newtonsoft.Json;
-using Octokit;
+using Annoy_o_Bot.GitHub.Callbacks;
+using Newtonsoft.Json;
 
 namespace Annoy_o_Bot.AcceptanceTests.Fakes;
 
 static class RepoHelperExtensions
 {
     private const string DefaultBranch = "main";
 
-    public static CallbackModel CommitNewReminder(this FakeGitHubRepository repo, ReminderDefinition reminderDefinition,
+    public static GitPushCallbackModel CommitNewReminder(this FakeGitHubRepository repo, ReminderDefinition reminderDefinition,
         string? branch = null)
     {
         var filename = Guid.NewGuid().ToString("N");
@@ -18,13 +18,13 @@ public static CallbackModel CommitNewReminder(this FakeGitHubRepository repo, Re
         return repo.Commit(commit, branch);
     }
 
-    public static CallbackModel Commit(this FakeGitHubRepository repo, CallbackModel.CommitModel commit,
+    public static GitPushCallbackModel Commit(this FakeGitHubRepository repo, GitPushCallbackModel.CommitModel commit,
         string? branch = null)
     {
-        return new CallbackModel
+        return new GitPushCallbackModel
         {
-            Installation = new CallbackModel.InstallationModel() { Id = repo.InstallationId },
-            Repository = new CallbackModel.RepositoryModel() { Id = repo.RepositoryId, DefaultBranch = DefaultBranch },
+            Installation = new GitPushCallbackModel.InstallationModel() { Id = repo.InstallationId },
+            Repository = new GitPushCallbackModel.RepositoryModel() { Id = repo.RepositoryId, DefaultBranch = DefaultBranch },
             Ref = $"refs/heads/{branch ?? DefaultBranch}",
             HeadCommit = commit,
             Commits = new []{ commit }

Annoy-o-Bot.AcceptanceTests/When_callback_type_not_push.cs

@@ -1,5 +1,4 @@
 using Annoy_o_Bot.AcceptanceTests.Fakes;
-using Annoy_o_Bot.GitHub;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging.Abstractions;
 using Xunit;

Annoy-o-Bot.AcceptanceTests/When_deleting_reminder_on_default_branch.cs

@@ -1,6 +1,4 @@
-using System.Text.Json;
-using Annoy_o_Bot.AcceptanceTests.Fakes;
-using Annoy_o_Bot.CosmosDB;
+using Annoy_o_Bot.AcceptanceTests.Fakes;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging.Abstractions;
 using Xunit;

Annoy-o-Bot.AcceptanceTests/When_detecting_missing_reminder.cs

@@ -1,6 +1,5 @@
 using Annoy_o_Bot.AcceptanceTests.Fakes;
 using Annoy_o_Bot.CosmosDB;
-using Annoy_o_Bot.CosmosDB.Tests;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Logging.Abstractions;
 using Xunit;

Annoy-o-Bot.AcceptanceTests/When_request_signature_does_not_match.cs

@@ -9,19 +9,20 @@ public class When_request_signature_does_not_match : AcceptanceTest
     [Fact]
     public async Task Should_return_error()
     {
+        const string InvalidSignature = "sha256=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855";
         var gitHubApi = new FakeGitHubApi();
         var repository = gitHubApi.CreateNewRepository();
 
         var request = CreateCallbackHttpRequest(repository.Commit(CallbackModelHelper.CreateCommitModel()));
         var requestHash = request.Headers["X-Hub-Signature-256"];
-        request.Headers["X-Hub-Signature-256"] = "1234567890"; // this is not the incorrect but the expected signature in this test
+        request.Headers["X-Hub-Signature-256"] = InvalidSignature; // this is not the incorrect but the expected signature in this test
 
         var handler = new CallbackHandler(gitHubApi, configurationBuilder.Build(), NullLogger<CallbackHandler>.Instance);
 
         var exception = await Assert.ThrowsAnyAsync<Exception>(() => handler.Run(request, container));
 
         Assert.Contains(
-            $"Computed request payload signature ('{requestHash}') does not match provided signature ('{request.Headers["X-Hub-Signature-256"]}')",
+            $"Computed request payload signature ('{requestHash}') does not match provided signature ('{InvalidSignature}')",
             exception.Message);
     }
 

Annoy-o-Bot.AcceptanceTests/When_updating_reminder_not_stored.cs

@@ -1,5 +1,6 @@
 using Annoy_o_Bot.AcceptanceTests.Fakes;
 using Annoy_o_Bot.CosmosDB;
+using Annoy_o_Bot.GitHub.Callbacks;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging.Abstractions;
 using Xunit;
@@ -24,7 +25,7 @@ public async Task Should_create_reminder_in_database()
         };
         var createCallback = appInstallation.CommitNewReminder(updatedReminder);
 
-        var updateCommit = new CallbackModel.CommitModel
+        var updateCommit = new GitPushCallbackModel.CommitModel
         {
             Id = Guid.NewGuid().ToString(),
             Modified =

Annoy-o-Bot.AcceptanceTests/When_updating_reminder_on_default_branch.cs

@@ -1,6 +1,6 @@
 using System.Text.Json;
 using Annoy_o_Bot.AcceptanceTests.Fakes;
-using Annoy_o_Bot.CosmosDB;
+using Annoy_o_Bot.GitHub.Callbacks;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging.Abstractions;
 using Xunit;
@@ -37,7 +37,7 @@ public async Task Should_update_reminder_in_database()
         };
         appInstallation.AddFileContent(createCallback.Commits[0].Added[0], JsonSerializer.Serialize(updatedReminder));
 
-        var updateCommit = new CallbackModel.CommitModel
+        var updateCommit = new GitPushCallbackModel.CommitModel
         {
             Id = Guid.NewGuid().ToString(),
             Modified = new[]

Annoy-o-Bot.Tests/Annoy-o-Bot.Tests.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
-    <RootNamespace>Annoy_o_Bot.Tests</RootNamespace>
+    <RootNamespace>Annoy_o_Bot</RootNamespace>
 
     <IsPackable>false</IsPackable>
   </PropertyGroup>

Annoy-o-Bot.Tests/FileChangesTests.cs

@@ -1,14 +1,14 @@
-namespace Annoy_o_Bot.Tests
-{
-    using Annoy_o_Bot.GitHub;
-    using Xunit;
+using Annoy_o_Bot.GitHub.Callbacks;
+using Xunit;
 
+namespace Annoy_o_Bot
+{
     public class FileChangesTests
     {
         [Fact]
         public void Should_return_empty_changes_when_no_commits()
         {
-            var result = CommitParser.GetChanges(new CallbackModel.CommitModel[0]);
+            var result = CommitParser.GetChanges(new GitPushCallbackModel.CommitModel[0]);
 
             Assert.Empty(result.New);
             Assert.Empty(result.Deleted);
@@ -20,19 +20,19 @@ public void Should_aggregate_changes_from_all_commits()
         {
             var commitModel = new[]
             {
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Added = new []{ "a1" },
                     Modified = new []{ "m1" },
                     Removed = new [] { "r1"}
                 },
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Added = new []{ "a2" },
                     Modified = new []{ "m2" },
                     Removed = new [] { "r2"}
                 },
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Added = new []{ "a3" },
                     Modified = new []{ "m3" },
@@ -58,11 +58,11 @@ public void Should_handle_multiple_updates()
         {
             var commitModel = new[]
             {
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Modified = new []{ "file1" },
                 },
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Modified = new [] { "file1"}
                 }
@@ -79,11 +79,11 @@ public void Should_handle_update_delete()
         {
             var commitModel = new[]
             {
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Modified = new []{ "file1" },
                 },
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Removed = new [] { "file1"}
                 }
@@ -101,15 +101,15 @@ public void Should_handle_new_delete()
         {
             var commitModel = new[]
             {
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Added = new []{ "file1" },
                 },
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Modified = new []{ "file1" },
                 },
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Removed = new [] { "file1"}
                 }
@@ -128,15 +128,15 @@ public void Should_handle_new_update()
         {
             var commitModel = new[]
             {
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Added = new []{ "file1" },
                 },
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Modified = new []{ "file1" },
                 },
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Modified = new [] { "file1"}
                 }
@@ -155,15 +155,15 @@ public void Should_handle_delete_new()
         {
             var commitModel = new[]
             {
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Modified = new []{ "file1" },
                 },
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Removed = new []{ "file1" },
                 },
-                new CallbackModel.CommitModel
+                new GitPushCallbackModel.CommitModel
                 {
                     Added = new [] { "file1"}
                 }

Annoy-o-Bot.Tests/GitHub/Callbacks/GitPushCallbackModelTests.cs

@@ -0,0 +1,69 @@
+using System.IO;
+using Newtonsoft.Json;
+using Xunit;
+
+namespace Annoy_o_Bot.GitHub.Callbacks;
+
+public class GitPushCallbackModelTests
+{
+    [Fact]
+    public void NewFileAdded()
+    {
+        var result = JsonConvert.DeserializeObject<GitPushCallbackModel>(File.ReadAllText("requests/fileAdded.json"));
+
+        Assert.Equal("refs/heads/master", result.Ref);
+
+        Assert.Equal(7498230L, result.Installation.Id);
+
+        Assert.Equal(179716425L, result.Repository.Id);
+        Assert.Equal("master", result.Repository.DefaultBranch);
+        Assert.Equal("TitleTest", result.Repository.Name);
+
+        var commit = Assert.Single(result.Commits);
+        Assert.Equal("ba7c6f17f5beaafc603eca52b864356848865fec", commit.Id);
+        var addedFile = Assert.Single(commit.Added);
+        Assert.Equal(".reminder/testReminder.json", addedFile);
+        Assert.Equal("Create trigger4.json", commit.Message);
+
+        Assert.Equal("timbussmann", result.Pusher.Name);
+    }
+
+    [Fact]
+    public void MultiCommit()
+    {
+        var result = JsonConvert.DeserializeObject<GitPushCallbackModel>(File.ReadAllText("requests/multiCommitFileHistory.json"));
+
+        Assert.Equal(4, result.Commits.Length);
+
+        Assert.Equal(".reminder/newFile.json", Assert.Single(result.Commits[0].Added));
+        Assert.Empty(result.Commits[0].Modified);
+        Assert.Empty(result.Commits[0].Removed);
+        Assert.Equal("Create newFile.json", result.Commits[0].Message);
+
+        Assert.Equal(".reminder/newFile.json", Assert.Single(result.Commits[1].Modified));
+        Assert.Empty(result.Commits[1].Added);
+        Assert.Empty(result.Commits[1].Removed);
+        Assert.Equal("Update newFile.json", result.Commits[1].Message);
+
+        Assert.Equal(".reminder/newFile.json", Assert.Single(result.Commits[2].Removed));
+        Assert.Empty(result.Commits[2].Added);
+        Assert.Empty(result.Commits[2].Modified);
+        Assert.Equal("Delete newFile.json", result.Commits[2].Message);
+
+        Assert.Empty(result.Commits[3].Added);
+        Assert.Empty(result.Commits[3].Modified);
+        Assert.Empty(result.Commits[3].Removed);
+        Assert.Equal("Merge pull request #15 from timbussmann/file-ops-history\n\nCreate newFile.json", result.Commits[3].Message);
+
+        Assert.Equal("cb1ec97f51657c2718ab4e0b1d0bf2656aeb3127", result.HeadCommit.Id);
+    }
+
+    [Fact]
+    public void BranchDeleted()
+    {
+        var result = JsonConvert.DeserializeObject<GitPushCallbackModel>(File.ReadAllText("requests/branchDeleted.json"));
+
+        Assert.Null(result.HeadCommit);
+        Assert.Empty(result.Commits);
+    }
+}