diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1ff0c42 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,63 @@ +############################################################################### +# Set default behavior to automatically normalize line endings. +############################################################################### +* text=auto + +############################################################################### +# Set default behavior for command prompt diff. +# +# This is need for earlier builds of msysgit that does not have it on by +# default for csharp files. +# Note: This is only used by command line +############################################################################### +#*.cs diff=csharp + +############################################################################### +# Set the merge driver for project and solution files +# +# Merging from the command prompt will add diff markers to the files if there +# are conflicts (Merging from VS is not affected by the settings below, in VS +# the diff markers are never inserted). Diff markers may cause the following +# file extensions to fail to load in VS. An alternative would be to treat +# these files as binary and thus will always conflict and require user +# intervention with every merge. To do so, just uncomment the entries below +############################################################################### +#*.sln merge=binary +#*.csproj merge=binary +#*.vbproj merge=binary +#*.vcxproj merge=binary +#*.vcproj merge=binary +#*.dbproj merge=binary +#*.fsproj merge=binary +#*.lsproj merge=binary +#*.wixproj merge=binary +#*.modelproj merge=binary +#*.sqlproj merge=binary +#*.wwaproj merge=binary + +############################################################################### +# behavior for image files +# +# image files are treated as binary by default. +############################################################################### +#*.jpg binary +#*.png binary +#*.gif binary + +############################################################################### +# diff behavior for common document formats +# +# Convert binary document formats to text before diffing them. This feature +# is only available from the command line. Turn it on by uncommenting the +# entries below. +############################################################################### +#*.doc diff=astextplain +#*.DOC diff=astextplain +#*.docx diff=astextplain +#*.DOCX diff=astextplain +#*.dot diff=astextplain +#*.DOT diff=astextplain +#*.pdf diff=astextplain +#*.PDF diff=astextplain +#*.rtf diff=astextplain +#*.RTF diff=astextplain diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3c4efe2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,261 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. + +# User-specific files +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ + +# Visual Studio 2015 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUNIT +*.VisualState.xml +TestResult.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# DNX +project.lock.json +project.fragment.lock.json +artifacts/ + +*_i.c +*_p.c +*_i.h +*.ilk +*.meta +*.obj +*.pch +*.pdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# TODO: Comment the next line if you want to checkin your web deploy settings +# but database connection strings (with potential passwords) will be unencrypted +#*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# The packages folder can be ignored because of Package Restore +**/packages/* +# except build/, which is used as an MSBuild target. +!**/packages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/packages/repositories.config +# NuGet v3's project.json files produces more ignoreable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +node_modules/ +orleans.codegen.cs + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm + +# SQL Server files +*.mdf +*.ldf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# JetBrains Rider +.idea/ +*.sln.iml + +# CodeRush +.cr/ + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..695e6f9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 Alessio Franceschelli + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/SafeSynchronous.sln b/SafeSynchronous.sln new file mode 100644 index 0000000..e050dab --- /dev/null +++ b/SafeSynchronous.sln @@ -0,0 +1,39 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio 15 +VisualStudioVersion = 15.0.26730.16 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{2337F2CB-FB43-4E56-965A-7AA59C7D172E}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{83FD9BF7-62C4-4369-A944-20A2F3B74F52}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SafeSynchronous", "src\SafeSynchronous\SafeSynchronous.csproj", "{052B946A-81D3-4176-874D-B9875FF22D29}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SafeSynchronous.Test", "test\SafeSynchronous.Test\SafeSynchronous.Test.csproj", "{20D0CFAD-7EB5-4C0B-9BE9-B66C72B5BBF9}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {052B946A-81D3-4176-874D-B9875FF22D29}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {052B946A-81D3-4176-874D-B9875FF22D29}.Debug|Any CPU.Build.0 = Debug|Any CPU + {052B946A-81D3-4176-874D-B9875FF22D29}.Release|Any CPU.ActiveCfg = Release|Any CPU + {052B946A-81D3-4176-874D-B9875FF22D29}.Release|Any CPU.Build.0 = Release|Any CPU + {20D0CFAD-7EB5-4C0B-9BE9-B66C72B5BBF9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {20D0CFAD-7EB5-4C0B-9BE9-B66C72B5BBF9}.Debug|Any CPU.Build.0 = Debug|Any CPU + {20D0CFAD-7EB5-4C0B-9BE9-B66C72B5BBF9}.Release|Any CPU.ActiveCfg = Release|Any CPU + {20D0CFAD-7EB5-4C0B-9BE9-B66C72B5BBF9}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {052B946A-81D3-4176-874D-B9875FF22D29} = {2337F2CB-FB43-4E56-965A-7AA59C7D172E} + {20D0CFAD-7EB5-4C0B-9BE9-B66C72B5BBF9} = {83FD9BF7-62C4-4369-A944-20A2F3B74F52} + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {E5A589C6-1CE0-44CA-A43E-6C530CB0B938} + EndGlobalSection +EndGlobal diff --git a/src/SafeSynchronous/SafeSynchronous.csproj b/src/SafeSynchronous/SafeSynchronous.csproj new file mode 100644 index 0000000..5c0504a --- /dev/null +++ b/src/SafeSynchronous/SafeSynchronous.csproj @@ -0,0 +1,15 @@ + + + + Helper to safely run a Task from a codebase not async. + Alessio Franceschelli + task async await synchronous run + https://github.com/alefranz/SafeSynchronous/blob/master/LICENSE + https://github.com/alefranz/SafeSynchronous + https://github.com/alefranz/SafeSynchronous.git + git + + netstandard1.0;net45 + + + diff --git a/src/SafeSynchronous/SafeSynchronousTask.cs b/src/SafeSynchronous/SafeSynchronousTask.cs new file mode 100644 index 0000000..2aa4ed7 --- /dev/null +++ b/src/SafeSynchronous/SafeSynchronousTask.cs @@ -0,0 +1,39 @@ +using System; +using System.Threading; +using System.Threading.Tasks; + +namespace SafeSynchronous +{ + public class SafeSynchronousTask + { + public static void Run(Func function) + { + var context = SynchronizationContext.Current; + SynchronizationContext.SetSynchronizationContext(null); + + try + { + function().GetAwaiter().GetResult(); + } + finally + { + SynchronizationContext.SetSynchronizationContext(context); + } + } + + public static T Run(Func> function) + { + var context = SynchronizationContext.Current; + SynchronizationContext.SetSynchronizationContext(null); + + try + { + return function().GetAwaiter().GetResult(); + } + finally + { + SynchronizationContext.SetSynchronizationContext(context); + } + } + } +} diff --git a/test/SafeSynchronous.Test/SafeSynchronous.Test.csproj b/test/SafeSynchronous.Test/SafeSynchronous.Test.csproj new file mode 100644 index 0000000..21f9d4a --- /dev/null +++ b/test/SafeSynchronous.Test/SafeSynchronous.Test.csproj @@ -0,0 +1,24 @@ + + + + Alessio Franceschelli + Alessio Franceschelli + + + netcoreapp2.0 + + false + + + + + + + + + + + + + + diff --git a/test/SafeSynchronous.Test/SafeSynchronousTaskTTest.cs b/test/SafeSynchronous.Test/SafeSynchronousTaskTTest.cs new file mode 100644 index 0000000..65d505f --- /dev/null +++ b/test/SafeSynchronous.Test/SafeSynchronousTaskTTest.cs @@ -0,0 +1,50 @@ +using System; +using System.Threading.Tasks; +using Moq; +using Xunit; + +namespace SafeSynchronous.Test +{ + public class SafeSynchronousTaskTTest : SafeSynchronousTaskTestBase + { + [Fact] + public void RunTaskT() + { + async Task SampleTask() => await Task.FromResult(true); + + var result = SafeSynchronousTask.Run(SampleTask); + + Assert.True(result); + VerifyContextCalled(Times.Never); + } + + [Fact] + public void RunTaskTUnwrapException() + { + Assert.Throws(() => SafeSynchronousTask.Run(SampleFaultedTaskT)); + } + + [Fact] + public void EnsureTaskTTestSetupCorectly() + { + var result = SampleTaskT().Result; + + Assert.True(result); + VerifyContextCalled(Times.Once); + } + + [Fact] + public void EnsureFaultedTaskTTestSetupCorectly() + { + Assert.Throws(() => SampleFaultedTaskT().Wait()); + } + + private static async Task SampleTaskT() + { + await Task.Yield(); + return true; + } + + private static Task SampleFaultedTaskT() => Task.FromException(new Exception()); + } +} \ No newline at end of file diff --git a/test/SafeSynchronous.Test/SafeSynchronousTaskTest.cs b/test/SafeSynchronous.Test/SafeSynchronousTaskTest.cs new file mode 100644 index 0000000..ce5bc78 --- /dev/null +++ b/test/SafeSynchronous.Test/SafeSynchronousTaskTest.cs @@ -0,0 +1,43 @@ +using System; +using System.Threading.Tasks; +using Moq; +using Xunit; + +namespace SafeSynchronous.Test +{ + public class SafeSynchronousTaskTest : SafeSynchronousTaskTestBase + { + [Fact] + public void RunTask() + { + SafeSynchronousTask.Run(SampleTask); + + VerifyContextCalled(Times.Never); + } + + [Fact] + public void RunTaskUnwrapException() + { + Assert.Throws(() => SafeSynchronousTask.Run(SampleFaultedTask)); + } + + [Fact] + public void EnsureTaskTestSetupCorectly() + { + async Task SampleTask() => await Task.Yield(); + + SampleTask().Wait(); + + VerifyContextCalled(Times.Once); + } + + [Fact] + public void EnsureFaultedTestSetupCorectly() + { + Assert.Throws(() => SampleFaultedTask().Wait()); + } + + private static async Task SampleTask() => await Task.Yield(); + private static Task SampleFaultedTask() => Task.FromException(new Exception()); + } +} diff --git a/test/SafeSynchronous.Test/SafeSynchronousTaskTestBase.cs b/test/SafeSynchronous.Test/SafeSynchronousTaskTestBase.cs new file mode 100644 index 0000000..a45e81f --- /dev/null +++ b/test/SafeSynchronous.Test/SafeSynchronousTaskTestBase.cs @@ -0,0 +1,31 @@ +using System; +using System.Threading; +using Moq; + +namespace SafeSynchronous.Test +{ + public class SafeSynchronousTaskTestBase : IDisposable + { + private readonly Mock _synchronizationContext; + private readonly SynchronizationContext _testFrameworkSynchronizationContext; + + public SafeSynchronousTaskTestBase() + { + _synchronizationContext = new Mock {CallBase = true}; + + _testFrameworkSynchronizationContext = SynchronizationContext.Current; + SynchronizationContext.SetSynchronizationContext(_synchronizationContext.Object); + } + + protected void VerifyContextCalled(Func times) + { + _synchronizationContext.Verify(context => context.Post(It.IsAny(), It.IsAny()), + times); + } + + public void Dispose() + { + SynchronizationContext.SetSynchronizationContext(_testFrameworkSynchronizationContext); + } + } +} \ No newline at end of file