listPlugins command, and test.
Roger A. Light
4 years ago
parent
82658805c7
commit
9b2c64135f
@ -0,0 +1,102 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
# Test $CONTROL/broker/v1 listListeners
|
||||||
|
|
||||||
|
from mosq_test_helper import *
|
||||||
|
import json
|
||||||
|
import shutil
|
||||||
|
|
||||||
|
def write_config(filename, port):
|
||||||
|
with open(filename, 'w') as f:
|
||||||
|
f.write("enable_control_api true\n")
|
||||||
|
f.write("allow_anonymous true\n")
|
||||||
|
f.write("listener %d\n" % (port))
|
||||||
|
f.write("plugin c/auth_plugin_v5_control.so\n")
|
||||||
|
|
||||||
|
def command_check(sock, command_payload, expected_response):
|
||||||
|
command_packet = mosq_test.gen_publish(topic="$CONTROL/broker/v1", qos=0, payload=json.dumps(command_payload))
|
||||||
|
sock.send(command_packet)
|
||||||
|
response = json.loads(mosq_test.read_publish(sock))
|
||||||
|
if response != expected_response:
|
||||||
|
print(expected_response)
|
||||||
|
print(response)
|
||||||
|
raise ValueError(response)
|
||||||
|
|
||||||
|
def invalid_command_check(sock, command_payload, cmd_name, error_msg):
|
||||||
|
command_packet = mosq_test.gen_publish(topic="$CONTROL/broker/v1", qos=0, payload=command_payload)
|
||||||
|
sock.send(command_packet)
|
||||||
|
response = json.loads(mosq_test.read_publish(sock))
|
||||||
|
expected_response = {'responses': [{'command': cmd_name, 'error': error_msg}]}
|
||||||
|
if response != expected_response:
|
||||||
|
print(expected_response)
|
||||||
|
print(response)
|
||||||
|
raise ValueError(response)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
port = mosq_test.get_port()
|
||||||
|
conf_file = os.path.basename(__file__).replace('.py', '.conf')
|
||||||
|
write_config(conf_file, port)
|
||||||
|
|
||||||
|
cmd_success = {"commands":[{"command": "listPlugins", "correlationData": "m3CtYVnySLCOwnHzITSeowvgla0InV4G"}]}
|
||||||
|
|
||||||
|
response_success = {'responses': [{'command': 'listPlugins', "correlationData": "m3CtYVnySLCOwnHzITSeowvgla0InV4G", 'data':{
|
||||||
|
'plugins':[
|
||||||
|
{
|
||||||
|
'name': 'test-plugin',
|
||||||
|
'control-endpoints': ['$CONTROL/test/v1']
|
||||||
|
}
|
||||||
|
]}}]}
|
||||||
|
|
||||||
|
rc = 1
|
||||||
|
connect_packet = mosq_test.gen_connect("17-list-listeners")
|
||||||
|
connack_packet = mosq_test.gen_connack(rc=0)
|
||||||
|
|
||||||
|
mid = 2
|
||||||
|
subscribe_packet = mosq_test.gen_subscribe(mid, "$CONTROL/broker/#", 0)
|
||||||
|
suback_packet = mosq_test.gen_suback(mid, 0)
|
||||||
|
|
||||||
|
broker = mosq_test.start_broker(filename=os.path.basename(__file__), use_conf=True, port=port)
|
||||||
|
|
||||||
|
try:
|
||||||
|
sock = mosq_test.do_client_connect(connect_packet, connack_packet, port=port)
|
||||||
|
mosq_test.do_send_receive(sock, subscribe_packet, suback_packet, "suback")
|
||||||
|
|
||||||
|
invalid_command_check(sock, "not valid json", "Unknown command", "Payload not valid JSON")
|
||||||
|
invalid_command_check(sock, "{}", "Unknown command", "Invalid/missing commands")
|
||||||
|
|
||||||
|
cmd = {"commands":["command"]}
|
||||||
|
invalid_command_check(sock, json.dumps(cmd), "Unknown command", "Command not an object")
|
||||||
|
|
||||||
|
cmd = {"commands":[{}]}
|
||||||
|
invalid_command_check(sock, json.dumps(cmd), "Unknown command", "Missing command")
|
||||||
|
|
||||||
|
cmd = {"commands":[{"command": "unknown command"}]}
|
||||||
|
invalid_command_check(sock, json.dumps(cmd), "unknown command", "Unknown command")
|
||||||
|
|
||||||
|
cmd = {"commands":[{"command": "listListeners", "correlationData": True}]}
|
||||||
|
invalid_command_check(sock, json.dumps(cmd), "listListeners", "Invalid correlationData data type.")
|
||||||
|
|
||||||
|
command_check(sock, cmd_success, response_success)
|
||||||
|
mosq_test.do_ping(sock)
|
||||||
|
|
||||||
|
rc = 0
|
||||||
|
|
||||||
|
sock.close()
|
||||||
|
except mosq_test.TestError:
|
||||||
|
pass
|
||||||
|
finally:
|
||||||
|
os.remove(conf_file)
|
||||||
|
for f in ["17-list-listeners-mqtt.sock", "17-list-listeners-websockets.sock"]:
|
||||||
|
try:
|
||||||
|
os.remove(f)
|
||||||
|
except FileNotFoundError:
|
||||||
|
pass
|
||||||
|
broker.terminate()
|
||||||
|
broker.wait()
|
||||||
|
(stdo, stde) = broker.communicate()
|
||||||
|
if rc:
|
||||||
|
print(stde.decode('utf-8'))
|
||||||
|
|
||||||
|
|
||||||
|
exit(rc)
|
||||||
@ -0,0 +1,60 @@
|
|||||||
|
#include <stdlib.h>
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <string.h>
|
||||||
|
#include <mosquitto.h>
|
||||||
|
#include <mosquitto_broker.h>
|
||||||
|
#include <mosquitto_plugin.h>
|
||||||
|
|
||||||
|
int mosquitto_auth_acl_check_v5(int event, void *event_data, void *user_data);
|
||||||
|
int mosquitto_auth_unpwd_check_v5(int event, void *event_data, void *user_data);
|
||||||
|
|
||||||
|
static mosquitto_plugin_id_t *plg_id;
|
||||||
|
|
||||||
|
MOSQUITTO_PLUGIN_DECLARE_VERSION(5);
|
||||||
|
|
||||||
|
int mosquitto_plugin_init(mosquitto_plugin_id_t *identifier, void **user_data, struct mosquitto_opt *auth_opts, int auth_opt_count)
|
||||||
|
{
|
||||||
|
(void)user_data;
|
||||||
|
(void)auth_opts;
|
||||||
|
(void)auth_opt_count;
|
||||||
|
|
||||||
|
plg_id = identifier;
|
||||||
|
|
||||||
|
mosquitto_plugin_set_info(identifier, "test-plugin", NULL);
|
||||||
|
|
||||||
|
mosquitto_callback_register(plg_id, MOSQ_EVT_ACL_CHECK, mosquitto_auth_acl_check_v5, NULL, NULL);
|
||||||
|
mosquitto_callback_register(plg_id, MOSQ_EVT_BASIC_AUTH, mosquitto_auth_unpwd_check_v5, NULL, NULL);
|
||||||
|
mosquitto_callback_register(plg_id, MOSQ_EVT_CONTROL, mosquitto_auth_unpwd_check_v5, "$CONTROL/test/v1", NULL);
|
||||||
|
|
||||||
|
return MOSQ_ERR_SUCCESS;
|
||||||
|
}
|
||||||
|
|
||||||
|
int mosquitto_plugin_cleanup(void *user_data, struct mosquitto_opt *auth_opts, int auth_opt_count)
|
||||||
|
{
|
||||||
|
(void)user_data;
|
||||||
|
(void)auth_opts;
|
||||||
|
(void)auth_opt_count;
|
||||||
|
|
||||||
|
mosquitto_callback_unregister(plg_id, MOSQ_EVT_ACL_CHECK, mosquitto_auth_acl_check_v5, NULL);
|
||||||
|
mosquitto_callback_unregister(plg_id, MOSQ_EVT_BASIC_AUTH, mosquitto_auth_unpwd_check_v5, NULL);
|
||||||
|
|
||||||
|
return MOSQ_ERR_SUCCESS;
|
||||||
|
}
|
||||||
|
|
||||||
|
int mosquitto_auth_acl_check_v5(int event, void *event_data, void *user_data)
|
||||||
|
{
|
||||||
|
(void)event;
|
||||||
|
(void)event_data;
|
||||||
|
(void)user_data;
|
||||||
|
|
||||||
|
return MOSQ_ERR_SUCCESS;
|
||||||
|
}
|
||||||
|
|
||||||
|
int mosquitto_auth_unpwd_check_v5(int event, void *event_data, void *user_data)
|
||||||
|
{
|
||||||
|
(void)event;
|
||||||
|
(void)event_data;
|
||||||
|
(void)user_data;
|
||||||
|
|
||||||
|
return MOSQ_ERR_SUCCESS;
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue