Skip to content

Add extension validation step to CI #2756

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

Closed
wants to merge 15 commits into from
Closed

Add extension validation step to CI #2756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
a418689
initial wip build task
satvu Aug 23, 2024
13d72f6
test vuln
satvu Aug 23, 2024
56eab95
test2
satvu Sep 5, 2024
9719aa0
validation test 3
satvu Sep 9, 2024
e8031c2
test 4 validation
satvu Sep 9, 2024
51cb7e7
test 5
satvu Sep 10, 2024
a2e05fa
test 7
satvu Sep 10, 2024
ec6f879
explicit build target added
satvu Sep 12, 2024
6043e22
add build target and test
satvu Sep 12, 2024
36dc5c2
mv targets to extensions folder
satvu Sep 17, 2024
3845e31
wip, assembly attribute design
satvu Oct 3, 2024
04aab25
move assembly attributes from assemblyinfo.cs to msbuild prop
satvu Oct 3, 2024
866eb54
Move WebJobsExtension projection into target
jviau Oct 4, 2024
aad77f0
test cg
satvu Oct 7, 2024
e80cc1c
cleanup
satvu Oct 7, 2024
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
18 changes: 18 additions & 0 deletions extensions/Directory.Build.Targets
View file
Open in desktop
Copy link
Contributor

@jviau jviau Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small nit on naming: Directory.Build.targets (lowercase t)

Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<Project>

<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory)../, $(_DirectoryBuildTargetsFile)))/$(_DirectoryBuildTargetsFile)"
Condition=" '$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory)../, $(_DirectoryBuildTargetsFile)))' != '' " />

<Import Project="$(MSBuildThisFileDirectory)extensionValidation/GenerateExtensionValidationProjects.targets" />

<Target Name="AddWebJobsExtensionInformation" BeforeTargets="CoreCompile" Condition="'@(WebJobsExtension)' != ''">
Copy link
Contributor

@jviau jviau Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: move this target into GenerateExtensionValidationProjects.targets

<ItemGroup>
<_ExtensionInformationAttribute Include="@(WebJobsExtension->'Microsoft.Azure.Functions.Worker.Extensions.Abstractions.ExtensionInformationAttribute')">
<_Parameter1>%(WebJobsExtension.Identity)</_Parameter1>
<_Parameter2>%(WebJobsExtension.Version)</_Parameter2>
</_ExtensionInformationAttribute>
<AssemblyAttribute Include="@(_ExtensionInformationAttribute)" RemoveMetadata="Version" />
</ItemGroup>
</Target>

</Project>
2 changes: 0 additions & 2 deletions extensions/Worker.Extensions.CosmosDB/src/Properties/AssemblyInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
// Licensed under the MIT License. See License.txt in the project root for license information.

using System.Runtime.CompilerServices;
using Microsoft.Azure.Functions.Worker.Extensions.Abstractions;

[assembly: ExtensionInformation("Microsoft.Azure.WebJobs.Extensions.CosmosDB", "4.8.0")]
[assembly: InternalsVisibleTo("Microsoft.Azure.Functions.Worker.Extensions.Tests, PublicKey=00240000048000009400000006020000002400005253413100040000010001005148be37ac1d9f58bd40a2e472c9d380d635b6048278f7d47480b08c928858f0f7fe17a6e4ce98da0e7a7f0b8c308aecd9e9b02d7e9680a5b5b75ac7773cec096fbbc64aebd429e77cb5f89a569a79b28e9c76426783f624b6b70327eb37341eb498a2c3918af97c4860db6cdca4732787150841e395a29cfacb959c1fd971c1")]
[assembly: InternalsVisibleTo("DynamicProxyGenAssembly2, PublicKey=0024000004800000940000000602000000240000525341310004000001000100c547cac37abd99c8db225ef2f6c8a3602f3b3606cc9891605d02baa56104f4cfc0734aa39b93bf7852f7d9266654753cc297e7d2edfe0bac1cdcf9f717241550e0a7b191195b7667bb4f64bcb8e2121380fd1d9d46ad2d92d2d15605093924cceaf74c4861eff62abf69b9291ed0a340e113be11e6a7d3113e92484cf7045cc7")]
4 changes: 4 additions & 0 deletions extensions/Worker.Extensions.CosmosDB/src/Worker.Extensions.CosmosDB.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,8 @@
<SharedReference Include="..\..\Worker.Extensions.Shared\Worker.Extensions.Shared.csproj" />
</ItemGroup>

<ItemGroup>
<WebJobsExtension Include="Microsoft.Azure.WebJobs.Extensions.CosmosDB" Version="4.8.0" />
</ItemGroup>

</Project>
1 change: 0 additions & 1 deletion extensions/Worker.Extensions.EventGrid/src/Properties/AssemblyInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@
using System.Runtime.CompilerServices;
using Microsoft.Azure.Functions.Worker.Extensions.Abstractions;

[assembly: ExtensionInformation("Microsoft.Azure.WebJobs.Extensions.EventGrid", "3.4.2")]
[assembly: InternalsVisibleTo("Microsoft.Azure.Functions.Worker.Extensions.Tests, PublicKey=00240000048000009400000006020000002400005253413100040000010001005148be37ac1d9f58bd40a2e472c9d380d635b6048278f7d47480b08c928858f0f7fe17a6e4ce98da0e7a7f0b8c308aecd9e9b02d7e9680a5b5b75ac7773cec096fbbc64aebd429e77cb5f89a569a79b28e9c76426783f624b6b70327eb37341eb498a2c3918af97c4860db6cdca4732787150841e395a29cfacb959c1fd971c1")]
4 changes: 4 additions & 0 deletions extensions/Worker.Extensions.EventGrid/src/Worker.Extensions.EventGrid.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,8 @@
<PackageReference Include="Azure.Messaging.EventGrid" Version="4.17.0" />
</ItemGroup>

<ItemGroup>
<WebJobsExtension Include="Microsoft.Azure.WebJobs.Extensions.EventGrid" Version="3.4.2" />
</ItemGroup>

</Project>
2 changes: 0 additions & 2 deletions extensions/Worker.Extensions.EventHubs/src/Properties/AssemblyInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,5 @@
// Licensed under the MIT License. See License.txt in the project root for license information.

using System.Runtime.CompilerServices;
using Microsoft.Azure.Functions.Worker.Extensions.Abstractions;

[assembly: ExtensionInformation("Microsoft.Azure.WebJobs.Extensions.EventHubs", "6.3.5")]
[assembly: InternalsVisibleTo("Microsoft.Azure.Functions.Worker.Extensions.Tests, PublicKey=00240000048000009400000006020000002400005253413100040000010001005148be37ac1d9f58bd40a2e472c9d380d635b6048278f7d47480b08c928858f0f7fe17a6e4ce98da0e7a7f0b8c308aecd9e9b02d7e9680a5b5b75ac7773cec096fbbc64aebd429e77cb5f89a569a79b28e9c76426783f624b6b70327eb37341eb498a2c3918af97c4860db6cdca4732787150841e395a29cfacb959c1fd971c1")]
4 changes: 4 additions & 0 deletions extensions/Worker.Extensions.EventHubs/src/Worker.Extensions.EventHubs.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,8 @@
<SharedReference Include="..\..\Worker.Extensions.Shared\Worker.Extensions.Shared.csproj" />
</ItemGroup>

<ItemGroup>
<WebJobsExtension Include="Microsoft.Azure.WebJobs.Extensions.EventHubs" Version="6.3.5" />
</ItemGroup>

</Project>
6 changes: 0 additions & 6 deletions extensions/Worker.Extensions.Kafka/src/Properties/AssemblyInfo.cs
View file
Open in desktop

This file was deleted.

6 changes: 6 additions & 0 deletions extensions/Worker.Extensions.Kafka/src/Worker.Extensions.Kafka.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<AssemblyName>Microsoft.Azure.Functions.Worker.Extensions.Kafka</AssemblyName>
<RootNamespace>Microsoft.Azure.Functions.Worker.Extensions.Kafka</RootNamespace>
Expand All @@ -18,4 +19,9 @@
<ItemGroup>
<ProjectReference Include="..\..\Worker.Extensions.Abstractions\src\Worker.Extensions.Abstractions.csproj" />
</ItemGroup>

<ItemGroup>
<WebJobsExtension Include="Microsoft.Azure.WebJobs.Extensions.Kafka" Version="3.9.0" />
</ItemGroup>

