Merge branch 'fixes/repository-manager-tests' into enhancements/repository-watcher-refactor

Author: StanleyGoldman

docs/contributing/how-to-test.md

@@ -0,0 +1,10 @@
+
+Unit and Integration tests for Unity can be found under `src/tests/`.
+
+## Testing requirements
+Tests currently run with NUnit 2.6.4.
+
+## Running tests
+Tests can be run after building the Unity project. To run the tests execute `test.cmd` on Windows or `test.sh` on Mac.
+
+We use [Appveyor](https://ci.appveyor.com/project/github-windows/unity/build/tests) as the CI for this project to run tests, but it is also necessary to run tests locally when making code changes.

src/GitHub.Api/Events/RepositoryWatcher.cs

@@ -157,7 +157,7 @@ private int ProcessEvents(Event[] fileEvents)
                     break;
                 }
 
-                //Logger.Trace(fileEvent.Describe());
+                Logger.Trace(fileEvent.Describe());
 
                 var eventDirectory = new NPath(fileEvent.Directory);
                 var fileA = eventDirectory.Combine(fileEvent.FileA);

src/tests/IntegrationTests/BaseGitEnvironmentTest.cs

@@ -9,7 +9,7 @@ namespace IntegrationTests
     class BaseGitEnvironmentTest : BaseGitRepoTest
     {
         protected async Task<IEnvironment> Initialize(NPath repoPath, NPath environmentPath = null,
-            bool enableEnvironmentTrace = false)
+            bool enableEnvironmentTrace = false, bool initializeRepository = true)
         {
             TaskManager = new TaskManager();
             SyncContext = new ThreadSynchronizationContext(TaskManager.Token);
@@ -34,8 +34,11 @@ protected async Task<IEnvironment> Initialize(NPath repoPath, NPath environmentP
             RepositoryManager = GitHub.Unity.RepositoryManager.CreateInstance(Platform, TaskManager, GitClient, repoPath);
             RepositoryManager.Initialize();
 
-            Environment.Repository = new Repository(repoPath, cacheContainer);
-            Environment.Repository.Initialize(RepositoryManager);
+            if (initializeRepository)
+            {
+                Environment.Repository = new Repository(repoPath, cacheContainer);
+                Environment.Repository.Initialize(RepositoryManager);
+            }
 
             RepositoryManager.Start();
 

src/tests/IntegrationTests/Events/RepositoryManagerTests.cs

@@ -14,7 +14,7 @@ public void Setup()
 
             Logging.LogAdapter = new MultipleLogAdapter(
                 new FileLogAdapter($"..\\{DateTime.UtcNow.ToString("yyyyMMddHHmmss")}-integration-tests.log")
-                //, new ConsoleLogAdapter()
+                , new ConsoleLogAdapter()
             );
         }
     }

src/tests/IntegrationTests/SetUpFixture.cs

@@ -10,8 +10,6 @@ namespace TestUtils.Events
     interface IRepositoryManagerListener
     {
         void OnIsBusyChanged(bool busy);
-        void OnStatusUpdated(GitStatus status);
-        void OnLocksUpdated(IEnumerable<GitLock> locks);
         void OnLocalBranchListUpdated(Dictionary<string, ConfigBranch> branchList);
         void OnRemoteBranchListUpdated(Dictionary<string, ConfigRemote> remotesList, Dictionary<string, Dictionary<string, ConfigBranch>> remoteBranchList);
         void OnCurrentBranchAndRemoteUpdated(ConfigBranch? configBranch, ConfigRemote? configRemote);
@@ -21,7 +19,6 @@ class RepositoryManagerEvents
     {
         public EventWaitHandle OnIsBusy { get; } = new AutoResetEvent(false);
         public EventWaitHandle OnIsNotBusy { get; } = new AutoResetEvent(false);
-        public EventWaitHandle OnStatusUpdated { get; } = new AutoResetEvent(false);
         public EventWaitHandle OnLocksUpdated { get; } = new AutoResetEvent(false);
         public EventWaitHandle OnCurrentBranchAndRemoteUpdated { get; } = new AutoResetEvent(false);
         public EventWaitHandle OnHeadUpdated { get; } = new AutoResetEvent(false);
@@ -32,7 +29,6 @@ public void Reset()
         {
             OnIsBusy.Reset();
             OnIsNotBusy.Reset();
-            OnStatusUpdated.Reset();
             OnLocksUpdated.Reset();
             OnCurrentBranchAndRemoteUpdated.Reset();
             OnHeadUpdated.Reset();
@@ -46,11 +42,6 @@ public void WaitForNotBusy(int seconds = 1)
             OnIsNotBusy.WaitOne(TimeSpan.FromSeconds(seconds));
         }
 
-        public void WaitForStatusUpdated(int seconds = 1)
-        {
-            OnStatusUpdated.WaitOne(TimeSpan.FromSeconds(seconds));
-        }
-
         public void WaitForHeadUpdated(int seconds = 1)
         {
             OnHeadUpdated.WaitOne(TimeSpan.FromSeconds(seconds));
@@ -95,8 +86,6 @@ public static void AttachListener(this IRepositoryManagerListener listener,
         public static void AssertDidNotReceiveAnyCalls(this IRepositoryManagerListener repositoryManagerListener)
         {
             repositoryManagerListener.DidNotReceive().OnIsBusyChanged(Args.Bool);
-            repositoryManagerListener.DidNotReceive().OnStatusUpdated(Args.GitStatus);
-            repositoryManagerListener.DidNotReceive().OnLocksUpdated(Args.EnumerableGitLock);
             repositoryManagerListener.DidNotReceive().OnCurrentBranchAndRemoteUpdated(Arg.Any<ConfigBranch?>(), Arg.Any<ConfigRemote?>());
             repositoryManagerListener.DidNotReceive().OnLocalBranchListUpdated(Arg.Any<Dictionary<string, ConfigBranch>>());
             repositoryManagerListener.DidNotReceive().OnRemoteBranchListUpdated(Arg.Any<Dictionary<string, ConfigRemote>>(), Arg.Any<Dictionary<string, Dictionary<string, ConfigBranch>>>());

src/tests/TestUtils/Events/IRepositoryManagerListener.cs

@@ -0,0 +1,24 @@
+@echo off
+setlocal
+
+set Config=Debug
+if not %1.==. (
+  set Config=%1
+)
+
+set Exclude=''
+if not %2.==. (
+  set Exclude=%2
+)
+
+:: make sure at Unity project root directory
+set NunitDirectory=packages\NUnit.Runners.2.6.4\tools
+echo %NunitDirectory%
+set ConsoleRunner=%NunitDirectory%\nunit-console.exe
+echo %ConsoleRunner%
+
+:: run tests
+echo Running "build\IntegrationTests\IntegrationTests.dll" "build\IntegrationTests\TestUtils.dll" "build\TaskSystemIntegrationTests\TaskSystemIntegrationTests.dll" "build\UnitTests\TestUtils.dll" "build\UnitTests\UnitTests.dll" "src\tests\TestUtils\bin\%Config%\TestUtils.dll" /exclude=%Exclude%
+call %ConsoleRunner% "build\IntegrationTests\IntegrationTests.dll" "build\IntegrationTests\TestUtils.dll" "build\TaskSystemIntegrationTests\TaskSystemIntegrationTests.dll" "build\UnitTests\TestUtils.dll" "build\UnitTests\UnitTests.dll" "src\tests\TestUtils\bin\%Config%\TestUtils.dll" /exclude=%Exclude%
+
+endlocal

test.cmd

@@ -0,0 +1,15 @@
+#!/bin/sh -eu
+Configuration="Debug"
+if [ $# -gt 0 ]; then
+	Configuration=$1
+fi
+
+Exclude=""
+if [ $# -gt 1 ]; then
+	Exclude="/exclude=$2"
+fi
+
+NunitDirectory="packages\NUnit.Runners.2.6.4\tools"
+ConsoleRunner="$NunitDirectory\nunit-console.exe"
+
+$ConsoleRunner "build\IntegrationTests\IntegrationTests.dll" "build\IntegrationTests\TestUtils.dll" "build\TaskSystemIntegrationTests\TaskSystemIntegrationTests.dll" "build\UnitTests\TestUtils.dll" "build\UnitTests\UnitTests.dll" "src\tests\TestUtils\bin\\$Configuration\TestUtils.dll" $Exclude