Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/jens-maus/occu-test

Automated System Tests of "ReGaHss" - the HomeMatic (O)CCU "Logic Layer" Engine...
https://github.com/jens-maus/occu-test

ccu homematic occu raspberrymatic rega regahss system-tests test-automation

Last synced: 22 days ago
JSON representation

Automated System Tests of "ReGaHss" - the HomeMatic (O)CCU "Logic Layer" Engine...

Host: GitHub
URL: https://github.com/jens-maus/occu-test
Owner: jens-maus
License: mit
Created: 2017-10-29T20:02:26.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-03-11T08:04:41.000Z (4 months ago)
Last Synced: 2024-05-22T01:14:43.444Z (about 1 month ago)
Topics: ccu, homematic, occu, raspberrymatic, rega, regahss, system-tests, test-automation
Language: JavaScript
Homepage:
Size: 1.83 MB
Stars: 3
Watchers: 5
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-homematic - occu-test - Automated System Tests of ReGaHss - the HomeMatic (O)CCU "Logic Layer". (Misc Software)

README

# ReGaHss Testing Environment
[![CI](https://github.com/jens-maus/occu-test/workflows/CI/badge.svg)](https://github.com/jens-maus/occu-test/actions)
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
[![Known Vulnerabilities](https://snyk.io/test/github/jens-maus/occu-test/badge.svg)](https://snyk.io/test/github/jens-maus/occu-test)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

This repository performs automated daily system tests of `ReGaHss` - the HomeMatic (O)CCU "Logic Layer" engine. It uses a [mocha](https://github.com/mochajs/mocha)-based node.js testing framework to test all published `ReGaHss` binaries in the [OCCU](https://github.com/eq-3/occu) environment published by eQ3. Beside testing common corner cases of the embedded scripting language of ReGaHss this testing framework also tests for security vulnerabilities.

Recent test results for the different build flavors of ReGaHss can be viewed here:

[![](http://github-actions.40ants.com/jens-maus/occu-test/matrix.svg?only=ci.build)](https://github.com/jens-maus/occu-test/actions)

## HOWTO run the tests locally
```bash
# Start the travis container
docker run --name travis -dit quay.io/travisci/travis-ruby /sbin/init

# Get a shell
docker start travis
docker exec -it travis bash -l

# Install Node.js
nvm install 10

# Clone the repo
cd /home/travis
git clone https://github.com/jens-maus/occu-test

# Install dependencies
cd occu-test
npm install

# Run the tests
npm test
```

## homematic.regadom

ReGaHss is started with a prebuilt `homematic.regadom` which contains the following variables, programs and objects:

#### Variables

* VarBool1 - id: 1237
* VarEnum1
* VarNum1
* VarString1

#### Programs

* Bool1OnFalse - BidCoS-RF:13 PRESS_LONG
* Bool1OnTrue - BidCoS-RF:12 PRESS_LONG
* Bool1OnFalseUpdate - BidCoS-RF:14 PRESS_LONG
* Bool1OnTrueUpdate - BidCoS-RF:15 PRESS_LONG
* TimeEveryMinute - id: 1302 - BidCoS-RF:50 PRESS_LONG
* Time0100 - id: 1314 - BidCoS-RF:11 PRESS_LONG
* Time0130 - id: 1430 - BidCoS-RF:20 PRESS_LONG
* Time0155 - id: 1458 - BidCoS-RF:21 PRESS_LONG
* Time0200 - id: 1470 - BidCoS-RF:22 PRESS_LONG
* Time0205 - id: 1498 - BidCoS-RF:23 PRESS_LONG
* Time0230 - id: 1510 - BidCoS-RF:24 PRESS_LONG
* Time0255 - id: 1522 - BidCoS-RF:25 PRESS_LONG
* Time0300 - id: 1534 - BidCoS-RF:26 PRESS_LONG
* Time0305 - id: 1546 - BidCoS-RF:27 PRESS_LONG
* Time0330 - id: 1558 - BidCoS-RF:28 PRESS_LONG
* Key16Key17 - on BidCoS-RF:16 PRESS_LONG => BidCoS-RF:17 PRESS_LONG
* Key1 - on BidCos-RF:1 PRESS_SHORT => BidCoS-RF:2 PRESS_LONG

## Todo

* test all examples of the official homematic script documentation **wip**
* test script error handling **wip**
* test popular scripts published on homematic-inside.de and homematic-forum.de **wip**
* extend regadom with more testvars/programs/devices
* add more devices to rfd and hmipserver simulator and add them to regadom
* test device interactions (add/delete/readyconfig, test programs, ...) **wip**
* trigger travis builds on commits in occu repository
* test variable creation/deletion via script
* test room/function creation/deletion via script
* test room/function assignment creation/deletion
* test program creation via script
* WebUI tests?
* ...

## Links

* [OCCU](https://github.com/eq-3/occu)
* [hm-simulator](https://github.com/hobbyquaker/hm-simulator) (simulates rfd/hmipserver)
* [ccu x86 docker image](https://hub.docker.com/r/litti/ccu2/) (used for creation of the prebuilt homematic.regadom)
* [homematic-rega](https://github.com/hobbyquaker/homematic-rega) (Node.js Homematic CCU ReGaHSS Remote Script Interface)

## Contributing

Help and Feedback highly appreciated, Pull Requests Welcome! :-)

## License