DeploymentItem Metadata

Artikel
12/15/2021

DeploymentItem metadata identifies file and folder dependencies for the files and folders that are used by the tests during the tests' execution so that Taef could be able to identify these and copy them appropriately (for example, in a cross machine execution scenario, Taef will deploy the files identified by DeploymentItem property to the specified test machine).

Taef DeploymentItem implementation is very similar to that found in the DeploymentItemAttribute Class in VSTS.

DeploymentItem metadata can be applied on either assembly, class, or test level. The items specified by DeploymentItem metadata will be deployed by the time correspondent (assembly, test class or test) setup runs. If DeploymentItem metadata specifies a dependency (for example, a file) and that dependency already exists at the destination, TAEF does a CRC comparison and only copies the file if it has changed. If DeploymentItem metadata specifies a dependency and the dependency cannot be found, an error is logged that will fail the test (or all test class or assembly tests, accordingly). TAEF will only deploy files once per assembly, class, or test - that is, the deployment does not happen at every assembly, class, or test expansion if these are data driven.

Syntax

[DeploymentItem("FileOrFolderToDeploy", "DestinationFolder")]

where FileOrFolderToDeployis a file or a folder path relative to the directory where test dll is. If FileOrFolderToDeploy is a folder, all its contents is copied; however, the folder itself does not get created. If there is a hierarchy of folders under FileOrFolderToDeploy, Taef will copy all these directories recursively, maintaining their directory hierarchy.

DestinationFolder is a folder path relative to the directory where the test dll is and where the deployment items are copied. DestinationFolder path could be specified using .. notation (for example, ..\MyFiles).

To deploy to the folder where your test dll is, you can omit DestinationFolder.

[DeploymentItem("FileOrFolderToDeploy")]

Multiple pieces of the property are supported. For example:

[TestClass]
[DeploymentItem("file1.xml")]
[DeploymentItem("file2.xml")]
[DeploymentItem("file3.xml")]
public class UnitTest1
{
    ...
}

Examples

[DeploymentItem("file1.xml")]

Tags file1.xml that is located next to the test dll as a dependency. This metadata could be interpreted as that the system deploys an item named file1.xml located in the folder next to the test dll to the test dll directory. This configuration is only useful for cross machine scenario.

[DeploymentItem("file2.xml", "DataFiles")]

Deploys an item named file2.xml located next to the test dll to the created DataFiles subdirectory in the test dll directory.

[DeploymentItem("C:\\\\MyDataFiles\\\\MyDataFiles2\\\\")]

Deploys all items and directories found within the C:\\MyDataFiles\\MyDataFiles2\\ directory. This configuration does not create the MyDataFiles\MyDataFiles2 directory underneath the deployment directory. All files and directories within MyDataFiles will be deployed to test dll directory. To copy the entire MyDataFiles\MyDataFiles2 directory structure, you must specify MyDataFiles\MyDataFiles2 as an output directory.

[DeploymentItem("%myDir%\\myFile.txt")]

Deploys the file myFile.txt if that file exists in the directory to which %myDir% resolves. If TAEF is unable to resolve the environment variable, it throws an error.

Managed Tests

The DeploymentItem (aka DeploymentItemAttribute) attribute can be applied to a test method (decorated by [TestMethod] attribute), test class (decorated by [TestClass] attribute) or test assembly. However, since VSTS does not support this property on assembly level, to apply this property on assembly level, you have to apply it to assembly setup (decorated by AssemblyInitialize attribute):

[AssemblyInitialize]
[DeploymentItem("file1.xml")]
[DeploymentItem("file2.xml")]
[DeploymentItem("file3.xml")]
public  static AssemblySetup(TestContext testContext)
{
    ...
}

Native Tests

For native tests, the property format is similar to the managed code format. However, since native properties only have a single value, the item path and optional destination are specified in the property value, separated with a '>' character:

BEGIN_TEST_CLASS(TestClassExample)
    TEST_CLASS_PROPERTY(L"DeploymentItem", L"C:\\Dependencies\\>Dependencies")
END_TEST_CLASS()

Script Tests

For script tests, the property format is the same as for native tests:

<method name="TestOne">
    <TestMethodProperty name="DeploymentItem" value="C:\\Dependencies\\>Dependencies"/>
</method>

Delen via