</Project>
6 changes: 0 additions & 6 deletions extensions/Worker.Extensions.RabbitMQ/src/Properties/AssemblyInfo.cs
View file
Open in desktop

This file was deleted.

4 changes: 4 additions & 0 deletions extensions/Worker.Extensions.RabbitMQ/src/Worker.Extensions.RabbitMQ.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,8 @@
<ProjectReference Include="..\..\Worker.Extensions.Abstractions\src\Worker.Extensions.Abstractions.csproj" />
</ItemGroup>

<ItemGroup>
<WebJobsExtension Include="Microsoft.Azure.WebJobs.Extensions.RabbitMQ" Version="2.0.3" />
</ItemGroup>

</Project>
6 changes: 0 additions & 6 deletions extensions/Worker.Extensions.SendGrid/src/Properties/AssemblyInfo.cs
View file
Open in desktop

This file was deleted.

4 changes: 4 additions & 0 deletions extensions/Worker.Extensions.SendGrid/src/Worker.Extensions.SendGrid.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,8 @@
<ProjectReference Include="..\..\Worker.Extensions.Abstractions\src\Worker.Extensions.Abstractions.csproj" />
</ItemGroup>

<ItemGroup>
<WebJobsExtension Include="Microsoft.Azure.WebJobs.Extensions.SendGrid" Version="3.0.3" />
</ItemGroup>

</Project>
2 changes: 0 additions & 2 deletions extensions/Worker.Extensions.ServiceBus/src/Properties/AssemblyInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,5 @@
// Licensed under the MIT License. See License.txt in the project root for license information.

using System.Runtime.CompilerServices;
using Microsoft.Azure.Functions.Worker.Extensions.Abstractions;

[assembly: ExtensionInformation("Microsoft.Azure.WebJobs.Extensions.ServiceBus", "5.16.4")]
[assembly: InternalsVisibleTo("Microsoft.Azure.Functions.Worker.Extensions.Tests, PublicKey=00240000048000009400000006020000002400005253413100040000010001005148be37ac1d9f58bd40a2e472c9d380d635b6048278f7d47480b08c928858f0f7fe17a6e4ce98da0e7a7f0b8c308aecd9e9b02d7e9680a5b5b75ac7773cec096fbbc64aebd429e77cb5f89a569a79b28e9c76426783f624b6b70327eb37341eb498a2c3918af97c4860db6cdca4732787150841e395a29cfacb959c1fd971c1")]
5 changes: 5 additions & 0 deletions extensions/Worker.Extensions.ServiceBus/src/Worker.Extensions.ServiceBus.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,9 @@
<ItemGroup>
<Protobuf Include="Proto/settlement.proto" GrpcServices="client" Access="internal" />
</ItemGroup>

<ItemGroup>
<WebJobsExtension Include="Microsoft.Azure.WebJobs.Extensions.ServiceBus" Version="5.16.4" />
</ItemGroup>

</Project>
6 changes: 0 additions & 6 deletions extensions/Worker.Extensions.SignalRService/src/Properties/AssemblyInfo.cs
View file
Open in desktop

This file was deleted.

4 changes: 4 additions & 0 deletions extensions/Worker.Extensions.SignalRService/src/Worker.Extensions.SignalRService.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,8 @@
<PackageReference Include="System.Text.Json" Version="5.0.2" />
</ItemGroup>

<ItemGroup>
<WebJobsExtension Include="Microsoft.Azure.WebJobs.Extensions.SignalRService" Version="1.14.0" />
</ItemGroup>

</Project>
2 changes: 0 additions & 2 deletions extensions/Worker.Extensions.Storage.Blobs/src/Properties/AssemblyInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
// Licensed under the MIT License. See License.txt in the project root for license information.

using System.Runtime.CompilerServices;
using Microsoft.Azure.Functions.Worker.Extensions.Abstractions;

