Merge pull request #106 from richardschneider/async-stream

Async streams (C# 8.0)

Author: richardschneider

.travis.yml

@@ -2,12 +2,12 @@ language: csharp
 sudo: required
 mono: none
 dist: xenial
-dotnet: 2.2.300
+dotnet: 3.0.100
 os:
   - linux
   - osx
 
 script:
   - dotnet restore
-  - dotnet build -c Release --no-restore --framework netstandard2 ./src
-  - dotnet test  -c Release --no-restore --framework netcoreapp2.1 ./test
+  - dotnet build -c Release --no-restore --framework netcoreapp3.0 ./src
+  - dotnet test  -c Release --no-restore --framework netcoreapp3.0 ./test

appveyor.yml

@@ -14,7 +14,7 @@ for:
       secure: NeX5NCOUXsCLc1UjTJjqB9F02FZ8Wq0VsxqTXC8kBdyK6zjxjebrf/9Da2sY1Kql
 
 configuration: Release
-os: Visual Studio 2017
+os: Visual Studio 2019
 
 init:
   - git config --global core.autocrlf input
@@ -23,17 +23,15 @@ init:
   - git config --global user.email "[email protected]"
   - git config --global user.name "Appveyor CI"
 
-cache:
-  - packages -> **\packages.config      # preserve "packages" directory in the root of build folder but will reset it if packages.config is modified
-
 environment:
   COVERALLS_REPO_TOKEN:
     secure: j4sELCwhVRRjNXFVhjPZjdG4y2itz8jrExhlyDU/lTiLlRQ/P4brB69MGQRFBQae
   DOTNET_CLI_TELEMETRY_OPTOUT: 1
 
 # tools we need for bulding/testing/deploying
 install:
-  - choco install gitversion.portable -y
+  # see https://help.appveyor.com/discussions/problems/24758-gitversion-5-not-working-on-visual-studio-2019-build
+  - choco install gitversion.portable -y --version 4.0.0
   - npm install [email protected] -g
   # No longer signing the assembly
   #- nuget install secure-file -ExcludeVersion
@@ -46,7 +44,9 @@ nuget:
   disable_publish_on_pr: true
 
 before_build:
-  - ps: gitversion /output buildserver /updateAssemblyInfo >gitversion.log
+#  - ps: gitversion /output buildserver /updateAssemblyInfo >gitversion.log
+  - gitversion /output buildserver /updateAssemblyInfo >gitversion
+
   - echo %GitVersion_MajorMinorPatch%
   - echo %GitVersion_NuGetVersion%
 
@@ -55,8 +55,7 @@ build_script:
 
 after_build:
 # Build documentation in doc\_site
-# v2.43 is requiring VS 2019!!!
-  - cmd: choco install docfx -y --version 2.42 --force
+  - cmd: choco install docfx -y
   - cmd: builddocs.cmd
   - cmd: 7z a -tzip docs.zip doc\_site
   - cmd: appveyor PushArtifact docs.zip
@@ -67,7 +66,7 @@ test_script:
 
 after_test: 
 # Generate coverage report
-    - dotnet test -c %CONFIGURATION% -f netcoreapp2.1 --no-build --no-restore test /p:CollectCoverage=true
+    - dotnet test -c %CONFIGURATION% -f netcoreapp3.0 --no-build --no-restore test /p:CollectCoverage=true /p:Include="[Ipfs.Core]*"
     - choco install codecov -y
     - codecov -f "test/coverage.opencover.xml"
     - dotnet tool install --global coveralls.net --version 1.0.0

doc/docfx.json

@@ -15,7 +15,7 @@
         }
       ],
       "properties": {
-        "TargetFramework": "net45"
+        "TargetFramework": "netcoreapp3.0"
       },
 
       "dest": "api"

src/CoreApi/IGenericApi.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Runtime.CompilerServices;
 using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
@@ -114,5 +115,49 @@ Task<IEnumerable<PingResult>> PingAsync(
             int count = 10,
             CancellationToken cancel = default(CancellationToken)
             );
