├── ListenerApi2Events.py
├── README.md
├── index.html
├── requirements.txt
└── screenshot.png


/ListenerApi2Events.py:
--------------------------------------------------------------------------------
 1 | from websocket import create_connection
 2 | import json
 3 | 
 4 | 
 5 | class ListenerApi2Events():
 6 |     ROBOT_LISTENER_API_VERSION = 2
 7 | 
 8 |     def send_message(self, event, name=None, attrs=None, message=None, path=None):
 9 |         ws = create_connection("ws://localhost:5678/")
10 |         info = {}
11 |         info["event"] = event
12 |         if name:
13 |             info["name"] = name
14 |         if path:
15 |             info["path"] = path
16 |         if message:
17 |             info.update(message)
18 |         if attrs:
19 |             info.update(attrs)
20 |         ws.send(json.dumps(info))
21 |         ws.close()
22 | 
23 |     def start_suite(self, name, attrs):
24 |         self.send_message("start_suite", name, attrs)
25 | 
26 |     def end_suite(self, name, attrs):
27 |         self.send_message("end_suite", name, attrs)
28 | 
29 |     def start_test(self, name, attrs):
30 |         self.send_message("start_test", name, attrs)
31 | 
32 |     def end_test(self, name, attrs):
33 |         self.send_message("end_test", name, attrs)
34 | 
35 |     def start_keyword(self, name, attrs):
36 |         self.send_message("start_keyword", name, attrs)
37 | 
38 |     def end_keyword(self, name, attrs):
39 |         self.send_message("end_keyword", name, attrs)
40 | 
41 |     def log_message(self, message):
42 |         self.send_message("log_message", message=message)
43 | 
44 |     def message(self, message):
45 |         self.send_message("message", message=message)
46 | 
47 |     def library_import(self, name, attrs):
48 |         self.send_message("library_import", name, attrs)
49 | 
50 |     def resource_import(self, name, attrs):
51 |         self.send_message("resource_import", name, attrs)
52 | 
53 |     def variables_import(self, name, attrs):
54 |         self.send_message("variables_import", name, attrs)
55 | 
56 |     def output_file(self, path):
57 |         self.send_message("output_file", path=path)
58 | 
59 |     def log_file(self, path):
60 |         self.send_message("log_file", path=path)
61 | 
62 |     def report_file(self, path):
63 |         self.send_message("report_file", path=path)
64 | 
65 |     def xunit_file(self, path):
66 |         self.send_message("xunit_file", path=path)
67 | 
68 |     def debug_file(self, path):
69 |         self.send_message("debug_file", path=path)
70 | 
71 |     def close(self):
72 |         self.send_message("close")
73 | 
74 | 
75 | if __name__ == "__main__":
76 |     from SimpleWebSocketServer import SimpleWebSocketServer, WebSocket
77 | 
78 |     clients = []
79 |     class SimpleServ(WebSocket):
80 | 
81 |         def handleMessage(self):
82 |           for client in clients:
83 |             if client != self and not client.closed:
84 |                 client.sendMessage(self.data)
85 | 
86 |         def handleConnected(self):
87 |             clients.append(self)
88 | 
89 |         def handleClose(self):
90 |             clients.remove(self)
91 | 
92 |     server = SimpleWebSocketServer('', 5678, SimpleServ)
93 |     server.serveforever()
94 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # robotframework-listener-api-events
 2 | 
 3 | Robot Framework listener for sending JSON formatted events
 4 | over websocket.
 5 | 
 6 | This solution can be used for live monitoring and debubbing of
 7 | events provided by Robot Framework listener API. Locally running
 8 | websocket server receives the event data as JSON and provides it
 9 | to websocket clients.
10 | 
11 | Initial use case is to provide easier means for debugging and studying the events and
12 | the data available via listener API (version 2). An example web application receives
13 | the data as JSON, parses it and provides an initial user interface. Some of the more
14 | verbose events (`message`, `log_message`) can be hidden from the view.
15 | 
16 | ![screenshot](./screenshot.png)
17 | 
18 | # Installing and running
19 | 
20 | ## Install Python dependencies
21 | 
22 |     pip install -r requirements.txt
23 | 
24 | ## run websocket server on background
25 | 
26 |     python ListenerApi2Events.py &
27 | 
28 | ## open [index.html](./index.html) in web brower, e.g.:
29 | 
30 |     open index.html
31 | 
32 | ## Run Robot Framework with the listener
33 | 
34 |     robot --listener ListenerApi2Events.py ~/Robots/Simple/tasks/robot.robot
35 | 
36 | # Implementation notes
37 | 
38 | All methods by Listener API 2 are provided. Arguments are collected to single JSON object
39 | where `"event"` matches the listener API method:
40 | 
41 |     "event": "end_suite",
42 | 
43 | Arguments of the methods (name, attrs, message, path) are added to the JSON object
44 | depending on the availability:
45 | 
46 |     {
47 |       "event": "output_file",
48 |       "path": "/Users/user123/src/websocket/output.xml"
49 |     }
50 | 
51 |     {
52 |       "event": "start_keyword",
53 |       "name": "BuiltIn.Log",
54 |       "kwname": "Log",
55 |       "libname": "BuiltIn",
56 |       "doc": "Logs the given message with the given level.",
57 |       "assign": [],
58 |       "tags": [],
59 |       "starttime": "20200906 23:26:48.209",
60 |       "args": [
61 |           "Hello!"
62 |       ],
63 |       "type": "Keyword"
64 |     }
65 | 
66 | JSON data can be parsed on web application Javascript as follows:
67 | 
68 |     var jsondata = JSON.parse(event.data);
69 | 
70 | and accessed easily:
71 | 
72 |     if (jsondata.event == "start_suite") {
73 |       button.classList.add("font-weight-bold");
74 |     }
75 | 
76 | Using hard coded `ws://localhost:5678/` for now, change in the code if needed.
77 | 
78 | 
79 | # References
80 | 
81 | Robot Framework listeners: https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#listener-interface
82 | 
83 | Listener API version 2: https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#listener-version-2
84 | 
85 | Based on the reference at https://github.com/mkorpela/robotframework-websocket
86 | 


