experiments/clixon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

* Major rewrite of event streams

Browse source 
* If you used old event callbacks API, you need to switch to the streams API
    * See clixon_stream.[ch]
  * Old streams API which needs to be removed include:
    * clicon_log_register_callback()
    * subscription_add() --> stream_register()
    * backend_notify() and backend_notify_xml() - use stream_notify() instead
* Example uses "NETCONF" stream instead of "ROUTING"
* Added timeout option -t for clixon_netconf - quit after max time.
This commit is contained in:
Olof hagsand 2018-09-30 14:51:30 +02:00
parent d7fbe75c9e
commit 98f3cd0e32
31 changed files with 597 additions and 635 deletions
Download patch file Download diff file Expand all files Collapse all files

18
CHANGELOG.md
View file

@ -11,17 +11,23 @@
* Not supported: notification, deviation, module-set-id, etc. * Not supported: notification, deviation, module-set-id, etc.
* Enabled by default, disable by resetting CLICON_MODULE_LIBRARY_RFC7895 * Enabled by default, disable by resetting CLICON_MODULE_LIBRARY_RFC7895
* Yang 1.1 notification support (RFC 7950: Sec 7.16) * Yang 1.1 notification support (RFC 7950: Sec 7.16)
* Event stream discovery support according to RFC 5277 for netconf * Major rewrite of event streams
* Implemented by ietf-netconf-notification.yang * If you used old event callbacks API, you need to switch to the streams API
* Disabled by default. Enable by setting CLICON_STREAM_DISCOVERY_RFC5277 * See clixon_stream.[ch]
* Event stream discovery support according to RFC 8040 for restconf * Old streams API which needs to be removed include:
* Implemented by ietf-restconf-monitoring.yang (mimics schema in 3.2.5.1) * clicon_log_register_callback()
* Disabled by default. Enable by setting CLICON_STREAM_DISCOVERY_RFC8040. * subscription_add() --> stream_register()
* backend_notify() and backend_notify_xml() - use stream_notify() instead
* Added stream discovery according to RFC 5277 for netconf and RFC 8040 for restconf
* Enabled by CLICON_STREAM_DISCOVERY_RFC5277 and CLICON_STREAM_DISCOVERY_RFC8040.
* Example uses "NETCONF" stream instead of "ROUTING"
* clixon_restconf and clixon_netconf now take -D <level> as command-line option instead of just -D * clixon_restconf and clixon_netconf now take -D <level> as command-line option instead of just -D
* This aligns to clixon_cli and clixon_backend * This aligns to clixon_cli and clixon_backend
* Application command option -S to clixon_netconf is obsolete. Use `clixon_netconf -l s` instead. * Application command option -S to clixon_netconf is obsolete. Use `clixon_netconf -l s` instead.
### Minor changes ### Minor changes
* Added timeout option -t for clixon_netconf - quit after max time.
* Comply to RFC 8040 3.5.3.1 rule: api-identifier = [module-name ":"] identifier * Comply to RFC 8040 3.5.3.1 rule: api-identifier = [module-name ":"] identifier
* The "module-name" was a no-op before. * The "module-name" was a no-op before.
* This means that there was no difference between eg: GET /restconf/data/ietf-yang-library:modules-state and GET /restconf/data/XXXX:modules-state * This means that there was no difference between eg: GET /restconf/data/ietf-yang-library:modules-state and GET /restconf/data/XXXX:modules-state

100
apps/backend/backend_client.c
View file

