Tests.targets

<!-- Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. -->
<Project>

  <PropertyGroup Condition="'$(IsTestProject)' == 'true'">
    <AutoGenerateBindingRedirects Condition="'$(TargetFrameworkIdentifier)' == '.NETFramework'">true</AutoGenerateBindingRedirects>

    <_GetTestsToRunTarget Condition="'$(TargetFrameworks)' == ''">_InnerGetTestsToRun</_GetTestsToRunTarget>
    <_GetTestsToRunTarget Condition="'$(TargetFrameworks)' != ''">_OuterGetTestsToRun</_GetTestsToRunTarget>

    <!-- The runtime to run tests on: 'Core', 'Mono', 'Full' (desktop FX). -->
    <TestRuntime Condition="'$(TestRuntime)' == '' and '$(TargetFrameworkIdentifier)' == '.NETCoreApp'">Core</TestRuntime>
    <TestRuntime Condition="'$(TestRuntime)' == '' and '$(MSBuildRuntimeType)' == 'Mono'">Mono</TestRuntime>
    <TestRuntime Condition="'$(TestRuntime)' == '' and '$(OS)' == 'Windows_NT'">Full</TestRuntime>

    <TestRunnerName Condition="'$(TestRunnerName)' == ''">XUnit</TestRunnerName>
    <TestRunnerName Condition="'$(UsingToolXUnit)' == 'false'"></TestRunnerName>

    <!--
      Look for the specified test runner in the building repository first.
      If we can't find it see if the requested test runner provided by the Arcade SDK.
    -->
    <TestRunnerTargets>$(RepositoryEngineeringDir)$(TestRunnerName)\$(TestRunnerName).targets</TestRunnerTargets>
    <TestRunnerTargets Condition="!Exists($(TestRunnerTargets))">$(MSBuildThisFileDirectory)$(TestRunnerName)\$(TestRunnerName).targets</TestRunnerTargets>
  </PropertyGroup>

  <Target Name="ErrorForMissingTestRunner" Condition="'$(IsTestProject)' == 'true' AND '$(TestRunnerName)' != ''">
    <Error Condition="!Exists($(TestRunnerTargets))" Text="Test runner $(TestRunnerName) is invalid."/>
  </Target>

  <!--
    Phase 1 of the test-runner consolidation effort. See
    Documentation/TestRunnerConsolidation.md for the full plan.

    We warn when a project opts into a code path that is scheduled for
    removal so that downstream repos can migrate before the next major
    Arcade release. Suppress by setting:
      <NoWarn>$(NoWarn);ARCADE0001;ARCADE0002</NoWarn>
  -->
  <Target Name="_WarnDeprecatedTestRunnerOptions"
          Condition="'$(IsTestProject)' == 'true' AND '$(SuppressArcadeTestRunnerDeprecationWarnings)' != 'true'"
          BeforeTargets="Test;IntegrationTest;Build">
    <Warning Code="ARCADE0001"
             Text="The 'UsingToolXUnit' property is deprecated and will be removed in a future Arcade release. Use the 'TestRunnerName' property (e.g. TestRunnerName=XUnitV3) to select a test runner. See Documentation/TestRunnerConsolidation.md."
             Condition="'$(_UsingToolXUnitExplicitlySet)' == 'true'" />

    <Warning Code="ARCADE0002"
             Text="The 'UseVSTestRunner' property is deprecated and the VSTest-based runner path will be removed in a future Arcade release. Migrate to Microsoft.Testing.Platform (the default for xUnit v3 and MSTest 4.x). See Documentation/TestRunnerConsolidation.md."
             Condition="'$(UseVSTestRunner)' == 'true'" />
  </Target>

  <PropertyGroup Condition="'$(IsTestProject)' == 'true' and '$(TestArchitectures)' == ''">
    <TestArchitectures>$(PlatformTarget)</TestArchitectures>
    <TestArchitectures Condition="'$(PlatformTarget)' == '' or '$(PlatformTarget)' == 'AnyCpu'">x64</TestArchitectures>
  </PropertyGroup>

  <Target Name="Test" DependsOnTargets="ErrorForMissingTestRunner;$(_GetTestsToRunTarget);RunTests" Condition="'$(IsUnitTestProject)' == 'true' or '$(IsPerformanceTestProject)' == 'true'" />
  <Target Name="IntegrationTest" DependsOnTargets="ErrorForMissingTestRunner;$(_GetTestsToRunTarget);RunTests" Condition="'$(IsIntegrationTestProject)' == 'true'" />

  <ItemGroup>
    <_TestArchitectureItems Include="$(TestArchitectures)" />
  </ItemGroup>

  <!-- Using Inputs/Outputs just to loop over test architectures -->
  <Target Name="_InnerGetTestsToRun"
          Outputs="%(_TestArchitectureItems.Identity)"
          Returns="@(TestToRun)"
          DependsOnTargets="ComputeRunArguments"
          Condition="'$(TestRuntime)' != '' and '$(SkipTests)' != 'true' and
                     ('$(TestTargetFrameworks)' == '' or $([System.String]::new(';$(TestTargetFrameworks);').Contains(';$(TargetFramework);')))">

    <PropertyGroup>
      <_TestArchitecture>%(_TestArchitectureItems.Identity)</_TestArchitecture>
      <_ResultFileNameNoExt>$(MSBuildProjectName)_$(TargetFramework)_$(_TestArchitecture)</_ResultFileNameNoExt>

      <!-- Send the logs into the default location, unless overriden by the consumer -->
      <TestResultsLogDir Condition=" '$(TestResultsLogDir)' == '' ">$(ArtifactsLogDir)</TestResultsLogDir>
    </PropertyGroup>

    <ItemGroup>
      <TestToRun Include="$(TargetPath)">
        <TargetFramework>$(TargetFramework)</TargetFramework>
        <TargetFrameworkIdentifier>$(TargetFrameworkIdentifier)</TargetFrameworkIdentifier>
        <TargetFrameworkVersion>$(TargetFrameworkVersion)</TargetFrameworkVersion>
        <TestRuntime>$(TestRuntime)</TestRuntime>
        <TestTimeout>$(TestTimeout)</TestTimeout>
        <Architecture>$(_TestArchitecture)</Architecture>
        <EnvironmentDisplay>$(TargetFramework)|$(_TestArchitecture)</EnvironmentDisplay>
        <ResultsFilePathWithoutExtension>$(_ResultFileNameNoExt)</ResultsFilePathWithoutExtension>
        <ResultsXmlPath>$(ArtifactsTestResultsDir)$(_ResultFileNameNoExt).xml</ResultsXmlPath>
        <ResultsTrxPath>$(ArtifactsTestResultsDir)$(_ResultFileNameNoExt).trx</ResultsTrxPath>
        <ResultsHtmlPath>$(ArtifactsTestResultsDir)$(_ResultFileNameNoExt).html</ResultsHtmlPath>
        <ResultsStdOutPath>$(TestResultsLogDir)$(_ResultFileNameNoExt).log</ResultsStdOutPath>
        <TestRunSettingsFile>$(TestRunSettingsFile)</TestRunSettingsFile>
        <TestRunnerAdditionalArguments>$(TestRunnerAdditionalArguments)</TestRunnerAdditionalArguments>
        <IsTestingPlatformApplication>$(IsTestingPlatformApplication)</IsTestingPlatformApplication>
        <RunArguments>$(RunArguments)</RunArguments>
        <RunCommand>$(RunCommand)</RunCommand>
      </TestToRun>
    </ItemGroup>
  </Target>

  <Target Name="_OuterGetTestsToRun" Returns="@(TestToRun)">
    <ItemGroup>
      <_TargetFramework Include="$(TargetFrameworks)" />
    </ItemGroup>
    <MSBuild Projects="$(MSBuildProjectFile)"
             Condition="'$(TargetFrameworks)' != ''"
             Targets="_InnerGetTestsToRun"
             Properties="TargetFramework=%(_TargetFramework.Identity)">
      <Output ItemName="TestToRun" TaskParameter="TargetOutputs" />
    </MSBuild>
  </Target>

  <!-- Import specialized targets files of supported test runners -->
  <Import Project="$(TestRunnerTargets)" Condition="'$(IsTestProject)' == 'true' and '$(TestRunnerName)' != '' and Exists('$(TestRunnerTargets)')"/>
  
  <!-- Allow for repo specific Test targets such as rerunning tests -->
  <Import Project="$(RepositoryEngineeringDir)Tests.targets" Condition="Exists('$(RepositoryEngineeringDir)Tests.targets')" />

</Project>