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

namespace XCoder.App.Tests;

/// <summary>地址解析:SSH / MQTT / API 共用的 host:port 解析</summary>
public class EndpointParserTests
{
    [Theory]
    [DisplayName("常见写法都能解析出主机与端口")]
    [InlineData("192.168.1.10", 22, "192.168.1.10", 22)]
    [InlineData("192.168.1.10:2222", 22, "192.168.1.10", 2222)]
    [InlineData("tcp://broker.local:1883", 1883, "broker.local", 1883)]
    [InlineData("udp://10.0.0.1:5500", 5500, "10.0.0.1", 5500)]
    [InlineData("host", 1883, "host", 1883)]
    public void Parse_Basic(String input, Int32 defaultPort, String host, Int32 port)
    {
        var endpoint = EndpointParser.Parse(input, defaultPort);

        Assert.Equal(host, endpoint.Host);
        Assert.Equal(port, endpoint.Port);
    }

    [Fact]
    [DisplayName("user@host 形式解析出用户名并保留原文本")]
    public void Parse_WithUser()
    {
        var endpoint = EndpointParser.Parse("root@192.168.1.10:2222", 22, "ssh");

        Assert.Equal("root", endpoint.User);
        Assert.Equal("192.168.1.10", endpoint.Host);
        Assert.Equal(2222, endpoint.Port);
        Assert.Equal("ssh://192.168.1.10:2222", endpoint.ToString());
    }

    [Fact]
    [DisplayName("协议大写与带路径的地址可正常解析")]
    public void Parse_SchemeAndPath()
    {
        var endpoint = EndpointParser.Parse("TCP://broker:1883/api", 1883);

        Assert.Equal("tcp", endpoint.Scheme);
        Assert.Equal("broker", endpoint.Host);
        Assert.Equal(1883, endpoint.Port);
    }

    [Fact]
    [DisplayName("IPv6 方括号写法可解析端口")]
    public void Parse_IPv6()
    {
        var endpoint = EndpointParser.Parse("[::1]:2222", 22);

        Assert.Equal("::1", endpoint.Host);
        Assert.Equal(2222, endpoint.Port);
    }

    [Fact]
    [DisplayName("未指定协议时使用默认协议")]
    public void Parse_DefaultScheme()
    {
        Assert.Equal("tcp", EndpointParser.Parse("127.0.0.1:1883", 1883, "tcp").Scheme);
        Assert.Equal("", EndpointParser.Parse("127.0.0.1:1883", 1883).Scheme);
    }

    [Theory]
    [DisplayName("空地址、非法端口、非法协议报参数错误")]
    [InlineData("")]
    [InlineData("   ")]
    [InlineData("host:abc")]
    [InlineData("host:0")]
    [InlineData("host:70000")]
    [InlineData("ht tp://host:80")]
    [InlineData("[::1#22")]
    public void Parse_Invalid_Throws(String input)
    {
        Assert.Throws<ArgumentException>(() => EndpointParser.Parse(input, 80));
    }

    [Fact]
    [DisplayName("没有默认端口且未写端口时报错")]
    public void Parse_MissingPort_Throws()
    {
        Assert.Throws<ArgumentException>(() => EndpointParser.Parse("host"));
    }

    [Fact]
    [DisplayName("端口合法性判断覆盖边界")]
    public void IsValidPort_Boundaries()
    {
        Assert.True(EndpointParser.IsValidPort(1));
        Assert.True(EndpointParser.IsValidPort(65535));
        Assert.False(EndpointParser.IsValidPort(0));
        Assert.False(EndpointParser.IsValidPort(-1));
        Assert.False(EndpointParser.IsValidPort(65536));
    }
}

/// <summary>MQTT 主题校验</summary>
public class MqttTopicValidatorTests
{
    [Theory]
    [DisplayName("普通主题在发布与订阅场景都合法")]
    [InlineData("topic/test")]
    [InlineData("a/b/c")]
    [InlineData("/sys/device/1")]
    public void Validate_Normal(String topic)
    {
        Assert.Null(MqttTopicValidator.Validate(topic, false));
        Assert.Null(MqttTopicValidator.Validate(topic, true));
    }

    [Theory]
    [DisplayName("订阅允许通配符,但位置必须正确")]
    [InlineData("topic/+", true)]
    [InlineData("topic/+/value", true)]
    [InlineData("topic/#", true)]
    [InlineData("#", true)]
    [InlineData("topic/#/x", false)]
    [InlineData("topic/a#", false)]
    [InlineData("topic/a+", false)]
    public void Validate_Wildcard(String topic, Boolean valid)
    {
        var error = MqttTopicValidator.Validate(topic, true);

        Assert.Equal(valid, error == null);
    }

