Update all examples from template changes

- Add appsettings.json copying - Update Cloud Event to CloudEvent
GoogleCloudPlatform · May 24, 2021 · 9ddddca · 9ddddca
1 parent 6832a52
commit 9ddddca
Show file tree

Hide file tree

Showing 27 changed files with 52 additions and 38 deletions.
diff --git a/docs/examples.md b/docs/examples.md
@@ -378,15 +378,6 @@ by the `ASPNETCORE_ENVIRONMENT` and `DOTNET_ENVIRONMENT` environment variables.
 > environment variables on a user level, to avoid accidentally attempting to run against the production
 > configuration.
 
-> **Note on AppSettings files**
->
-> Currently, `appsettings.json` files are not copied by default when the project is published using `dotnet publish`.
-> This means that although the function meay run as expected locally, when it is deployed the settings files would be
-> absent. This can be fixed by explicitly including them in the project file, [as shown in this
-> example](../examples/Google.Cloud.Functions.Examples.Configuration/Google.Cloud.Functions.Examples.Configuration.csproj).
-> We hope to do this implicitly in a future release. See [issue
-> 201](https://github.com/GoogleCloudPlatform/functions-framework-dotnet/issues/201) for more information.
-
 Sample deployment:
 
 ```sh

diff --git a/...cedDependencyInjection/Google.Cloud.Functions.Examples.AdvancedDependencyInjection.csproj b/...cedDependencyInjection/Google.Cloud.Functions.Examples.AdvancedDependencyInjection.csproj
@@ -5,6 +5,7 @@
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 
 </Project>
diff --git a/...s.Examples.CustomConfiguration/Google.Cloud.Functions.Examples.CustomConfiguration.csproj b/...s.Examples.CustomConfiguration/Google.Cloud.Functions.Examples.CustomConfiguration.csproj
@@ -6,6 +6,7 @@
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
     <PackageReference Include="Steeltoe.Extensions.Configuration.RandomValueBase" Version="2.4.4" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 
 </Project>
diff --git a/...es.CustomEventDataFunction/Google.Cloud.Functions.Examples.CustomEventDataFunction.csproj b/...es.CustomEventDataFunction/Google.Cloud.Functions.Examples.CustomEventDataFunction.csproj
@@ -7,5 +7,6 @@
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
     <PackageReference Include="CloudNative.CloudEvents.NewtonsoftJson" Version="2.0.0-beta.3" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 </Project>
diff --git a/examples/Google.Cloud.Functions.Examples.FSharpEventFunction/Function.fs b/examples/Google.Cloud.Functions.Examples.FSharpEventFunction/Function.fs
@@ -29,11 +29,11 @@ open System.Threading.Tasks
 type Function() =
     interface ICloudEventFunction<StorageObjectData> with
         /// <summary>
-        /// Logic for your function goes here. Note that a Cloud Event function just consumes an event;
+        /// Logic for your function goes here. Note that a CloudEvent function just consumes an event;
         /// it doesn't provide any response.
         /// </summary>
-        /// <param name="cloudEvent">The Cloud Event your function should consume.</param>
-        /// <param name="data">The deserialized data within the Cloud Event.</param>
+        /// <param name="cloudEvent">The CloudEvent your function should consume.</param>
+        /// <param name="data">The deserialized data within the CloudEvent.</param>
         /// <param name="cancellationToken">A cancellation token that is notified if the request is aborted.</param>
         /// <returns>A task representing the asynchronous operation.</returns>
         member this.HandleAsync(cloudEvent, data, cancellationToken) =
@@ -42,7 +42,7 @@ type Function() =
             printfn "  Bucket: %s" data.Bucket
             printfn "  Size: %i" data.Size
             printfn "  Content type: %s" data.ContentType
-            printfn "Cloud event information:"
+            printfn "CloudEvent information:"
             printfn "  ID: %s" cloudEvent.Id
             printfn "  Source: %O" cloudEvent.Source
             printfn "  Type: %s" cloudEvent.Type

diff --git a/...s.Examples.FSharpEventFunction/Google.Cloud.Functions.Examples.FSharpEventFunction.fsproj b/...s.Examples.FSharpEventFunction/Google.Cloud.Functions.Examples.FSharpEventFunction.fsproj
@@ -6,6 +6,7 @@
 
   <ItemGroup>
     <Compile Include="Function.fs" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/...ons.Examples.FSharpHttpFunction/Google.Cloud.Functions.Examples.FSharpHttpFunction.fsproj b/...ons.Examples.FSharpHttpFunction/Google.Cloud.Functions.Examples.FSharpHttpFunction.fsproj
@@ -1,11 +1,12 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.1</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
     <Compile Include="Function.fs" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/examples/Google.Cloud.Functions.Examples.FSharpUntypedEventFunction/Function.fs b/examples/Google.Cloud.Functions.Examples.FSharpUntypedEventFunction/Function.fs
@@ -20,14 +20,14 @@ open System.Threading.Tasks
 type Function() =
     interface ICloudEventFunction with
         /// <summary>
-        /// Logic for your function goes here. Note that a Cloud Event function just consumes an event;
+        /// Logic for your function goes here. Note that a CloudEvent function just consumes an event;
         /// it doesn't provide any response.
         /// </summary>
-        /// <param name="cloudEvent">The Cloud Event your function should consume.</param>
+        /// <param name="cloudEvent">The CloudEvent your function should consume.</param>
         /// <param name="cancellationToken">A cancellation token that is notified if the request is aborted.</param>
         /// <returns>A task representing the asynchronous operation.</returns>
         member this.HandleAsync(cloudEvent, cancellationToken) =
-            printfn "Cloud event information:"
+            printfn "CloudEvent information:"
             printfn "ID: %s" cloudEvent.Id
             printfn "Source: %A" cloudEvent.Source
             printfn "Type: %s" cloudEvent.Type

diff --git a/...arpUntypedEventFunction/Google.Cloud.Functions.Examples.FSharpUntypedEventFunction.fsproj b/...arpUntypedEventFunction/Google.Cloud.Functions.Examples.FSharpUntypedEventFunction.fsproj
@@ -1,11 +1,12 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.1</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
     <Compile Include="Function.fs" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/...gle.Cloud.Functions.Examples.Middleware/Google.Cloud.Functions.Examples.Middleware.csproj b/...gle.Cloud.Functions.Examples.Middleware/Google.Cloud.Functions.Examples.Middleware.csproj
@@ -7,6 +7,7 @@
 
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 
 </Project>
diff --git a/...Examples.MultiProjectFunction/Google.Cloud.Functions.Examples.MultiProjectFunction.csproj b/...Examples.MultiProjectFunction/Google.Cloud.Functions.Examples.MultiProjectFunction.csproj
@@ -6,6 +6,7 @@
 
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/...impleDependencyInjection/Google.Cloud.Functions.Examples.SimpleDependencyInjection.csproj b/...impleDependencyInjection/Google.Cloud.Functions.Examples.SimpleDependencyInjection.csproj
@@ -6,5 +6,6 @@
 
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 </Project>
diff --git a/examples/Google.Cloud.Functions.Examples.SimpleEventFunction/Function.cs b/examples/Google.Cloud.Functions.Examples.SimpleEventFunction/Function.cs
@@ -31,11 +31,11 @@ namespace Google.Cloud.Functions.Examples.SimpleEventFunction
     public class Function : ICloudEventFunction<StorageObjectData>
     {
         /// <summary>
-        /// Logic for your function goes here. Note that a Cloud Event function just consumes an event;
+        /// Logic for your function goes here. Note that a CloudEvent function just consumes an event;
         /// it doesn't provide any response.
         /// </summary>
-        /// <param name="cloudEvent">The Cloud Event your function should consume.</param>
-        /// <param name="data">The deserialized data within the Cloud Event.</param>
+        /// <param name="cloudEvent">The CloudEvent your function should consume.</param>
+        /// <param name="data">The deserialized data within the CloudEvent.</param>
         /// <param name="cancellationToken">A cancellation token that is notified if the request is aborted.</param>
         /// <returns>A task representing the asynchronous operation.</returns>
         public Task HandleAsync(CloudEvent cloudEvent, StorageObjectData data, CancellationToken cancellationToken)
@@ -45,7 +45,7 @@ public Task HandleAsync(CloudEvent cloudEvent, StorageObjectData data, Cancellat
             Console.WriteLine($"  Bucket: {data.Bucket}");
             Console.WriteLine($"  Size: {data.Size}");
             Console.WriteLine($"  Content type: {data.ContentType}");
-            Console.WriteLine("Cloud event information:");
+            Console.WriteLine("CloudEvent information:");
             Console.WriteLine($"  ID: {cloudEvent.Id}");
             Console.WriteLine($"  Source: {cloudEvent.Source}");
             Console.WriteLine($"  Type: {cloudEvent.Type}");

diff --git a/...s.Examples.SimpleEventFunction/Google.Cloud.Functions.Examples.SimpleEventFunction.csproj b/...s.Examples.SimpleEventFunction/Google.Cloud.Functions.Examples.SimpleEventFunction.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.1</TargetFramework>
@@ -7,5 +7,6 @@
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
     <PackageReference Include="Google.Events.Protobuf" Version="1.0.0-beta04" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 </Project>
diff --git a/...ons.Examples.SimpleHttpFunction/Google.Cloud.Functions.Examples.SimpleHttpFunction.csproj b/...ons.Examples.SimpleHttpFunction/Google.Cloud.Functions.Examples.SimpleHttpFunction.csproj
@@ -1,10 +1,11 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.1</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 </Project>
diff --git a/examples/Google.Cloud.Functions.Examples.SimpleUntypedEventFunction/Function.cs b/examples/Google.Cloud.Functions.Examples.SimpleUntypedEventFunction/Function.cs
@@ -26,12 +26,12 @@ public class Function : ICloudEventFunction
         /// Logic for your function goes here. Note that a CloudEvent function just consumes an event;
         /// it doesn't provide any response.
         /// </summary>
-        /// <param name="cloudEvent">The Cloud Event your function should consume.</param>
+        /// <param name="cloudEvent">The CloudEvent your function should consume.</param>
         /// <param name="cancellationToken">A cancellation token that is notified if the request is aborted.</param>
         /// <returns>A task representing the asynchronous operation.</returns>
         public Task HandleAsync(CloudEvent cloudEvent, CancellationToken cancellationToken)
         {
-            Console.WriteLine("Cloud event information:");
+            Console.WriteLine("CloudEvent information:");
             Console.WriteLine($"ID: {cloudEvent.Id}");
             Console.WriteLine($"Source: {cloudEvent.Source}");
             Console.WriteLine($"Type: {cloudEvent.Type}");

diff --git a/...pleUntypedEventFunction/Google.Cloud.Functions.Examples.SimpleUntypedEventFunction.csproj b/...pleUntypedEventFunction/Google.Cloud.Functions.Examples.SimpleUntypedEventFunction.csproj
@@ -1,10 +1,11 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.1</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 </Project>
diff --git a/...amples.StorageImageAnnotator/Google.Cloud.Functions.Examples.StorageImageAnnotator.csproj b/...amples.StorageImageAnnotator/Google.Cloud.Functions.Examples.StorageImageAnnotator.csproj
@@ -9,5 +9,6 @@
     <PackageReference Include="Google.Cloud.Storage.V1" Version="3.2.0" />
     <PackageReference Include="Google.Cloud.Vision.V1" Version="2.0.0" />
     <PackageReference Include="Google.Events.Protobuf" Version="1.0.0-beta04" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 </Project>
diff --git a/...Examples.TestableDependencies/Google.Cloud.Functions.Examples.TestableDependencies.csproj b/...Examples.TestableDependencies/Google.Cloud.Functions.Examples.TestableDependencies.csproj
@@ -5,6 +5,7 @@
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 
 </Project>
diff --git a/...tions.Examples.TimeZoneConverter/Google.Cloud.Functions.Examples.TimeZoneConverter.csproj b/...tions.Examples.TimeZoneConverter/Google.Cloud.Functions.Examples.TimeZoneConverter.csproj
@@ -8,5 +8,6 @@
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
     <PackageReference Include="NodaTime" Version="3.0.0" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 </Project>
diff --git a/examples/Google.Cloud.Functions.Examples.VbEventFunction/CloudFunction.vb b/examples/Google.Cloud.Functions.Examples.VbEventFunction/CloudFunction.vb
@@ -28,11 +28,11 @@ Public Class CloudFunction
     Implements ICloudEventFunction(Of StorageObjectData)
 
     ''' <summary>
-    ''' Logic for your function goes here. Note that a Cloud Event function just consumes an event;
+    ''' Logic for your function goes here. Note that a CloudEvent function just consumes an event;
     ''' it doesn't provide any response.
     ''' </summary>
-    ''' <param name="cloudEvent">The Cloud Event your function should consume.</param>
-    ''' <param name="data">The deserialized data within the Cloud Event.</param>
+    ''' <param name="cloudEvent">The CloudEvent your function should consume.</param>
+    ''' <param name="data">The deserialized data within the CloudEvent.</param>
     ''' <param name="cancellationToken">A cancellation token that is notified if the request is aborted.</param>
     ''' <returns>A task representing the asynchronous operation.</returns>
     Public Function HandleAsync(cloudEvent As CloudEvent, data As StorageObjectData, cancellationToken As CancellationToken) As Task _
@@ -42,7 +42,7 @@ Public Class CloudFunction
         Console.WriteLine($"  Bucket: {data.Bucket}")
         Console.WriteLine($"  Size: {data.Size}")
         Console.WriteLine($"  Content type: {data.ContentType}")
-        Console.WriteLine("Cloud event information:")
+        Console.WriteLine("CloudEvent information:")
         Console.WriteLine($"  ID: {cloudEvent.Id}")
         Console.WriteLine($"  Source: {cloudEvent.Source}")
         Console.WriteLine($"  Type: {cloudEvent.Type}")

diff --git a/...Functions.Examples.VbEventFunction/Google.Cloud.Functions.Examples.VbEventFunction.vbproj b/...Functions.Examples.VbEventFunction/Google.Cloud.Functions.Examples.VbEventFunction.vbproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <RootNamespace>Google.Cloud.Functions.Examples.VbEventFunction</RootNamespace>
@@ -8,5 +8,6 @@
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
     <PackageReference Include="Google.Events.Protobuf" Version="1.0.0-beta04" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 </Project>
diff --git a/...d.Functions.Examples.VbHttpFunction/Google.Cloud.Functions.Examples.VbHttpFunction.vbproj b/...d.Functions.Examples.VbHttpFunction/Google.Cloud.Functions.Examples.VbHttpFunction.vbproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <RootNamespace>Google.Cloud.Functions.Examples.VbHttpFunction</RootNamespace>
@@ -7,5 +7,6 @@
 
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 </Project>
diff --git a/examples/Google.Cloud.Functions.Examples.VbUntypedEventFunction/CloudFunction.vb b/examples/Google.Cloud.Functions.Examples.VbUntypedEventFunction/CloudFunction.vb
@@ -20,15 +20,15 @@ Public Class CloudFunction
     Implements ICloudEventFunction
 
     ''' <summary>
-    ''' Logic for your function goes here. Note that a Cloud Event function just consumes an event;
+    ''' Logic for your function goes here. Note that a CloudEvent function just consumes an event;
     ''' it doesn't provide any response.
     ''' </summary>
-    ''' <param name="cloudEvent">The Cloud Event your function should consume.</param>
+    ''' <param name="cloudEvent">The CloudEvent your function should consume.</param>
     ''' <param name="cancellationToken">A cancellation token that is notified if the request is aborted.</param>
     ''' <returns>A task representing the asynchronous operation.</returns>
     Public Function HandleAsync(cloudEvent As CloudEvent, cancellationToken As CancellationToken) As Task _
         Implements ICloudEventFunction.HandleAsync
-        Console.WriteLine("Cloud event information:")
+        Console.WriteLine("CloudEvent information:")
         Console.WriteLine($"ID: {cloudEvent.Id}")
         Console.WriteLine($"Source: {cloudEvent.Source}")
         Console.WriteLine($"Type: {cloudEvent.Type}")

diff --git a/...ples.VbUntypedEventFunction/Google.Cloud.Functions.Examples.VbUntypedEventFunction.vbproj b/...ples.VbUntypedEventFunction/Google.Cloud.Functions.Examples.VbUntypedEventFunction.vbproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <RootNamespace>Google.Cloud.Functions.Examples.VbUntypedEventFunction</RootNamespace>
@@ -7,5 +7,6 @@
 
   <ItemGroup>
     <PackageReference Include="Google.Cloud.Functions.Hosting" Version="1.0.0-beta04" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 </Project>
diff --git a/install-local-templates.sh b/install-local-templates.sh
@@ -13,6 +13,10 @@ NUGET_SOURCE=$PWD/src/Google.Cloud.Functions.Templates/bin/Release/
 
 # Come out of the functions-framework-dotnet directory to use the default SDK,
 # which is what VS uses.
-$(cd .. && dotnet new -i Google.Cloud.Functions.Templates::$VERSION --nuget-source=$NUGET_SOURCE)
+(cd .. && dotnet new -i Google.Cloud.Functions.Templates::$VERSION --nuget-source=$NUGET_SOURCE)
+
+# Also install within functions-framework-dotnet directory so that it will
+# be installed for use in examples/generate.sh
+dotnet new -i Google.Cloud.Functions.Templates::$VERSION --nuget-source=$NUGET_SOURCE
 
 echo "Installed local templates as version $VERSION"
diff --git a/src/Google.Cloud.Functions.Templates/templates/http-function-fs/MyFunction.fsproj b/src/Google.Cloud.Functions.Templates/templates/http-function-fs/MyFunction.fsproj
@@ -6,6 +6,7 @@
 
   <ItemGroup>
     <Compile Include="Function.fs" />
+    <None Include="appsettings*.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 
   <ItemGroup>