Move event_publish_tool to sbin (#26)

* Add conf to host, move plugin to sbin

* Add missing comma in dependencies

* Correct flag to -p

* Fix events_info and j2

* Add host event

* Revert back to creating and moving

* Split into multiple regex for each process

* Modify regex and set .py to sbin in monit_events

* Change log level from err to notice

* Move publish tool to sbin

* Remove has_timer from init cfg

* Add peer review changes

* Change to /usr/bin

* Remove empty lines

* Change monit_events

dockers/docker-eventd/supervisord.conf

@@ -41,7 +41,7 @@ dependent_startup_wait_for=rsyslogd:running
 
 
 [program:eventd]
-command=/usr/sbin/eventd
+command=/usr/bin/eventd
 priority=3
 autostart=false
 autorestart=false

dockers/docker-fpm-frr/Dockerfile.j2

@@ -63,7 +63,7 @@ RUN chmod a+x /usr/bin/TSA && \
     chmod a+x /usr/bin/zsocket.sh
 
 RUN j2 -f json /etc/rsyslog.d/rsyslog_plugin.conf.j2 /etc/rsyslog.d/events_info.json  > /etc/rsyslog.d/bgp_events.conf
-RUN rm -f /etc/rsyslog.d/rsyslog_plugin.conf.j2*
-RUN rm -f /etc/rsyslog.d/events_info.json*
+RUN rm -f /etc/rsyslog.d/rsyslog_plugin.conf.j2
+RUN rm -f /etc/rsyslog.d/events_info.json
 
 ENTRYPOINT ["/usr/bin/docker_init.sh"]

files/build_templates/init_cfg.json.j2

@@ -39,7 +39,7 @@
                    ("pmon", "enabled", false, "enabled"),
                    ("radv", "enabled", false, "enabled"),
                    ("snmp", "enabled", true, "enabled"),
-                   ("eventd", "enabled", true, "enabled"),
+                   ("eventd", "enabled", false, "enabled"),
                    ("swss", "enabled", false, "enabled"),
                    ("syncd", "enabled", false, "enabled"),
                    ("teamd", "enabled", false, "enabled")] %}

files/build_templates/rsyslog_plugin.conf.j2

@@ -12,7 +12,7 @@ $ModLoad omprog
 {% for proc in proclist %}
 if re_match($programname, "{{ proc.name }}") then {
     action(type="omprog"
-        binary="/usr/sbin/rsyslog_plugin -r /etc/rsyslog.d/{{ proc.parse_json }} -m {{ yang_module }}"
+        binary="/usr/bin/rsyslog_plugin -r /etc/rsyslog.d/{{ proc.parse_json }} -m {{ yang_module }}"
         output="/var/log/rsyslog_plugin.log"
         template="prog_msg")
 }

slave.mk

@@ -1129,7 +1129,7 @@ $(addprefix $(TARGET_PATH)/, $(SONIC_INSTALLERS)) : $(TARGET_PATH)/% : \
                 $(PYTHON_SWSSCOMMON) \
                 $(PYTHON3_SWSSCOMMON) \
                 $(SONIC_DB_CLI) \
-		$(SONIC_RSYSLOG_PLUGIN) \
+                $(SONIC_RSYSLOG_PLUGIN) \
                 $(SONIC_UTILITIES_DATA) \
                 $(SONIC_HOST_SERVICES_DATA) \
                 $(BASH) \

src/sonic-eventd/Makefile

@@ -71,13 +71,13 @@ rsyslog-plugin-tests: $(RSYSLOG-PLUGIN-TEST_OBJS)
 	@echo ' '
 
 install:
-	$(MKDIR) -p $(DESTDIR)/usr/sbin
+	$(MKDIR) -p $(DESTDIR)/usr/bin
 	$(MKDIR) -p $(DESTDIR)/etc/monit/conf.d
-	$(CP) $(EVENTD_TARGET) $(DESTDIR)/usr/sbin
-	$(CP) $(EVENTD_TOOL) $(DESTDIR)/usr/sbin
-	$(CP) $(EVENTD_PUBLISH_TOOL) $(DESTDIR)/usr/sbin
-	$(CP) $(RSYSLOG-PLUGIN_TARGET) $(DESTDIR)/usr/sbin
-	$(CP) $(EVENTD_MONIT) $(DESTDIR)/usr/sbin
+	$(CP) $(EVENTD_TARGET) $(DESTDIR)/usr/bin
+	$(CP) $(EVENTD_TOOL) $(DESTDIR)/usr/bin
+	$(CP) $(EVENTD_PUBLISH_TOOL) $(DESTDIR)/usr/bin
+	$(CP) $(RSYSLOG-PLUGIN_TARGET) $(DESTDIR)/usr/bin
+	$(CP) $(EVENTD_MONIT) $(DESTDIR)/usr/bin
 	$(CP) $(EVENTD_MONIT_CONF) $(DESTDIR)/etc/monit/conf.d
 
 deinstall:

src/sonic-eventd/debian/sonic-eventd.install

@@ -1,2 +1,3 @@
-usr/sbin/eventd
-usr/sbin/events_tool
+usr/bin/eventd
+usr/bin/events_tool
+usr/bin/events_publish_tool.py

src/sonic-eventd/debian/sonic-rsyslog-plugin.install

@@ -1,3 +1,3 @@
-usr/sbin/rsyslog_plugin
-usr/sbin/events_monit_test.py
+usr/bin/rsyslog_plugin
+usr/bin/events_monit_test.py
 etc/monit/conf.d/monit_events

src/sonic-eventd/tools/events_monit_test.py

@@ -1,4 +1,4 @@
-#! /usr/bin/python -u
+#! /usr/bin/env python3
 
 from inspect import getframeinfo, stack
 from swsscommon.swsscommon import events_init_publisher, event_publish, FieldValueMap
@@ -25,11 +25,11 @@
 
 # Async connection wait time in milliseconds.
 ASYNC_CONN_WAIT = 300
-
+RECEIVE_TIMEOUT = 1000
 
 # Thread results
 rc_test_receive = -1
-
+publish_cnt = 0
 
 def _log_msg(lvl, pfx, msg):
     if lvl <= chk_log_level:
@@ -60,28 +60,32 @@ def map_dict_fvm(s, d):
 def test_receiver(event_obj, cnt):
     global rc_test_receive
 
-    sh = events_init_subscriber()
+    sh = events_init_subscriber(false, RECEIVE_TIMEOUT, null)
 
     # Sleep ASYNC_CONN_WAIT to ensure async connectivity is complete.
     time.sleep(ASYNC_CONN_WAIT/1000)
 
     exp_params = dict(test_event_params)
 
+    # Signal main thread that subscriber is ready to receive
     event_obj.set()
     cnt_done = 0
 
-    for i in range(cnt):
+    while cnt_done < cnt:
         p = event_receive_op_t()
         rc = event_receive(sh, p)
+
+        if rc > 0 && publish_cnt < 2:
+            # ignore timeout as test code has not yet published an event yet
+            continue
 
-        if (rc != 0):
+        if rc != 0:
             log_notice("Failed to receive. {}/{} rc={}".format(i, cnt, rc))
             break
 
         if test_event_key != p.key:
-            log_notice("key mismatch {} != {} {}/{}".format(test_event_key,
-                p.key, i, cnt))
-            break
+            # received a different event than published
+            continue
 
         exp_params["index"] = str(i)
         rcv_params = {}
@@ -117,20 +121,8 @@ def test_receiver(event_obj, cnt):
     else:
         log_notice("test receive abort {}/{}".format(cnt_done, cnt))
 
-    # wait for a max of 5 secs for main thread to clear the event.
-    tout = 5000 
-    while(event_obj.is_set()):
-        # main thread yet to consume last set event
-        if tout > 0:
-            t_sleep = 100
-            time.sleep(t_sleep / 1000)
-            tout -= t_sleep
-        else:
-            log_notice("test_receiver:Internal err: event not cleared by main")
-            break
-
+    # Signal main thread that subscriber thread is done
     event_obj.set()
-
     events_deinit_subscriber(sh)
 
 
@@ -157,6 +149,7 @@ def publish_events(cnt):
             log_notice("Failed to publish. {}/{} rc={}".format(i, cnt, rc))
             break
         log_debug("published: {}/{}".format(i+1, cnt))
+        publish_cnt += 1
 
     # Sleep ASYNC_CONN_WAIT to ensure publish complete, before closing channel.
     time.sleep(ASYNC_CONN_WAIT/1000)
@@ -179,6 +172,8 @@ def run_test(cnt):
     thread_sub = threading.Thread(target=test_receiver, args=(event_sub, cnt))
     thread_sub.start()
 
+    # Wait until subscriber thread completes the async subscription
+    # Any event published prior to that could get lost
     # Subscriber would wait for ASYNC_CONN_WAIT. Wait additional 200ms
     # for signal from test_receiver as ready.
     event_sub.wait((ASYNC_CONN_WAIT + 200)/1000)
@@ -227,10 +222,3 @@ def main():
 
 if __name__ == "__main__":
     main()
-
-
-
-
-
-
-

src/sonic-eventd/tools/monit_events

@@ -1,6 +1,6 @@
 ###############################################################################
 ## Monit configuration for telemetry container
 ###############################################################################
-check program container_eventd with path "/usr/sbin/events_monit_test.py"
+check program container_eventd with path "/usr/bin/events_monit_test.py"
     every 5 cycles
     if status != 0 for 3 cycle then alert repeat every 1 cycles