@ -69,59 +69,6 @@
#include "backend_client.h" #include "backend_client.h"
#include "backend_handle.h" #include "backend_handle.h"
/*! Add client notification subscription. Ie send notify to this client when event occurs
* @param[in] ce Client entry struct
* @param[in] stream Notification stream name
* @param[in] format How to display event (see enum format_enum)
* @param[in] filter Filter, what to display, eg xpath for format=xml, fnmatch
*
* @see backend_notify - where subscription is made and notify call is made
*/
static struct client_subscription *
client_subscription_add(struct client_entry *ce,
char *stream,
enum format_enum format,
char *filter)
{
struct client_subscription *su = NULL;
if ((su = malloc(sizeof(*su))) == NULL){
clicon_err(OE_PLUGIN, errno, "malloc");
goto done;
}
memset(su, 0, sizeof(*su));
su->su_stream = strdup(stream);
su->su_format = format;
su->su_filter = filter?strdup(filter):strdup("");
su->su_next = ce->ce_subscription;
ce->ce_subscription = su;
done:
return su;
}
/*! Delete stream subscription from client subscription list */
static int
client_subscription_delete(struct client_entry *ce,
struct client_subscription *su0)
{
struct client_subscription *su;
struct client_subscription **su_prev;
su_prev = &ce->ce_subscription; /* this points to stack and is not real backpointer */
for (su = *su_prev; su; su = su->su_next){
if (su == su0){
*su_prev = su->su_next;
free(su->su_stream);
if (su->su_filter)
free(su->su_filter);
free(su);
break;
}
su_prev = &su->su_next;
}
return 0;
}
static struct client_entry * static struct client_entry *
ce_find_bypid(struct client_entry *ce_list, ce_find_bypid(struct client_entry *ce_list,
int pid) int pid)
@ -134,6 +81,31 @@ ce_find_bypid(struct client_entry *ce_list,
return NULL; return NULL;
} }
static int
ce_event_cb(clicon_handle h,
void *event,
void *arg)
{
struct client_entry *ce = (struct client_entry *)arg;
if (send_msg_notify_xml(ce->ce_s, (cxobj*)event) < 0){
if (errno == ECONNRESET || errno == EPIPE){
clicon_log(LOG_WARNING, "client %d reset", ce->ce_nr);
#if 0
/* We should remove here but removal is not possible
from a client since backend_client is not linked.
Maybe we should add it to the plugin, but it feels
"safe" that you cant remove a client.
Instead, the client is (hopefully) removed elsewhere?
*/
backend_client_rm(h, ce);
#endif
}
}
return 0;
}
/*! Remove client entry state /*! Remove client entry state
* Close down everything wrt clients (eg sockets, subscriptions) * Close down everything wrt clients (eg sockets, subscriptions)
* Finally actually remove client struct in handle * Finally actually remove client struct in handle
@ -148,7 +120,6 @@ backend_client_rm(clicon_handle h,
struct client_entry *c; struct client_entry *c;
struct client_entry *c0; struct client_entry *c0;
struct client_entry **ce_prev; struct client_entry **ce_prev;
struct client_subscription *su;
c0 = backend_client_list(h); c0 = backend_client_list(h);
ce_prev = &c0; /* this points to stack and is not real backpointer */ ce_prev = &c0; /* this points to stack and is not real backpointer */
@ -159,8 +130,8 @@ backend_client_rm(clicon_handle h,
close(ce->ce_s); close(ce->ce_s);
ce->ce_s = 0; ce->ce_s = 0;
} }
while ((su = ce->ce_subscription) != NULL) /* for all streams */
client_subscription_delete(ce, su); stream_cb_delete(h, NULL, ce_event_cb, (void*)ce);
break; break;
} }
ce_prev = &c->ce_next; ce_prev = &c->ce_next;
@ -900,6 +871,7 @@ from_client_delete_config(clicon_handle h,
return retval; return retval;
} }
/*! Internal message: Create subscription for notifications see RFC 5277 /*! Internal message: Create subscription for notifications see RFC 5277
* @param[in] h Clicon handle * @param[in] h Clicon handle
* @param[in] xe Netconf request xml tree * @param[in] xe Netconf request xml tree
@ -910,7 +882,7 @@ from_client_delete_config(clicon_handle h,
* @example: * @example:
* <create-subscription> * <create-subscription>
* <stream>RESULT</stream> # If not present, events in the default NETCONF stream will be sent. * <stream>RESULT</stream> # If not present, events in the default NETCONF stream will be sent.
* <filter>XPATH-EXPR<(filter> * <filter type="xpath" select="XPATH-EXPR"/>
* <startTime/> # only for replay (NYI) * <startTime/> # only for replay (NYI)
* <stopTime/> # only for replay (NYI) * <stopTime/> # only for replay (NYI)
* </create-subscription> * </create-subscription>
@ -922,24 +894,27 @@ from_client_create_subscription(clicon_handle h,
cbuf *cbret) cbuf *cbret)
{ {
char *stream = "NETCONF"; char *stream = "NETCONF";
char *filter = NULL;
int retval = -1; int retval = -1;
cxobj *x; /* Genereic xml tree */ cxobj *x; /* Generic xml tree */
cxobj *xfilter; /* Filter xml tree */
char *ftype; char *ftype;
char *selector = NULL;
if ((x = xpath_first(xe, "//stream")) != NULL) if ((x = xpath_first(xe, "//stream")) != NULL)
stream = xml_find_value(x, "body"); stream = xml_find_value(x, "body");
if ((x = xpath_first(xe, "//filter")) != NULL){ if ((xfilter = xpath_first(xe, "//filter")) != NULL){
if ((ftype = xml_find_value(x, "type")) != NULL){ if ((ftype = xml_find_value(xfilter, "type")) != NULL){
/* Only accept xpath as filter type */ /* Only accept xpath as filter type */
if (strcmp(ftype, "xpath") != 0){ if (strcmp(ftype, "xpath") != 0){
if (netconf_operation_failed(cbret, "application", "Only xpath filter type supported")< 0) if (netconf_operation_failed(cbret, "application", "Only xpath filter type supported")< 0)
goto done; goto done;
goto ok; goto ok;
} }
if ((selector = xml_find_value(xfilter, "select")) == NULL)
goto done;
} }
} }
if (client_subscription_add(ce, stream, FORMAT_XML, filter) == NULL) if (stream_cb_add(h, stream, selector, ce_event_cb, (void*)ce) < 0)
goto done; goto done;
cprintf(cbret, "<rpc-reply><ok/></rpc-reply>"); cprintf(cbret, "<rpc-reply><ok/></rpc-reply>");
ok: ok:
@ -1334,6 +1309,7 @@ from_client_msg(clicon_handle h,
} }
else if (strcmp(name, "close-session") == 0){ else if (strcmp(name, "close-session") == 0){
xmldb_unlock_all(h, pid); xmldb_unlock_all(h, pid);
stream_cb_delete(h, NULL, ce_event_cb, (void*)ce);
cprintf(cbret, "<rpc-reply><ok/></rpc-reply>"); cprintf(cbret, "<rpc-reply><ok/></rpc-reply>");
} }
else if (strcmp(name, "kill-session") == 0){ else if (strcmp(name, "kill-session") == 0){

11
apps/backend/backend_client.h
View file

@ -52,19 +52,8 @@ struct client_entry{
int ce_pid; /* Process id */ int ce_pid; /* Process id */
int ce_uid; /* User id of calling process */ int ce_uid; /* User id of calling process */
clicon_handle ce_handle; /* clicon config handle (all clients have same?) */ clicon_handle ce_handle; /* clicon config handle (all clients have same?) */
struct client_subscription *ce_subscription; /* notification subscriptions */
}; };
/* Notification subscription info
* @see subscription in config_handle.c
*/
struct client_subscription{
struct client_subscription *su_next;
int su_s; /* stream socket */
enum format_enum su_format; /* format of notification stream */
char *su_stream;
char *su_filter;
};
/* /*
* Prototypes * Prototypes

46
apps/backend/backend_main.c
View file

@ -98,7 +98,6 @@ backend_terminate(clicon_handle h)
xmldb_plugin_unload(h); /* unload storage plugin */ xmldb_plugin_unload(h); /* unload storage plugin */
backend_handle_exit(h); /* Cannot use h after this */ backend_handle_exit(h); /* Cannot use h after this */
event_exit(); event_exit();
clicon_log_register_callback(NULL, NULL);
clicon_debug(1, "%s done", __FUNCTION__); clicon_debug(1, "%s done", __FUNCTION__);
clicon_log_exit(); clicon_log_exit();
return 0; return 0;
@ -191,7 +190,6 @@ db_merge(clicon_handle h,
return retval; return retval;
} }
/*! Create backend server socket and register callback /*! Create backend server socket and register callback
*/ */
static int static int
@ -211,45 +209,6 @@ server_socket(clicon_handle h)
return ss; return ss;
} }
/*! Callback for CLICON log events
* If you make a subscription to CLICON stream, this function is called for every
* log event.
*/
static int
backend_log_cb(int level,
char *msg,
void *arg)
{
int retval = -1;
size_t n;
char *ptr;
char *nptr;
char *newmsg = NULL;
/* backend_notify() will go through all clients and see if any has
registered "CLICON", and if so make a clicon_proto notify message to
those clients.
Sanitize '%' into "%%" to prevent segvfaults in vsnprintf later.
At this stage all formatting is already done */
n = 0;
for(ptr=msg; *ptr; ptr++)
if (*ptr == '%')
n++;
if ((newmsg = malloc(strlen(msg) + n + 1)) == NULL) {
clicon_err(OE_UNIX, errno, "malloc");
return -1;
}
for(ptr=msg, nptr=newmsg; *ptr; ptr++) {
*nptr++ = *ptr;
if (*ptr == '%')
*nptr++ = '%';
}
retval = backend_notify(arg, "CLICON", level, newmsg);
free(newmsg);
return retval;
}
/*! Call plugin_start with -- user options */ /*! Call plugin_start with -- user options */
static int static int
plugin_start_useroptions(clicon_handle h, plugin_start_useroptions(clicon_handle h,
@ -758,8 +717,6 @@ main(int argc,
if (stream_register(h, "NETCONF", "default NETCONF event stream") < 0) if (stream_register(h, "NETCONF", "default NETCONF event stream") < 0)
goto done; goto done;
if (stream_register(h, "CLICON", "Clicon logs") < 0)
goto done;
if ((xmldb_plugin = clicon_xmldb_plugin(h)) == NULL){ if ((xmldb_plugin = clicon_xmldb_plugin(h)) == NULL){
clicon_log(LOG_ERR, "No xmldb plugin given (specify option CLICON_XMLDB_PLUGIN).\n"); clicon_log(LOG_ERR, "No xmldb plugin given (specify option CLICON_XMLDB_PLUGIN).\n");
@ -850,9 +807,6 @@ main(int argc,
if ((pid = pidfile_write(pidfile)) < 0) if ((pid = pidfile_write(pidfile)) < 0)
goto done; goto done;
/* Register log notifications */
if (clicon_log_register_callback(backend_log_cb, h) < 0)
goto done;
clicon_log(LOG_NOTICE, "%s: %u Started", __PROGRAM__, getpid()); clicon_log(LOG_NOTICE, "%s: %u Started", __PROGRAM__, getpid());
if (set_signal(SIGTERM, backend_sig_term, NULL) < 0){ if (set_signal(SIGTERM, backend_sig_term, NULL) < 0){
clicon_err(OE_DEMON, errno, "Setting signal"); clicon_err(OE_DEMON, errno, "Setting signal");

255
apps/backend/clixon_backend_handle.c
View file

@ -91,7 +91,6 @@ struct backend_handle {
/* ------ end of common handle ------ */ /* ------ end of common handle ------ */
struct client_entry *bh_ce_list; /* The client list */ struct client_entry *bh_ce_list; /* The client list */
int bh_ce_nr; /* Number of clients, just increment */ int bh_ce_nr; /* Number of clients, just increment */
struct handle_subscription *bh_subscription; /* Event subscription list */
cxobj *bh_nacm; /* NACM external struct */ cxobj *bh_nacm; /* NACM external struct */
}; };
@ -121,155 +120,6 @@ backend_handle_exit(clicon_handle h)
return 0; return 0;
} }
/*! Notify event and distribute to all registered clients
*
* @param[in] h Clicon handle
* @param[in] stream Name of event stream. CLICON is predefined as LOG stream
* @param[in] level Event level (not used yet)
* @param[in] event Actual message as text format
*
* Stream is a string used to qualify the event-stream. Distribute the
* event to all clients registered to this backend.
* XXX: event-log NYI.
* @see also subscription_add()
* @see also backend_notify_xml()
*/
int
backend_notify(clicon_handle h,
char *stream,
int level,
char *event)
{
struct client_entry *ce;
struct client_entry *ce_next;
struct client_subscription *su;
struct handle_subscription *hs;
int retval = -1;
clicon_debug(2, "%s %s", __FUNCTION__, stream);
/* First thru all clients(sessions), and all subscriptions and find matches */
for (ce = backend_client_list(h); ce; ce = ce_next){
ce_next = ce->ce_next;
for (su = ce->ce_subscription; su; su = su->su_next)
if (strcmp(su->su_stream, stream) == 0){
if (strlen(su->su_filter)==0 || fnmatch(su->su_filter, event, 0) == 0){
if (send_msg_notify(ce->ce_s, level, event) < 0){
if (errno == ECONNRESET || errno == EPIPE){
clicon_log(LOG_WARNING, "client %d reset", ce->ce_nr);
#if 0
/* We should remove here but removal is not possible
from a client since backend_client is not linked.
Maybe we should add it to the plugin, but it feels
"safe" that you cant remove a client.
Instead, the client is (hopefully) removed elsewhere?
*/
backend_client_rm(h, ce);
#endif
break;
}
goto done;
}
}
}
}
/* Then go thru all global (handle) subscriptions and find matches */
hs = NULL;
while ((hs = subscription_each(h, hs)) != NULL){
if (hs->hs_format != FORMAT_TEXT)
continue;
if (strcmp(hs->hs_stream, stream))
continue;
if (hs->hs_filter==NULL ||
strlen(hs->hs_filter)==0 ||
fnmatch(hs->hs_filter, event, 0) == 0)
if ((*hs->hs_fn)(h, event, hs->hs_arg) < 0)
goto done;
}
retval = 0;
done:
return retval;
}
/*! Notify event and distribute to all registered clients
*
* @param[in] h Clicon handle
* @param[in] stream Name of event stream. CLICON is predefined as LOG stream
* @param[in] level Event level (not used yet)
* @param[in] x Actual message as xml tree
*
* Stream is a string used to qualify the event-stream. Distribute the
* event to all clients registered to this backend.
* XXX: event-log NYI.
* @see also subscription_add()
* @see also backend_notify()
*/
int
backend_notify_xml(clicon_handle h,
char *stream,
int level,
cxobj *x)
{
struct client_entry *ce;
struct client_entry *ce_next;
struct client_subscription *su;
int retval = -1;
cbuf *cb = NULL;
struct handle_subscription *hs;
clicon_debug(1, "%s %s", __FUNCTION__, stream);
/* Now go thru all clients(sessions), and all subscriptions and find matches */
for (ce = backend_client_list(h); ce; ce = ce_next){
ce_next = ce->ce_next;
for (su = ce->ce_subscription; su; su = su->su_next)
if (strcmp(su->su_stream, stream) == 0){
if (strlen(su->su_filter)==0 || xpath_first(x, "%s", su->su_filter) != NULL){
if (cb==NULL){
if ((cb = cbuf_new()) == NULL){
clicon_err(OE_PLUGIN, errno, "cbuf_new");
goto done;
}
if (clicon_xml2cbuf(cb, x, 0, 0) < 0)
goto done;
}
if (send_msg_notify(ce->ce_s, level, cbuf_get(cb)) < 0){
if (errno == ECONNRESET || errno == EPIPE){
clicon_log(LOG_WARNING, "client %d reset", ce->ce_nr);
#if 0
/* We should remove here but removal is not possible
from a client since backend_client is not linked.
Maybe we should add it to the plugin, but it feels
"safe" that you cant remove a client.
Instead, the client is (hopefully) removed elsewhere?
*/
backend_client_rm(h, ce);
#endif
break;
}
goto done;
}
}
}
}
/* Then go thru all global (handle) subscriptions and find matches */
hs = NULL;
while ((hs = subscription_each(h, hs)) != NULL){
if (hs->hs_format != FORMAT_XML)
continue;
if (strcmp(hs->hs_stream, stream))
continue;
if (strlen(hs->hs_filter)==0 || xpath_first(x, "%s", hs->hs_filter) != NULL){
if ((*hs->hs_fn)(h, x, hs->hs_arg) < 0)
goto done;
}
}
retval = 0;
done:
if (cb)
cbuf_free(cb);
return retval;
}
/*! Add new client, typically frontend such as cli, netconf, restconf /*! Add new client, typically frontend such as cli, netconf, restconf
* @param[in] h Clicon handle * @param[in] h Clicon handle
* @param[in] addr Address of client * @param[in] addr Address of client
@ -332,111 +182,6 @@ backend_client_delete(clicon_handle h,
return 0; return 0;
} }
/*! Add subscription given stream name, callback and argument
* @param[in] h Clicon handle
* @param[in] stream Name of event stream
* @param[in] format Expected format of event, eg text or xml
* @param[in] filter Filter to match event, depends on format, eg xpath for xml
* @param[in] fn Callback when event occurs
* @param[in] arg Argument to use with callback. Also handle when deleting
* Note that arg is not a real handle.
* @see subscription_delete
* @see subscription_each
*/
struct handle_subscription *
subscription_add(clicon_handle h,
char *stream,
enum format_enum format,
char *filter,
subscription_fn_t fn,
void *arg)
{
struct backend_handle *bh = handle(h);
struct handle_subscription *hs = NULL;
if ((hs = malloc(sizeof(*hs))) == NULL){
clicon_err(OE_PLUGIN, errno, "malloc");
goto done;
}
memset(hs, 0, sizeof(*hs));
hs->hs_stream = strdup(stream);
hs->hs_format = format;
hs->hs_filter = filter?strdup(filter):NULL;
hs->hs_next = bh->bh_subscription;
hs->hs_fn = fn;
hs->hs_arg = arg;
bh->bh_subscription = hs;
done:
return hs;
}
/*! Delete subscription given stream name, callback and argument
* @param[in] h Clicon handle
* @param[in] stream Name of event stream
* @param[in] fn Callback when event occurs
* @param[in] arg Argument to use with callback and handle
* Note that arg is not a real handle.
* @see subscription_add
* @see subscription_each
*/
int
subscription_delete(clicon_handle h,
char *stream,
subscription_fn_t fn,
void *arg)
{
struct backend_handle *bh = handle(h);
struct handle_subscription *hs;
struct handle_subscription **hs_prev;
hs_prev = &bh->bh_subscription; /* this points to stack and is not real backpointer */
for (hs = *hs_prev; hs; hs = hs->hs_next){
/* XXX arg == hs->hs_arg */
if (strcmp(hs->hs_stream, stream)==0 && hs->hs_fn == fn){
*hs_prev = hs->hs_next;
free(hs->hs_stream);
if (hs->hs_filter)
free(hs->hs_filter);
if (hs->hs_arg)
free(hs->hs_arg);
free(hs);
break;
}
hs_prev = &hs->hs_next;
}
return 0;
}
/*! Iterator over subscriptions
*
* NOTE: Never manipulate the child-list during operation or using the
* same object recursively, the function uses an internal field to remember the
* index used. It works as long as the same object is not iterated concurrently.
*
* @param[in] h clicon handle
* @param[in] hprev iterator, initialize with NULL
* @code
* clicon_handle h;
* struct handle_subscription *hs = NULL;
* while ((hs = subscription_each(h, hs)) != NULL) {
* ...
* }
* @endcode
*/
struct handle_subscription *
subscription_each(clicon_handle h,
struct handle_subscription *hprev)
{
struct backend_handle *bh = handle(h);
struct handle_subscription *hs = NULL;
if (hprev)
hs = hprev->hs_next;
else
hs = bh->bh_subscription;
return hs;
}
int int
backend_nacm_list_set(clicon_handle h, backend_nacm_list_set(clicon_handle h,
cxobj *xnacm) cxobj *xnacm)

25
apps/backend/clixon_backend_handle.h
View file

@ -43,34 +43,9 @@
/* /*
* Types * Types
*/ */
/* Notification subscription info
* @see client_subscription in config_client.h
*/
struct handle_subscription{
struct handle_subscription *hs_next;
enum format_enum hs_format; /* format (enum format_enum) XXX not needed? */
char *hs_stream; /* name of notify stream */
char *hs_filter; /* filter, if format=xml: xpath, if text: fnmatch */
subscription_fn_t hs_fn; /* Callback when event occurs */
void *hs_arg; /* Callback argument */
};
/* /*
* Prototypes * Prototypes
*/ */
/* Log for netconf notify function (config_client.c) */
int backend_notify(clicon_handle h, char *stream, int level, char *txt);
int backend_notify_xml(clicon_handle h, char *stream, int level, cxobj *x);
struct handle_subscription *subscription_add(clicon_handle h, char *stream,
enum format_enum format, char *filter,
subscription_fn_t fn, void *arg);
int subscription_delete(clicon_handle h, char *stream,
subscription_fn_t fn, void *arg);
struct handle_subscription *subscription_each(clicon_handle h,
struct handle_subscription *hprev);
#endif /* _CLIXON_BACKEND_HANDLE_H_ */ #endif /* _CLIXON_BACKEND_HANDLE_H_ */

30
apps/netconf/netconf_main.c
View file

@ -71,7 +71,7 @@
#include "netconf_rpc.h" #include "netconf_rpc.h"
/* Command line options to be passed to getopt(3) */ /* Command line options to be passed to getopt(3) */
#define NETCONF_OPTS "hDf:l:qa:u:d:y:U:" #define NETCONF_OPTS "hD:f:l:qa:u:d:y:U:t:"
#define NETCONF_LOGFILE "/tmp/clixon_netconf.log" #define NETCONF_LOGFILE "/tmp/clixon_netconf.log"
@ -284,6 +284,13 @@ netconf_terminate(clicon_handle h)
return 0; return 0;
} }
static int
timeout_fn(int s,
void *arg)
{
clicon_err(OE_EVENTS, ETIME, "User request timeout");
return -1;
}
/*! Usage help routine /*! Usage help routine
* @param[in] h Clicon handle * @param[in] h Clicon handle
@ -305,7 +312,8 @@ usage(clicon_handle h,
"\t-d <dir>\tSpecify netconf plugin directory dir (default: %s)\n" "\t-d <dir>\tSpecify netconf plugin directory dir (default: %s)\n"
"\t-y <file>\tOverride yang spec file (dont include .yang suffix)\n" "\t-y <file>\tOverride yang spec file (dont include .yang suffix)\n"
"\t-U <user>\tOver-ride unix user with a pseudo user for NACM.\n", "\t-U <user>\tOver-ride unix user with a pseudo user for NACM.\n"
"\t-t <sec>\tTimeout in seconds. Quit after this time.\n",
argv0, argv0,
clicon_netconf_dir(h) clicon_netconf_dir(h)
); );
@ -324,12 +332,13 @@ main(int argc,
char *dir; char *dir;
int logdst = CLICON_LOG_STDERR; int logdst = CLICON_LOG_STDERR;
struct passwd *pw; struct passwd *pw;
struct timeval tv = {0,}; /* timeout */
/* In the startup, logs to stderr & debug flag set later */
clicon_log_init(__PROGRAM__, LOG_INFO, logdst);
/* Create handle */ /* Create handle */
if ((h = clicon_handle_init()) == NULL) if ((h = clicon_handle_init()) == NULL)
return -1; return -1;
/* In the startup, logs to stderr & debug flag set later */
clicon_log_init(__PROGRAM__, LOG_INFO, logdst);
/* Set username to clicon handle. Use in all communication to backend */ /* Set username to clicon handle. Use in all communication to backend */
if ((pw = getpwuid(getuid())) == NULL){ if ((pw = getpwuid(getuid())) == NULL){
@ -338,7 +347,6 @@ main(int argc,
} }
if (clicon_username_set(h, pw->pw_name) < 0) if (clicon_username_set(h, pw->pw_name) < 0)
goto done; goto done;
while ((c = getopt(argc, argv, NETCONF_OPTS)) != -1) while ((c = getopt(argc, argv, NETCONF_OPTS)) != -1)
switch (c) { switch (c) {
case 'h' : /* help */ case 'h' : /* help */
@ -362,6 +370,7 @@ main(int argc,
goto done; goto done;
break; break;
} }
/* /*
* Logs, error and debug to stderr or syslog, set debug level * Logs, error and debug to stderr or syslog, set debug level
*/ */
@ -408,6 +417,10 @@ main(int argc,
if (clicon_username_set(h, optarg) < 0) if (clicon_username_set(h, optarg) < 0)
goto done; goto done;
break; break;
case 't': /* timeout in seconds */
tv.tv_sec = atoi(optarg);
break;
default: default:
usage(h, argv[0]); usage(h, argv[0]);
break; break;
@ -440,6 +453,13 @@ main(int argc,
goto done; goto done;
if (debug) if (debug)
clicon_option_dump(h, debug); clicon_option_dump(h, debug);
if (tv.tv_sec || tv.tv_usec){
struct timeval t;
gettimeofday(&t, NULL);
timeradd(&t, &tv, &t);
if (event_reg_timeout(t, timeout_fn, NULL, "timeout") < 0)
goto done;
}
if (event_loop() < 0) if (event_loop() < 0)
goto done; goto done;
done: done:

36
apps/netconf/netconf_rpc.c
View file

@ -733,20 +733,14 @@ static int
netconf_notification_cb(int s, netconf_notification_cb(int s,
void *arg) void *arg)
{ {
cxobj *xfilter = (cxobj *)arg;
char *selector;
struct clicon_msg *reply = NULL; struct clicon_msg *reply = NULL;
int eof; int eof;
char *event = NULL;
int retval = -1; int retval = -1;
cbuf *cb; cbuf *cb;
cxobj *xe = NULL; /* event xml */ cxobj *xn = NULL; /* event xml */
cxobj *xt = NULL; /* top xml */ cxobj *xt = NULL; /* top xml */
if (0){ clicon_debug(1, "%s", __FUNCTION__);
fprintf(stderr, "%s\n", __FUNCTION__); /* debug */
xml_print(stderr, xfilter); /* debug */
}
/* get msg (this is the reason this function is called) */ /* get msg (this is the reason this function is called) */
if (clicon_msg_rcv(s, &reply, &eof) < 0) if (clicon_msg_rcv(s, &reply, &eof) < 0)
goto done; goto done;
@ -756,31 +750,20 @@ netconf_notification_cb(int s,
close(s); close(s);
errno = ESHUTDOWN; errno = ESHUTDOWN;
event_unreg_fd(s, netconf_notification_cb); event_unreg_fd(s, netconf_notification_cb);
if (xfilter)
xml_free(xfilter);
goto done; goto done;
} }
if (clicon_msg_decode(reply, &xt) < 0) if (clicon_msg_decode(reply, &xt) < 0)
goto done; goto done;
if ((xe = xpath_first(xt, "//event")) != NULL) if ((xn = xpath_first(xt, "notification")) == NULL)
event = xml_body(xe); goto ok;
/* parse event */
if (0){ /* XXX CLICON events are not xml */
/* find and apply filter */
if ((selector = xml_find_value(xfilter, "select")) == NULL)
goto done;
if (xpath_first(xe, "%s", selector) == NULL) {
fprintf(stderr, "%s no match\n", __FUNCTION__); /* debug */
}
}
/* create netconf message */ /* create netconf message */
if ((cb = cbuf_new()) == NULL){ if ((cb = cbuf_new()) == NULL){
clicon_err(OE_PLUGIN, errno, "cbuf_new"); clicon_err(OE_PLUGIN, errno, "cbuf_new");
goto done; goto done;
} }
add_preamble(cb); /* Make it well-formed netconf xml */ add_preamble(cb); /* Make it well-formed netconf xml */
cprintf(cb, "<notification><event>%s</event></notification>", event); if (clicon_xml2cbuf(cb, xn, 0, 0) < 0)
goto done;
add_postamble(cb); add_postamble(cb);
/* Send it to listening client on stdout */ /* Send it to listening client on stdout */
if (netconf_output(1, cb, "notification") < 0){ if (netconf_output(1, cb, "notification") < 0){
@ -789,6 +772,7 @@ netconf_notification_cb(int s,
} }
fflush(stdout); fflush(stdout);
cbuf_free(cb); cbuf_free(cb);
ok:
retval = 0; retval = 0;
done: done:
if (xt != NULL) if (xt != NULL)
@ -802,7 +786,7 @@ netconf_notification_cb(int s,
<create-subscription> <create-subscription>
<stream>RESULT</stream> # If not present, events in the default NETCONF stream will be sent. <stream>RESULT</stream> # If not present, events in the default NETCONF stream will be sent.
<filter>XPATH-EXPR<(filter> <filter type="xpath" select="XPATHEXPR"/>
<startTime/> # only for replay (NYI) <startTime/> # only for replay (NYI)
<stopTime/> # only for replay (NYI) <stopTime/> # only for replay (NYI)
</create-subscription> </create-subscription>
@ -810,7 +794,7 @@ netconf_notification_cb(int s,
* @param[in] h clicon handle * @param[in] h clicon handle
* @param[in] xn Sub-tree (under xorig) at <rpc>...</rpc> level. * @param[in] xn Sub-tree (under xorig) at <rpc>...</rpc> level.
* @param[out] xret Return XML, error or OK * @param[out] xret Return XML, error or OK
* @see netconf_notification_cb for asynchronous stream notifications
*/ */
static int static int
netconf_create_subscription(clicon_handle h, netconf_create_subscription(clicon_handle h,
@ -840,7 +824,7 @@ netconf_create_subscription(clicon_handle h,
goto done; goto done;
if (event_reg_fd(s, if (event_reg_fd(s,
netconf_notification_cb, netconf_notification_cb,
xfilter?xml_dup(xfilter):NULL, NULL,
"notification socket") < 0) "notification socket") < 0)
goto done; goto done;
ok: ok:

13
apps/restconf/README.md
View file

@ -13,10 +13,15 @@ Define nginx config file: /etc/nginx/sites-available/default
``` ```
server { server {
... ...
location / { location /restconf {
root /usr/share/nginx/html/restconf; fastcgi_pass unix:/www-data/fastcgi_restconf.sock;
fastcgi_pass unix:/www-data/fastcgi_restconf.sock; include fastcgi_params;
include fastcgi_params; }
location /stream { # for restconf notifications
fastcgi_pass unix:/www-data/fastcgi_restconf.sock;
include fastcgi_params;
proxy_http_version 1.1;
proxy_set_header Connection "";
} }
} }
``` ```

6
apps/restconf/restconf_lib.h
View file

@ -36,6 +36,12 @@
#ifndef _RESTCONF_LIB_H_ #ifndef _RESTCONF_LIB_H_
#define _RESTCONF_LIB_H_ #define _RESTCONF_LIB_H_
/*
* Constants
*/
#define RESTCONF_API "restconf"
#define RESTCONF_STREAM "stream"
/* /*
* Prototypes (also in clixon_restconf.h) * Prototypes (also in clixon_restconf.h)
*/ */

14
apps/restconf/restconf_main.c
View file

@ -89,12 +89,6 @@
*/ */
#define RESTCONF_WELL_KNOWN "/.well-known/host-meta" #define RESTCONF_WELL_KNOWN "/.well-known/host-meta"
#define RESTCONF_API "restconf"
#define RESTCONF_API_ROOT "/restconf"
#define RESTCONF_STREAM_ROOT "/stream"
#define RESTCONF_LOGFILE "/www-data/clixon_restconf.log"
/*! Generic REST method, GET, PUT, DELETE, etc /*! Generic REST method, GET, PUT, DELETE, etc
* @param[in] h CLIXON handle * @param[in] h CLIXON handle
* @param[in] r Fastcgi request handle * @param[in] r Fastcgi request handle
@ -531,9 +525,11 @@ main(int argc,
/* In the startup, logs to stderr & debug flag set later */ /* In the startup, logs to stderr & debug flag set later */
clicon_log_init(__PROGRAM__, LOG_INFO, logdst); clicon_log_init(__PROGRAM__, LOG_INFO, logdst);
/* Create handle */ /* Create handle */
if ((h = clicon_handle_init()) == NULL) if ((h = clicon_handle_init()) == NULL)
goto done; goto done;
_CLICON_HANDLE = h; /* for termination handling */ _CLICON_HANDLE = h; /* for termination handling */
while ((c = getopt(argc, argv, RESTCONF_OPTS)) != -1) while ((c = getopt(argc, argv, RESTCONF_OPTS)) != -1)
switch (c) { switch (c) {
@ -634,6 +630,8 @@ main(int argc,
yang_spec_append(h, CLIXON_DATADIR, "ietf-yang-library", NULL)< 0) yang_spec_append(h, CLIXON_DATADIR, "ietf-yang-library", NULL)< 0)
goto done; goto done;
if (stream_register(h, "NETCONF", "default NETCONF event stream") < 0)
goto done;
/* Call start function in all plugins before we go interactive /* Call start function in all plugins before we go interactive
Pass all args after the standard options to plugin_start Pass all args after the standard options to plugin_start
*/ */
@ -667,9 +665,9 @@ main(int argc,
clicon_debug(1, "------------"); clicon_debug(1, "------------");
if ((path = FCGX_GetParam("REQUEST_URI", r->envp)) != NULL){ if ((path = FCGX_GetParam("REQUEST_URI", r->envp)) != NULL){
clicon_debug(1, "path: %s", path); clicon_debug(1, "path: %s", path);
if (strncmp(path, RESTCONF_API_ROOT, strlen(RESTCONF_API_ROOT)) == 0) if (strncmp(path, "/" RESTCONF_API, strlen("/" RESTCONF_API)) == 0)
api_restconf(h, r); /* This is the function */ api_restconf(h, r); /* This is the function */
else if (strncmp(path, RESTCONF_STREAM_ROOT, strlen(RESTCONF_STREAM_ROOT)) == 0) { else if (strncmp(path, "/" RESTCONF_STREAM, strlen("/" RESTCONF_STREAM)) == 0) {
api_stream(h, r); api_stream(h, r);
} }
else if (strncmp(path, RESTCONF_WELL_KNOWN, strlen(RESTCONF_WELL_KNOWN)) == 0) { else if (strncmp(path, RESTCONF_WELL_KNOWN, strlen(RESTCONF_WELL_KNOWN)) == 0) {

139
apps/restconf/restconf_stream.c
View file

@ -64,6 +64,32 @@
#include <fcgi_stdio.h> /* Need to be after clixon_xml-h due to attribute format */ #include <fcgi_stdio.h> /* Need to be after clixon_xml-h due to attribute format */
static int
restconf_stream(clicon_handle h,
FCGX_Request *r,
event_stream_t *es)
{
int retval = -1;
clicon_debug(1, "%s", __FUNCTION__);
FCGX_SetExitStatus(201, r->out); /* Created */
FCGX_FPrintF(r->out, "Content-Type: text/event-stream\r\n");
FCGX_FPrintF(r->out, "Cache-Control: no-cache\r\n");
FCGX_FPrintF(r->out, "Connection: keep-alive\r\n");
FCGX_FPrintF(r->out, "X-Accel-Buffering: no\r\n");
FCGX_FPrintF(r->out, "\r\n");
FCGX_FPrintF(r->out, "Here is output\r\n");
FCGX_FPrintF(r->out, "\r\n");
FCGX_FFlush(r->out);
sync();
sleep(1);
FCGX_FPrintF(r->out, "Here is output 2\r\n");
retval = 0;
// done:
return retval;
}
/* restconf */ /* restconf */
#include "restconf_lib.h" #include "restconf_lib.h"
#include "restconf_stream.h" #include "restconf_stream.h"
@ -73,13 +99,122 @@
*/ */
int int
api_stream(clicon_handle h, api_stream(clicon_handle h,
FCGX_Request *r) FCGX_Request *r)
{ {
int retval = -1; int retval = -1;
char *path;
char *query;
char *method;
char **pvec = NULL;
int pn;
cvec *qvec = NULL;
cvec *dvec = NULL;
cvec *pcvec = NULL; /* for rest api */
cbuf *cb = NULL;
char *data;
int authenticated = 0;
char *media_accept;
char *media_content_type;
int pretty;
int parse_xml = 0; /* By default expect and parse JSON */
int use_xml = 0; /* By default use JSON */
cbuf *cbret = NULL;
cxobj *xret = NULL;
cxobj *xerr;
event_stream_t *es;
clicon_debug(1, "%s", __FUNCTION__); clicon_debug(1, "%s", __FUNCTION__);
path = FCGX_GetParam("REQUEST_URI", r->envp);
query = FCGX_GetParam("QUERY_STRING", r->envp);
pretty = clicon_option_bool(h, "CLICON_RESTCONF_PRETTY");
/* get xml/json in put and output */
media_accept = FCGX_GetParam("HTTP_ACCEPT", r->envp);
if (media_accept && strcmp(media_accept, "application/yang-data+xml")==0)
use_xml++;
media_content_type = FCGX_GetParam("HTTP_CONTENT_TYPE", r->envp);
if (media_content_type &&
strcmp(media_content_type, "application/yang-data+xml")==0)
parse_xml++;
if ((pvec = clicon_strsep(path, "/", &pn)) == NULL)
goto done;
/* Sanity check of path. Should be /stream/<name> */
if (pn != 3){
notfound(r);
goto ok;
}
if (strlen(pvec[0]) != 0){
retval = notfound(r);
goto done;
}
if (strcmp(pvec[1], RESTCONF_STREAM)){
retval = notfound(r);
goto done;
}
test(r, 1);
if ((method = pvec[2]) == NULL){
retval = notfound(r);
goto done;
}
clicon_debug(1, "%s: method=%s", __FUNCTION__, method);
if (str2cvec(query, '&', '=', &qvec) < 0)
goto done;
if (str2cvec(path, '/', '=', &pcvec) < 0) /* rest url eg /album=ricky/foo */
goto done;
/* data */
if ((cb = readdata(r)) == NULL)
goto done;
data = cbuf_get(cb);
clicon_debug(1, "%s DATA=%s", __FUNCTION__, data);
if (str2cvec(data, '&', '=', &dvec) < 0)
goto done;
/* If present, check credentials. See "plugin_credentials" in plugin
* See RFC 8040 section 2.5
*/
if ((authenticated = clixon_plugin_auth(h, r)) < 0)
goto done;
clicon_debug(1, "%s auth:%d %s", __FUNCTION__, authenticated, clicon_username_get(h));
/* If set but no user, we set a dummy user */
if (authenticated){
if (clicon_username_get(h) == NULL)
clicon_username_set(h, "none");
}
else{
if (netconf_access_denied_xml(&xret, "protocol", "The requested URL was unauthorized") < 0)
goto done;
if ((xerr = xpath_first(xret, "//rpc-error")) != NULL){
if (api_return_err(h, r, xerr, pretty, use_xml) < 0)
goto done;
goto ok;
}
goto ok;
}
clicon_debug(1, "%s auth2:%d %s", __FUNCTION__, authenticated, clicon_username_get(h));
if ((es = stream_find(h, method)) == NULL){
retval = notfound(r);
goto done;
}
if (restconf_stream(h, r, es) < 0)
goto done;
ok:
retval = 0; retval = 0;
// done: done:
clicon_debug(1, "%s retval:%d", __FUNCTION__, retval); clicon_debug(1, "%s retval:%d", __FUNCTION__, retval);
if (pvec)
free(pvec);
if (dvec)
cvec_free(dvec);
if (qvec)
cvec_free(qvec);
if (pcvec)
cvec_free(pcvec);
if (cb)
cbuf_free(cb);
if (cbret)
cbuf_free(cbret);
if (xret)
xml_free(xret);
return retval; return retval;
} }

2
datastore/text/clixon_xmldb_text.c
View file

@ -892,7 +892,7 @@ text_put(xmldb_handle xh,
} }
cbretlocal++; cbretlocal++;
} }
if ((yspec = th->th_yangspec) == NULL){ if ((yspec = th->th_yangspec) == NULL){
clicon_err(OE_YANG, ENOENT, "No yang spec"); clicon_err(OE_YANG, ENOENT, "No yang spec");
goto done; goto done;
} }

7
doc/FAQ.md
View file

@ -164,7 +164,7 @@ Example:
## How do I use notifications? ## How do I use notifications?
The example has a prebuilt notification stream called "ROUTING" that triggers every 10s. The example has a prebuilt notification stream called "NETCONF" that triggers every 5s.
You enable the notification either via the cli: You enable the notification either via the cli:
``` ```
cli> notify cli> notify
@ -173,10 +173,9 @@ cli>
or via netconf: or via netconf:
``` ```
clixon_netconf -qf /usr/local/etc/example.xml clixon_netconf -qf /usr/local/etc/example.xml
<rpc><create-subscription><stream>ROUTING</stream></create-subscription></rpc>]]>]]> <rpc><create-subscription><stream>NETCONF</stream></create-subscription></rpc>]]>]]>
<rpc-reply><ok/></rpc-reply>]]>]]> <rpc-reply><ok/></rpc-reply>]]>]]>
<notification><event>Routing notification</event></notification>]]>]]> <notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"><eventTime>2018-09-30T12:44:59.657276</eventTime><event xmlns="http://example.com/event/1.0"><event-class>fault</event-class><reportingEntity><card>Ethernet0</card></reportingEntity><severity>major</severity></event></notification>]]>]]>
<notification><event>Routing notification</event></notification>]]>]]>
... ...
``` ```

