借助网络配置,控制Modbus工具的日志显示,避免卡死界面
智能大石头 authored at 2021-12-11 22:09:19
10.25 KiB
XCoder
using System.ComponentModel;
using NewLife;
using NewLife.Log;
using NewLife.Net;
using NewLife.Remoting;
using NewLife.XCoder.Models;
using NewLife.XCoder.ViewModels;
using Xunit;

namespace XCoder.App.Tests;

/// <summary>测试用发现服务控制器,动作名 Api/Info</summary>
public class LoopInfoApi
{
    /// <summary>服务信息</summary>
    /// <returns>名称与版本</returns>
    public Object Info() => new { Name = "码神测试服务", Version = "1.0.0" };
}

/// <summary>测试用空应答控制器,模拟本机接口收到广播后的空回包</summary>
public class EmptyInfoApi
{
    /// <summary>服务信息</summary>
    /// <returns>空应答</returns>
    public Object Info() => new Dictionary<String, Object>();
}

/// <summary>测试用星尘代理控制器:Api/Info 报设备信息,Info 补充编码与服务器</summary>
public class FakeStarAgentApi
{
    /// <summary>服务信息</summary>
    /// <returns>设备信息</returns>
    public Object Info() => new
    {
        Id = 8801,
        Name = "StarAgent",
        Title = "Stardust agent",
        MachineName = "test-box",
        OS = "Linux",
        LocalIP = "127.0.0.1",
    };

    /// <summary>代理详情</summary>
    /// <returns>编码与服务器地址</returns>
    public Object Detail() => new { Code = "CODE-9527", Server = "http://star.example:8080" };
}

/// <summary>API 发现(DEV-5)本机回环测试</summary>
/// <remarks>
/// 在本进程内起一个 UDP ApiServer,按「Api/Info」应答,再用 ViewModel 点对点探测,
/// 验证「组帧 → 发包 → 收应答 → 解析服务」整条链路,不依赖外部设备。
/// </remarks>
public class ApiDiscoverLoopTests
{
    private static (ApiServer server, Int32 port) StartUdpServer()
    {
        var server = new ApiServer(new NetUri("udp://127.0.0.1:0")) { Log = Logger.Null };
        server.Register<LoopInfoApi>();
        server.Start();

        return (server, server.Port);
    }

    [Fact]
    [DisplayName("指定目标 IP 时能发现本机 API 服务")]
    public async Task Scan_TargetIp_DiscoversService()
    {
        var (server, port) = StartUdpServer();

        try
        {
            Assert.True(port > 0, $"服务端未分配端口:{port}");

            var vm = new ApiDiscoverViewModel { Port = port, TargetIp = "127.0.0.1" };

            await vm.ScanCommand.ExecuteAsync(null);

            Assert.NotEmpty(vm.Services);
            Assert.Contains("127.0.0.1", vm.Services[0].RemoteIP);
            Assert.Equal(port, vm.Services[0].Port);
            Assert.Contains("发现服务", vm.Log);
            Assert.False(vm.IsScanning);
        }
        finally
        {
            server.Dispose();
        }
    }

    [Fact]
    [DisplayName("目标 IP 非法时不发包并给出提示")]
    public async Task Scan_InvalidIp_ReportsTip()
    {
        var vm = new ApiDiscoverViewModel { Port = 5500, TargetIp = "not-an-ip" };

        await vm.ScanCommand.ExecuteAsync(null);

        Assert.Contains("目标 IP 无效", vm.Log);
        Assert.Empty(vm.Services);
        Assert.False(vm.IsScanning);
    }

    [Fact]
    [DisplayName("端口非法时不发包并给出提示")]
    public async Task Scan_InvalidPort_ReportsTip()
    {
        var vm = new ApiDiscoverViewModel { Port = 70000 };

        await vm.ScanCommand.ExecuteAsync(null);

        Assert.Contains("端口无效", vm.Log);
        Assert.Empty(vm.Services);
    }

