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

时间:2018-06-17 18:20:06

标签: c#

我是新手开发者,我正在尝试为下面的代码创建一个单元测试。请注意,代码并不完美,因为我已经在我到目前为止阅读/学习的内容中编写了代码。它的程序旨在显示用户输入的数字的素因子。在我的单元测试文件中,我创建了一个类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);
        }
    }
}

2 个答案:

答案 0 :(得分: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 传递给 {{1 }} 方法,我们期望返回的质因数为 2、3 和 7。

如果您想向测试添加更多输入和预期输出,只需添加更多 PrimeFactors 属性。

答案 1 :(得分:0)

不要使用 Array 类型。使用类型安全的 int[] 或可变长度 List<int>。您可以使用 CollectionAssert.AreEqual()

查看集合

例如在测试方法中

List<int> actual = PrimeFactors(42);
int[] expected = new int[] { 2, 3, 7 };
CollectionAssert.AreEqual(expected, actual);