Unable to build projects with Allure using .NET Core

[darrenge]

Doing a "dotnet build" from cmd prompt causes an error.

.nuget\packages\aspectinjector\2.8.1\buildTransitive\netstandard2.0\AspectInjector.targets(102,5): error MSB4803: The task "GetFrameworkSdkPath" is not supported on the .NET Core version of MSBuild. Please use the .NET Framework version of MSBuild.

The work around is to add this to the project:
<AspectInjector_Enabled>false</AspectInjector_Enabled>

But then again for Allure.NUnit and Allure.Xunit, attribute-based steps (the [AllureStep] attribute), won't work without AspectInjector.

[delatrie]

Hi, @darrenge . Sorry I took so long.

Actually, this is something we've faced ourselves in this repo. AspectInjector doesn't resign assemblies properly when running against .NET Framework via the dotnet CLI.

Currently, we use a combination of two techniques to workaround the issue. Each requires putting a bunch of targets in the .targets file shared by all projects affected by AspectInjector (e.g., in Directory.Build.targets in some common directory). Here is where these are defined in this repo:

allure-csharp/Directory.Build.targets

Line 55 in 977f3fa

<Target Name="Allure_SetAssemblyTimestampBeforeAspectInjection"

The first thing to do is to disable AspectInjector just before it starts resigning, and enable it again right after the resigning task is skipped:

<Target Name="Allure_DisableAspectInjector"
        BeforeTargets="_ASI_ResignAssembly"
        AfterTargets="_ASI_InjectAspectsCore"
        Condition=" '$(_InjectionNeeded)' == 'true' ">
    <PropertyGroup>
        <Allure_ShouldEnableAspectInjector>true</Allure_ShouldEnableAspectInjector>
        <_InjectionNeeded>false</_InjectionNeeded>
    </PropertyGroup>
</Target>

<Target Name="Allure_EnableAspectInjector"
        BeforeTargets="_ASI_TouchTimestampFile"
        AfterTargets="_ASI_ResignAssembly"
        Condition=" '$(Allure_ShouldEnableAspectInjector)' == 'true' ">
    <PropertyGroup>
        <_InjectionNeeded>true</_InjectionNeeded>
    </PropertyGroup>
</Target>

The second is to actually resign the assembly so it works in .NET Framework:

<Target Name="Allure_SetAssemblyTimestampBeforeAspectInjection"
        AfterTargets="CoreCompile"
        BeforeTargets="$(_InjectAspectsDependsOn)">
    <PropertyGroup>
        <Allure_AssemblyTimestampBeforeAspectInjection>%(IntermediateAssembly.ModifiedTime)</Allure_AssemblyTimestampBeforeAspectInjection>
    </PropertyGroup>
</Target>

<Target Name="Allure_SetAssemblyTimestampAfterAspectInjection"
        AfterTargets="AspectInjector_InjectAspects;InjectAspects"
        BeforeTargets="Allure_UpdateStrongNameSignatures">
    <PropertyGroup>
        <Allure_AssemblyTimestampAfterAspectInjection>%(IntermediateAssembly.ModifiedTime)</Allure_AssemblyTimestampAfterAspectInjection>
    </PropertyGroup>
</Target>

<Target Name="Allure_UpdateStrongNameSignatures"
        Condition=" '$(OS)' == 'Windows_NT'
            And '$(SignAssembly)' == 'true'
            And Exists('$(AssemblyOriginatorKeyFile)')
            And Exists('$(Allure_SnExePath)')
            And '$(Allure_AssemblyTimestampBeforeAspectInjection)' != '$(Allure_AssemblyTimestampAfterAspectInjection)'"
        AfterTargets="AspectInjector_InjectAspects;InjectAspects"
        BeforeTargets="_TimeStampAfterCompile;AfterCompile">
    <Exec   UseUtf8Encoding="Always"
            StdOutEncoding="UTF-8"
            StdErrEncoding="UTF-8"
            Command="&quot;$(Allure_SnExePath)&quot; -Ra &quot;%(IntermediateAssembly.FullPath)&quot; &quot;$(AssemblyOriginatorKeyFile)&quot;"
    />
</Target>

The resign target only kicks in if AspectInjector actually modifies the assembly (i.e., if the assembly contains injections like [AllureStep] applied to a method, or if it defines its own aspects). This is necessary to prevent sn.exe from crashing the build with a file lock error (at least that's what happened on my machine and in GitHub actions).

Also, the Allure_SnExePath environment variable must point to sn.exe (comes with Visual Studio). On a dev machine it can be hardcoded.

In a CI workflow, we use vswhere.exe (available by default in GitHub Windows workers) to find Launch-VsDevShell.ps1. When loaded, it makes sn.exe available in PATH. Then, Get-Command sn.exe will return the location of sn.exe. See how we use ./build/findvstool.ps1 in the publish workflow.

I understand this is cumbersome. Currently, I'm experimenting with an alternative approach to defining Allure steps. If it works, we may get rid or at least reduce the importance of AspectInjector in many cases, which will automatically solve this issue.

[darrenge]

At this time, we are able to get what we need with <AspectInjector_Enabled>false</AspectInjector_Enabled>. We aren't fully implemented yet, so maybe we will need to get this point at a future date.