[assembly: ExtensionInformation("Microsoft.Azure.WebJobs.Extensions.Storage.Blobs", "5.3.1")]
[assembly: InternalsVisibleTo("Microsoft.Azure.Functions.Worker.Extensions.Tests, PublicKey=00240000048000009400000006020000002400005253413100040000010001005148be37ac1d9f58bd40a2e472c9d380d635b6048278f7d47480b08c928858f0f7fe17a6e4ce98da0e7a7f0b8c308aecd9e9b02d7e9680a5b5b75ac7773cec096fbbc64aebd429e77cb5f89a569a79b28e9c76426783f624b6b70327eb37341eb498a2c3918af97c4860db6cdca4732787150841e395a29cfacb959c1fd971c1")]
[assembly: InternalsVisibleTo("DynamicProxyGenAssembly2, PublicKey=0024000004800000940000000602000000240000525341310004000001000100c547cac37abd99c8db225ef2f6c8a3602f3b3606cc9891605d02baa56104f4cfc0734aa39b93bf7852f7d9266654753cc297e7d2edfe0bac1cdcf9f717241550e0a7b191195b7667bb4f64bcb8e2121380fd1d9d46ad2d92d2d15605093924cceaf74c4861eff62abf69b9291ed0a340e113be11e6a7d3113e92484cf7045cc7")]

4 changes: 4 additions & 0 deletions extensions/Worker.Extensions.Storage.Blobs/src/Worker.Extensions.Storage.Blobs.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,8 @@
<SharedReference Include="..\..\Worker.Extensions.Shared\Worker.Extensions.Shared.csproj" />
</ItemGroup>

<ItemGroup>
<WebJobsExtension Include="Microsoft.Azure.WebJobs.Extensions.Storage.Blobs" Version="5.3.1" />
</ItemGroup>

</Project>
2 changes: 0 additions & 2 deletions extensions/Worker.Extensions.Storage.Queues/src/Properties/AssemblyInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,5 @@
// Licensed under the MIT License. See License.txt in the project root for license information.

using System.Runtime.CompilerServices;
using Microsoft.Azure.Functions.Worker.Extensions.Abstractions;

[assembly: ExtensionInformation("Microsoft.Azure.WebJobs.Extensions.Storage.Queues", "5.3.1")]
[assembly: InternalsVisibleTo("Microsoft.Azure.Functions.Worker.Extensions.Tests, PublicKey=00240000048000009400000006020000002400005253413100040000010001005148be37ac1d9f58bd40a2e472c9d380d635b6048278f7d47480b08c928858f0f7fe17a6e4ce98da0e7a7f0b8c308aecd9e9b02d7e9680a5b5b75ac7773cec096fbbc64aebd429e77cb5f89a569a79b28e9c76426783f624b6b70327eb37341eb498a2c3918af97c4860db6cdca4732787150841e395a29cfacb959c1fd971c1")]
4 changes: 4 additions & 0 deletions extensions/Worker.Extensions.Storage.Queues/src/Worker.Extensions.Storage.Queues.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,8 @@
<SharedReference Include="..\..\Worker.Extensions.Shared\Worker.Extensions.Shared.csproj" />
</ItemGroup>

<ItemGroup>
<WebJobsExtension Include="Microsoft.Azure.WebJobs.Extensions.Storage.Queues" Version="5.3.1" />
</ItemGroup>

</Project>
2 changes: 0 additions & 2 deletions extensions/Worker.Extensions.Tables/src/Properties/AssemblyInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
// Licensed under the MIT License. See License.txt in the project root for license information.

using System.Runtime.CompilerServices;
using Microsoft.Azure.Functions.Worker.Extensions.Abstractions;

[assembly: ExtensionInformation("Microsoft.Azure.WebJobs.Extensions.Tables", "1.3.2")]
[assembly: InternalsVisibleTo("Microsoft.Azure.Functions.Worker.Extensions.Tests, PublicKey=00240000048000009400000006020000002400005253413100040000010001005148be37ac1d9f58bd40a2e472c9d380d635b6048278f7d47480b08c928858f0f7fe17a6e4ce98da0e7a7f0b8c308aecd9e9b02d7e9680a5b5b75ac7773cec096fbbc64aebd429e77cb5f89a569a79b28e9c76426783f624b6b70327eb37341eb498a2c3918af97c4860db6cdca4732787150841e395a29cfacb959c1fd971c1")]
[assembly: InternalsVisibleTo("DynamicProxyGenAssembly2, PublicKey=0024000004800000940000000602000000240000525341310004000001000100c547cac37abd99c8db225ef2f6c8a3602f3b3606cc9891605d02baa56104f4cfc0734aa39b93bf7852f7d9266654753cc297e7d2edfe0bac1cdcf9f717241550e0a7b191195b7667bb4f64bcb8e2121380fd1d9d46ad2d92d2d15605093924cceaf74c4861eff62abf69b9291ed0a340e113be11e6a7d3113e92484cf7045cc7")]
4 changes: 4 additions & 0 deletions extensions/Worker.Extensions.Tables/src/Worker.Extensions.Tables.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,9 @@
<ItemGroup>
<SharedReference Include="..\..\Worker.Extensions.Shared\Worker.Extensions.Shared.csproj" />
</ItemGroup>

