Home

System overview

The breakdown of the system is the following:

1. Add-in part. This is a C# part of the codebase that represents a MS Excel add-in. Lives in comnsense/comnsense/ and consists of:

• Excel add-in ThisAddin.cs, that communicates with Excel through COM and to Router through ZeroMQ.
• Router Router.cs, that talks to Agent through ZeroMQ.

2. Agent part. This is Python code that runs as a Windows application, that lives in comnsense/agent/ and consists of:

• Agent. When an Excel file is opened it receives a message and allocates a Worker for this file. Then it routes messages between Excel and worker.
• Worker. Allocated for a particular Excel file, it receives events from Excel, processes them in its runtime and spits back actions.

For a description of events, actions and communication between system parts see Methods.

Bulding comnsense

From the files in this repo you can build a complete comnsense installation package. For it you need to:

1. Build an Add-in C# application build with Visual Studio, find instructions here. This will produce a complete Add-in installation distribution.
2. Package an Agent python code and binaries into a distribution as shown here. This will produce a folder from which the agent can be run.

This will produce two separate distributions that can be run on any Windows machine.

Tests

To execute tests use next command:

$ python runtests.py

If you want to see allure report:

$ python runtests.py --alluredir ./allure
$ allure generate -o ./allure-report -v 1.4.9 -- ./allure
$ allure report

Runtime test cases:

• Initialization