    [Theory]
    [DisplayName("发布主题不允许通配符")]
    [InlineData("topic/#")]
    [InlineData("topic/+")]
    public void Validate_PublishRejectsWildcard(String topic)
    {
        Assert.NotNull(MqttTopicValidator.Validate(topic, false));
    }

    [Theory]
    [DisplayName("空主题与超长主题被拒绝")]
    [InlineData(null)]
    [InlineData("")]
    public void Validate_Empty(String? topic)
    {
        Assert.NotNull(MqttTopicValidator.Validate(topic, true));
    }

    [Fact]
    [DisplayName("超长主题被拒绝")]
    public void Validate_TooLong()
    {
        var topic = new String('a', MqttTopicValidator.MaxLength + 1);

        Assert.NotNull(MqttTopicValidator.Validate(topic, true));
    }

    [Fact]
    [DisplayName("QoS 越界时夹到 0~2")]
    public void NormalizeQos_Clamps()
    {
        Assert.Equal(0, MqttTopicValidator.NormalizeQos(-3));
        Assert.Equal(1, MqttTopicValidator.NormalizeQos(1));
        Assert.Equal(2, MqttTopicValidator.NormalizeQos(9));
    }

    [Fact]
    [DisplayName("客户端标识缺失时生成,超长时截断")]
    public void EnsureClientId_Works()
    {
        var generated = MqttTopicValidator.EnsureClientId("");
        Assert.StartsWith("xcoder-", generated);

        Assert.Equal("abc", MqttTopicValidator.EnsureClientId("  abc  "));

        var longId = MqttTopicValidator.EnsureClientId(new String('x', 64));
        Assert.Equal(23, longId.Length);
        Assert.NotEqual(MqttTopicValidator.EnsureClientId(null), generated);
    }

    [Fact]
    [DisplayName("主题拆层级")]
    public void SplitLevels_Works()
    {
        Assert.Equal(["a", "b", "c"], MqttTopicValidator.SplitLevels("a/b/c"));
        Assert.Empty(MqttTopicValidator.SplitLevels(""));
    }
}

/// <summary>API 调试参数解析</summary>
public class ApiRequestParserTests
{
    [Theory]
    [DisplayName("普通文本按字符串传参")]
    [InlineData("hello")]
    [InlineData("123")]
    [InlineData("a=1&b=2")]
    public void ParseArguments_PlainText(String text)
    {
        Assert.Equal(text, ApiRequestParser.ParseArguments(text));
        Assert.False(ApiRequestParser.LooksLikeJson(text));
    }

    [Fact]
    [DisplayName("JSON 对象被解析为结构化参数,数组保持原文")]
    public void ParseArguments_Json()
    {
        var obj = ApiRequestParser.ParseArguments("""{"name":"x","age":18}""");
        Assert.IsAssignableFrom<System.Collections.IDictionary>(obj);
        Assert.True(ApiRequestParser.LooksLikeJson("""{"a":1}"""));

        // 顶层数组按原始文本传,交给服务端解释
        const String array = "[1,2,3]";
        Assert.Equal(array, ApiRequestParser.ParseArguments(array));
        Assert.False(ApiRequestParser.LooksLikeJson(array));
    }

    [Fact]
    [DisplayName("损坏的 JSON 回落为原始文本")]
    public void ParseArguments_BrokenJson()
    {
        const String broken = """{"a":}""";

        Assert.Equal(broken, ApiRequestParser.ParseArguments(broken));
        Assert.False(ApiRequestParser.LooksLikeJson(broken));
    }

    [Fact]
    [DisplayName("空输入返回空字符串")]
    public void ParseArguments_Empty()
    {
        Assert.Equal("", ApiRequestParser.ParseArguments(null));
        Assert.Equal("", ApiRequestParser.ParseArguments("   "));
    }

    [Theory]
    [DisplayName("Action 名称校验:空、带空格、带查询串、带协议都拒绝")]
    [InlineData(null)]
    [InlineData("")]
    [InlineData("User Login")]
    [InlineData("Api/Info?x=1")]
    [InlineData("http://host/Api/Info")]
    public void ValidateAction_Invalid(String? action)
    {
        Assert.NotNull(ApiRequestParser.ValidateAction(action));
    }

    [Theory]
    [DisplayName("Action 名称合法写法通过")]
    [InlineData("Api/Info")]
    [InlineData("User/Login")]
    [InlineData("Ping")]
    public void ValidateAction_Valid(String action)
    {
        Assert.Null(ApiRequestParser.ValidateAction(action));
    }

    [Fact]
    [DisplayName("结果格式化:空结果显示占位、过长截断")]
    public void FormatResult_Cases()
    {
        Assert.Equal("< 空结果", ApiRequestParser.FormatResult(null));
        Assert.Equal("< abc", ApiRequestParser.FormatResult("abc"));

        var longText = new String('x', 100);
        Assert.Contains("已截断", ApiRequestParser.FormatResult(longText, 10));
    }
}