31
example/example_backend.c
View file

@ -99,7 +99,8 @@ notification_timer(int fd,
int retval = -1; int retval = -1;
clicon_handle h = (clicon_handle)arg; clicon_handle h = (clicon_handle)arg;
if (backend_notify(h, "ROUTING", 0, "Routing notification") < 0) /* XXX Change to actual netconf notifications */
if (stream_notify(h, "NETCONF", "<event xmlns=\"http://example.com/event/1.0\"><event-class>fault</event-class><reportingEntity><card>Ethernet0</card></reportingEntity><severity>major</severity></event>") < 0)
goto done; goto done;
if (notification_timer_setup(h) < 0) if (notification_timer_setup(h) < 0)
goto done; goto done;
@ -108,7 +109,7 @@ notification_timer(int fd,
return retval; return retval;
} }
/*! Set up routing notifcation timer /*! Set up routing notification timer
*/ */
static int static int
notification_timer_setup(clicon_handle h) notification_timer_setup(clicon_handle h)
@ -116,7 +117,7 @@ notification_timer_setup(clicon_handle h)
struct timeval t, t1; struct timeval t, t1;
gettimeofday(&t, NULL); gettimeofday(&t, NULL);
t1.tv_sec = 10; t1.tv_usec = 0; t1.tv_sec = 5; t1.tv_usec = 0;
timeradd(&t, &t1, &t); timeradd(&t, &t1, &t);
return event_reg_timeout(t, notification_timer, h, "notification timer"); return event_reg_timeout(t, notification_timer, h, "notification timer");
} }
@ -176,8 +177,15 @@ empty(clicon_handle h, /* Clicon handle */
* @retval 0 OK * @retval 0 OK
* @retval -1 Error * @retval -1 Error
* @see xmldb_get * @see xmldb_get
* @note this example code returns a static statedata used in testing. * @note this example code returns requires this yang snippet:
* Real code would poll state container state {
config false;
description "state data for example application";
leaf-list op {
type string;
}
}
*
*/ */
int int
example_statedata(clicon_handle h, example_statedata(clicon_handle h,
@ -187,12 +195,13 @@ example_statedata(clicon_handle h,
int retval = -1; int retval = -1;
cxobj **xvec = NULL; cxobj **xvec = NULL;
/* Example of (static) statedata, real code would poll state */ /* Example of (static) statedata, real code would poll state
if (xml_parse_string("<interfaces-state><interface>" * Note this state needs to be accomanied by yang snippet
"<name>eth0</name>" * above
"<type>ex:eth</type>" */
"<if-index>42</if-index>" if (xml_parse_string("<state>"
"</interface></interfaces-state>", NULL, &xstate) < 0) "<op>42</op>"
"</state>", NULL, &xstate) < 0)
goto done; goto done;
retval = 0; retval = 0;
done: done:

4
example/example_cli.cli
View file

@ -64,7 +64,7 @@ load("Load configuration from XML file") <filename:string>("Filename (local file
} }
example("This is a comment") <var:int32>("Just a random number"), mycallback("myarg"); example("This is a comment") <var:int32>("Just a random number"), mycallback("myarg");
rpc("ex:fib-route rpc") <instance:string>("routing instance"), fib_route_rpc("myarg"); rpc("ex:fib-route rpc") <instance:string>("routing instance"), fib_route_rpc("myarg");
notify("Get notifications from backend"), cli_notify("ROUTING", "1", "text"); notify("Get notifications from backend"), cli_notify("NETCONF", "1", "text");
no("Negate") notify("Get notifications from backend"), cli_notify("ROUTING", "0", "xml"); no("Negate") notify("Get notifications from backend"), cli_notify("NETCONF", "0", "xml");
lock,cli_lock("candidate"); lock,cli_lock("candidate");
unlock,cli_unlock("candidate"); unlock,cli_unlock("candidate");

4
lib/clixon/clixon.h.in
View file

@ -63,12 +63,11 @@
#define LIBCLIXON_API 1 #define LIBCLIXON_API 1
#include <clixon/clixon_sig.h> #include <clixon/clixon_sig.h>
#include <clixon/clixon_log.h>
#include <clixon/clixon_err.h> #include <clixon/clixon_err.h>
#include <clixon/clixon_queue.h> #include <clixon/clixon_queue.h>
#include <clixon/clixon_hash.h> #include <clixon/clixon_hash.h>
#include <clixon/clixon_handle.h> #include <clixon/clixon_handle.h>
#include <clixon/clixon_stream.h> #include <clixon/clixon_log.h>
#include <clixon/clixon_yang.h> #include <clixon/clixon_yang.h>
#include <clixon/clixon_yang_type.h> #include <clixon/clixon_yang_type.h>
#include <clixon/clixon_event.h> #include <clixon/clixon_event.h>
@ -76,6 +75,7 @@
#include <clixon/clixon_file.h> #include <clixon/clixon_file.h>
#include <clixon/clixon_xml.h> #include <clixon/clixon_xml.h>
#include <clixon/clixon_xml_sort.h> #include <clixon/clixon_xml_sort.h>
#include <clixon/clixon_stream.h>
#include <clixon/clixon_proto.h> #include <clixon/clixon_proto.h>
#include <clixon/clixon_proto_client.h> #include <clixon/clixon_proto_client.h>
#include <clixon/clixon_plugin.h> #include <clixon/clixon_plugin.h>

8
lib/clixon/clixon_log.h
View file

@ -46,11 +46,6 @@
#define CLICON_LOG_STDOUT 4 /* print logs on stdout */ #define CLICON_LOG_STDOUT 4 /* print logs on stdout */
#define CLICON_LOG_FILE 8 /* print logs on clicon_log_filename */ #define CLICON_LOG_FILE 8 /* print logs on clicon_log_filename */
/*
* Types
*/
typedef int (clicon_log_notify_t)(int level, char *msg, void *arg);
/* /*
* Variables * Variables
*/ */
@ -64,7 +59,6 @@ int clicon_log_exit(void);
int clicon_log_opt(char c); int clicon_log_opt(char c);
int clicon_log_file(char *filename); int clicon_log_file(char *filename);
int clicon_get_logflags(void); int clicon_get_logflags(void);
int clicon_log_str(int level, char *msg);
#if defined(__GNUC__) && __GNUC__ >= 3 #if defined(__GNUC__) && __GNUC__ >= 3
int clicon_log(int level, char *format, ...) __attribute__ ((format (printf, 2, 3))); int clicon_log(int level, char *format, ...) __attribute__ ((format (printf, 2, 3)));
int clicon_debug(int dbglevel, char *format, ...) __attribute__ ((format (printf, 2, 3))); int clicon_debug(int dbglevel, char *format, ...) __attribute__ ((format (printf, 2, 3)));
@ -72,9 +66,7 @@ int clicon_debug(int dbglevel, char *format, ...) __attribute__ ((format (printf
int clicon_log(int level, char *format, ...); int clicon_log(int level, char *format, ...);
int clicon_debug(int dbglevel, char *format, ...); int clicon_debug(int dbglevel, char *format, ...);
#endif #endif
clicon_log_notify_t *clicon_log_register_callback(clicon_log_notify_t *cb, void *arg);
int clicon_debug_init(int dbglevel, FILE *f); int clicon_debug_init(int dbglevel, FILE *f);
char *mon2name(int md); char *mon2name(int md);
#endif /* _CLIXON_LOG_H_ */ #endif /* _CLIXON_LOG_H_ */

2
lib/clixon/clixon_proto.h
View file

@ -87,7 +87,7 @@ int clicon_msg_send(int s, struct clicon_msg *msg);
int clicon_msg_rcv(int s, struct clicon_msg **msg, int *eof); int clicon_msg_rcv(int s, struct clicon_msg **msg, int *eof);
int send_msg_notify(int s, int level, char *event); int send_msg_notify_xml(int s, cxobj *xev);
int send_msg_reply(int s, char *data, uint32_t datalen); int send_msg_reply(int s, char *data, uint32_t datalen);

16
lib/clixon/clixon_stream.h
View file

@ -40,12 +40,12 @@
* Types * Types
*/ */
/* subscription callback */ /* subscription callback */
typedef int (*stream_fn_t)(clicon_handle, void *filter, void *arg); typedef int (*stream_fn_t)(clicon_handle h, void *event, void *arg);
typedef stream_fn_t subscription_fn_t;
struct stream_subscription{ struct stream_subscription{
struct stream_subscription *ss_next; struct stream_subscription *ss_next;
char *ss_stream; /* Name of associated stream */ char *ss_stream; /* Name of associated stream */
char *ss_xpath; /* Filter selector as xpath */
stream_fn_t ss_fn; /* Callback when event occurs */ stream_fn_t ss_fn; /* Callback when event occurs */
void *ss_arg; /* Callback argument */ void *ss_arg; /* Callback argument */
}; };
@ -65,9 +65,15 @@ typedef struct event_stream event_stream_t;
*/ */
event_stream_t *stream_find(clicon_handle h, const char *name); event_stream_t *stream_find(clicon_handle h, const char *name);
int stream_register(clicon_handle h, const char *name, const char *description); int stream_register(clicon_handle h, const char *name, const char *description);
int stream_free(event_stream_t *es); int stream_delete_all(event_stream_t *es);
int stream_get_xml(clicon_handle h, int access, cbuf *cb); int stream_get_xml(clicon_handle h, int access, cbuf *cb);
int stream_cb_add(clicon_handle h, char *stream, stream_fn_t fn, void *arg); int stream_cb_add(clicon_handle h, char *stream, char *xpath, stream_fn_t fn, void *arg);
int stream_cb_delete(clicon_handle h, char *stream, stream_fn_t fn); int stream_cb_delete(clicon_handle h, char *stream, stream_fn_t fn, void *arg);
int stream_notify_xml(clicon_handle h, char *stream, cxobj *xevent);
#if defined(__GNUC__) && __GNUC__ >= 3
int stream_notify(clicon_handle h, char *stream, const char *event, ...) __attribute__ ((format (printf, 3, 4)));
#else
int stream_notify(clicon_handle h, char *stream, const char *event, ...);
#endif
#endif /* _CLIXON_STREAM_H_ */ #endif /* _CLIXON_STREAM_H_ */

2
lib/src/clixon_handle.c
View file

@ -136,7 +136,7 @@ clicon_handle_exit(clicon_handle h)
hash_free(copt); hash_free(copt);
if ((data = clicon_data(h)) != NULL) if ((data = clicon_data(h)) != NULL)
hash_free(data); hash_free(data);
stream_free(clicon_stream(h)); stream_delete_all(clicon_stream(h));
free(ch); free(ch);
return 0; return 0;
} }

65
lib/src/clixon_log.c
View file

@ -52,6 +52,9 @@
#include <sys/time.h> #include <sys/time.h>
#include <sys/types.h> #include <sys/types.h>
/* cligen */
#include <cligen/cligen.h>
/* clicon */ /* clicon */
#include "clixon_err.h" #include "clixon_err.h"
#include "clixon_log.h" #include "clixon_log.h"
@ -62,10 +65,6 @@ int debug = 0;
/* Bitmask whether to log to syslog or stderr: CLICON_LOG_STDERR | CLICON_LOG_SYSLOG */ /* Bitmask whether to log to syslog or stderr: CLICON_LOG_STDERR | CLICON_LOG_SYSLOG */
static int _logflags = 0x0; static int _logflags = 0x0;
/* Function pointer to log notify callback */
static clicon_log_notify_t *_log_notify_cb = NULL;
static void *_log_notify_arg = NULL;
/* Set to open file to write debug messages directly to file */ /* Set to open file to write debug messages directly to file */
static FILE *_logfile = NULL; static FILE *_logfile = NULL;
@ -81,15 +80,14 @@ static FILE *_logfile = NULL;
* if CLICON_LOG_SYSLOG, then print logs to syslog * if CLICON_LOG_SYSLOG, then print logs to syslog
* You can do a combination of both * You can do a combination of both
* @code * @code
* clicon_log_init(__PROGRAM__, LOG_INFO, CLICON_LOG_STDERR); * clicon_log_init(h, __PROGRAM__, LOG_INFO, CLICON_LOG_STDERR);
* @endcode * @endcode
*/ */
int int
clicon_log_init(char *ident, clicon_log_init(char *ident,
int upto, int upto,
int flags) int flags)
{ {
_logflags = flags; _logflags = flags;
if (flags & CLICON_LOG_SYSLOG){ if (flags & CLICON_LOG_SYSLOG){
if (setlogmask(LOG_UPTO(upto)) < 0) if (setlogmask(LOG_UPTO(upto)) < 0)
@ -160,18 +158,6 @@ clicon_get_logflags(void)
return _logflags; return _logflags;
} }
/*! Register log callback, return old setting
*/
clicon_log_notify_t *
clicon_log_register_callback(clicon_log_notify_t *cb,
void *arg)
{
clicon_log_notify_t *old = _log_notify_cb;
_log_notify_cb = cb;
_log_notify_arg = arg;
return old;
}
/*! Mimic syslog and print a time on file f /*! Mimic syslog and print a time on file f
*/ */
static int static int
@ -188,6 +174,7 @@ flogtime(FILE *f)
return 0; return 0;
} }
#ifdef NOTUSED
/* /*
* Mimic syslog and print a time on string s * Mimic syslog and print a time on string s
* String returned needs to be freed. * String returned needs to be freed.
@ -211,19 +198,19 @@ slogtime(void)
tm->tm_hour, tm->tm_min, tm->tm_sec); tm->tm_hour, tm->tm_min, tm->tm_sec);
return str; return str;
} }
#endif
/*! Make a logging call to syslog (or stderr). /*! Make a logging call to syslog (or stderr).
* *
* @param[in] level log level, eg LOG_DEBUG,LOG_INFO,...,LOG_EMERG. Thisis OR:d with facility == LOG_USER * @param[in] level log level, eg LOG_DEBUG,LOG_INFO,...,LOG_EMERG. Thisis OR:d with facility == LOG_USER
* @param[in] msg Message to print as argv. * @param[in] msg Message to print as argv.
* This is the _only_ place the actual syslog (or stderr) logging is made in clicon,.. * This is the _only_ place the actual syslog (or stderr) logging is made in clicon,..
* @note syslog makes itw own filtering, but if log to stderr we do it here * @note syslog makes its own filtering, but if log to stderr we do it here
* @see clicon_debug * @see clicon_debug
*/ */
int static int
clicon_log_str(int level, clicon_log_str(int level,
char *msg) char *msg)
{ {
if (_logflags & CLICON_LOG_SYSLOG) if (_logflags & CLICON_LOG_SYSLOG)
syslog(LOG_MAKEPRI(LOG_USER, level), "%s", msg); syslog(LOG_MAKEPRI(LOG_USER, level), "%s", msg);
@ -245,30 +232,10 @@ clicon_log_str(int level,
fprintf(_logfile, "%s\n", msg); fprintf(_logfile, "%s\n", msg);
fflush(_logfile); fflush(_logfile);
} }
if (_log_notify_cb){
static int cb = 0;
char *d, *msg2;
int len;
if (cb++ == 0){ /* Enable this if you want syslog in a stream. But there are problems with
/* Here there is danger of recursion: if callback in turn logs, therefore * recursion
make static check (should be stack-based - now global) */
*/
if ((d = slogtime()) == NULL)
return -1;
len = strlen(d) + strlen(msg) + 1;
if ((msg2 = malloc(len)) == NULL){
fprintf(stderr, "%s: malloc: %s\n", __FUNCTION__, strerror(errno));
return -1;
}
snprintf(msg2, len, "%s%s", d, msg);
assert(_log_notify_arg);
_log_notify_cb(level, msg2, _log_notify_arg);
free(d);
free(msg2);
}
cb--;
}
done: done:
return 0; return 0;
} }

39
lib/src/clixon_proto.c
View file

@ -64,10 +64,10 @@
/* clicon */ /* clicon */
#include "clixon_err.h" #include "clixon_err.h"
#include "clixon_log.h"
#include "clixon_queue.h" #include "clixon_queue.h"
#include "clixon_hash.h" #include "clixon_hash.h"
#include "clixon_handle.h" #include "clixon_handle.h"
#include "clixon_log.h"
#include "clixon_yang.h" #include "clixon_yang.h"
#include "clixon_sig.h" #include "clixon_sig.h"
#include "clixon_xml.h" #include "clixon_xml.h"
@ -564,16 +564,16 @@ send_msg_reply(int s,
* @param[in] event * @param[in] event
* @retval 0 OK * @retval 0 OK
* @retval -1 Error * @retval -1 Error
* @see send_msg_notify_xml
*/ */
int static int
send_msg_notify(int s, send_msg_notify(int s,
int level,
char *event) char *event)
{ {
int retval = -1; int retval = -1;
struct clicon_msg *msg = NULL; struct clicon_msg *msg = NULL;
if ((msg=clicon_msg_encode("<notification><event>%s</event></notification>", event)) == NULL) if ((msg=clicon_msg_encode("%s", event)) == NULL)
goto done; goto done;
if (clicon_msg_send(s, msg) < 0) if (clicon_msg_send(s, msg) < 0)
goto done; goto done;
@ -584,6 +584,37 @@ send_msg_notify(int s,
return retval; return retval;
} }
/*! Send a clicon_msg NOTIFY message asynchronously to client
*
* @param[in] s Socket to communicate with client
* @param[in] level
* @param[in] xml Event as XML
* @retval 0 OK
* @retval -1 Error
* @see send_msg_notify XXX beauty contest
*/
int
send_msg_notify_xml(int s,
cxobj *xev)
{
int retval = -1;
cbuf *cb = NULL;
if ((cb = cbuf_new()) == NULL){
clicon_err(OE_PLUGIN, errno, "cbuf_new");
goto done;
}
if (clicon_xml2cbuf(cb, xev, 0, 0) < 0)
goto done;
if (send_msg_notify(s, cbuf_get(cb)) < 0)
goto done;
retval = 0;
done:
if (cb)
cbuf_free(cb);
return retval;
}
/*! Look for a text pattern in an input string, one char at a time /*! Look for a text pattern in an input string, one char at a time
* @param[in] tag What to look for * @param[in] tag What to look for
* @param[in] ch New input character * @param[in] ch New input character

4
lib/src/clixon_proto_client.c
View file

@ -57,9 +57,9 @@
/* clicon */ /* clicon */
#include "clixon_queue.h" #include "clixon_queue.h"
#include "clixon_log.h"
#include "clixon_hash.h" #include "clixon_hash.h"
#include "clixon_handle.h" #include "clixon_handle.h"
#include "clixon_log.h"
#include "clixon_yang.h" #include "clixon_yang.h"
#include "clixon_options.h" #include "clixon_options.h"
#include "clixon_xml.h" #include "clixon_xml.h"
@ -775,7 +775,7 @@ clicon_rpc_create_subscription(clicon_handle h,
username = clicon_username_get(h); username = clicon_username_get(h);
if ((msg = clicon_msg_encode("<rpc username=\"%s\"><create-subscription>" if ((msg = clicon_msg_encode("<rpc username=\"%s\"><create-subscription>"
"<stream>%s</stream>" "<stream>%s</stream>"
"<filter>%s</filter>" "<filter type=\"xpath\" select=\"%s\" />"
"</create-subscription></rpc>", "</create-subscription></rpc>",
username?username:"", username?username:"",
stream?stream:"", filter?filter:"")) == NULL) stream?stream:"", filter?filter:"")) == NULL)

181
lib/src/clixon_stream.c
View file

@ -44,6 +44,7 @@
#include <string.h> #include <string.h>
#include <errno.h> #include <errno.h>
#include <inttypes.h> #include <inttypes.h>
#include <sys/time.h>
/* cligen */ /* cligen */
#include <cligen/cligen.h> #include <cligen/cligen.h>
@ -51,8 +52,14 @@
/* clicon */ /* clicon */
#include "clixon_queue.h" #include "clixon_queue.h"
#include "clixon_err.h" #include "clixon_err.h"
#include "clixon_string.h"
#include "clixon_hash.h" #include "clixon_hash.h"
#include "clixon_handle.h" #include "clixon_handle.h"
#include "clixon_yang.h"
#include "clixon_xml.h"
#include "clixon_options.h"
#include "clixon_xpath_ctx.h"
#include "clixon_xpath.h"
#include "clixon_stream.h" #include "clixon_stream.h"
/*! Find an event notification stream given name /*! Find an event notification stream given name
@ -74,6 +81,7 @@ stream_find(clicon_handle h,
} }
/*! Add notification event stream /*! Add notification event stream
*
*/ */
int int
stream_register(clicon_handle h, stream_register(clicon_handle h,
@ -105,10 +113,10 @@ stream_register(clicon_handle h,
return retval; return retval;
} }
/*! Delete complete notification event stream list /*! Delete complete notification event stream list (not just single stream)
*/ */
int int
stream_free(event_stream_t *es) stream_delete_all(event_stream_t *es)
{ {
event_stream_t *e_next; event_stream_t *e_next;
@ -148,8 +156,11 @@ stream_get_xml(clicon_handle h,
if (access){ if (access){
cprintf(cb, "<access>"); cprintf(cb, "<access>");
cprintf(cb, "<encoding>xml</encoding>"); cprintf(cb, "<encoding>xml</encoding>");
/* Note /stream need to be in http proxy declaration */ /* Note /stream need to be in http proxy declaration
cprintf(cb, "<location>https://example.com/stream/%s</location>", es->es_name); * XXX
*/
cprintf(cb, "<location>/stream/%s</location>", es->es_name);
cprintf(cb, "</access>"); cprintf(cb, "</access>");
} }
cprintf(cb, "</stream>"); cprintf(cb, "</stream>");
@ -173,6 +184,7 @@ stream_del()
/*! Add an event notification callback to a stream given a callback function /*! Add an event notification callback to a stream given a callback function
* @param[in] h Clicon handle * @param[in] h Clicon handle
* @param[in] stream Name of stream * @param[in] stream Name of stream
* @param[in] xpath Filter selector - xpath
* @param[in] fn Callback when event occurs * @param[in] fn Callback when event occurs
* @param[in] arg Argument to use with callback. Also handle when deleting * @param[in] arg Argument to use with callback. Also handle when deleting
* @retval 0 OK * @retval 0 OK
@ -182,6 +194,7 @@ stream_del()
int int
stream_cb_add(clicon_handle h, stream_cb_add(clicon_handle h,
char *stream, char *stream,
char *xpath,
stream_fn_t fn, stream_fn_t fn,
void *arg) void *arg)
{ {
@ -190,7 +203,7 @@ stream_cb_add(clicon_handle h,
struct stream_subscription *ss; struct stream_subscription *ss;
if ((es = stream_find(h, stream)) == NULL){ if ((es = stream_find(h, stream)) == NULL){
clicon_err(OE_CFG, ENOENT, "Stream not found"); clicon_err(OE_CFG, ENOENT, "Stream %s not found", stream);
goto done; goto done;
} }
if ((ss = malloc(sizeof(*ss))) == NULL){ if ((ss = malloc(sizeof(*ss))) == NULL){
@ -198,7 +211,14 @@ stream_cb_add(clicon_handle h,
goto done; goto done;
} }
memset(ss, 0, sizeof(*ss)); memset(ss, 0, sizeof(*ss));
ss->ss_stream = strdup(stream); if ((ss->ss_stream = strdup(stream)) == NULL){
clicon_err(OE_CFG, errno, "strdup");
goto done;
}
if (xpath && (ss->ss_xpath = strdup(xpath)) == NULL){
clicon_err(OE_CFG, errno, "strdup");
goto done;
}
ss->ss_fn = fn; ss->ss_fn = fn;
ss->ss_arg = arg; ss->ss_arg = arg;
ss->ss_next = es->es_subscription; ss->ss_next = es->es_subscription;
@ -208,34 +228,149 @@ stream_cb_add(clicon_handle h,
return retval; return retval;
} }
/*! Delete event notification callback to a stream given a callback function /*! Delete event notification callback to a stream given a callback and arg
* Alt just send in an ss struct? * @param[in] h Clicon handle
* @param[in] stream Name of stream or NULL for all streams
* @param[in] fn Callback when event occurs
* @param[in] arg Argument to use with callback. Also handle when deleting
* @retval 0 OK
* @retval -1 Error
*/ */
int int
stream_cb_delete(clicon_handle h, stream_cb_delete(clicon_handle h,
char *stream, char *stream,
stream_fn_t fn) stream_fn_t fn,
void *arg)
{ {
int retval = -1; int retval = -1;
event_stream_t *es; event_stream_t *es;
struct stream_subscription *ss;
struct stream_subscription **ss_prev; struct stream_subscription **ss_prev;
struct stream_subscription *ss;
struct stream_subscription *ss_next;
if ((es = stream_find(h, stream)) == NULL) for (es=clicon_stream(h); es; es=es->es_next){
goto ok; if (stream && strcmp(stream, es->es_name)!=0)
ss_prev = &es->es_subscription; continue;
for (ss = *ss_prev; ss; ss = ss->ss_next){ ss_prev = &es->es_subscription;
if (ss->ss_fn == fn){ for (ss = *ss_prev; ss; ss = ss_next){
*ss_prev = ss->ss_next; ss_next = ss->ss_next;
free(ss->ss_stream); if (fn == ss->ss_fn && arg == ss->ss_arg){
if (ss->ss_arg) *ss_prev = ss->ss_next;
free(ss->ss_arg); if (ss->ss_stream)
free(ss); free(ss->ss_stream);
break; if (ss->ss_xpath)
free(ss->ss_xpath);
free(ss);
continue;
// break; if more > 1
}
ss_prev = &ss->ss_next;
} }
ss_prev = &ss->ss_next;
} }
ok:
retval = 0; retval = 0;
return retval; return retval;
} }
/*! Stream notify event and distribute to all registered callbacks
* @param[in] h Clicon handle
* @param[in] stream Name of event stream. CLICON is predefined as LOG stream
* @param[in] event Notification as xml tree
* @retval 0 OK
* @retval -1 Error with clicon_err called
* @see stream_notify
*/
int
stream_notify_xml(clicon_handle h,
char *stream,
cxobj *xevent)
{
int retval = -1;
event_stream_t *es;
struct stream_subscription *ss;
if ((es = stream_find(h, stream)) == NULL)
goto ok;
/* Go thru all global (handle) subscriptions and find matches */
for (ss = es->es_subscription; ss; ss = ss->ss_next){
if (ss->ss_xpath == NULL ||
strlen(ss->ss_xpath)==0 ||
xpath_first(xevent, "%s", ss->ss_xpath) != NULL)
if ((*ss->ss_fn)(h, xevent, ss->ss_arg) < 0)
goto done;
}
ok:
retval = 0;
done:
return retval;
}
/*! Stream notify event and distribute to all registered callbacks
* @param[in] h Clicon handle
* @param[in] stream Name of event stream. CLICON is predefined as LOG stream
* @param[in] event Notification as format string according to printf(3)
* @retval 0 OK
* @retval -1 Error with clicon_err called
* @code
* if (stream_notify(h, "NETCONF", "<event><event-class>fault</event-class><reportingEntity><card>Ethernet0</card></reportingEntity><severity>major</severity></event>") < 0)
* err;
* @endcode
* @see stream_notify_xml
* @see backend_notify
*/
int
stream_notify(clicon_handle h,
char *stream,
const char *event, ...)
{
int retval = -1;
va_list args;
int len;
cxobj *xev = NULL;
yang_spec *yspec = NULL;
char *str = NULL;
cbuf *cb = NULL;
char timestr[27];
struct timeval tv;
va_start(args, event);
len = vsnprintf(NULL, 0, event, args) + 1;
va_end(args);
if ((str = malloc(len)) == NULL){
clicon_err(OE_UNIX, errno, "malloc");
goto done;
}
memset(str, 0, len);
va_start(args, event);
len = vsnprintf(str, len, event, args) + 1;
va_end(args);
if ((yspec = clicon_dbspec_yang(h)) == NULL){
clicon_err(OE_YANG, 0, "No yang spec");
goto done;
}
if ((cb = cbuf_new()) == NULL){
clicon_err(OE_UNIX, errno, "cbuf_new");
goto done;
}
gettimeofday(&tv, NULL);
if (time2str(tv, timestr, sizeof(timestr)) < 0){
clicon_err(OE_UNIX, errno, "time2str");
goto done;
}
cprintf(cb, "<notification xmlns=\"urn:ietf:params:xml:ns:netconf:notification:1.0\"><eventTime>%s</eventTime>%s</notification>", timestr, str);
if (xml_parse_string(cbuf_get(cb), yspec, &xev) < 0)
goto done;
if (xml_rootchild(xev, 0, &xev) < 0)
goto done;
if (stream_notify_xml(h, stream, xev) < 0)
goto done;
retval = 0;
done:
if (cb)
cbuf_free(cb);
if (xev)
xml_free(xev);
if (str)
free(str);
return retval;
}

5
lib/src/clixon_xml.c
View file

@ -55,11 +55,11 @@
/* clixon */ /* clixon */
#include "clixon_err.h" #include "clixon_err.h"
#include "clixon_log.h"
#include "clixon_string.h" #include "clixon_string.h"
#include "clixon_queue.h" #include "clixon_queue.h"
#include "clixon_hash.h" #include "clixon_hash.h"
#include "clixon_handle.h" #include "clixon_handle.h"
#include "clixon_log.h"
#include "clixon_yang.h" #include "clixon_yang.h"
#include "clixon_xml.h" #include "clixon_xml.h"
#include "clixon_xml_sort.h" #include "clixon_xml_sort.h"
@ -1412,7 +1412,8 @@ xml_parse_file(int fd,
* cxobj *xt = NULL; * cxobj *xt = NULL;
* if (xml_parse_string(str, yspec, &xt) < 0) * if (xml_parse_string(str, yspec, &xt) < 0)
* err; * err;
* xml_free(xt); * if (xml_root_child(xt, 0, &xt) < 0) # If you want to remove TOP
* err;
* @endcode * @endcode
* @see xml_parse_file * @see xml_parse_file
* @see xml_parse_va * @see xml_parse_va

21
test/lib.sh
View file

@ -2,6 +2,8 @@
# Define test functions. # Define test functions.
# Create working dir as variable "dir" # Create working dir as variable "dir"
#set -e
testnr=0 testnr=0
testname= testname=
@ -32,6 +34,7 @@ err(){
echo -e "\e[31m\nError in Test$testnr [$testname]:" echo -e "\e[31m\nError in Test$testnr [$testname]:"
if [ $# -gt 0 ]; then if [ $# -gt 0 ]; then
echo "Expected: $1" echo "Expected: $1"
echo
fi fi
if [ $# -gt 1 ]; then if [ $# -gt 1 ]; then
echo "Received: $2" echo "Received: $2"
@ -174,13 +177,25 @@ expectwait(){
wait=$4 wait=$4
# Do while read stuff # Do while read stuff
sleep 10|cat <(echo $input) -| $cmd | while [ 1 ] ; do echo timeout > /tmp/flag
read ret ret=""
sleep $wait | cat <(echo $input) -| $cmd | while [ 1 ] ; do
read r
# echo "r:$r"
ret="$ret$r"
match=$(echo "$ret" | grep -Eo "$expect"); match=$(echo "$ret" | grep -Eo "$expect");
if [ -z "$match" ]; then if [ -z "$match" ]; then
echo error > /tmp/flag
err $expect "$ret" err $expect "$ret"
else
echo ok > /tmp/flag # only this is OK
break;
fi fi
break
done done
cat /tmp/flag
if [ $(cat /tmp/flag) != "ok" ]; then
cat /tmp/flag
exit
fi
} }

26
test/test_auth_ext.sh
View file

@ -39,12 +39,6 @@ EOF
cat <<EOF > $fyang cat <<EOF > $fyang
module $APPNAME{ module $APPNAME{
prefix ex; prefix ex;
import ietf-interfaces {
prefix if;
}
import iana-if-type {
prefix ianaift;
}
container authentication { container authentication {
description "Example code for enabling www basic auth and some example description "Example code for enabling www basic auth and some example
users"; users";
@ -70,21 +64,13 @@ module $APPNAME{
type int32; type int32;
description "something to edit"; description "something to edit";
} }
container interfaces-state { container state {
config false; config false;
list interface{ description "state data for example application";
key "name"; leaf-list op {
leaf name{ type string;
type string; }
}
leaf type{
type string;
}
leaf if-index {
type int32;
}
} }
}
} }
EOF EOF
@ -191,7 +177,7 @@ new "restconf DELETE whole datastore"
expecteq "$(curl -u adm1:bar -sS -X DELETE http://localhost/restconf/data)" "" expecteq "$(curl -u adm1:bar -sS -X DELETE http://localhost/restconf/data)" ""
new2 "auth get" new2 "auth get"
expecteq "$(curl -u adm1:bar -sS -X GET http://localhost/restconf/data/ietf-interfaces:interfaces-state)" '{"interfaces-state": {"interface": [{"name": "eth0","type": "ex:eth","if-index": 42}]}} expecteq "$(curl -u adm1:bar -sS -X GET http://localhost/restconf/data/state)" '{"state": {"op": "42"}}
' '
new "Set x to 0" new "Set x to 0"

41
test/test_event.sh
View file

@ -16,6 +16,8 @@ cat <<EOF > $cfg
<CLICON_YANG_MODULE_MAIN>$fyang</CLICON_YANG_MODULE_MAIN> <CLICON_YANG_MODULE_MAIN>$fyang</CLICON_YANG_MODULE_MAIN>
<CLICON_RESTCONF_PRETTY>false</CLICON_RESTCONF_PRETTY> <CLICON_RESTCONF_PRETTY>false</CLICON_RESTCONF_PRETTY>
<CLICON_SOCK>/usr/local/var/$APPNAME/$APPNAME.sock</CLICON_SOCK> <CLICON_SOCK>/usr/local/var/$APPNAME/$APPNAME.sock</CLICON_SOCK>
<CLICON_BACKEND_DIR>/usr/local/lib/$APPNAME/backend</CLICON_BACKEND_DIR>
<CLICON_BACKEND_REGEXP>example_backend.so$</CLICON_BACKEND_REGEXP>
<CLICON_BACKEND_PIDFILE>$dir/restconf.pidfile</CLICON_BACKEND_PIDFILE> <CLICON_BACKEND_PIDFILE>$dir/restconf.pidfile</CLICON_BACKEND_PIDFILE>
<CLICON_XMLDB_DIR>/usr/local/var/$APPNAME</CLICON_XMLDB_DIR> <CLICON_XMLDB_DIR>/usr/local/var/$APPNAME</CLICON_XMLDB_DIR>
<CLICON_XMLDB_PLUGIN>/usr/local/lib/xmldb/text.so</CLICON_XMLDB_PLUGIN> <CLICON_XMLDB_PLUGIN>/usr/local/lib/xmldb/text.so</CLICON_XMLDB_PLUGIN>
@ -29,11 +31,11 @@ cat <<EOF > $cfg
EOF EOF
# RFC5277 NETCONF Event Notifications # RFC5277 NETCONF Event Notifications
# using reportingEntity (rfc5277) not reporting-entity (rfc8040)
cat <<EOF > $fyang cat <<EOF > $fyang
module example { module example {
namespace "http://example.com/event/1.0"; namespace "http://example.com/event/1.0";
prefix ex; prefix ex;
organization "Example, Inc."; organization "Example, Inc.";
contact "support at example.com"; contact "support at example.com";
description "Example Notification Data Model Module."; description "Example Notification Data Model Module.";
@ -41,14 +43,13 @@ cat <<EOF > $fyang
description "Initial version."; description "Initial version.";
reference "example.com document 2-9976."; reference "example.com document 2-9976.";
} }
notification event { notification event {
description "Example notification event."; description "Example notification event.";
leaf event-class { leaf event-class {
type string; type string;
description "Event class identifier."; description "Event class identifier.";
} }
container reporting-entity { container reportingEntity {
description "Event specific information."; description "Event specific information.";
leaf card { leaf card {
type string; type string;
@ -60,7 +61,14 @@ cat <<EOF > $fyang
description "Event severity description."; description "Event severity description.";
} }
} }
} container state {
config false;
description "state data for example application";
leaf-list op {
type string;
}
}
}
EOF EOF
# kill old backend (if any) # kill old backend (if any)
@ -84,24 +92,29 @@ sudo start-stop-daemon -S -q -o -b -x /www-data/clixon_restconf -d /www-data -c
sleep 1 sleep 1
# get the stream list using netconf
new "netconf event stream discovery RFC5277 Sec 3.2.5" new "netconf event stream discovery RFC5277 Sec 3.2.5"
expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 '<rpc><get><filter type="xpath" select="netconf/streams" xmlns="urn:ietf:params:xml:ns:netmod:notification"/></get></rpc>]]>]]>' '<rpc-reply><data><netconf><streams><stream><name>CLICON</name><description>Clicon logs</description><replay-support>false</replay-support></stream><stream><name>NETCONF</name><description>default NETCONF event stream</description><replay-support>false</replay-support></stream></streams></netconf></data></rpc-reply>]]>]]>' expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 '<rpc><get><filter type="xpath" select="netconf/streams" xmlns="urn:ietf:params:xml:ns:netmod:notification"/></get></rpc>]]>]]>' '<rpc-reply><data><netconf><streams><stream><name>NETCONF</name><description>default NETCONF event stream</description><replay-support>false</replay-support></stream></streams></netconf></data></rpc-reply>]]>]]>'
new "netconf event stream discovery RFC8040 Sec 6.2" new "netconf event stream discovery RFC8040 Sec 6.2"
expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 '<rpc><get><filter type="xpath" select="restconf-state/streams" xmlns="urn:ietf:params:xml:ns:netmod:notification"/></get></rpc>]]>]]>' '<rpc-reply><data><restconf-state><streams><stream><name>CLICON</name><description>Clicon logs</description><replay-support>false</replay-support><access><encoding>xml</encoding><location>https://example.com/stream/CLICON</location></access></stream><stream><name>NETCONF</name><description>default NETCONF event stream</description><replay-support>false</replay-support><access><encoding>xml</encoding><location>https://example.com/stream/NETCONF</location></access></stream></streams></restconf-state></data></rpc-reply>]]>]]>' expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 '<rpc><get><filter type="xpath" select="restconf-state/streams" xmlns="urn:ietf:params:xml:ns:netmod:notification"/></get></rpc>]]>]]>' '<rpc-reply><data><restconf-state><streams><stream><name>NETCONF</name><description>default NETCONF event stream</description><replay-support>false</replay-support><access><encoding>xml</encoding><location>/stream/NETCONF</location></access></stream></streams></restconf-state></data></rpc-reply>]]>]]>'
new "restconf event stream discovery RFC8040 Sec 6.2" new "restconf event stream discovery RFC8040 Sec 6.2"
expectfn "curl -s -X GET http://localhost/restconf/data/ietf-restconf-monitoring:restconf-state/streams" 0 '{"streams": {"stream": \[{"name": "CLICON","description": "Clicon logs","replay-support": false,"access": \[{"encoding": "xml","location": "https://example.com/stream/CLICON"}\]},{ "name": "NETCONF","description": "default NETCONF event stream","replay-support": false,"access": \[{"encoding": "xml","location": "https://example.com/stream/NETCONF"}\]}\]}' expectfn "curl -s -X GET http://localhost/restconf/data/ietf-restconf-monitoring:restconf-state/streams" 0 '{"streams": {"stream": \[{"name": "NETCONF","description": "default NETCONF event stream","replay-support": false,"access": \[{"encoding": "xml","location": "/stream/NETCONF"}\]}\]}'
new "restconf subscribe RFC8040 Sec 6.3, get location" new "restconf subscribe RFC8040 Sec 6.3, get location"
expectfn "curl -s -X GET http://localhost/restconf/data/ietf-restconf-monitoring:restconf-state/streams/stream=NETCONF/access=xml/location" 0 '{"location": "https://example.com/stream/NETCONF"}' expectfn "curl -s -X GET http://localhost/restconf/data/ietf-restconf-monitoring:restconf-state/streams/stream=NETCONF/access=xml/location" 0 '{"location": "/stream/NETCONF"}'
new "restconf monitor event stream RFC8040 Sec 6.3" new "netconf NETCONF subscription"
#expectfn "curl -s -X GET http://localhost/stream/NETCONF" 0 '' expectwait "$clixon_netconf -qf $cfg -y $fyang" '<rpc><create-subscription><stream>NETCONF</stream></create-subscription></rpc>]]>]]>' '^<rpc-reply><ok/></rpc-reply>]]>]]><notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"><eventTime>20' 5
#new "netconf subscription" NOTYET new "netconf NETCONF subscription with simple filter"
#expectwait "$clixon_netconf -qf $cfg -y $fyang" "<rpc><create-subscription><stream>ROUTING</stream></create-subscription></rpc>]]>]]>" "^<rpc-reply><ok/></rpc-reply>]]>]]><notification><event>Routing notification</event></notification>]]>]]>$" 30 expectwait "$clixon_netconf -qf $cfg -y $fyang" "<rpc><create-subscription><stream>NETCONF</stream><filter type=\"xpath\" select=\"event\"/></create-subscription></rpc>]]>]]>" '^<rpc-reply><ok/></rpc-reply>]]>]]><notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"><eventTime>20' 5
new "netconf NETCONF subscription with filter classfier"
expectwait "$clixon_netconf -qf $cfg -y $fyang" "<rpc><create-subscription><stream>NETCONF</stream><filter type=\"xpath\" select=\"event[event-class='fault']\"/></create-subscription></rpc>]]>]]>" '^<rpc-reply><ok/></rpc-reply>]]>]]><notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"><eventTime>20' 5
#new "restconf monitor event stream RFC8040 Sec 6.3"
#XXX expectfn "curl -s -X GET http://localhost/stream/NETCONF" 0 ''
new "Kill restconf daemon" new "Kill restconf daemon"
sudo pkill -u www-data clixon_restconf sudo pkill -u www-data clixon_restconf
@ -119,4 +132,4 @@ if [ -n "$pid" ]; then
sudo kill $pid sudo kill $pid
fi fi
rm -rf $dir #rm -rf $dir

24
test/test_netconf.sh
View file

@ -65,6 +65,13 @@ module example{
} }
} }
} }
container state {
config false;
description "state data for example application";
leaf-list op {
type string;
}
}
} }
EOF EOF
@ -180,10 +187,10 @@ new "netconf discard-changes"
expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 "<rpc><discard-changes/></rpc>]]>]]>" "^<rpc-reply><ok/></rpc-reply>]]>]]>$" expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 "<rpc><discard-changes/></rpc>]]>]]>" "^<rpc-reply><ok/></rpc-reply>]]>]]>$"
new "netconf edit state operation should fail" new "netconf edit state operation should fail"
expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 "<rpc><edit-config><target><candidate/></target><config><interfaces-state><interface><name>eth1</name><type>ex:eth</type></interface></interfaces-state></config></edit-config></rpc>]]>]]>" "^<rpc-reply><rpc-error><error-tag>invalid-value</error-tag>" expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 "<rpc><edit-config><target><candidate/></target><config><state><op>42</op></state></config></edit-config></rpc>]]>]]>" "^<rpc-reply><rpc-error><error-tag>invalid-value</error-tag>"
new "netconf get state operation" new "netconf get state operation"
expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 "<rpc><get><filter type=\"xpath\" select=\"/interfaces-state\"/></get></rpc>]]>]]>" "^<rpc-reply><data><interfaces-state><interface><name>eth0</name><type>ex:eth</type><if-index>42</if-index></interface></interfaces-state></data></rpc-reply>]]>]]>$" expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 "<rpc><get><filter type=\"xpath\" select=\"/state\"/></get></rpc>]]>]]>" "^<rpc-reply><data><state><op>42</op></state></data></rpc-reply>]]>]]>$"
new "netconf lock/unlock" new "netconf lock/unlock"
expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 "<rpc><lock><target><candidate/></target></lock></rpc>]]>]]><rpc><unlock><target><candidate/></target></unlock></rpc>]]>]]>" "^<rpc-reply><ok/></rpc-reply>]]>]]><rpc-reply><ok/></rpc-reply>]]>]]>$" expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 "<rpc><lock><target><candidate/></target></lock></rpc>]]>]]><rpc><unlock><target><candidate/></target></unlock></rpc>]]>]]>" "^<rpc-reply><ok/></rpc-reply>]]>]]><rpc-reply><ok/></rpc-reply>]]>]]>$"
@ -225,18 +232,19 @@ new "netconf client-side rpc"
expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 "<rpc><ex:client-rpc><request>example</request></ex:client-rpc></rpc>]]>]]>" "^<rpc-reply><result>ok</result></rpc-reply>]]>]]>$" expecteof "$clixon_netconf -qf $cfg -y $fyang" 0 "<rpc><ex:client-rpc><request>example</request></ex:client-rpc></rpc>]]>]]>" "^<rpc-reply><result>ok</result></rpc-reply>]]>]]>$"
new "netconf subscription" new "netconf subscription"
expectwait "$clixon_netconf -qf $cfg -y $fyang" "<rpc><create-subscription><stream>ROUTING</stream></create-subscription></rpc>]]>]]>" "^<rpc-reply><ok/></rpc-reply>]]>]]><notification><event>Routing notification</event></notification>]]>]]>$" 30 expectwait "$clixon_netconf -qf $cfg -y $fyang" "<rpc><create-subscription><stream>NETCONF</stream></create-subscription></rpc>]]>]]>" '^<rpc-reply><ok/></rpc-reply>]]>]]><notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"><eventTime>201' 10
new "Kill backend" new "Kill backend"
# Check if still alive
pid=`pgrep clixon_backend`
if [ -z "$pid" ]; then
err "backend already dead"
fi
# kill backend # kill backend
sudo clixon_backend -zf $cfg sudo clixon_backend -zf $cfg
if [ $? -ne 0 ]; then if [ $? -ne 0 ]; then
err "kill backend" err "kill backend"
fi fi
# Check if still alive
pid=`pgrep clixon_backend`
if [ -n "$pid" ]; then
sudo kill $pid
fi
rm -rf $dir rm -rf $dir

45
test/test_restconf.sh
View file

@ -71,11 +71,18 @@ module example{
} }
} }
} }
container state {
config false;
description "state data for example application";
leaf-list op {
type string;
}
}
} }
EOF EOF
# This is a fixed 'state' implemented in routing_backend. It is assumed to be always there # This is a fixed 'state' implemented in routing_backend. It is assumed to be always there
state='{"interfaces-state": {"interface": \[{"name": "eth0","type": "ex:eth","if-index": 42}\]}}' state='{"state": {"op": "42"}}'
# kill old backend (if any) # kill old backend (if any)
new "kill old backend" new "kill old backend"
@ -136,7 +143,7 @@ if [ -z "$match" ]; then
err "$expect" "$ret" err "$expect" "$ret"
fi fi
new "restconf schema resource, RFC 8040 sec 3.7 according to RFC 7895" new2 "restconf schema resource, RFC 8040 sec 3.7 according to RFC 7895"
expecteq "$(curl -s -H 'Accept: application/yang-data+json' -G http://localhost/restconf/data/ietf-yang-library:modules-state/module=ietf-routing,2014-10-26/)" '{"module": [{"name": "ietf-routing","revision": "2014-10-26","namespace": "urn:ietf:params:xml:ns:yang:ietf-routing"}]} expecteq "$(curl -s -H 'Accept: application/yang-data+json' -G http://localhost/restconf/data/ietf-yang-library:modules-state/module=ietf-routing,2014-10-26/)" '{"module": [{"name": "ietf-routing","revision": "2014-10-26","namespace": "urn:ietf:params:xml:ns:yang:ietf-routing"}]}
' '
@ -151,52 +158,52 @@ new "restconf empty rpc"
expecteq "$(curl -s -X POST -d {\"input\":{\"name\":\"\"}} http://localhost/restconf/operations/example:empty)" "" expecteq "$(curl -s -X POST -d {\"input\":{\"name\":\"\"}} http://localhost/restconf/operations/example:empty)" ""
new2 "restconf get empty config + state json" new2 "restconf get empty config + state json"
expecteq "$(curl -sSG http://localhost/restconf/data/interfaces-state)" '{"interfaces-state": {"interface": [{"name": "eth0","type": "ex:eth","if-index": 42}]}} expecteq "$(curl -sSG http://localhost/restconf/data/state)" '{"state": {"op": "42"}}
' '
new2 "restconf get empty config + state json with module name" new2 "restconf get empty config + state json + module"
expecteq "$(curl -sSG http://localhost/restconf/data/ietf-interfaces:interfaces-state)" '{"interfaces-state": {"interface": [{"name": "eth0","type": "ex:eth","if-index": 42}]}} expecteq "$(curl -sSG http://localhost/restconf/data/example:state)" '{"state": {"op": "42"}}
' '
new2 "restconf get empty config + state json with wrong module name" new2 "restconf get empty config + state json with wrong module name"
expecteq "$(curl -sSG http://localhost/restconf/data/badmodule:interfaces-state)" '{"ietf-restconf:errors" : {"error": {"rpc-error": {"error-tag": "operation-failed","error-type": "protocol","error-severity": "error","error-message": "No yang node found: badmodule:interfaces-state"}}}} ' expecteq "$(curl -sSG http://localhost/restconf/data/badmodule:state)" '{"ietf-restconf:errors" : {"error": {"rpc-error": {"error-tag": "operation-failed","error-type": "protocol","error-severity": "error","error-message": "No yang node found: badmodule:state"}}}} '
new "restconf get empty config + state xml" new "restconf get empty config + state xml"
ret=$(curl -s -H "Accept: application/yang-data+xml" -G http://localhost/restconf/data/interfaces-state) ret=$(curl -s -H "Accept: application/yang-data+xml" -G http://localhost/restconf/data/state)
expect="<interfaces-state><interface><name>eth0</name><type>ex:eth</type><if-index>42</if-index></interface></interfaces-state>" expect="<state><op>42</op></state>"
match=`echo $ret | grep -EZo "$expect"` match=`echo $ret | grep -EZo "$expect"`
if [ -z "$match" ]; then if [ -z "$match" ]; then
err "$expect" "$ret" err "$expect" "$ret"
fi fi
new2 "restconf get data/interfaces-state/interface=eth0 json" new2 "restconf get data/ json"
expecteq "$(curl -s -G http://localhost/restconf/data/interfaces-state/interface=eth0)" '{"interface": [{"name": "eth0","type": "ex:eth","if-index": 42}]} expecteq "$(curl -s -G http://localhost/restconf/data/state/op=42)" '{"op": "42"}
' '
new "restconf get state operation eth0 xml" new "restconf get state operation eth0 xml"
# Cant get shell macros to work, inline matching from lib.sh # Cant get shell macros to work, inline matching from lib.sh
ret=$(curl -s -H "Accept: application/yang-data+xml" -G http://localhost/restconf/data/interfaces-state/interface=eth0) ret=$(curl -s -H "Accept: application/yang-data+xml" -G http://localhost/restconf/data/state/op=42)
expect="<interface><name>eth0</name><type>ex:eth</type><if-index>42</if-index></interface>" expect="<op>42</op>"
match=`echo $ret | grep -EZo "$expect"` match=`echo $ret | grep -EZo "$expect"`
if [ -z "$match" ]; then if [ -z "$match" ]; then
err "$expect" "$ret" err "$expect" "$ret"
fi fi
new2 "restconf get state operation eth0 type json" new2 "restconf get state operation eth0 type json"
expecteq "$(curl -s -G http://localhost/restconf/data/interfaces-state/interface=eth0/type)" '{"type": "ex:eth"} expecteq "$(curl -s -G http://localhost/restconf/data/state/op=42)" '{"op": "42"}
' '
new "restconf get state operation eth0 type xml" new "restconf get state operation eth0 type xml"
# Cant get shell macros to work, inline matching from lib.sh # Cant get shell macros to work, inline matching from lib.sh
ret=$(curl -s -H "Accept: application/yang-data+xml" -G http://localhost/restconf/data/interfaces-state/interface=eth0/type) ret=$(curl -s -H "Accept: application/yang-data+xml" -G http://localhost/restconf/data/state/op=42)
expect="<type>ex:eth</type>" expect="<op>42</op>"
match=`echo $ret | grep -EZo "$expect"` match=`echo $ret | grep -EZo "$expect"`
if [ -z "$match" ]; then if [ -z "$match" ]; then
err "$expect" "$ret" err "$expect" "$ret"
fi fi
new2 "restconf GET datastore" new2 "restconf GET datastore"
expecteq "$(curl -s -X GET http://localhost/restconf/data/interfaces-state)" '{"interfaces-state": {"interface": [{"name": "eth0","type": "ex:eth","if-index": 42}]}} expecteq "$(curl -s -X GET http://localhost/restconf/data/state)" '{"state": {"op": "42"}}
' '
# Exact match # Exact match
@ -210,14 +217,14 @@ expectfn 'curl -s -X POST -d {"interfaces":{"interface":{"name":"eth/0/0","type"
#expecteq "$(curl -s -X POST -d {\"interfaces\":{\"interface\":{\"name\":\"eth/0/0\",\"type\":\"ex:eth\",\"enabled\":true}}} http://localhost/restconf/data)" '{"ietf-restconf:errors" : {"error": {"error-tag": "data-exists","error-type": "application","error-severity": "error","error-message": "Data already exists; cannot create new resource"}}}' #expecteq "$(curl -s -X POST -d {\"interfaces\":{\"interface\":{\"name\":\"eth/0/0\",\"type\":\"ex:eth\",\"enabled\":true}}} http://localhost/restconf/data)" '{"ietf-restconf:errors" : {"error": {"error-tag": "data-exists","error-type": "application","error-severity": "error","error-message": "Data already exists; cannot create new resource"}}}'
new "restconf Check interfaces eth/0/0 added" new "restconf Check interfaces eth/0/0 added"
expectfn "curl -s -G http://localhost/restconf/data" 0 '{"interfaces": {"interface": \[{"name": "eth/0/0","type": "ex:eth","enabled": true}\]},"interfaces-state": {"interface": \[{"name": "eth0","type": "ex:eth","if-index": 42}\]}} expectfn "curl -s -G http://localhost/restconf/data" 0 '{"interfaces": {"interface": \[{"name": "eth/0/0","type": "ex:eth","enabled": true}\]},"state": {"op": "42"}}
' '
new "restconf delete interfaces" new "restconf delete interfaces"
expecteq $(curl -s -X DELETE http://localhost/restconf/data/interfaces) "" expecteq $(curl -s -X DELETE http://localhost/restconf/data/interfaces) ""
new "restconf Check empty config" new "restconf Check empty config"
expectfn "curl -sG http://localhost/restconf/data/interfaces-state" 0 "$state" expectfn "curl -sG http://localhost/restconf/data/state" 0 "$state"
new "restconf Add interfaces subtree eth/0/0 using POST" new "restconf Add interfaces subtree eth/0/0 using POST"
expectfn 'curl -s -X POST -d {"interface":{"name":"eth/0/0","type":"ex:eth","enabled":true}} http://localhost/restconf/data/interfaces' 0 "" expectfn 'curl -s -X POST -d {"interface":{"name":"eth/0/0","type":"ex:eth","enabled":true}} http://localhost/restconf/data/interfaces' 0 ""
@ -229,7 +236,7 @@ expecteq "$(curl -s -G http://localhost/restconf/data/interfaces)" '{"interfaces
' '
new2 "restconf Check eth/0/0 added state" new2 "restconf Check eth/0/0 added state"
expecteq "$(curl -s -G http://localhost/restconf/data/interfaces-state)" '{"interfaces-state": {"interface": [{"name": "eth0","type": "ex:eth","if-index": 42}]}} expecteq "$(curl -s -G http://localhost/restconf/data/state)" '{"state": {"op": "42"}}
' '
new2 "restconf Re-post eth/0/0 which should generate error" new2 "restconf Re-post eth/0/0 which should generate error"