From b53febad715a02e0bfc33c47651ea066766b0f5a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20P=C3=A4tzold?= <paetzold@itc.rwth-aachen.de> Date: Thu, 16 Jul 2020 13:39:42 +0200 Subject: [PATCH] Reorganisation der Ordnerstruktur --- {Demo => PesterTests}/MailAdm-Doku.Tests.ps1 | 0 {Demo => PesterTests}/connect.ps1 | 0 {Demo => PesterTests}/distributionlist.ps1 | 0 {Demo => PesterTests}/listquota.ps1 | 0 {Demo => PesterTests}/mailaccounts.ps1 | 0 PesterTests/readme.md | 27 ++++++++++++++++++++ readme.md | 18 +++---------- 7 files changed, 31 insertions(+), 14 deletions(-) rename {Demo => PesterTests}/MailAdm-Doku.Tests.ps1 (100%) rename {Demo => PesterTests}/connect.ps1 (100%) rename {Demo => PesterTests}/distributionlist.ps1 (100%) rename {Demo => PesterTests}/listquota.ps1 (100%) rename {Demo => PesterTests}/mailaccounts.ps1 (100%) create mode 100644 PesterTests/readme.md diff --git a/Demo/MailAdm-Doku.Tests.ps1 b/PesterTests/MailAdm-Doku.Tests.ps1 similarity index 100% rename from Demo/MailAdm-Doku.Tests.ps1 rename to PesterTests/MailAdm-Doku.Tests.ps1 diff --git a/Demo/connect.ps1 b/PesterTests/connect.ps1 similarity index 100% rename from Demo/connect.ps1 rename to PesterTests/connect.ps1 diff --git a/Demo/distributionlist.ps1 b/PesterTests/distributionlist.ps1 similarity index 100% rename from Demo/distributionlist.ps1 rename to PesterTests/distributionlist.ps1 diff --git a/Demo/listquota.ps1 b/PesterTests/listquota.ps1 similarity index 100% rename from Demo/listquota.ps1 rename to PesterTests/listquota.ps1 diff --git a/Demo/mailaccounts.ps1 b/PesterTests/mailaccounts.ps1 similarity index 100% rename from Demo/mailaccounts.ps1 rename to PesterTests/mailaccounts.ps1 diff --git a/PesterTests/readme.md b/PesterTests/readme.md new file mode 100644 index 0000000..b59733d --- /dev/null +++ b/PesterTests/readme.md @@ -0,0 +1,27 @@ +# Pester Tests für die MailAdm API + + +### Voraussetzungen + +Zur Nutzung der MailAdm API benötigen Sie einen Serviceaccount. Diesen können Sie anfordern, indem sie eine Mail an servicedesk@itc.rwth-aachen.de schicken. Derzeit ist unsere Schnittstelle mit der Windows Powershell 5.1 getestet. + +## Projektinhalt + +Das Projekt besteht aus dem Unerverzeichnis Demo, dass beispielhaft den in der API beritgestellten Funktionen zeigt. Hierbei beinhalten die einzelnen Datien folgende Themenblöcke: +1. connect.ps1 +- Verbindungsaufbau zur API +2. listquota.ps1 +- Funktionsaufrufe zur Verwaltung des Quotapool +3. mailaccounts.ps1 +- Funktionsaufrufe zur verwaltung von Mailadressen +4. distributionlist.ps1 +- Funktionsaufrufe zur Verwaltung von Verteilerlisten + +## Ausführung + +Im Verzeichnis PesterTests finden Sie entsprechende Unittests, um die Schnittstelle mit Ihrem Serviceaccount zu testen. Bitte passen Sie hierzu in der Datei MailAdm-Doku.Tests.ps1 den Bereich "connection settings" an. +Um die Tests zu starten, wechseln Sie mit in der Windows Powershell ins "Demo" Verzeichnis und starten Sie das Cmdlet invoke-pester + +## Autoren + +* **Thomas Pätzold** \ No newline at end of file diff --git a/readme.md b/readme.md index 77fd2f7..202ad72 100644 --- a/readme.md +++ b/readme.md @@ -4,26 +4,16 @@ Das IT Center der RWTH Aachen stellt den zentralen Mailserver bereit. Die Verwaltung der Mailadressen wird durch registrierte Ansprechpartner für die jeweiligen Einrichtungen (Maildomänen) über eine Web Application (MailAdm) vorgenommen. Um die Prozesse zur Pflege von Mailadressen in die internen Abläufe automatisch integrieren zu können, wird neben dem MailAdm auch eine entsprechende, auf SOAP basierende, API angeboten, so dass die Pflege der Mailadressen in die vorhandenen lokalen Prozesse der jeweiligen Einrichtung integriert werden kann. -### Voraussetzungen +## Voraussetzungen Zur Nutzung der MailAdm API benötigen Sie einen Serviceaccount. Diesen können Sie anfordern, indem sie eine Mail an servicedesk@itc.rwth-aachen.de schicken. Derzeit ist unsere Schnittstelle mit der Windows Powershell 5.1 getestet. -## Projektinhalt -Das Projekt besteht aus dem Unerverzeichnis Demo, dass beispielhaft den in der API beritgestellten Funktionen zeigt. Hierbei beinhalten die einzelnen Datien folgende Themenblöcke: -1. connect.ps1 -- Verbindungsaufbau zur API -2. listquota.ps1 -- Funktionsaufrufe zur Verwaltung des Quotapool -3. mailaccounts.ps1 -- Funktionsaufrufe zur verwaltung von Mailadressen -4. distributionlist.ps1 -- Funktionsaufrufe zur Verwaltung von Verteilerlisten +## Inhalt +### PesterTests - Dieses Verzeichnis beinhaltet die Wrapper Methoden der eigentlichen API Aufrufe die über ein zentrales Script verknüft sind, das entsprechende Unit Tests beinhaltet +### DemoAnwendung - Dieses Verzeichnis beinhalteet eine Demoanwendung, die die Stuerung der Maildomaenenkonfiguration über eine editierbare Excel Datei steuert. -## Ausführung -Im Verzeichnis Demo finden Sie entsprechende Unittests, um die Schnittstelle mit Ihrem Serviceaccount zu testen. Bitte passen Sie hierzu in der Datei MailAdm-Doku.Tests.ps1 den Bereich "connection settings" an. -Um die Tests zu starten, wechseln Sie mit in der Windows Powershell ins "Demo" Verzeichnis und starten Sie das Cmdlet invoke-pester ## Autoren -- GitLab