+
+#if ASYNCSTREAM
+        /// <summary>
+        ///   Send echo requests to a peer.
+        /// </summary>
+        /// <param name="peer">
+        ///   The peer ID to receive the echo requests.
+        /// </param>
+        /// <param name="count">
+        ///   The number of echo requests to send.  Defaults to 10.
+        /// </param>
+        /// <param name="cancel">
+        ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
+        /// </param>
+        /// <returns>
+        ///   An asynchronous stream of <see cref="PingResult"/>.
+        /// </returns>
+        IAsyncEnumerable<PingResult> Ping(
+            MultiHash peer,
+            int count = 10,
+            CancellationToken cancel = default
+            );
+
+        /// <summary>
+        ///   Send echo requests to a peer.
+        /// </summary>
+        /// <param name="address">
+        ///   The address of a peer to receive the echo requests.
+        /// </param>
+        /// <param name="count">
+        ///   The number of echo requests to send.  Defaults to 10.
+        /// </param>
+        /// <param name="cancel">
+        ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
+        /// </param>
+        /// <returns>
+        ///   An asynchronous stream of <see cref="PingResult"/>.
+        /// </returns>
+        IAsyncEnumerable<PingResult> Ping(
+            MultiAddress address,
+            int count = 10,
+            CancellationToken cancel = default
+            );
+#endif
     }
 }

src/IpfsCore.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netstandard14;netstandard2;net45</TargetFrameworks>
+    <TargetFrameworks>netstandard14;netstandard2;net45;netcoreapp3.0</TargetFrameworks>
     <AssemblyName>Ipfs.Core</AssemblyName>
     <RootNamespace>Ipfs</RootNamespace>
     <DebugType>portable</DebugType>
@@ -63,4 +63,9 @@
   <PropertyGroup Condition=" '$(TargetFramework)' == 'netstandard14'">
     <DefineConstants>NETSTANDARD14</DefineConstants>
   </PropertyGroup>
+
+  <PropertyGroup Condition=" '$(TargetFramework)' == 'netcoreapp3.0'">
+    <DefineConstants>ASYNCSTREAM</DefineConstants>
+  </PropertyGroup>
+
 </Project>

test/CoreApi/ObjectStatTest.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Linq;
+using System.Text;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace Ipfs.CoreApi
+{
+    [TestClass]
+    public class ObjectStatTest
+    {
+        [TestMethod]
+        public void Properties()
+        {
+            var stat = new ObjectStat
+            {
+                BlockSize = 1,
+                CumulativeSize = 2,
+                DataSize = 3,
+                LinkCount = 4,
+                LinkSize = 5
+            };
+            Assert.AreEqual(1, stat.BlockSize);
+            Assert.AreEqual(2, stat.CumulativeSize);
+            Assert.AreEqual(3, stat.DataSize);
+            Assert.AreEqual(4, stat.LinkCount);
+            Assert.AreEqual(5, stat.LinkSize);
+        }
+
+    }
+}

test/CoreApi/PingResultTest.cs

@@ -0,0 +1,27 @@
+using System;
+using System.Linq;
+using System.Text;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace Ipfs.CoreApi
+{
+    [TestClass]
+    public class PingResultTest
+    {
+        [TestMethod]
+        public void Properties()
+        {
+            var time = TimeSpan.FromSeconds(3);
+            var r = new PingResult
+            {
+                Success = true,
+                Text = "ping",
+                Time = time
+            };
+            Assert.AreEqual(true, r.Success);
+            Assert.AreEqual("ping", r.Text);
+            Assert.AreEqual(time, r.Time);
+        }
+
+    }
+}

test/IpfsCoreTests.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net45;netcoreapp1.1;netcoreapp2.1</TargetFrameworks>
+    <TargetFrameworks>net45;netcoreapp1.1;netcoreapp2.1;netcoreapp3.0</TargetFrameworks>
 
     <IsPackable>false</IsPackable>
     <DebugType>portable</DebugType>