xUnit测试将模型添加到列表失败

本文关键字:列表 失败 添加 模型 测试 xUnit | 更新日期: 2023-09-27 18:05:26

我使用xUnit来测试我的项目。我有一个测试,检查user是否已经添加了userslist,如下所示:

private readonly IJsonService _jsonService;
private readonly IUserService _userService;
[Fact]
    public void Add_User_To_User_List()
    {
        //Given
        _userService = new UserService(_jsonService, _guidService);
        _jsonService = Substitute.For<IJsonService>();
        var _fakeUserJsonFile = "Users.json";
        var _fakeNewUser = new User()
        {
            ID = new Guid(),
            FirstName = "Denis",
            LastName = "Menis"
        };
        var _fakeUserList = new List<User>
        {
            new User()
                {
                    ID = new Guid(),
                    FirstName = "Paddy",
                    LastName = "Halle"
                },
            new User()
                {
                    ID = new Guid(),
                    FirstName = "Job",
                    LastName = "Blogs"
                }
        };
        var _fakeUpdatedUserList = new List<User>
        {
            new User()
                {
                    ID = new Guid(),
                    FirstName = "Paddy",
                    LastName = "Halle"
                },
            new User()
                {
                    ID = new Guid(),
                    FirstName = "Job",
                    LastName = "Blogs"
                },
            new User()
                {
                    ID = new Guid(),
                    FirstName = "Denis",
                    LastName = "Menis"
                }
        };
        _jsonService.DeserializeObject<User>(_fakeUserJsonFile).Returns(_fakeUserList);
        _jsonService.SerializeObject(_fakeUserJsonFile, _fakeUpdatedUserList).Returns(true);
        //When
        var result = _userService.AddUser(_fakeNewUser);
        //Then
        Assert.Contains(_fakeNewUser, _fakeUpdatedUserList);
    }

现在我知道代码可以工作,因为我先写了它,但是当我运行测试时,它失败了!下面是我将用户添加到用户列表的代码:

public bool AddUser(User user)
    {
        var userList = GetUsers();
        user.ID = _guidService.NewGuid();
        userList.Add(user);
        var serializeObject = _jsonService.SerializeObject(_fileName, userList);
        return serializeObject;
    }

GetUser方法:

public List<User> GetUsers()
    {
        return _jsonService.DeserializeObject<User>(_fileName).ToList();
    }

Deserialise方法:

private readonly IFileSystem _file;
    private readonly HttpContextBase _httpContext;
    private readonly ILogger _logger;
    public JsonService(IFileSystem file, HttpContextBase httpContext, ILogger logger)
    {
        _file = file;
        _httpContext = httpContext;
        _logger = logger;
    }
    public IEnumerable<T> DeserializeObject<T>(string fileName)
    {
        try
        {
            var relativeFileName = _httpContext.Server.MapPath(fileName);
            var readFile = _file.ReadAllText(relativeFileName);
            var list = JsonConvert.DeserializeObject<List<T>>(readFile);
            return list;
        }
        catch (Exception ex)
        {
            _logger.LogException(ex);
            return null;
        }
    }

文件系统类:

public class FileSystem : IFileSystem
{
    public void WriteAllText(string path, string contents)
    {
        File.WriteAllText(path, contents);
    }
    public string ReadAllText(string path)
    {
        return File.ReadAllText(path);
    }
}

当我运行测试时,AddUser方法中的var serializeObject = _jsonService.SerializeObject(_fileName, userList);每次都返回false。

我认为它这样做是因为即使它是与预期结果相同的数据,在内存中它是对相同数据的不同引用。

谁能帮我这个我想要它返回相同的引用数据。如果我说得不够清楚,我可以再详细说明。由于

xUnit测试将模型添加到列表失败

你完全正确,问题的根源在于_fakeUserList_fakeUpdatedUserList引用了两个完全不同的对象。您已将_jsonService.SerializeObject配置为在传递给_fakeUpdatedUserList的引用时返回true -但您实际上传递给(修改后的)_fakeUserList的引用。

基本上,_fakeUpdatedUserList是完全不必要的。您可以关注_fakeUserList,因为它是提供给SUT的对象(大概是通过DeserializeObject<User>)。

例如:

[Fact]
public void Add_User_To_User_List()
{
    //Given
    _userService = new UserService(_jsonService, _guidService);
    _jsonService = Substitute.For<IJsonService>();
    var _fakeUserJsonFile = "Users.json";
    var _fakeNewUser = new User()
    {
        ID = new Guid(),
        FirstName = "Denis",
        LastName = "Menis"
    };
    var _fakeUserList = new List<User>
    {
        new User()
            {
                ID = new Guid(),
                FirstName = "Paddy",
                LastName = "Halle"
            },
        new User()
            {
                ID = new Guid(),
                FirstName = "Job",
                LastName = "Blogs"
            }
    };
    _jsonService.DeserializeObject<User>(_fakeUserJsonFile).Returns(_fakeUserList);
    _jsonService.SerializeObject(_fakeUserJsonFile, _fakeUserList).Returns(true); // Match the original _fakeUserList, since that is what gets passed in by the implementation
    //When
    var result = _userService.AddUser(_fakeNewUser);
    //Then
    Assert.Contains(_fakeNewUser, _fakeUserList); // Verify that the provided _fakeUserList has been modified
}

附带说明:您实际上可以从该测试中删除许多细节,因为它们与正在测试的功能无关。例如,_fakeUserList最初可以是空的——它不必包含任何虚值。并且您可以使用_fakeNewUser的默认值(即,不指定FirstName等),因为在此测试中根本没有引用它们。

编辑:感谢张贴额外的代码(GetUsers等)。这段代码表明,您正在对DeserializeObject<User>返回的IEnumerable<User>调用ToList()。这就是为什么您的模拟对象的行为不像您期望的那样:ToList()返回的列表与_fakeUserList是完全独立的列表。

此外,我在测试中没有看到_fakeUserJsonFile被注入SUT的任何地方。所以AddUser中的_fileName可能也不是你所期望的。

要解决这个问题,您需要修改您的设计(例如,不调用ToList),或者修改测试中的预期行为。虽然你可能会考虑前者的可能性,但后者可能更容易。

例如:

    // Match any filename (unless you have a way of getting _fakeUserJsonFile into the SUT)
    // Match any list, as long as it contains the new user
    _jsonService.SerializeObject(Arg.Any<string>(), Arg.Is<List<User>>(list => list.Contains(_fakeNewUser))).Returns(true);
    //When
    var result = _userService.AddUser(_fakeNewUser);
    //Then
    Assert.IsTrue(result); // Only returns true if the mock object is invoked as expected
    // There is no way to verify the following assertion, because the test has no way of accessing the "updated" list
    //Assert.Contains(_fakeNewUser, _fakeUserList);