From b2c66e1d18e9c8828b624d44ff7760f4fa6a40cb Mon Sep 17 00:00:00 2001 From: Wolfram Date: Sat, 8 Feb 2025 13:33:42 +0100 Subject: [PATCH] 2025.2 --- .gitignore | 3 +- CHANGELOG | 47 +++--- README-OLD.md | 256 ------------------------------ config-generator.py | 91 +++-------- docs/bffh-vorlage.dhall | 6 +- generator/core.py | 341 ++++++++++++++++++++++++++-------------- generator/globals.py | 10 +- generator/helpers.py | 11 +- settings.ini | 18 --- 9 files changed, 299 insertions(+), 484 deletions(-) delete mode 100644 README-OLD.md diff --git a/.gitignore b/.gitignore index ab366dc..e2cd78c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ __pycache__ output/* -dev.py \ No newline at end of file +dev*.py +maschinenliste-*.csv \ No newline at end of file diff --git a/CHANGELOG b/CHANGELOG index 346678d..7ab2007 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,19 +1,30 @@ -2025.1 -- **Features** - - Neu: Option zur Erstellung eines Domänen-Managers. (`manager_domain`) - - Neu: Option zur Erstellung eines werkstattweiten Benutzers. (`domain_user`) - - Neu: Option zum Einstellen des CSV-Trennzeichens. (`csv_delimiter`) -- **Konzeptionelle Änderungen** - - -- **Umbenennungen** - - Die Einstellung `fa_update_dhall` heißt jetzt `fa_dhall_update`, damit ein einheitliches Benennungsschema mit der dazugehörigen Einstellungen `fa_dhall_file` gegeben ist. -- **Bugfixes** - - Crash bei Verwendung der Einstellung `show_machines` - - Korrektur der erzeugten dhall-Syntax. Der letzte Eintrag einer Datenstruktur wird nicht mehr mit einem Komma abgeschlossen. -- **Sonstiges** - - Admin-Berechtigungen wurden vollständig auf Wildcard-Zugriffsschema umgestellt. Zuvor wurden Berechtigungen für einzelne Bereiche vergeben. +# 2025.2 +## Neuerungen + - Option zur Erstellung eines Domänen-Managers. (`manager_domain`) + - Option zur Erstellung eines werkstattweiten Benutzers. (`domain_user`) + - Parameter, um die CSV-Datei mit der Maschinenliste zu definieren. + - Der verwende CSV-Delimiter wird automatisch erkannt. + - Die erzeugte Konfiguration wird in einzelnen dhall-Dateien abgelegt, die in der `bffh.dhall` importiert werden. + - Die FabAccess-Konfiguration in der `bffh.dhall` wird nicht mehr berührt. + - Kompatibilität mit dem offiziellen dhall-Parser (Imports bleiben erhalten; die bisherigen Platzhalter zum Aktualisieren der `bffh.dhall` bleiben bei Nutzung des Parsers nicht erhalten) -2024.6 -- **Diagrammerzeugung** - - Das Diagramm enthält jetzt eine Icon-Legende - - Unterschiedliche Icons für Administrator und Manager, um die Unterscheidung zu erleichtern. \ No newline at end of file +## Bugfixes +- Crash bei Verwendung der Einstellung `show_machines` behoben. +- Korrektur der erzeugten dhall-Syntax. Der letzte Eintrag einer Datenstruktur wird nicht mehr mit einem Komma abgeschlossen. + +## Sonstiges +- Die erzeugten DHALL-Dateien werden standardgemäß auch im Unterordner `/output` abgelegt. +- Admin-Berechtigungen wurden vollständig auf Wildcard-Zugriffsschema umgestellt. Zuvor wurden Berechtigungen für einzelne Bereiche vergeben. +- Schönere Darstellung der Statusinformationen, wenn das Python-Modul `rich` installiert ist. + +## Änderungen in der settings.ini +- Neue Einstellung `fa_dhall_directory` +- Die Einstellung `manager_schichtleitung ` entfällt (wird ersetzt von `manager_domain`). +- Die Einstellung `create_file_roles` entfällt. Eine CSV-Datei mit allen Rollennamen und deren FabAcess-IDs wird jetzt standardgemäß erzeugt. +- Die Einstellung `generate_mermaid` entfällt. Eine Textdatei mit Mermaid-Code für ein Werkstattdiagramm wird jetzt standardgemäß erzeugt. +- Die Einstellungen `fa_update_dhall` und `fa_dhall_file` entfallen. + +# 2024.6 +## Diagrammerzeugung +- Das Diagramm enthält jetzt eine Icon-Legende +- Unterschiedliche Icons für Administrator und Manager, um die Unterscheidung zu erleichtern. \ No newline at end of file diff --git a/README-OLD.md b/README-OLD.md deleted file mode 100644 index 5ebb1c4..0000000 --- a/README-OLD.md +++ /dev/null @@ -1,256 +0,0 @@ -# fabaccess-config-generator -Automatische Generierung von Maschinen, Rollen, Aktoren und Aktor-Verbindungen auf Basis einer Maschinenliste im CSV-Format. - -- [Funktionsumfang](#funktionsumfang) -- [Funktionsweise](#funktionsweise) - - [Bereichskonzept](#bereichskonzept) - - [Rollenkonzept \& Berechtigungen](#rollenkonzept--berechtigungen) - - [Beispielwerkstatt](#beispielwerkstatt) - - [Auszug aus der CSV](#auszug-aus-der-csv) - - [Werkstattdiagramm](#werkstattdiagramm) - - [Erklärung der Konfiguration](#erklärung-der-konfiguration) -- [Nutzung des Python-Skripts](#nutzung-des-python-skripts) - - [Anlegen von Maschinen (maschinenliste.csv)](#anlegen-von-maschinen-maschinenlistecsv) - - [Einstellungen des Skripts (settings.ini)](#einstellungen-des-skripts-settingsini) - - [Aktorenbibliothek (actors.ini)](#aktorenbibliothek-actorsini) - - [Beispiel für die Erstellung eines Aktor-Typs](#beispiel-für-die-erstellung-eines-aktor-typs) -- [Verschiedene Informationen](#verschiedene-informationen) - - [ID-Schema für Rollen, Maschinen und Aktoren](#id-schema-für-rollen-maschinen-und-aktoren) - - [Ausnahme: Alternativrollen](#ausnahme-alternativrollen) - - [Aktualisierung einer bestehenden bffh.dhall](#aktualisierung-einer-bestehenden-bffhdhall) - - -# Funktionsumfang - - Generierung von Maschinen - - Generierung von Rollen - - Generierung von Aktoren - - Generierung von einfachen Aktoren-Verbindungen - - Export einer gesonderten Rollenliste (interne ID & Anzeigename der Rolle) - - Abbildung der Struktur mittels Mermaid-Diagramm - - Direkte Aktualisierung einer bestehenden `bffh.dhall` - -# Funktionsweise -Die CSV-Zeile enthält pro Zeile einen Eintrag für eine Maschine. Neben Angaben zur Maschine selbst (ID, Wiki-URL etc.) werden Angaben zum Bereich vermerkt, in dem sich die Maschine befindet. Aus den Angaben zu den Bereichen werden dann alle Rollen abgeleitet. - -## Bereichskonzept -Innerhalb der globalen Infrastruktur existieren die folgenden Einheit: -- **Domäne**: Fasst die gesamte Werkstatt zusammen und unterteilt sich in mehrere Bereiche (=Gewerke). Bei Bedarf können auch mehrere Domänen definiert werden. -- **Bereich**: Entspricht üblicherweise einem Gewerk (z.B. Holzwerkstatt, Siebdruck), aber kann auch genutzt werden, um andere Maschinen zu gruppieren (z.B. Eingangstüren). Ein Bereich kann bei Bedarf über Unterbereiche verfügen. -- **Unterbereich**: Ein Unterbereich ermöglicht einzelne Maschinen/ Maschinengruppen separat zu behandeln. - -## Rollenkonzept & Berechtigungen -| Rolle | Berechtigungen | Infrastruktur | Domäne | Bereich | Unterbereich | Spezifische Maschinen | -| --------------- | ---------------------------------------------------------------------- | ------------- | -------- | ------- | ------------ | --------------------- | -| Administrator | - *bffh.users.manage*
- *bffh.users.info*
- *bffh.users.admin* | Ja | - | - | - | - | -| Manager | - *read*
- *write*
- *disclose*
- *manage* | - | Optional | Ja | Optional | - | -| Benutzer | - *read*
- *write*
- *disclose* | - | - | Ja | Ja | - | -| Alternativrolle | - *read*
- *write*
- *disclose* | - | - | - | - | Ja | - -- Berechtigungen werden grundsätzlich via Wildcard vergeben und gelten somit für eine gesamte Einheit (Infrastruktur/ Domäne/ Bereich/ Unterbereich). - - Berechtigungen für Bereich und Unterbereich sind getrennt. Benutzer eines Bereichs haben keinen Zugriff auf Maschinen eines Unterbereichs (und umgekehrt). -- **Ausnahme: Alternativrolle** - - Die Alternativrolle dient der Erstellung einer bereichsübergreifenden Berechtigung für einzelne Maschine. Diese wird vergeben, wenn in mehreren Bereichen die gleiche (bzw. eine ähnliche) Maschinen existieren und dafür nur eine Einweisung notwendig ist. - -## Beispielwerkstatt - -Die CSV-Datei `beispielwerkstatt.csv` und das Diagramm `beispielwerkstatt.svg` befinden sich im Unterordner `docs`. - -### Auszug aus der CSV - -| Name Domäne | Name Bereich | Name Unterbereich | Name Maschine | Manager Unterbereich | Name Alternativrolle | -| ----------------- | --------------- | ----------------- | ------------------- | -------------------- | -------------------- | -| Beispielwerkstatt | Holzwerkstatt | Bandsäge | Bandsäge | | | -| Beispielwerkstatt | Holzwerkstatt | Hobelmaschine | Hobelmaschine | | | -| Beispielwerkstatt | Holzwerkstatt | CNC-Fräse | CNC-Fräse | | | -| Beispielwerkstatt | Holzwerkstatt | | Kappsäge | | | -| Beispielwerkstatt | Holzwerkstatt | | Bandschleifer | | | -| Beispielwerkstatt | Holzwerkstatt | | Ständerbohrmaschine | | | -| Beispielwerkstatt | Textilwerkstatt | | Nähmaschine 1 | | | -| Beispielwerkstatt | Textilwerkstatt | | Nähmaschine 2 | | | -| Beispielwerkstatt | FabLab | 3D-Druck | 3D-Drucker 1 | x | | -| Beispielwerkstatt | FabLab | 3D-Druck | 3D-Drucker 2 | x | | -| Beispielwerkstatt | FabLab | Laser | Lasercutter | x | | -| Beispielwerkstatt | FabLab | Laser | Kühlung | x | | -| Beispielwerkstatt | Siebdruck | | SD-Belichter | | | -| Beispielwerkstatt | Siebdruck | | A3-Drucker | | Druckernutzung | -| Beispielwerkstatt | Büro | | Drucker | | Druckernutzung | - - -### Werkstattdiagramm -![Beispiel für eine Werkstattstruktur](docs/beispielwerkstatt.svg) - - -### Erklärung der Konfiguration -- **Textilwerkstatt** - - In der Textilwerkstatt verwaltet eine Person den gesamten Bereich. - - Eine Einweisung deckte alle Maschinen ab, daher gibt es keine Unterbereiche. -- **Holzwerkstatt** - - In der Holzwerkstatt verwaltet eine Person den gesamten Bereich. - - Es gibt unterschiedliche Einweisungen: - - Holzwerkstatt Allgemein (Kappsäge, Bandschleifer, Ständerbohrmaschine) - - Bandsäge - - Hobelmaschine - - CNC-Fräse - - Bandsäge, Hobelmaschine, CNC-Fräse verfügen jeweils über einen eigenen Unterbereich, um für jede Maschine eine eigene Berechtigung vergeben zu können. -- **FabLab** - - Im FabLab sind mehrere Personen für die Verwaltung zuständig: - - Person A ist im Allgemenien für das FabLab zuständig. Hier gib es keine Maschinen, die von von FabAccess verwaltet werden. - - Person B ist für die 3D-Drucker zuständig. - - Person C ist für den Lasercutter inkl. Kühlung zuständig. - - Beide Maschinengruppen (3D-Drucker & Laser) sind in einem eigenen Unterbereich, um eine eigene Berechtigung vergeben zu können. - - Beide Unterbereiche verfügen über einen Unterbereich-Manager, damit Person A und B ihren jeweiligen Bereich verwalten können. -- **Siebdruck & Büro** - - Es gibt eine allgemeine Drucker-Einweisung, die zur Nutzung aller Drucker in beiden Bereichen berechtigt. Die Drucker der beiden Bereiche sind mit der Alternativrolle _Druckernutzung_ verknüpft. - - -# Nutzung des Python-Skripts -- Eingelesen wird die Datei `maschinenliste.csv` [^1] - - Die Spaltennamen dienen der Zuordnung und dürfen nicht umbenannt werden. - - Die Reihenfolge der Spalten kann nach Belieben verändert werden. -- Zentrale Einstellungen können in der `settings.ini` vorgenommen werden, -- Aktor-Typen können in der `actors.ini` definiert -- Erzeugte Daten werden im Unterordner `output` gespeichert. - -[^1]: Die Datei muss in der Enkodierung UTF-8 (ohne BOM) vorliegen. - -## Anlegen von Maschinen (maschinenliste.csv) -- Verwendetes Trennzeichen: `;` -- IDs können Buchstaben und Zahlen enthalten. - - Alle Großbuchstaben werden automatisch in Kleinbuchstaben umgewandelt. - - Deutsche Sonderzeichen werden automatisch umgewandelt (ä = ae, ö = oe, ü = ue, ß = ss). - - Alle übrigen Zeichen werden automatisch entfernt. - - -| Feld | Info | Pflichtfeld | -| ------------------------ | --------------------------------------------------------------------- | ----------- | -| **ID Domäne** | Eindeutige ID einer Domäne. | Ja | -| **ID Bereich** | Eindeutige ID eines Bereichs. | Ja | -| **ID Unterbereich** | Eindeutige ID eines Unterbereichs. | - | -| **ID Maschine** | Eindeutige ID der Maschine. | Ja | -| **Unterbereich Manager** | Erstellung einer Manager-Rolle für den dazugehörigen Unterbereich | - | -| **Name Bereich** | Anzeigename des Bereichs. | Ja | -| **Name Unterbereich** | Anzeigename des Unterbereichs. | - | -| **Name Maschine** | Anzeigename der Maschine. | Ja | -| **Maschinbeschreibung** | Feld `description` einer Maschine in FabAccess. | - | -| **Wiki-URL** | Feld `wiki` einer Maschine in FabAccess. | - | -| **Aktor ID** | Eindeutige ID eines Aktors. | - | -| **Aktor Typ** | Definiert den Aktorentyp, der aus der Aktorenbibliothek geladen wird. | - | -| **ID Alternativrolle** | Eindeutige ID einer alternativen Rolle. | - | -| **Name Alternativrolle** | Anzeigename einer alterantiven Rolle. | - | -| **Anmerkungen** | Zusatzfeld für Anmerkungen, wird nicht verarbeitet. | - | - -Hinweis zum Feld `Unterbereich Manager`: -- Für die Erstellung der Rolle muss eni Unterbereich definiert sein. -- Das Feld wird aktiv sobald ein beliebiger Inhalt eingetragen wird. -- Das Feld muss nur für eine Maschine des Unterbereichs ausgefüllt werden. - -## Einstellungen des Skripts (settings.ini) -| Einstellung | Info | -| -------------------------- | -------------------------------------------------------------------------------------------------------------- | -| **multi_domains** | Verwendung mehrer Domänen. Es wird dann automatisch eine Manager-Rolle für jede Domäne erstellt. | -| **manager_schichtleitung** | Rolle "Schichtleitung" erstellen, die über Manager-Berechtigungen für alle Domänen verfügt. | -| **manager_area** | Manager-Rolle für jeden Bereich erstellen. | -| **manager_subarea** | Spalte "Unterbereich Manager" der CSV beachten (True) oder nicht (False). | -| **fa_update_dhall** | Automatische Aktualisierung einer bestehenden `bffh.dhall`. | -| **fa_dhall_file** | Pfad zur bffh.dall. | -| **generate_mermaid** | Mermaid-Code erzeugen, der Bereiche und Rolle in einem Diagramm abbildet. [^2] | -| **create_file_roles** | Erstellung einer gesonderten CSV-Datei, die jede Rollen-ID und den dazugehörigen Rollen-Name beinhaltet. | -| **show_machines** | Alle importierten Maschinen-Daten anzeigen. | -| **show_roles** | Alle erzeugten Rollen-Daten anzeigen. | -| **string_adminhandle** | Kennzeichnung von Administrator-Rollen im Anzeigename. Der String wird dem Namen der Rolle vorangestellt. [^3] | -| **string_managerhandle** | Kennzeichnung für Manager-Rollen, steht am Anfang des Namens der Rolle. [^3] | -| **string_userhandle** | Kennzeichnung von Benutzer-Rollen im Anzeigename. Der String wird dem Namen der Rolle vorangestellt. [^3] | - -[^2]: Ausgabe erfolgt in die Datei `mermaid-code.txt`. Der enthaltene Code kann auf [mermaid.live](https://mermaid.live/) eingefügt werden, um das Diagramm als Grafik zu speichern. -[^3]: Der Anzeigename wird aktuell nur im Diagramm verwendet. - - -## Aktorenbibliothek (actors.ini) -In der Aktorenbibliothek können Vorlagen für Aktor-Typen angelegt werden. Ein bestimmter Aktor muss somit nur einmal angelegt werden und kann in der `maschinenliste.csv` angegeben werden. - -Ein Aktor-Typ besteht immer aus: -- Titel des Aktors. Dieser wird in eckigen Klammern angegeben und definiert den Aktor. -- Angabe zum Feld `module` von FabAccess. - -Darüber hinaus können beliebig viele eigene Parameter übergeben werden. Diese müssen mit Präfix `param_` als Parameter gekennzeichnet sein. - - -### Beispiel für die Erstellung eines Aktor-Typs -Angelegt wird der Aktor *shellyplus*. Für diesen wird anschließend in der `maschinenliste.csv` eine Maschine mit der Aktor-ID *test12345* angelegt. - -> Groß- und Kleinschreibung spielt für die Datenverarbeitung keine Rolle. Sowohl der Aktor-Name als auch alle Parameter werden automatisch in Kleinbuchstaben umgewandelt. -
- -Aktor-Definition in der actors.ini -``` -[shellyplus] -module = "MqttSwitch" -param_topic = "shellyplus1pm-$actor_id/rpc", -param_onMsg = "{\"id\": 1, \"src\": \"bffh\", \"method\": \"Switch.Set\", \"params\": {\"id\": 0, \"on\": true}" -param_offMsg= "{\"id\": 1, \"src\": \"bffh\", \"method\": \"Switch.Set\", \"params\": {\"id\": 0, \"on\": false}" -``` -
- -Fertiger Aktor in der `bffh.dhall`: -``` -shellyplus_test12345 = -{ - module = ""MqttSwitch"", - params = - { - topic = "shellyplus1pm-bbbb/rpc",, - onmsg = "{\"id\": 1, \"src\": \"bffh\", \"method\": \"Switch.Set\", \"params\": {\"id\": 0, \"on\": true}", - offmsg = "{\"id\": 1, \"src\": \"bffh\", \"method\": \"Switch.Set\", \"params\": {\"id\": 0, \"on\": false}", - } -}, -``` - - -# Verschiedene Informationen -## ID-Schema für Rollen, Maschinen und Aktoren -| ID | Schema | -| ------------ | --------------------------------------------------------- | -| **Rolle** | domäne.bereich.bereich.rollentyp bzw. domäne.unterbereich.rollentyp | -| **Maschine** | domäne-bereich-bereich-maschinen bzw. domäne-unterbereich-maschinen | -| **Aktor** | aktortyp_aktorid | - -**Auszug aus der Beispielwerkstatt: Unterbereich FabLab Laser** -- Rolle "*Manager FabLab Laser*": beispielw_fablab_laser_manager -- Rolle "*Benutzer FabLab Laser*": beispielw_fablab_laser_user -- Maschinen-IDs: - - Maschine "*Lasercutter*": beispielw-fablab-laser-laser3000 - - Maschine "*Kühlung*": beispielw-fablab-laser-kuehlung3000 - -### Ausnahme: Alternativrollen -Bei einer Alternativrolle weicht die Rollen-ID von der Maschinen-ID ab, da es sich um eine bereichsübergreifende Rolle handelt. Die Rollen-ID beinhaltet keine Bereichszuordnung. Die Maschinen-ID beinhaltet nach wie vor eine Bereichszuordnung, um die Maschine eindeutig in der Werkstatt verorten zu können. - -**Auszug aus der Beispielwerkstatt: Alternative Rolle für Druckernutzung** -- Rolle "*Benutzer Druckerbenutzung*": beispielw_drucker -- Maschinen-IDs: - - beispielw-siebdruck-a3drucker - - beispielw-buero-drucker - -## Aktualisierung einer bestehenden bffh.dhall -Eine bestehende `bffh.dhall` kann auf Wunsch automatisch aktualisiert werden. Dabei wird der Inhalt der bestehenden `bffh.dhall` eingelesen und die vom Config-Generator erzeugten Daten an einer vordefinierten Stelle eingesetzt. - -**Einstellungen in der settings.ini setzen** -Hierfür müssen in der `settings.ini` die folgenden Einstellungen gesetzt sein: -- `fa_update_dhall`auf `True` -- `fa_dhall_file` muss die Pfandangabe zur bffh.dhall enthalten - -**bffh.dhall vorbereiten** -1. Bestehende Datenstrukturen löschen: - - roles - - maschines - - actors - - actor_connections -2. Die folgenden Zeilen einfügen. - - `-- ||| GENERATOR START` - - ` -- ||| GENERATOR END` - -Das Skript fügt die erzeugten Daten automatisch zwischen beiden Platzhaltern ein. Bestehender Inhalt zwischen den Platzhaltern wird dabei überschrieben. - ->   -> **Hinweis** -> Ein Vorlage für eine entsprechend angepasste `bffh.dhall` befindet sich im Unterordner `docs` ->   \ No newline at end of file diff --git a/config-generator.py b/config-generator.py index 74df1df..061c2b4 100644 --- a/config-generator.py +++ b/config-generator.py @@ -1,5 +1,7 @@ __version__ = '2025.1' +import os +import sys import time time_start = time.perf_counter() @@ -7,21 +9,32 @@ from pathlib import Path from generator.core import * from generator.helpers import * +app_path = os.path.dirname(os.path.realpath(__file__)) + input_file = 'maschinenliste.csv' +# CLI Parameter +if len(sys.argv) > 0: + + for arg in sys.argv: + + if 'file=' in arg: + input_file = arg.replace('file=', '') + + # Output-Ordner anlegen +print('Erzeuge Konfiguration\n|') + directory = "output" path = Path(directory) path.mkdir(parents=True, exist_ok=True) -print(f' --- Datei = {input_file}') +print(f'|- Datei = {input_file}') # Maschinenliste einlesen -print(' --- Maschinen importieren:') machines = import_machines(input_file) # Rollen für FabAccess erzeugen -print(' --- Rollen erzeugen') roles = generate_roles(machines) # Finale DHALL-Daten erzeugen @@ -32,74 +45,22 @@ export_actorconnections = generate_bffh_actorconnections(machines) export_all = export_roles + export_machines + export_actors + export_actorconnections -# Anzeigen der erzeugten Daten -if settings["show_machines"] == True: - for m in machines.values(): - display_machine(m) +# ------- Daten exportieren -if settings["show_roles"] == True: - print_dict(roles) +# Textdatei mit komplettem dhall-Inhalt +create_singledhall(export_roles, export_machines, export_actors, export_actorconnections) -# Daten exportieren -print(' --- DHALL-Daten exportieren') -write_file('output/bffh-dhall-data.txt', export_all) +# Rollenliste als CSV +create_roles_csv(roles) -if settings["create_file_roles"] == True: - print(' --- Rollen exportieren in roles.csv') - content = generate_csv_roles(roles) - write_file('output/roles.csv', content) - -if settings["fa_dhall_update"] == True: - print(' --- Aktualisierung der bffh.dhall') - fa_dhall_file = settings["fa_dhall_file"] - - # Pfadangabe "fa_dhall_file" hat Inhalt - if len(fa_dhall_file) > 0: - - # Daten schreiben - dhall_content = generate_bffh_dhall(export_all) - - if len(dhall_content) > 0: - write_file(fa_dhall_file, dhall_content) - - # Pfadangabe "fa_dhall_file" ist leer - else: - print('Einstellung "fa_dhall_file" ist leer, es wurde kein Pfad zur bffh.dhall angegeben.') - print('Bitte das Feld ausfüllen oder "fa_dhall_update" auf "False" setzen.') - -if settings["fa_dhall_create"] == True: - - fa_dhall_directory = settings["fa_dhall_directory"].replace('\\', '/') - - # Rollen - target = fa_dhall_directory + '/' + 'roles.dhall' - target = target.replace('//', '/') - write_file(target, export_roles) - - # Maschinen - target = fa_dhall_directory + '/' + 'machines.dhall' - target = target.replace('//', '/') - write_file(target, export_machines) - - # Aktoren - target = fa_dhall_directory + '/' + 'actors.dhall' - target = target.replace('//', '/') - write_file(target, export_actors) - - # Aktorenverbindung - target = fa_dhall_directory + '/' + 'actorconnections.dhall' - target = target.replace('//', '/') - write_file(target, export_actorconnections) +# Einzelne DHALLs +create_multipledhalls(export_roles, export_machines, export_actors, export_actorconnections) # Mermaid-Code -if settings["generate_mermaid"] == True: - print(' --- Mermaid-Code erzeugen') - graphelements = graph_create_elements(machines) - mermaidcode = graph_create_mermaidcode(graphelements) - write_file('output/mermaid-code.txt', mermaidcode) +create_mermaid(machines) -# ------------------------------------------------------------------ +# ---------------------- time_end = time.perf_counter() time_span = round(time_end - time_start, 2) -print('-------------------------') +print('---------') print(f'Laufzeit: {time_span} Sekunden') \ No newline at end of file diff --git a/docs/bffh-vorlage.dhall b/docs/bffh-vorlage.dhall index 4442436..478a08d 100644 --- a/docs/bffh-vorlage.dhall +++ b/docs/bffh-vorlage.dhall @@ -44,8 +44,10 @@ auditlog_path = "/tmp/bffh.audit", - -- ||| GENERATOR START - -- ||| GENERATOR END + roles = ./roles.dhall, + machines = ./machines.dhall, + actors = ./actors.dhall, + actor_connections = ./actorconnections.dhall, -- Initiators are configured almost the same way as Actors, refer to actor documentation for more details diff --git a/generator/core.py b/generator/core.py index 9c88eee..c313292 100644 --- a/generator/core.py +++ b/generator/core.py @@ -3,6 +3,27 @@ from string import Template from generator.globals import * from generator.helpers import * +# Rich-Module +try: + from rich.table import Table + from rich.console import Console + from rich.text import Text + module_rich = True +except ImportError: + module_rich = False + + +# Settings-Dateien finden und laden +if os.path.isfile('settings.ini') == True: + settings = config_load('settings.ini', 'generator') +else: + settings = config_load('./settings.ini', 'generator') + +if os.path.isfile('actors.ini') == True: + actor_library = load_actors('actors.ini') +else: + actor_library = load_actors('./actors.ini') + string_userhandle = settings["string_userhandle"] + ' ' string_adminhandle = settings["string_adminhandle"] + ' ' string_managerhandle = settings["string_managerhandle"] + ' ' @@ -284,12 +305,14 @@ class GraphElement: # Maschinen aus der CSV-importieren def import_machines(file): + print('|- Maschinen importieren:') + machines = {} - data = csv_listdict(file, settings['csv_delimiter'], csv_match) + data = csv_listdict(file, csv_match) count = 2 - print(f'{"Zeile": ^8} | {"Status": ^24} | {"Zusatzinformation": ^20}') - print(f'{"1": ^8} | {"Kopfzeile": ^24} | {"Kopfzeile wird nicht verarbeitet.": ^20}') + + feedback = [] for entry in data: @@ -297,7 +320,6 @@ def import_machines(file): errors = [] # Pflichtfelder - for el in importcheck["single"].keys(): # Einzelfeld ist leer? @@ -316,18 +338,34 @@ def import_machines(file): field2_name = key if len(entry[field1]) > 0 and len(entry[field2]) == 0: - errors.append(f'Optionales Felderpaar unvollständig: Feld "{field1_name}" ist ausgefüllt, aber Feld "{field2_name}" ist leer.') + errors.append(f' |- Felderpaar unvollständig: Feld "{field1_name}" ist ausgefüllt, aber Feld "{field2_name}" ist leer.') if len(entry[field2]) > 0 and len(entry[field1]) == 0: - errors.append(f'Optionales Felderpaar unvollständig: Feld "{field2_name}" ist ausgefüllt, aber Feld "{field1_name}" ist leer.') + errors.append(f' |- Felderpaar unvollständig: Feld "{field2_name}" ist ausgefüllt, aber Feld "{field1_name}" ist leer.') - status = 'Eintrag übersprungen' - info = f'Fehlerhafte Konfiguration. ID = {entry["machine_id"]}' if len(errors) > 0: - print(f'{count: ^8} | {status: ^24} | {info: ^20}') + + feedback.append( + { + "count": str(count), + "status": 'Übersprungen', + "info": 'Konfigurationsfehler', + "details": f'ID: {entry["machine_id"]}', + } + ) + for e in errors: - print(f'{"":>36}| ' + e) + feedback.append( + { + "count": '', + "status": '', + "info": '', + "details": e, + } + ) + count += 1 + continue # Maschine anlegen @@ -339,17 +377,74 @@ def import_machines(file): f'{fa_id}': Machine(entry) }) - status = 'Maschine angelegt' - info = f'FA_ID = {fa_id}' + feedback.append( + { + "count": str(count), + "status": 'OK', + "info": 'Maschine angelegt', + "details": f'ID: {entry["machine_id"]}', + } + ) - print(f'{count: ^8} | {status: ^24} | {info: ^20}') else: - status = 'Eintrag übersprungen' - info = f'ID bereits vergeben. ID = {entry["machine_id"]}' - print(f'{count: ^8} | {status: ^24} | {info: ^20}') + + feedback.append( + { + "count": str(count), + "status": 'Übersprungen', + "info": 'Doppelte Maschinen-ID', + "details": f'ID: {entry["machine_id"]}', + } + ) count += 1 + + # rich-switch + if module_rich == True: + console = Console() + table = Table(highlight="pale_green3") + table.add_column("Zeile", justify="right") + table.add_column("Status") + table.add_column("Info") + table.add_column("Details") + + status = Text('OK') + status.stylize("green") + table.add_row("1", status, "Kopfzeile", "Kopfzeile wird nicht verarbeitet.") + + for f in feedback: + + if 'OK' in f["status"]: + status = Text(f["status"]) + status.stylize("green") + + else: + + if 'Übersprungen' in f["status"]: + status = Text(f["status"]) + status.stylize("dark_orange") + else: + status = Text(f["status"]) + + table.add_row(f["count"], status, f["info"], f["details"]) + + console.print(table) + + else: + print(f'{"Zeile": ^8} | {"Status": ^24} | {"Details": ^20}') + print(f'{"1": ^8} | {"Kopfzeile": ^24} | {"Kopfzeile wird nicht verarbeitet.": <20}') + + for f in feedback: + print(f'{f["count"]: ^8} | {f["status"]: ^24} | {f["details"]: <20}') + + + # Datenanzeige + if settings["show_machines"] == True: + for m in machines.values(): + display_machine(m) + + return machines @@ -358,6 +453,8 @@ def import_machines(file): # Rollen erstellen def generate_roles(machines): + print('|- Rollen erzeugen') + roles = {} # Globalen Admin erstellen @@ -461,7 +558,9 @@ def generate_roles(machines): roles[roledata["id"]]["perms"].append(p) - # print_dict(roles) + # Datenanzeige + if settings["show_roles"] == True: + print_dict(roles) return roles @@ -471,18 +570,15 @@ def generate_bffh_roles(roles): data = [] # Anfang Datenstruktur - if settings["fa_dhall_create"] == False: - data.append(space + 'roles = {') - else: - data.append('{') + data.append('{') # Inhalt last_role = len(roles) - 1 for index_role, role in enumerate(roles): - data.append(space * 1 + extraspace + f'{role}' + ' =') - data.append(space * 1 + extraspace + '{') - data.append(space * 2 + extraspace + 'permissions = [') + data.append(space * 1 + f'{role}' + ' =') + data.append(space * 1 + '{') + data.append(space * 2 + 'permissions = [') last_perm = len(roles[role]["perms"]) - 1 @@ -494,20 +590,17 @@ def generate_bffh_roles(roles): else: data.append(space * 4 + f'"{perm}"') - data.append(space * 2 + extraspace + ']') + data.append(space * 2 + ']') if index_role == last_role: - data.append(space * 1 + extraspace + '}') + data.append(space * 1 + '}') else: - data.append(space * 1 + extraspace + '},') + data.append(space * 1 + '},') data.append(' ') # Ende Datenstruktur - if settings["fa_dhall_create"] == False: - data.append(space + '},') - else: - data.append('}') + data.append('}') return data @@ -517,10 +610,7 @@ def generate_bffh_machines(machines): data = [] # Anfang Datenstruktur - if settings["fa_dhall_create"] == False: - data.append(space + 'machines = {') - else: - data.append('{') + data.append('{') # Inhalt last_machine = len(machines) - 1 @@ -528,12 +618,12 @@ def generate_bffh_machines(machines): for index_machine, (id, m) in enumerate(machines.items()): specs = m.get_machine() - data.append(space * 1 + extraspace + f'{specs["fa_id"]}' + ' =') - data.append(space * 1 + extraspace + '{') - data.append(space * 2 + extraspace + f'name = "{specs["name"]}",') - data.append(space * 2 + extraspace + f'description = "{specs["desc"]}",') - data.append(space * 2 + extraspace + f'wiki = "{specs["wikiurl"]}",') - data.append(space * 2 + extraspace + f'category = "{specs["category"]}",') + data.append(space * 1 + f'{specs["fa_id"]}' + ' =') + data.append(space * 1 + '{') + data.append(space * 2 + f'name = "{specs["name"]}",') + data.append(space * 2 + f'description = "{specs["desc"]}",') + data.append(space * 2 + f'wiki = "{specs["wikiurl"]}",') + data.append(space * 2 + f'category = "{specs["category"]}",') permcount = len(specs["perms"]) @@ -542,25 +632,22 @@ def generate_bffh_machines(machines): for i in range(permcount): if i < last_perm: - data.append(space * 2 + extraspace + f'{specs["perms_names"][i]} = "{specs["perms"][i]}",') + data.append(space * 2 + f'{specs["perms_names"][i]} = "{specs["perms"][i]}",') else: - data.append(space * 2 + extraspace + f'{specs["perms_names"][i]} = "{specs["perms"][i]}"') + data.append(space * 2 + f'{specs["perms_names"][i]} = "{specs["perms"][i]}"') if index_machine == last_machine: - data.append(space * 1 + extraspace + '}') + data.append(space * 1 + '}') state = 'last' else: - data.append(space * 1 + extraspace + '},') + data.append(space * 1 + '},') state = 'not last' data.append(' ') index_machine +=1 # Ende Datenstruktur - if settings["fa_dhall_create"] == False: - data.append(space + '},') - else: - data.append('}') + data.append('}') return data @@ -570,10 +657,7 @@ def generate_bffh_actors(machines): data = [] # Anfang Datenstruktur - if settings["fa_dhall_create"] == False: - data.append(space + 'actors = {') - else: - data.append('{') + data.append('{') # Inhalt last_actor = len(machines) - 1 @@ -586,11 +670,11 @@ def generate_bffh_actors(machines): # 2do Actor Library Funktionalität - data.append(space * 1 + extraspace + f'{actor_handle} =') - data.append(space * 1 + extraspace + '{') - data.append(space * 2 + extraspace + f'module = "{actor_library[specs["actor_type"]]["module"]}",') - data.append(space * 2 + extraspace + 'params =') - data.append(space * 2 + extraspace + '{') + data.append(space * 1 + f'{actor_handle} =') + data.append(space * 1 + '{') + data.append(space * 2 + f'module = "{actor_library[specs["actor_type"]]["module"]}",') + data.append(space * 2 + 'params =') + data.append(space * 2 + '{') # Aktor-ID der aktuellen Maschine speichern replace = { @@ -604,24 +688,21 @@ def generate_bffh_actors(machines): string = template.substitute(replace) if index_param < last_param: - data.append(space * 3 + extraspace + f'{key} = {string},') + data.append(space * 3 + f'{key} = {string},') else: - data.append(space * 3 + extraspace + f'{key} = {string}') + data.append(space * 3 + f'{key} = {string}') - data.append(space * 2 + extraspace + '}') + data.append(space * 2 + '}') if index_actor == last_actor: - data.append(space * 1 + extraspace + '}') + data.append(space * 1 + '}') else: - data.append(space * 1 + extraspace + '},') + data.append(space * 1 + '},') data.append(' ') # Ende Datenstruktur - if settings["fa_dhall_create"] == False: - data.append(space + '},') - else: - data.append('}') + data.append('}') return data @@ -632,10 +713,7 @@ def generate_bffh_actorconnections(machines): data = [] # Anfang Datenstruktur - if settings["fa_dhall_create"] == False: - data.append(space + 'actor_connections = [') - else: - data.append('[') + data.append('[') # Inhalt last = len(machines) - 1 @@ -647,80 +725,113 @@ def generate_bffh_actorconnections(machines): actor_fullid = specs["actor_type"] + '_' + specs["actor_id"] if index == last: - data.append(space * 1 + extraspace + '{ ' + f'machine = "{specs["fa_id"]}", actor = "{actor_fullid}"' + ' }') + data.append(space * 1 + '{ ' + f'machine = "{specs["fa_id"]}", actor = "{actor_fullid}"' + ' }') else: - data.append(space * 1 + extraspace + '{ ' + f'machine = "{specs["fa_id"]}", actor = "{actor_fullid}"' + ' },') + data.append(space * 1 + '{ ' + f'machine = "{specs["fa_id"]}", actor = "{actor_fullid}"' + ' },') # Ende Datenstruktur - if settings["fa_dhall_create"] == False: - data.append(space + '],') - else: - data.append(']') + data.append(']') return data # CSV-Rollenliste -def generate_csv_roles(roles): +def create_roles_csv(roles): + + print('|- Rollenliste exportieren') + data = [] data.append('ID der Rolle; Name der Rolle') for id, values in roles.items(): string = id + ';' + values["name"] data.append(string) - return data + write_file('output/roles.csv', data) + + +# dhall-Dateien erzeugen + +def create_singledhall(export_roles, export_machines, export_actors, export_actorconnections): + print('|- Gesamten DHALL-Output exportieren') + + input = [export_roles, export_machines, export_actors, export_actorconnections] + + data = [] + + # Rollen + + index_input = 0 + + for i in input: + + match(index_input): + case 0: data.append('roles =') + case 1: data.append('machines =') + case 2: data.append('actors =') + case 3: data.append('export_actorconnections =') + + + last = len(input[index_input]) - 1 + for index_seg, (el) in enumerate(i): + + if index_seg == last: + data.append(el + ',') + else: + data.append(el) + + index_input += 1 + + + write_file('output/bffh-dhall-data.txt', data) + +def create_multipledhalls(export_roles, export_machines, export_actors, export_actorconnections): -# bffh.dhall aktualisieren + input = [export_roles, export_machines, export_actors, export_actorconnections] -def generate_bffh_dhall(generated_content): + fa_dhall_directory = settings["fa_dhall_directory"].replace('\\', '/') - dhall_file = settings["fa_dhall_file"] - reader = open(dhall_file, "r", encoding='utf-8') + print('|- Einzelne DHALLs exportieren') - data_write = [] + if fa_dhall_directory != '': + print(f'|- Ablegen der DHALL-Dateien in: "{fa_dhall_directory}"') - inside_generator_block = False - found_generator_block = False + index_input = 0 - count = 1 + for i in input: - # bffh.dhall zeilenweise durchlaufen - for line in reader: + match(index_input): + case 0: target_file = 'roles.dhall' + case 1: target_file = 'machines.dhall' + case 2: target_file = 'actors.dhall' + case 3: target_file = 'actorconnections.dhall' - # Beginn des Generator-Blocks gefunden --> Erzeugte Daten anhängen, Variablen umschalten - if 'GENERATOR START' in line: - found_generator_block = True - inside_generator_block = True - data_write.append(line.replace('\n', '')) - data_write.append(' ') - data_write += generated_content - data_write.append(' ') - added_generated_content = True - # print(f'{count} Generatorblock-Anfang gefunden') + print(f' |- Erzeuge {target_file}') - # Beginn des Generator-Blocks gefunden --> Variable umschalten - if 'GENERATOR END' in line: - inside_generator_block = False - # print(f'{count} Generatorblock-Ende gefunden') + # Im Output-Ordner + target = 'output/' + target_file + write_file(target, i) - # Zeile liegt außerhalb des Generator-Blocks --> Zeile übernehmen - if inside_generator_block == False: - data_write.append(line.replace('\n', '')) - # Zeile liegt innerhalb des Generator-Blocks --> Zeile übernehmen - if inside_generator_block == True: - # Einfügung wurden vorgenommen, Zeile aus bffh.dhall ignorieren - continue + # Im zusätzlichen Ordner + if fa_dhall_directory != '': + target = fa_dhall_directory + '/' + target_file + target = target.replace('//', '/') + write_file(target, i) - if found_generator_block == True: - return data_write - else: - print('Datei "bffh.dhall" enthält keinen Platzhalter zum automatischen Einfügen.') - return [] + index_input += 1 + + +def create_mermaid(machines): + print('|- Mermaid-Code erzeugen') + + graphelements = graph_create_elements(machines) + mermaidcode = graph_create_mermaidcode(graphelements) + + write_file('output/mermaid-code.txt', mermaidcode) # Maschine vollständig ausgeben diff --git a/generator/globals.py b/generator/globals.py index cb882b6..5bdb1ce 100644 --- a/generator/globals.py +++ b/generator/globals.py @@ -1,14 +1,7 @@ from generator.helpers import config_load from generator.helpers import load_actors -# Daten für Generator -settings = config_load('settings.ini', 'generator') -actor_library = load_actors('actors.ini') - -if settings["fa_dhall_create"] == False: - extraspace = '\t' -else: - extraspace = '' +# Icons für Mermaid-Code icon_admin = "👑" icon_manager = "🛠️" @@ -17,6 +10,7 @@ icon_user = "👷‍♂️" icon_custom = '👩‍🚀' +# Daten für den zentrale Rollen admin_global = { "id": "Admin", "name": "_Admin FabAccess", diff --git a/generator/helpers.py b/generator/helpers.py index 1764bdd..d0983ca 100644 --- a/generator/helpers.py +++ b/generator/helpers.py @@ -49,8 +49,16 @@ def list_join(my_list, insert): my_string = f'{insert}'.join(str(element) for element in my_list) return my_string +# CSV-Delimiter ermitteln +def csv_getdelimiter(file: str) -> str: + with open(file, 'r') as csvfile: + delimiter = str(csv.Sniffer().sniff(csvfile.read()).delimiter) + return delimiter + # CSV einlesen: Erzeugt eine Liste, die für jede Zeile ein Dictionary mit Header und Value ausgibt -def csv_listdict(filename, csv_delimiter, replacedict = {}): +def csv_listdict(filename, replacedict = {}): + + csv_delimiter = csv_getdelimiter(filename) csvfile = open(filename, 'r', encoding='utf-8-sig') tempfile = '' @@ -88,6 +96,7 @@ def csv_listdict(filename, csv_delimiter, replacedict = {}): return finaldata + # Datei schreiben def write_file(filename, content): f = open(filename, "w", encoding='utf-8', newline='\n') diff --git a/settings.ini b/settings.ini index 812de48..ccac7d1 100644 --- a/settings.ini +++ b/settings.ini @@ -3,9 +3,6 @@ ; Einstellung inkativ = False [generator] -; CSV-Trennzeichen. Bei Ververwendung des Kommas als Trennzeichen müssen Beschreibungstexte in Anführungszeichen gesetzt werden. -csv_delimiter = ; - ; Verwendung mehrer Domänen. Bei Verwendung mehrer Domänen werden wird für jede Domäne ein Manager erstellt multi_domains = False @@ -21,24 +18,9 @@ manager_area = False ; Spalte "Unterbereich Manager" der CSV beachten (True) der nicht (False). manager_subarea = False -; Automatisches Einfügen aller erzeugten Daten (Maschinen, Rolle, Aktoren, Aktor-Verbindungen) in die bffh.dhall -; Die Datei muss über Platzhalter verfügen, siehe Beispieldatei ( /docs/bffh-vorlage.dhall ) -fa_dhall_update = False - -; Pfad zur bffh.dall von FabAccess. Der Pfad muss vollständig sein und die bffh.dhall beinhalten. -; Beispiel: D:\FabAccess\config\bffh\bffh.dhall bzw. /home/fabaccess/bffh/bffh.dhall -fa_dhall_file = F:\fabaccess-docker\config\bffh\bffh.dhall - ; Erzeugt DHALL-Dateien für Rollen, Maschinen, Aktoren und Aktorenverbindungen -fa_dhall_create = True fa_dhall_directory = F:\fabaccess-docker\config\bffh\ -; Mermaid-Code erzeugen -generate_mermaid = True - -; Gesonderte Datei die eine Liste aller Rollen enthält -create_file_roles = True - ; Anzeige aller erzeugten Maschinendaten show_machines = False