--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE html>
  2 | <html>
  3 |     <head>
  4 |         <!-- Required meta tags -->
  5 |     <meta charset="utf-8">
  6 |     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  7 | 
  8 |     <!-- Bootstrap CSS -->
  9 |     <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
 10 | 
 11 |         <title>WebSocket listener</title>
 12 |     </head>
 13 |     <body>
 14 |         <div class="container">
 15 |             <div class="form-check">
 16 |                 <input type="checkbox" class="form-check-input" id="messageCheck" data-toggle="toggle" onclick="setVisibility()">
 17 |                 <label class="form-check-label" for="messageCheck">message</label>
 18 |             </div>
 19 |                 <div class="form-check">
 20 |                 <input type="checkbox" class="form-check-input" id="log_messageCheck" data-toggle="toggle" onclick="setVisibility()">
 21 |                 <label class="form-check-label" for="log_messageCheck">log_message</label>
 22 |             </div>
 23 |             <div class="accordion" id="accordionExample"></div>
 24 |         </div>
 25 | 
 26 |         <script>
 27 |             var ws = new WebSocket("ws://127.0.0.1:5678/");
 28 |             var count = 0;
 29 | 
 30 |             function showhide(el, check) {
 31 |                 /* Card open and gets hidden by checkbox, close first. */
 32 |                 var content = el.nextElementSibling;
 33 |                 if (content) {
 34 |                     content.classList.remove("show");
 35 |                 }
 36 |                 el.style.display = check ? 'block' : 'none';
 37 |             }
 38 | 
 39 |             function setVisibility(){
 40 |                 var messageChecked = document.getElementById('messageCheck').checked;
 41 |                 var message_list = document.getElementsByClassName('message');
 42 |                 var log_messageChecked = document.getElementById('log_messageCheck').checked;
 43 |                 var log_message_list = document.getElementsByClassName('log_message');
 44 | 
 45 |                 for (var i = 0; i < message_list.length; i++) {
 46 |                     showhide(message_list[i], messageChecked);
 47 |                 }
 48 | 
 49 |                 for (var i = 0; i < log_message_list.length; i++) {
 50 |                     showhide(log_message_list[i], log_messageChecked);
 51 |                 }
 52 |             }
 53 | 
 54 |             ws.onmessage = function (event) {
 55 |                 var jsondata = JSON.parse(event.data);
 56 |                 var messages = document.getElementsByClassName('accordion')[0];
 57 | 
 58 |                 var message = document.createElement('div');
 59 |                 message.setAttribute("class", "card-header");
 60 |                 message.classList.add(jsondata.event);
 61 | 
 62 |                 /* Checkboxes set the visibility of these events. */
 63 |                 if (jsondata.event == "message") {
 64 |                     var messageChecked = document.getElementById('messageCheck').checked;
 65 |                     showhide(message, messageChecked);
 66 |                 }
 67 |                 if (jsondata.event == "log_message") {
 68 |                     var messageChecked = document.getElementById('log_messageCheck').checked;
 69 |                     showhide(message, messageChecked);
 70 |                 }
 71 | 
 72 |                 var button = document.createElement('button');
 73 |                 button.setAttribute("type", "button");
 74 |                 button.setAttribute("data-toggle", "collapse");
 75 |                 button.setAttribute("data-target", "#collapse-" + count);
 76 |                 button.setAttribute("class", "btn btn-link");
 77 | 
 78 |                 if (jsondata.event == "start_suite") {
 79 |                     button.classList.add("font-weight-bold");
 80 |                 }
 81 | 
 82 |                 var kwname = '';
 83 |                 if (jsondata.kwname) {
 84 |                     kwname = ' - ' + jsondata.kwname;
 85 |                 }
 86 |                 var content = document.createTextNode(jsondata.event + kwname);
 87 |                 button.appendChild(content);
 88 |                 message.appendChild(button);
 89 |                 messages.appendChild(message);
 90 | 
 91 |                 var card = document.createElement('div');
 92 |                 card.setAttribute("class", "collapse hide card-body");
 93 |                 card.setAttribute("id", "collapse-" + count);
 94 |                 card.setAttribute("data-parent", "#accordionExample");
 95 | 
 96 |                 var message = document.createElement('pre');
 97 |                 message.innerHTML= JSON.stringify(jsondata, undefined, 2);
 98 |                 card.appendChild(message);
 99 |                 messages.appendChild(card);
100 |                 count = count + 1;
101 |             };
102 |         </script>
103 |         <script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
104 |         <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.1/dist/umd/popper.min.js" integrity="sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN" crossorigin="anonymous"></script>
105 |         <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script>
106 |     </body>
107 | </html>
108 | 


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | SimpleWebSocketServer
2 | websocket_client


--------------------------------------------------------------------------------
/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mikaukora/robotframework-listener-api-events/28584b8073516df05f8f921778e04b6f78e71ba7/screenshot.png


--------------------------------------------------------------------------------