DeploymentItem 属性存在问题

Question

我目前正在维护一个用 C# .NET 编写的“旧”系统，删除了一些过时的功能并进行了一些重构。 前一个人写了一些单元测试（MSTests）。 我对 JUnit 测试非常满意，但对 MSTests 还没有做太多事情。

测试方法有一个 DeploymentItem 属性，指定由具有正在测试的业务逻辑的方法解析的文本文件，以及仅指定路径的第二个 DeploymentItem包含一堆也必须部署的 TIF 文件。

[TestMethod()]
[DeploymentItem(@"files\valid\valid_entries.txt")]
[DeploymentItem(@"files\tif\")]
public void ExistsTifTest()
{
   ...
}

测试之前有效，但现在我必须更改 \files\tif 目录中包含的 TIF 文件的名称。 根据规则，TIF 文件名必须匹配特定模式，该模式也由 ExistsTifTest() 方法检查。 现在我必须更改文件名以使它们适应新的要求，突然间 TIF 文件不再像以前那样部署。

有人可以给我提示为什么会发生这种情况或者可能是什么原因吗？ 如果我在 \files\valid\ 目录中的“valid_entries.txt”旁边添加一个新的文本文件“my2ndTest.txt”，并在测试方法上使用相应的 DeploymentItem 属性，也会发生同样的情况。 文件未部署？

我现在通过直接在 testrunco​​nfig 中定义部署路径来部署图像，但我想了解为什么会发生这些事情，或者为什么我的新文件“my2ndTest.txt”没有部署，而其他文件却部署了。

Answer 1

DeploymentItem 有点混乱。

解决方案中的每个文件在 VS.NET 中都会有一个“复制到输出文件夹”设置。 您需要将其设置为“始终复制”（或类似的）才能将文件放入输出文件夹中。

检查您是否已为新文件设置了此设置。 如果您没有进行此设置，则文件将不会复制到输出文件夹，并且无法将它们从输出文件夹部署到 MSTest 执行操作的文件夹。

就我个人而言，如果我有单元测试所需的文件，我发现将这些文件作为资源嵌入到程序集中，并在测试期间让该程序集“解包”本身是一种更可预测的做事方式。 YMMV。

注意：这些评论基于我使用 VS2010 的经验。 对我的回答的评论表明这不是 VS2012 的问题。 我仍然坚持这样的观点，即使用嵌入式资源涉及较少的“魔力”，并且对我来说，使我的单元测试的“安排”阶段更加明确。

Answer 2

在 VS2010 中，我的 Local.testsettings 未选中“启用部署”，并且 DeploymentItem 属性不起作用。 我检查了一下，一切正常。
我希望这有帮助！

Answer 3

我也遇到过类似的问题，但我找到了简单的三步解决方案：

假设您的文件夹结构如下所示：
<代码>
解决方案文件夹\
测试项目文件夹\
子文件夹\

1. 转到“解决方案项目/Local.testsettings”> “部署”> 检查“启用部署”
2. 如果您使用的是 VS2010，请确保要部署的任何文件的“复制到输出文件夹”属性设置为“始终复制”或“如果较新则复制”
3. 使用以下任一方式为您的 TestMethod 赋予属性：
   • [DeploymentItem(@"TestProjectFolder\SubFolder")] 将 的所有内容部署到测试运行目录
   • [DeploymentItem(@"TestProjectFolder\SubFolder", "TargetFolder")] 将 的所有内容部署到 < /code> 在测试运行目录

   


最后一个关于 MSTest 的注意事项（至少对于 VS2010）：

如果您希望 与 具有相同的名称，请使用 [DeploymentItem当 MSTest 运行程序遇到愚蠢的边缘情况时， (@"SubFolder", @"SubFolder")] 将默默失败。 这就是为什么您应该在 前添加 前缀，如下所示：[DeploymentItem(@"TestProjectFolder\SubFolder", @"SubFolder “）]

Answer 4

希望可以帮助其他人：我尝试了这里的所有建议，但仍然我的部署项目没有被复制。

我必须做什么（按照此处的建议）是向 DeploymentItem 属性添加第二个参数：

[DeploymentItem(@"UnitTestData\TestData.xml", "UnitTestData")]

Answer 5

如果您进入 .testrunco​​nfig 文件并在部署下取消选中“启用部署”，测试将在正常位置运行，并且一切都会像在单元测试之外运行应用程序时一样工作。

Answer 6

这可能与您的确切问题无关，但这里有一些我在 [DeploymentItem] 属性中发现的提示。

1. 复制到输出目录应设置为始终复制。

当与 [TestInitialize] 属性一起使用时，它不能工作

[TestInitialize]
[DeploymentItem("test.xlsx")]
public void Setup()
{

它应该在您的 [TestMethod] 上，例如

    [TestInitialize]
    public void Setup()
    {
        string spreadsheet = Path.GetFullPath("test.xlsx");
        Assert.IsTrue(File.Exists(spreadsheet));
        ...
    }

    [TestMethod]
    [DeploymentItem("test.xlsx")]
    public void ExcelQuestionParser_Reads_XmlElements()
    {
        ...
    }

Answer 7

不要使用DeploymentItem。

正确设置非常困难，并且它无法与我的 ReSharper 测试运行程序或 Visual Studio 2017 中 MSTEST 的本机运行程序一起使用。

相反，右键单击您的数据文件，然后选择属性。 选择复制到输出目录：始终。

现在在您的测试中，执行此操作。 该目录只是相对于测试项目的文件目录。 简单的。

    [TestMethod()]
    public void ParseProductsTest()
    {
        // Arrange
        var file = @"Features\ParseProducts\Files\ParseProducts_Workbook_2017.xlsx";
        var fileStream = File.Open(file, FileMode.Open);
        // etc.
    }

这似乎确实适用于自动化构建和测试系统。

下面是文件在解决方案中的位置的图片：

Answer 8

在尝试了此处列出的所有其他建议后，我仍然无法弄清楚发生了什么。 最后我发现在测试/测试设置菜单下没有选择设置文件，这意味着部署没有被启用。 我单击“测试/测试设置/选择测试设置文件”菜单项，选择 Local.TestSettings 文件，然后一切正常。

Answer 9

不确定这是否完全回答了问题，但可能对一些人有帮助。
首先，我发现必须选中“启用部署”框才能使部署正常工作。
其次，文档说源路径是“相对于项目路径”，起初我认为它是指项目文件夹。 事实上，它似乎指的是构建输出文件夹。
因此，如果我有一个名为“TestFiles”的项目文件夹，其中有一个名为 Testdata.xml 的文件，则以这种方式使用该属性不起作用：

[DeploymentItem(@"TestFiles\Testdata.xml")] 

我可以标记 Testdata.xml code> 文件 始终复制，以便构建将副本放在输出文件夹下（例如，Debug\TestFiles\TestData.xml）。 然后，部署机制将找到位于相对于构建输出的该路径 (TestFiles\Testdata.xml) 的文件副本。
或者，我可以这样设置属性：

[DeploymentItem(@"..\\..\TestFiles\Testdata.xml")] 

部署机制将找到原始文件。
因此，两者都有效，但我注意到，使用 Copy Always 我偶尔会遇到在项目中编辑 app.config 文件时遇到的相同问题 - 如果我不更改代码或强制执行重建，没有任何东西会触发复制标记为在构建时复制的文件。

Answer 10

我首先禁用了部署标志。 但即使在我启用它之后，由于某种未知的原因，甚至目标 DLL 仍然不会被复制。 我不小心打开了“测试运行”窗口并终止了之前的所有运行，并且神奇地我在下一次运行的测试文件夹中找到了我需要的所有 DLL 和文件...非常令人困惑。

Answer 11

我在尝试部署文件时遇到了巨大的问题 - 尝试了上面的所有建议。

然后我关闭了VS2010； 重新启动它，加载解决方案，一切正常。 (!)

我做了一些检查； 在 local.TestSetting 上设置“启用部署”标志后，您不应简单地从“测试结果”窗口重新运行测试。 您必须从 UI 中删除先前的测试运行，例如通过运行不同的测试或重新打开解决方案。

Answer 12

对于那些希望避免 DeploymentItem 混乱并采用@Martin Peck（已接受答案）建议的方法的人，您可以使用以下代码来访问嵌入资源的内容：

public string GetEmbeddedResource(string fullyQulifiedResourceName)
{
    var assembly = Assembly.GetExecutingAssembly();
    // NOTE resourceName is of the format "Namespace.Class.File.extension";

    using (Stream stream = assembly.GetManifestResourceStream(fullyQulifiedResourceName))
    using (StreamReader reader = new StreamReader(stream))
    {
        string result = reader.ReadToEnd();
    }
}

有关详细信息，请参阅 这个SO线程

Answer 13

由于我总是发现 DeploymentItem 属性一团糟，因此我使用构建后脚本来部署此类文件。
- 确保您要复制的文件设置了“始终复制”属性。
- 修改您的测试项目构建后脚本，将文件从构建目标文件夹 (Bin\Debug) 复制到测试所需的位置。

Answer 14

在 VS2010 上试试这个。 因此您不需要为每个 tif 添加 DeployItems
删除

[DeploymentItem(@"files\valid\valid_entries.txt")]  
[DeploymentItem(@"files\tif\")]  

添加测试配置。
- 右键单击​​解决方案资源管理器中的解决方案节点
- 添加-> 新项目...
- 选择左侧的测试设置节点，选择右侧的项目
- 单击“添加”，

调用它，例如TDD

选择TestMenu 下的TDD > 编辑测试设置。

单击“部署”。 启用它，然后添加所需的文件和目录。将会有一个相对于解决方案的路径。 文件将被放上。
例如，原始文件如下：

D:\Users\Patrik\Documents\Visual Studio 2010\Projects\DCArrDate\WebMVCDCArrDate\Trunk\WebMVCDCArrDate\Authority.xml  

当我运行单元测试时，它会被复制到

D:\Users\Patrik\Documents\Visual Studio 2010\Projects\DCArrDate\WebMVCDCArrDate\Trunk\WebMVCDCArrDate.Tests\bin\Debug\TestResults\Patrik_HERKULES 2011-12-17 18_03_27\Authority.xml  

我调用它的测试代码中：

[TestMethod()]
public void Read_AuthorityFiles_And_ParseXML_To_Make_Dictonary()  
{  
  string authorityFile = "Authority.xml";  
  var Xmldoc = XDocument.Load(authorityFile);  

无需选择“始终复制”； 将文件放入测试项目中； 在测试代​​码中添加硬编码路径。 对我来说这个解决方案效果最好。 我尝试使用 DeploymentItem，总是复制，但它不符合我的喜好。

Answer 15

对我来说，根本原因完全是另一回事：我的测试所执行的生产代码是重命名和/或删除正在部署的 .xml 测试文件。

因此，当我单独运行测试时，它们会通过，但是当一起运行它们时，第二个和后续测试将失败，并出现“文件未找到”错误（我最初将其误诊为 DeploymentItem< /code> 属性不起作用）。

我的解决方案是让每个单独的测试方法复制已部署的文件（使用此技术），然后让正在测试的生产代码使用复制的文件而不是原始文件。

Answer 16

我们花了很多时间来解决部署项目问题，在本地单元测试运行和 teamcity 单元测试重新运行中也解决了这个问题。 这不简单。

调试此问题的非常好的工具是 ProcessExplorer。 使用流程资源管理器，您可以检查Visual Studio在哪里搜索部署项并对项目进行更正。 只需过滤路径包含您的部署项文件名的所有文件操作，您就会看到它。

Answer 17

除了需要检查 Deployment 属性之外，我还发现了有关 DeploymentItem 属性的其他内容。

[TestMethod()]
[DeploymentItem("folder\subfolder\deploymentFile.txt")]
public void TestMethod1()
{
   ...
}

您的deploymentFile.txt需要与解决方案文件相关，而不是与testfile.cs相关。

Answer 18

我一直在VS2013中从事这个工作。 我的发现是为了使其正常工作：“

• 复制到输出目录”应设置为“如果较新则复制/始终复制：强制”。
• .TestSettings 中的“启用部署”：不需要。 我得到了这个工作
  根本没有 .TestSettings 文件。
• 指定文件夹作为第二个参数：可选。 塑造输出文件夹布局，无需使用即可正常工作。
• 文件名中的空格：这让我很头疼 - 文件从未被复制。 删除空格解决了这个问题。 还没有研究过转义字符。

我还通过惨痛的经历学到了一个技巧：不要忘记将此属性添加到每个单独的测试中。 该文件在测试运行中的第一个属性测试上进行复制，但当测试顺序更改并且非属性测试首先尝试查找该文件时，该文件仍然丢失。

Answer 19

我最大的“问题”是 DeploymentItem 处理目录的方式。 我使用的是双参数版本，两者都作为包含我想要部署的子目录的目录路径。 我最初没有意识到它只复制目录根目录中的内容，而不是整个递归文件夹结构！

我基本上有 [DeploymentItem(@"Foo\", @"Foo\")] 并期望它部署我的 Foo\Bar。 我特别必须将其更改为 [DeploymentItem(@"Foo\Bar\", @"Foo\Bar\")]，现在它就像一个魅力。

Answer 20

我也遇到过类似的问题。 我已经完成了上述所有步骤，但仍然没有运气。 我用的是VS2010。 然后我发现 $Menu > 测试> 选择主动测试设置 > 选择跟踪和测试影响。 在我将跟踪和测试影响更改为本地后，它开始工作。 此页面包含有关将文件复制到测试结果文件夹的非常丰富的信息，我觉得也可以添加此经验。