Skip to content

[SourceGen] Add GeneratedCode Attribute #2104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
satvu merged 13 commits into from
Nov 30, 2023
Merged

[SourceGen] Add GeneratedCode Attribute #2104

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
12f7e99
first draft, example test changes
satvu Nov 28, 2023
0da01e7
add compiler generated attribute
satvu Nov 29, 2023
caf60a8
release notes
satvu Nov 29, 2023
30a6508
Merge branch 'main' into satvu/code-gen-attribute
satvu Nov 29, 2023
807fe72
resolve comments
satvu Nov 29, 2023
804bb8a
resolve comments
satvu Nov 29, 2023
3da48f2
cleanup
satvu Nov 29, 2023
3d0eb11
more cleanup
satvu Nov 29, 2023
829b575
more cleanup
satvu Nov 29, 2023
c5e63ff
Merge branch 'main' into satvu/code-gen-attribute
satvu Nov 29, 2023
762b8d0
fix test
satvu Nov 29, 2023
ceddead
Merge branch 'satvu/code-gen-attribute' of https://github.com/Azure/a…
satvu Nov 29, 2023
ebd6087
fix new test pulled in
satvu Nov 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions ...Generators/FunctionMetadataProviderGenerator/FunctionMetadataProviderGenerator.Emitter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
// Licensed under the MIT License. See License.txt in the project root for license information.