    [Fact]
    [DisplayName("空应答不进入服务列表")]
    public async Task Scan_EmptyReply_Ignored()
    {
        var server = new ApiServer(new NetUri("udp://127.0.0.1:0")) { Log = Logger.Null };

        try
        {
            server.Start();

            // 覆盖内置 Api/Info,返回空对象,模拟本机接口自回包
            Register(server.Manager, new EmptyInfoApi(), nameof(EmptyInfoApi.Info), "Api/Info");

            var vm = new ApiDiscoverViewModel { Port = server.Port, TargetIp = "127.0.0.1" };

            await vm.ScanCommand.ExecuteAsync(null);

            Assert.Empty(vm.Services);
            Assert.Contains("扫描完成", vm.Log);
        }
        finally
        {
            server.Dispose();
        }
    }

    [Fact]
    [DisplayName("清空命令清掉服务与日志")]
    public async Task Clear_RemovesServicesAndLog()
    {
        var (server, port) = StartUdpServer();

        try
        {
            var vm = new ApiDiscoverViewModel { Port = port, TargetIp = "127.0.0.1" };
            await vm.ScanCommand.ExecuteAsync(null);

            vm.ClearServicesCommand.Execute(null);
            vm.ClearLogCommand.Execute(null);

            Assert.Empty(vm.Services);
            Assert.Equal("", vm.Log);
        }
        finally
        {
            server.Dispose();
        }
    }

    [Fact]
    [DisplayName("扫描 StarAgent 时补充设备编码与服务器地址")]
    public async Task Scan_StarAgent_FillsCodeAndServer()
    {
        var controller = new FakeStarAgentApi();
        var server = new ApiServer(new NetUri("udp://127.0.0.1:0")) { Log = Logger.Null };

        try
        {
            server.Start();

            // 覆盖内置 Api/Info,并额外提供 Info 动作
            Register(server.Manager, controller, nameof(FakeStarAgentApi.Info), "Api/Info");
            Register(server.Manager, controller, nameof(FakeStarAgentApi.Detail), "Info");

            var vm = new ApiDiscoverViewModel { Port = server.Port, TargetIp = "127.0.0.1" };

            await vm.ScanCommand.ExecuteAsync(null);

            var item = Assert.Single(vm.Services);
            Assert.Equal("StarAgent", item.Name);
            Assert.Equal("test-box", item.MachineName);
            Assert.Equal("Linux", item.OS);
            Assert.Equal("127.0.0.1", item.RemoteIP);
            Assert.Equal(server.Port, item.Port);
            Assert.Equal("CODE-9527", item.Code);
            Assert.Equal("http://star.example:8080", item.Server);
            Assert.False(item.RawJson.IsNullOrEmpty());
        }
        finally
        {
            server.Dispose();
        }
    }

    [Fact]
    [DisplayName("目标地址支持单个 IP、CIDR 网段与 IP 范围")]
    public void ParseTargets_Cases()
    {
        Assert.Empty(ApiDiscoverViewModel.ParseTargets(""));
        Assert.Empty(ApiDiscoverViewModel.ParseTargets("   "));

        var single = ApiDiscoverViewModel.ParseTargets("192.168.1.5");
        Assert.Equal("192.168.1.5", Assert.Single(single).ToString());

        // /30 去掉网络地址与广播地址后剩两个可用地址
        var cidr = ApiDiscoverViewModel.ParseTargets("192.168.1.0/30").Select(e => e.ToString()).ToArray();
        Assert.Equal(["192.168.1.1", "192.168.1.2"], cidr);

        // 带主机位的网段按掩码对齐,10.0.0.12/24 等价于 10.0.0.0/24
        var hostBits = ApiDiscoverViewModel.ParseTargets("10.0.0.12/24");
        Assert.Equal(254, hostBits.Count);
        Assert.Equal("10.0.0.1", hostBits[0].ToString());
        Assert.Equal("10.0.0.254", hostBits[^1].ToString());

        // /30 同理,192.168.1.5 落在 192.168.1.4/30 内
        Assert.Equal(["192.168.1.5", "192.168.1.6"], ApiDiscoverViewModel.ParseTargets("192.168.1.5/30").Select(e => e.ToString()).ToArray());

        // /32 就是一个地址
        Assert.Equal("10.0.0.7", Assert.Single(ApiDiscoverViewModel.ParseTargets("10.0.0.7/32")).ToString());

        // IP 范围
        var range = ApiDiscoverViewModel.ParseTargets("10.0.0.1-10.0.0.3").Select(e => e.ToString()).ToArray();
        Assert.Equal(["10.0.0.1", "10.0.0.2", "10.0.0.3"], range);

        // 多项输入去重
        Assert.Equal(2, ApiDiscoverViewModel.ParseTargets("192.168.1.1, 192.168.1.1;192.168.1.2").Count);
    }

    [Fact]
    [DisplayName("目标地址非法或过多时给出明确错误")]
    public void ParseTargets_Invalid()
    {
        Assert.Throws<ArgumentException>(() => ApiDiscoverViewModel.ParseTargets("abc"));
        Assert.Throws<ArgumentException>(() => ApiDiscoverViewModel.ParseTargets("10.0.0.1-10.0.0.0"));
        Assert.Throws<ArgumentException>(() => ApiDiscoverViewModel.ParseTargets("10.0.0.0/8"));
        Assert.Throws<ArgumentException>(() => ApiDiscoverViewModel.ParseTargets("192.168.1.0/24/1"));
    }

    [Fact]
    [DisplayName("同一设备的多条应答按设备标识归并,不被空值覆盖")]
    public void ApiServiceInfo_Merge()
    {
        var first = new ApiServiceInfo
        {
            Id = 8801,
            Name = "StarAgent",
            MachineName = "test-box",
            LocalIP = "192.168.1.5",
            RemoteIP = "255.255.255.255",
            Port = 5500,
            FoundTime = DateTime.Now,
        };
        var second = new ApiServiceInfo
        {
            Id = 8801,
            Name = "StarAgent",
            MachineName = "test-box",
            LocalIP = "192.168.1.5",
            RemoteIP = "192.168.1.5",
            Port = 5500,
            Code = "CODE-9527",
            RawJson = "{}",
            FoundTime = DateTime.Now,
        };

        Assert.Equal(ApiServiceInfo.GetKey(first), ApiServiceInfo.GetKey(second));

        Assert.True(ApiServiceInfo.Merge(first, second));
        Assert.Equal("192.168.1.5", first.RemoteIP);
        Assert.Equal("CODE-9527", first.Code);
        Assert.Equal("{}", first.RawJson);

        // 空应答不得抹掉已有字段
        Assert.False(ApiServiceInfo.Merge(first, new ApiServiceInfo()));
        Assert.Equal("StarAgent", first.Name);
        Assert.Equal("192.168.1.5", first.RemoteIP);
    }

    [Fact]
    [DisplayName("导出 CSV 时逗号与引号被转义")]
    public void ToCsv_Escape()
    {
        var csv = ApiDiscoverViewModel.ToCsv([new ApiServiceInfo { Name = "a,b", Title = "say \"hi\"", RemoteIP = "1.2.3.4", Port = 5500 }]);

        var lines = csv.Split(Environment.NewLine, StringSplitOptions.RemoveEmptyEntries);
        Assert.Equal(2, lines.Length);
        Assert.Contains("\"a,b\"", lines[1]);
        Assert.Contains("\"say \"\"hi\"\"\"", lines[1]);
        Assert.Contains("1.2.3.4:5500", lines[1]);
    }

    private static void Register(IApiManager manager, Object controller, String method, String action)
    {
        var type = controller.GetType();
        var mi = type.GetMethod(method)!;

        manager.Services[action] = new ApiAction(mi, type) { Controller = controller, Name = action };
    }
}