c# - 如何为返回数组的函数创建单元测试

Question

我是一名开发新手，我正在尝试为下面的代码创建一个单元测试。请注意，代码并不完美，因为我是在我目前所读/所学内容的背景下编写的。它是一个程序，旨在显示用户输入的数字的质因数。在我的单元测试文件中，我创建了一个 PFGen 类的对象，但由于某种原因我无法使用该对象来调用方法 PrimeFactors(它返回一个数组)。将感谢所有帮助。

using System;
using static System.Console;
using System.Diagnostics;
using System.IO;

namespace PrimeFactorsGen
{
    public class PFGen
    {
        public static Array PrimeFactors(int number)
        {
            int[] pf = new int[10];
            int position = 0;

            for(int div = 2; div <= number; div++)
            {
                while(number % div == 0)
                {
                    pf[position] = div;
                    number = number / div;
                    position = position + 1;
                }
            }

            return pf;
        }

        public static void RunPrimeFactor()
        {
            Write("Please enter a value to calculate prime factors: ");
            if (int.TryParse(ReadLine(), out int number)){
                if(number >= 2)
                {
                    WriteLine($"The prime factors of {number} are: ");
                    foreach(var entry in PrimeFactors(number))
                    {
                        Write($"{entry}, ");
                    }
                }
                else
                {
                    WriteLine("Enter a number greater than 2 next time!");
                }
            }else
            {
                WriteLine("Enter a valid number");
            }
        }

        static void Main(string[] args)
        {
            Trace.Listeners.Add(new TextWriterTraceListener(File.CreateText("log.txt")));

            Trace.AutoFlush = true;
            Trace.WriteLine("Trace is listening...");

            RunPrimeFactor();
        }
    }
}

感谢您到目前为止的帮助。我已经能够通过使用 PFGen 直接调用它来访问 PrimeFactors。单元测试代码如下。它过去了。

using System;
using Xunit;
using PrimeFactorsGen;

namespace FactorialUnitTest
{
    public class UnitTest1
    {
        [Fact]
        public void Test1()
        {
            //arrange
            int number = 42;
            int[] expected = { 2, 3, 7, 0, 0, 0, 0, 0, 0, 0 };
            //act
            var actual = PFGen.PrimeFactors(number);
            //assert
            Assert.Equal(actual,expected);
        }
    }
}

Answer 1

这是 XUnit 的一个很好的用例 Theory属性。用 Theory 装饰测试方法属性意味着您可以使用不同的输入和预期的输出多次运行它。

首先，我冒昧地将 PrimeFactors 方法的返回值从数组更改为 List<int>。 (see Microsoft documentation of this class)。与数组相比，这有两个优点:

• 数组的长度在声明时是固定的，而 List<T>随着项目的添加或删除而增长和缩小 - 这消除了数组未使用元素中的误导性零(零不是任何事物的主要因素)。
• A List<T>类型安全——我们知道列表中的每个元素都是 T 类型，任何将非 T 类型的元素放入列表的尝试都会导致编译错误。

public static List<int> PrimeFactors(int number)
{
    //int[] pf = new int[10];
    var pf = new List<int>();
    //int position = 0;

    for (int div = 2; div <= number; div++)
    {
        while (number % div == 0)
        {
            //pf[position] = div;
            pf.Add(div);
            number = number / div;
            //position = position + 1;
        }
    }

    return pf;
}

不管怎样，回到实际问题...

有几种不同的方法可以将测试数据传递给您的 Theory测试，但最简单的可能是添加 InlineData测试方法的属性。 InlineData属性接受与您的测试方法相同的参数，并将这些参数传递给您的测试方法。

这是我写的单元测试:

[Theory]
[InlineData(2, new int[] { 2 })]
[InlineData(3, new int[] { 3 })]
[InlineData(4, new int[] { 2, 2 })]
[InlineData(5, new int[] { 5 })]
[InlineData(6, new int[] { 2, 3 })]
[InlineData(7, new int[] { 7 })]
[InlineData(8, new int[] { 2, 2, 2 })]
[InlineData(9, new int[] { 3, 3 })]
[InlineData(10, new int[] { 2, 5 })]
[InlineData(11, new int[] { 11 })]
[InlineData(12, new int[] { 2, 2, 3 })]
[InlineData(13, new int[] { 13 })]
[InlineData(14, new int[] { 2, 7 })]
[InlineData(15, new int[] { 3, 5 })]
[InlineData(16, new int[] { 2, 2, 2, 2 })]
[InlineData(17, new int[] { 17 })]
[InlineData(18, new int[] { 2, 3, 3 })]
[InlineData(19, new int[] { 19 })]
[InlineData(20, new int[] { 2, 2, 5 })]
[InlineData(21, new int[] { 3, 7 })]
[InlineData(22, new int[] { 2, 11 })]
[InlineData(23, new int[] { 23 })]
[InlineData(24, new int[] { 2, 2, 2, 3 })]
[InlineData(25, new int[] { 5, 5 })]
[InlineData(42, new int[] { 2, 3, 7 })]
public void PrimeFactorsTest(int input, int[] primeFactors)
{
    // Arrange
    var expected = new List<int>(primeFactors);

    // Act
    var actual = PFGen.PrimeFactors(input);

    // Assert
    Assert.Equal(expected, actual);
}

测试方法接受两个参数

• 一个名为 input 的整数- 这是我们想要找到其质因数的数字。
• 一个名为 primeFactors 的数组- 这是我们期望 PrimeFactors 的一系列主要因素返回给定值 input 的方法.

每个InlineData属性将相同的两个参数传递给测试方法，例如

[InlineData(42, new int[] { 2, 3, 7 })]

这会将 42 传递给测试方法的 input参数，以及 2、3 和 7 的数组到测试方法的 primeFactors参数，表示当我们将 42 传递给 PrimeFactors 时方法，我们期望返回的素因子为 2、3 和 7。

如果您想为测试添加更多输入和预期输出，只需添加更多 InlineData属性。