using System.Collections.Generic;
using System.Diagnostics;
using System.Reflection;
using System.Text;
using System.Text.Json;
using System.Threading;
Expand All @@ -22,6 +24,9 @@ internal sealed class Emitter
public string Emit(GeneratorExecutionContext context, IReadOnlyList<GeneratorFunctionMetadata> funcMetadata, bool includeAutoRegistrationCode)
{
string functionMetadataInfo = AddFunctionMetadataInfo(funcMetadata, context.CancellationToken);
Assembly assembly = Assembly.GetExecutingAssembly();
FileVersionInfo fileVersionInfo = FileVersionInfo.GetVersionInfo(assembly.Location);
string generatorVersion = fileVersionInfo.ProductVersion;
Comment thread
satvu marked this conversation as resolved.
Outdated

return $$"""
// <auto-generated/>
Expand All @@ -41,6 +46,7 @@ namespace {{FunctionsUtil.GetNamespaceForGeneratedCode(context)}}
/// Custom <see cref="IFunctionMetadataProvider"/> implementation that returns function metadata definitions for the current worker."/>
/// </summary>
[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)]
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Azure.Functions.Worker.Sdk.Generators", "{{generatorVersion}}")]
public class GeneratedFunctionMetadataProvider : IFunctionMetadataProvider
{
/// <inheritdoc/>
Expand Down
1 change: 1 addition & 0 deletions ...k.Generator.Tests/FunctionMetadataProviderGeneratorTests/AutoConfigureStartupTypeTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ namespace TestProject
/// Custom <see cref=""IFunctionMetadataProvider""/> implementation that returns function metadata definitions for the current worker.""/>
/// </summary>
[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)]
[global::System.CodeDom.Compiler.GeneratedCodeAttribute(""Microsoft.Azure.Functions.Worker.Sdk.Generators"", ""1.1.4-local+5ee6e55d820a2ddfc019b1a57553560859c3d01b"")]
public class GeneratedFunctionMetadataProvider : IFunctionMetadataProvider
{{
/// <inheritdoc/>
Expand Down
26 changes: 20 additions & 6 deletions ...erator.Tests/FunctionMetadataProviderGeneratorTests/IntegratedTriggersAndBindingsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@
// Licensed under the MIT License. See License.txt in the project root for license information.

using System.Collections.Generic;
using System.Diagnostics;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Threading.Tasks;
using Microsoft.Azure.Functions.Worker.Sdk.Generators;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Testing;
using Xunit;

Expand All @@ -15,9 +18,14 @@ public partial class FunctionMetadataProviderGeneratorTests
public class IntegratedTriggersAndBindingsTests
{
private readonly Assembly[] _referencedExtensionAssemblies;
private readonly string _generatorVersion;

public IntegratedTriggersAndBindingsTests()
{
var generatorAssembly = Assembly.LoadFrom("Microsoft.Azure.Functions.Worker.Sdk.Generators.dll");
FileVersionInfo fileVersionInfo = FileVersionInfo.GetVersionInfo(generatorAssembly.Location);
_generatorVersion = fileVersionInfo.ProductVersion!;

// load all extensions used in tests (match extensions tested on E2E app? Or include ALL extensions?)
var abstractionsExtension = Assembly.LoadFrom("Microsoft.Azure.Functions.Worker.Extensions.Abstractions.dll");
var httpExtension = Assembly.LoadFrom("Microsoft.Azure.Functions.Worker.Extensions.Http.dll");
Expand Down Expand Up @@ -94,7 +102,7 @@ public class MyOutputTypeNoHttpProp


string expectedGeneratedFileName = $"GeneratedFunctionMetadataProvider.g.cs";
string expectedOutput = """
string expectedOutput = $$"""
// <auto-generated/>
using System;
using System.Collections.Generic;
Expand All @@ -112,6 +120,7 @@ namespace TestProject
/// Custom <see cref="IFunctionMetadataProvider"/> implementation that returns function metadata definitions for the current worker."/>
/// </summary>
[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)]
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Azure.Functions.Worker.Sdk.Generators", "{{_generatorVersion}}")]
public class GeneratedFunctionMetadataProvider : IFunctionMetadataProvider
{
/// <inheritdoc/>
Expand Down Expand Up @@ -229,7 +238,7 @@ public class Book
""";

string expectedGeneratedFileName = $"GeneratedFunctionMetadataProvider.g.cs";
string expectedOutput = """
string expectedOutput = $$"""
// <auto-generated/>
using System;
using System.Collections.Generic;
Expand All @@ -247,6 +256,7 @@ namespace TestProject
/// Custom <see cref="IFunctionMetadataProvider"/> implementation that returns function metadata definitions for the current worker."/>
/// </summary>
[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)]
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Azure.Functions.Worker.Sdk.Generators", "{{_generatorVersion}}")]
public class GeneratedFunctionMetadataProvider : IFunctionMetadataProvider
{
/// <inheritdoc/>
Expand Down Expand Up @@ -339,7 +349,7 @@ public FakeAttribute(string name)
""";

string expectedGeneratedFileName = $"GeneratedFunctionMetadataProvider.g.cs";
string expectedOutput = """
string expectedOutput = $$"""
// <auto-generated/>
using System;
using System.Collections.Generic;
Expand All @@ -357,6 +367,7 @@ namespace TestProject
/// Custom <see cref="IFunctionMetadataProvider"/> implementation that returns function metadata definitions for the current worker."/>
/// </summary>
[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)]
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Azure.Functions.Worker.Sdk.Generators", "{{_generatorVersion}}")]
public class GeneratedFunctionMetadataProvider : IFunctionMetadataProvider
{
/// <inheritdoc/>
Expand Down Expand Up @@ -434,7 +445,7 @@ public Task RunTimer([TimerTrigger("0 0 0 * * *", RunOnStartup = false)] object
""";

string expectedGeneratedFileName = $"GeneratedFunctionMetadataProvider.g.cs";
string expectedOutput = """
string expectedOutput = $$"""
// <auto-generated/>
using System;
using System.Collections.Generic;
Expand All @@ -452,6 +463,7 @@ namespace TestProject
/// Custom <see cref="IFunctionMetadataProvider"/> implementation that returns function metadata definitions for the current worker."/>
/// </summary>
[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)]
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Azure.Functions.Worker.Sdk.Generators", "{{_generatorVersion}}")]
public class GeneratedFunctionMetadataProvider : IFunctionMetadataProvider
{
/// <inheritdoc/>
Expand Down Expand Up @@ -528,7 +540,7 @@ public Task<HttpResponseData> Http([HttpTrigger(AuthorizationLevel.Admin, "get",
""";

string expectedGeneratedFileName = $"GeneratedFunctionMetadataProvider.g.cs";
string expectedOutput = """
string expectedOutput = $$"""
// <auto-generated/>
using System;
using System.Collections.Generic;
Expand All @@ -546,6 +558,7 @@ namespace TestProject
/// Custom <see cref="IFunctionMetadataProvider"/> implementation that returns function metadata definitions for the current worker."/>
/// </summary>
[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)]
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Azure.Functions.Worker.Sdk.Generators", "{{_generatorVersion}}")]
public class GeneratedFunctionMetadataProvider : IFunctionMetadataProvider
{
/// <inheritdoc/>
Expand Down Expand Up @@ -632,7 +645,7 @@ public async Task<HttpResponseData> RunAsync2([HttpTrigger(AuthorizationLevel.An
""";

string expectedGeneratedFileName = $"GeneratedFunctionMetadataProvider.g.cs";
string expectedOutput = """
string expectedOutput = $$"""
// <auto-generated/>
using System;
using System.Collections.Generic;
Expand All @@ -650,6 +663,7 @@ namespace TestProject
/// Custom <see cref="IFunctionMetadataProvider"/> implementation that returns function metadata definitions for the current worker."/>
/// </summary>
[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Never)]
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Azure.Functions.Worker.Sdk.Generators", "{{_generatorVersion}}")]
public class GeneratedFunctionMetadataProvider : IFunctionMetadataProvider
{
/// <inheritdoc/>
Expand Down