Skip to content

Commit

Permalink
Merge pull request #6 from symcon/fixes/migrate-tests
Browse files Browse the repository at this point in the history
Migration der Tests auf phpUnit v10
  • Loading branch information
Sunnyka98 authored Sep 19, 2023
2 parents 522a7b7 + bd48a6e commit 552e101
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 71 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.DS_Store
.idea/
.phpunit.*
.php_cs.cache
62 changes: 2 additions & 60 deletions Countdown/README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,5 @@
# Countdown
Das Modul ermöglicht es einen Countdown bis zu einem Event im Webfront anzuzeigen.

### Inhaltverzeichnis

1. [Funktionsumfang](#1-funktionsumfang)
2. [Voraussetzungen](#2-voraussetzungen)
3. [Software-Installation](#3-software-installation)
4. [Einrichten der Instanzen in IP-Symcon](#4-einrichten-der-instanzen-in-ip-symcon)
5. [Statusvariablen und Profile](#5-statusvariablen-und-profile)
6. [WebFront](#6-webfront)
7. [PHP-Befehlsreferenz](#7-php-befehlsreferenz)

### 1. Funktionsumfang

* Ermöglicht es einen Countdown im Webfront anzuzeigen, der sich minütlich aktualisiert
* Festlegung eines Zeitpunktes und Namen eines Ereignis

### 2. Voraussetzungen

- IP-Symcon ab Version 5.0

### 3. Software-Installation

* Über den Modul Store das Modul Countdown installieren.
* Alternativ über das Modul Control folgende URL hinzufügen:
`https://github.com/symcon/Countdown`

### 4. Einrichten der Instanzen in IP-Symcon

- Unter "Instanz hinzufügen" kann das 'Countdown'-Modul mithilfe des Schnellfilters gefunden werden.
- Weitere Informationen zum Hinzufügen von Instanzen in der [Dokumentation der Instanzen](https://www.symcon.de/service/dokumentation/konzepte/instanzen/#Instanz_hinzufügen)

__Konfigurationsseite__:

Name | Beschreibung
----------------- | -------------------------------------
Datum und Uhrzeit | Datum und Uhrzeit
Ereignis | Name der Im WebFront angezeigt werden soll


### 5. Statusvariablen und Profile

Die Statusvariablen/Kategorien werden automatisch angelegt. Das Löschen einzelner kann zu Fehlfunktionen führen.

##### Statusvariablen

Name | Typ | Beschreibung
----------------- | ------- | --------------------------------
Ereignis erreicht | Boolean | Zeigt an ob das Ereignis erreicht wurde
Verbleibende Zeit | String | Beinhaltet die verbleibende Zeit

##### Profile:

Es werden keine neuen Profile erstellt.

### 6. WebFront

Hier wird der Countdown angezeit und, sowie eine Nachricht, wenn das Ereignis eingetreten ist.

### 7. PHP-Befehlsreferenz

[Link zur deutschen Dokumentation](https://www.symcon.de/de/service/dokumentation/modulreferenz/countdown/)

[Link to the english documentation](https://www.symcon.de/en/service/documentation/module-reference/countdown/)
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@

Folgende Module beinhaltet das Countdown Repository:

- __Countdown__ ([Dokumentation](Countdown))
- __Countdown__ ([Dokumentation](https://www.symcon.de/de/service/dokumentation/modulreferenz/countdown))
Das Modul ermöglicht es einen Countdown bis zu einem Event im Webfront anzuzeigen.
File renamed without changes.
21 changes: 11 additions & 10 deletions tests/phpunit.xml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
<php>
<const name="PHPUNIT_TESTSUITE" value="true"/>
</php>
<filter>
<whitelist processUncoveredFilesFromWhitelist="true">
<directory suffix=".php">../Countdown</directory>
</whitelist>
</filter>
</phpunit>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd" cacheDirectory=".phpunit.cache">
<coverage/>
<php>
<const name="PHPUNIT_TESTSUITE" value="true"/>
</php>
<source>
<include>
<directory suffix=".php">../Countdown</directory>
</include>
</source>
</phpunit>

0 comments on commit 552e101

Please sign in to comment.