Add more sync tests and some docs

Author: joshsmith

lib/code_corps/github/sync/comment/comment/changeset.ex

@@ -7,7 +7,6 @@ defmodule CodeCorps.GitHub.Sync.Comment.Comment.Changeset do
   alias CodeCorps.{
     Comment,
     GithubComment,
-    ProjectGithubRepo,
     Services.MarkdownRendererService,
     Task,
     User,
@@ -17,8 +16,7 @@ defmodule CodeCorps.GitHub.Sync.Comment.Comment.Changeset do
   alias Ecto.Changeset
 
   @doc ~S"""
-  Constructs a changeset for syncing a task when processing a GitHub Comment
-  payload
+  Constructs a changeset for syncing a task from a GitHub API Comment payload.
   """
   @spec build_changeset(Comment.t, map, GithubComment.t, Task.t, User.t) :: Changeset.t
   def build_changeset(
@@ -34,6 +32,9 @@ defmodule CodeCorps.GitHub.Sync.Comment.Comment.Changeset do
     comment |> update_changeset(attrs)
   end
 
+  @doc ~S"""
+  Constructs a changeset for syncing a task from a `GithubComment` record.
+  """
   @spec build_changeset(Comment.t, GithubComment.t, Task.t, User.t) :: Changeset.t
   def build_changeset(
     %Comment{id: comment_id} = comment,

test/lib/code_corps/github/sync/sync_test.exs

@@ -90,14 +90,34 @@ defmodule CodeCorps.GitHub.SyncTest do
   end
 
   describe "sync_project_github_repo/1" do
-    test "syncs with the project repo" do
+    test "syncs and resyncs with the project repo" do
       owner = "baxterthehacker"
       repo = "public-repo"
       github_app_installation = insert(:github_app_installation, github_account_login: owner)
       github_repo = insert(:github_repo, github_app_installation: github_app_installation, name: repo, github_account_id: 6752317, github_account_avatar_url: "https://avatars3.githubusercontent.com/u/6752317?v=4", github_account_type: "User", github_id: 35129377)
       %{project: project} = project_github_repo = insert(:project_github_repo, github_repo: github_repo)
       insert(:task_list, project: project, inbox: true)
 
+      # Sync a first time
+
+      Sync.sync_project_github_repo(project_github_repo)
+
+      repo = Repo.one(GithubRepo)
+
+      assert repo.syncing_pull_requests_count == 4
+      assert repo.syncing_issues_count == 8
+      assert repo.syncing_comments_count == 12
+
+      assert Repo.aggregate(GithubComment, :count, :id) == 12
+      assert Repo.aggregate(GithubIssue, :count, :id) == 8
+      assert Repo.aggregate(GithubPullRequest, :count, :id) == 4
+      assert Repo.aggregate(GithubUser, :count, :id) == 10
+      assert Repo.aggregate(Comment, :count, :id) == 12
+      assert Repo.aggregate(Task, :count, :id) == 8
+      assert Repo.aggregate(User, :count, :id) == 13
+
+      # Sync a second time – should run without trouble
+
       Sync.sync_project_github_repo(project_github_repo)
 
       repo = Repo.one(GithubRepo)