<ItemGroup>
<WebJobsExtension Include="Microsoft.Azure.WebJobs.Extensions.Tables" Version="1.3.2" />
</ItemGroup>

</Project>
19 changes: 19 additions & 0 deletions extensions/extensionValidation/GenerateExtensionValidationProjects.targets
View file
Open in desktop
Copy link
Contributor

@jviau jviau Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you move this to eng/build? Also recommend naming WorkerExtensions.targets or something similar - so we can put all extension related targets into it.

Copy link
Contributor

@jviau jviau Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For importing, in the root Directory.Build.props, add this:

<PropertyGroup>
  <RepoRoot>$(MSBuildThisFileDirectory)</RepoRoot>
  <EngRoot>$(RepoRoot)eng/</EngRoot>
  <TargetsRoot>$(EngRoot)build/</TargetsRoot>
</PropertyGroup>

You can then use $(TargetsRoot)WorkerExtensions.targets to import this file in the Directory.Build.targets you are adding.

Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<Project>
<PropertyGroup>
<_ExtensionProjectTemplate>$(MSBuildThisFileDirectory)\extensionProjectTemplate.txt</_ExtensionProjectTemplate>
</PropertyGroup>

<Target Name="GenerateExtensionProject" AfterTargets="Compile" Condition="'@(WebJobsExtension)' != ''">
<MakeDir Directories="$(IntermediateOutputPath)ExtensionValidation" />
<WriteLinesToFile
File="$(IntermediateOutputPath)ExtensionValidation\ExtensionValidation.csproj"
Copy link
Contributor

@jviau jviau Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
File="$(IntermediateOutputPath)ExtensionValidation\ExtensionValidation.csproj"
File="$(IntermediateOutputPath)ExtensionValidation/ExtensionValidation.csproj"

Copy link
Contributor

@jviau jviau Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could pull $(IntermediateOutputPath)ExtensionValidation/ExtensionValidation.csproj into a property for re-use.

Lines="$([System.IO.File]::ReadAllText($(_ExtensionProjectTemplate))
.Replace('$PackageName$', '%(WebJobsExtension.Identity)')
.Replace('$PackageVersion$', '%(WebJobsExtension.Version)'))"
Overwrite="true" />
Copy link
Contributor

@jviau jviau Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine for now, but we may want to do some work for incremental build support. There are a few ways to do it, but primarily you want to only write to files if their contents have actually changed. By not writing to the csproj if it has not changed, restore will no-op as it will be already up to date.

</Target>

<Target Name="BuildGeneratedExtensionProject" AfterTargets="GenerateExtensionProject" Condition="'@(WebJobsExtension)' != ''">
<MSBuild Projects="$(IntermediateOutputPath)\ExtensionValidation\ExtensionValidation.csproj" Targets="Restore;Build" />
Copy link
Contributor

@jviau jviau Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nit: use forward slashes /. Also $(IntermediateOutputPath) already includes a trailing slash.

I think we only need to restore to get the project.assets.json, correct?

Suggested change
<MSBuild Projects="$(IntermediateOutputPath)\ExtensionValidation\ExtensionValidation.csproj" Targets="Restore;Build" />
<MSBuild Projects="$(IntermediateOutputPath)ExtensionValidation/ExtensionValidation.csproj" Targets="Restore" />

</Target>
</Project>
10 changes: 10 additions & 0 deletions extensions/extensionValidation/extensionProjectTemplate.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<OutputType>Library</OutputType>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="$PackageName$" Version="$PackageVersion$" />
</ItemGroup>
</Project>
Loading