GithubStar/neuron
1
0
Fork 0
mirror of https://github.com/emqx/neuron.git synced 2026-10-18 13:41:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

mqtt format description

Browse Source
This commit is contained in:
fengzero
2025-01-08 06:54:20 +00:00
parent fa1964304f
commit 6dbd8d1a08
3 changed files with 131 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/mqtt/mqtt.json
+2 -2
View File
@@ -56,8 +56,8 @@
"format": {
"name": "Upload Format",
"name_zh": "上报数据格式",
"description": "JSON format of the data reported. In values-mode, data are split into `values` and `errors` sub objects. In tags-mode, tag data are put in a single array.",
"description_zh": "上报数据的 JSON 格式。在 values-format 格式下，数据被分为 `values` 和 `errors` 两个子对象。在 tags-format 格式下，数据被放在一个数组中。",
"description": "JSON format of the data reported. In Values-format mode, data are split into `values` and `errors` sub objects. In Tags-format mode, tag data are put in a single array. ECP-format is the format for connecting to ECP data storage. Custom format supports user-defined data format. For variable definition specifications, please refer to [https://docs.emqx.com/en/neuronex/latest/configuration/north-apps/mqtt/api.html].",
"description_zh": "上报数据的 JSON 格式。在 Values-format 格式下，数据被分为 `values` 和 `errors` 两个子对象。在 Tags-format 格式下，数据被放在一个数组中。 ECP-format 为对接 ECP 数据存储的格式。自定义格式，支持用户自定义上报数据格式，变量定义规范请参考【https://docs.emqx.com/zh/neuronex/latest/configuration/north-apps/mqtt/api.html】。",
"attribute": "required",
"type": "map",
"default": 0,
tests/ut/CMakeLists.txt
+1
View File
@@ -105,3 +105,4 @@ gtest_discover_tests(rolling_counter_test)
gtest_discover_tests(mqtt_client_test)
gtest_discover_tests(common_test)
gtest_discover_tests(cid_test)
gtest_discover_tests(mqtt_schema_test)
tests/ut/mqtt_schema_test.cc
+128 -2
View File
@@ -12,16 +12,142 @@ TEST(validate_success, schema)
const char *schema =
"{\"timestamp\":\"${timestamp}\",\"node\":\"${node}\",\"group\":\"${"
"group}\",\"tags\":\"${tag_values}\",\"static\":\"${static_"
"tags}\",\"errors\":\"${tag_errors}\"}";
"tags}\",\"errors\":\"${tag_errors}\", \"xxxxx\":\"yyy\"}";
mqtt_schema_vt_t *vts;
size_t n_vts;
int ret = mqtt_schema_validate(schema, &vts, &n_vts);
EXPECT_EQ(ret, 0);
EXPECT_EQ(n_vts, 7);
EXPECT_STREQ(vts[0].name, "timestamp");
EXPECT_EQ(vts[0].vt, MQTT_SCHEMA_TIMESTAMP);
EXPECT_STREQ(vts[1].name, "node");
EXPECT_EQ(vts[1].vt, MQTT_SCHEMA_NODE_NAME);
EXPECT_STREQ(vts[2].name, "group");
EXPECT_EQ(vts[2].vt, MQTT_SCHEMA_GROUP_NAME);
EXPECT_STREQ(vts[3].name, "tags");
EXPECT_EQ(vts[3].vt, MQTT_SCHEMA_TAG_VALUES);
EXPECT_STREQ(vts[4].name, "static");
EXPECT_EQ(vts[4].vt, MQTT_SCHEMA_STATIC_TAG_VALUES);
EXPECT_STREQ(vts[5].name, "errors");
EXPECT_EQ(vts[5].vt, MQTT_SCHEMA_TAG_ERRORS);
EXPECT_STREQ(vts[6].name, "xxxxx");
EXPECT_EQ(vts[6].vt, MQTT_SCHEMA_UD);
EXPECT_STREQ(vts[6].ud, "yyy");
EXPECT_EQ(n_vts, 6);
free(vts);
}
TEST(validate_failed, schema)
{
const char *schema =
"{\"timestamp\":\"${timestamp}\",\"node\":\"${node}\",\"group\":\"${"
"group}\",\"tags\":\"${tag_values1}\",\"static\":\"${static_"
"tags}\",\"errors\":\"${tag_errors}\", \"xxxxx\":\"yyy\"}";
mqtt_schema_vt_t *vts;
size_t n_vts;
int ret = mqtt_schema_validate(schema, &vts, &n_vts);
EXPECT_EQ(ret, -1);
}
TEST(validate_success, schema_static)
{
const char *static_tags =
"{\"static_tags\": {\"static_tag1\":\"string\", "
"\"static_tag2\": 1234,\"static_tag3\": 11.44, "
"\"static_tag4\": true, \"static_tag5\": "
"[1,3,4], \"static_tag6\": {\"sub\": 13}, \"static_tag7\": {\"sub1\": "
"{\"sub2\": \"string\"}} }}";
mqtt_static_vt_t *vts = NULL;
size_t n_vts;
int ret = mqtt_static_validate(static_tags, &vts, &n_vts);
EXPECT_EQ(ret, 0);
EXPECT_EQ(n_vts, 7);
EXPECT_STREQ(vts[0].name, "static_tag1");
EXPECT_EQ(vts[0].jtype, NEU_JSON_STR);
EXPECT_STREQ(vts[0].jvalue.val_str, "string");
EXPECT_STREQ(vts[1].name, "static_tag2");
EXPECT_EQ(vts[1].jtype, NEU_JSON_INT);
EXPECT_EQ(vts[1].jvalue.val_int, 1234);
EXPECT_STREQ(vts[2].name, "static_tag3");
EXPECT_EQ(vts[2].jtype, NEU_JSON_DOUBLE);
EXPECT_EQ(vts[2].jvalue.val_double, 11.44);
EXPECT_STREQ(vts[3].name, "static_tag4");
EXPECT_EQ(vts[3].jtype, NEU_JSON_BOOL);
EXPECT_EQ(vts[3].jvalue.val_bool, true);
EXPECT_STREQ(vts[4].name, "static_tag5");
EXPECT_EQ(vts[4].jtype, NEU_JSON_STR);
EXPECT_STREQ(vts[5].name, "static_tag6");
EXPECT_EQ(vts[5].jtype, NEU_JSON_STR);
EXPECT_STREQ(vts[6].name, "static_tag7");
EXPECT_EQ(vts[6].jtype, NEU_JSON_STR);
mqtt_static_free(vts, n_vts);
}
TEST(schema_encode, schema_static)
{
const char *schema =
"{\"timestamp\":\"${timestamp}\",\"node\":\"${node}\",\"group\":\"${"
"group}\",\"tags\":\"${tag_values}\",\"static\":\"${static_"
"tags}\",\"errors\":\"${tag_errors}\", \"xxxxx\":\"yyy\"}";
mqtt_schema_vt_t *schema_vts;
size_t schema_n_vts;
int ret = mqtt_schema_validate(schema, &schema_vts, &schema_n_vts);
EXPECT_EQ(ret, 0);
EXPECT_EQ(schema_n_vts, 7);
const char *static_tags =
"{\"static_tags\": {\"static_tag1\":\"string\", "
"\"static_tag2\": 1234,\"static_tag3\": 11.44, "
"\"static_tag4\": true, \"static_tag5\": "
"[1,3,4], \"static_tag6\": {\"sub\": 13}, \"static_tag7\": {\"sub1\": "
"{\"sub2\": \"string\"}} }}";
mqtt_static_vt_t *vts = NULL;
size_t n_vts;
ret = mqtt_static_validate(static_tags, &vts, &n_vts);
EXPECT_EQ(ret, 0);
EXPECT_EQ(n_vts, 7);
char * result = NULL;
neu_json_read_resp_t tags = { 0 };
ret = mqtt_schema_encode((char *) "driver", (char *) "group", &tags,
schema_vts, schema_n_vts, vts, n_vts, &result);
EXPECT_EQ(ret, 0);
EXPECT_STREQ(
result,
"{\"timestamp\": 0, \"node\": \"driver\", \"group\": \"group\", "
"\"tags\": [], \"static\": [{\"name\": \"static_tag1\", \"value\": "
"\"string\"}, {\"name\": \"static_tag2\", \"value\": 1234}, {\"name\": "
"\"static_tag3\", \"value\": 11.44}, {\"name\": \"static_tag4\", "
"\"value\": true}, {\"name\": \"static_tag5\", \"value\": \"[1, 3, "
"4]\"}, {\"name\": \"static_tag6\", \"value\": \"{\\\"sub\\\": 13}\"}, "
"{\"name\": \"static_tag7\", \"value\": \"{\\\"sub1\\\": "
"{\\\"sub2\\\": \\\"string\\\"}}\"}], \"errors\": [], \"xxxxx\": "
"\"yyy\"}");
mqtt_static_free(vts, n_vts);
free(schema_vts);
free(result);
}
int main(int argc, char **argv)
{
zlog_init("./config/dev.conf");