amosproj / amos2021ss01-emba-service

EMBA Service (AMOS SS 2021)

Siemens Energy EMBA Project (AMOS SS 2021)
(Embark)

• About
• Setup
• Docker
• Pipelines
• Logging

About

Embark is being developed to provide the Linux-based firmware analyzer emba as a containerized service, to ease accessibility to emba regardless of system and operating system.

Furthermore Embark is improves the data provision by aggregating the various emba outputs in a fancy dashboard.

Setup

1. Change directory to root of the repository i.e amos-ss2021-emba-service
2. Clone original emba repository (git clone https://github.com/e-m-b-a/emba.git)
3. Run ./emba/installer.sh -F to force install all the dependencies on host. This enables functionalities like CVE Search.
4. Setup docker containers(See docker instructions)

Docker

See docker.md

Pipelines

Currently there are two Pipelines running:

• Linter (pycodestyle / pep8)
  To check your conformity with pep8 locally: pycodestyle .
  To get further information about the violation run: pycodestyle --show-source .
  For further setting see pycodestyle documentation

• Unit Tests
  Pipeline runs the django test environment: python manage.py test
  This invokes all methodes in test classes labeled with test_

Logging

For logging use pythons logging environment.
Configuration can be found in embark/manage.py

Example:

logger = logging.getLogger('web')

[...]

logger.info("log message")

For further reading see how to logging.

You can inspect the emba repository emba and get more information about usage of emba in the wiki.