Add iCal parsing to GTT (for EXA related maintenance) (#273)

aliex-13 · web-flow · commit 956c04945fc1 · 2024-03-15T08:54:50.000+01:00
* Add new EXA parser to separate from GTT

* Add iCal parser to GTT and remove EXA

* Fix linter issue

* Update ical include_filter GTT

* Fix linter issues
diff --git a/circuit_maintenance_parser/provider.py b/circuit_maintenance_parser/provider.py
@@ -307,10 +307,13 @@ class GTT(GenericProvider):
     """EXA (formerly GTT) provider custom class."""
 
     # "Planned Work Notification", "Emergency Work Notification"
-    _include_filter = PrivateAttr({EMAIL_HEADER_SUBJECT: ["Work Notification"]})
+    _include_filter = PrivateAttr(
+        {"Icalendar": ["BEGIN"], "ical": ["BEGIN"], EMAIL_HEADER_SUBJECT: ["Work Notification"]}
+    )
 
     _processors: List[GenericProcessor] = PrivateAttr(
         [
+            SimpleProcessor(data_parsers=[ICal]),
             CombinedProcessor(data_parsers=[EmailDateParser, HtmlParserGTT1]),
         ]
     )
diff --git a/tests/unit/data/gtt/gtt8 b/tests/unit/data/gtt/gtt8
@@ -0,0 +1,21 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:EXA
+BEGIN:VEVENT
+UID:00123456
+DTSTART;VALUE=DATE-TIME:20240306T190000Z
+SEQUENCE:1
+TRANSP:OPAQUE
+DTEND;VALUE=DATE-TIME:20240307T060000Z
+SUMMARY:EXA TT#(00123456)\ Planned Work
+CLASS:PUBLIC
+ORGANIZER;CN="EXAInfra":mailto:akanksha.ambastha@exainfra.net
+DTSTAMP;VALUE=DATE-TIME:20240208T000000Z
+X-MAINTNOTE-PROVIDER:EXA Infrastructure 
+X-MAINTNOTE-ACCOUNT:Test Account
+X-MAINTNOTE-MAINTENANCE-ID:00123456
+X-MAINTNOTE-OBJECT-ID:TEST/WAVE/123456
+X-MAINTNOTE-IMPACT:OUTAGE
+X-MAINTNOTE-STATUS:CONFIRMED
+END:VEVENT
+END:VCALENDAR
diff --git a/tests/unit/data/gtt/gtt8_result.json b/tests/unit/data/gtt/gtt8_result.json
@@ -0,0 +1,21 @@
+[
+    {
+        "account": "Test Account",
+        "circuits": [
+          {
+            "circuit_id": "TEST/WAVE/123456",
+            "impact": "OUTAGE"
+          }
+        ],
+        "end": 1709791200,
+        "maintenance_id": "00123456",
+        "organizer": "mailto:akanksha.ambastha@exainfra.net",
+        "provider": "EXA Infrastructure ",
+        "sequence": 1,
+        "stamp": 1707350400,
+        "start": 1709751600,
+        "status": "CONFIRMED",
+        "summary": "EXA TT#(00123456)\\ Planned Work",
+        "uid": "00123456"
+    }
+]
diff --git a/tests/unit/data/gtt/gtt9 b/tests/unit/data/gtt/gtt9
@@ -0,0 +1,21 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:EXA
+BEGIN:VEVENT
+UID:00223456
+DTSTART;VALUE=DATE-TIME:20240306T190000Z
+SEQUENCE:1
+TRANSP:OPAQUE
+DTEND;VALUE=DATE-TIME:20240307T060000Z
+SUMMARY:EXA TT#(00223456)\ Planned Work
+CLASS:PUBLIC
+ORGANIZER;CN="EXAInfra":mailto:akanksha.ambastha@exainfra.net
+DTSTAMP;VALUE=DATE-TIME:20240208T000000Z
+X-MAINTNOTE-PROVIDER:EXA Infrastructure 
+X-MAINTNOTE-ACCOUNT:Test Account
+X-MAINTNOTE-MAINTENANCE-ID:00223456
+X-MAINTNOTE-OBJECT-ID:TEST/WAVE/123456
+X-MAINTNOTE-IMPACT:OUTAGE
+X-MAINTNOTE-STATUS:CONFIRMED
+END:VEVENT
+END:VCALENDAR
diff --git a/tests/unit/data/gtt/gtt9_result.json b/tests/unit/data/gtt/gtt9_result.json
@@ -0,0 +1,21 @@
+[
+    {
+        "account": "Test Account",
+        "circuits": [
+          {
+            "circuit_id": "TEST/WAVE/123456",
+            "impact": "OUTAGE"
+          }
+        ],
+        "end": 1709791200,
+        "maintenance_id": "00223456",
+        "organizer": "mailto:akanksha.ambastha@exainfra.net",
+        "provider": "EXA Infrastructure ",
+        "sequence": 1,
+        "stamp": 1707350400,
+        "start": 1709751600,
+        "status": "CONFIRMED",
+        "summary": "EXA TT#(00223456)\\ Planned Work",
+        "uid": "00223456"
+    }
+]
diff --git a/tests/unit/test_e2e.py b/tests/unit/test_e2e.py
@@ -411,6 +411,24 @@
                 Path(dir_path, "data", "gtt", "gtt7_result.json"),
             ],
         ),
+        (
+            GTT,
+            [
+                ("ical", Path(dir_path, "data", "gtt", "gtt8")),
+            ],
+            [
+                Path(dir_path, "data", "gtt", "gtt8_result.json"),
+            ],
+        ),
+        (
+            GTT,
+            [
+                ("ical", Path(dir_path, "data", "gtt", "gtt9")),
+            ],
+            [
+                Path(dir_path, "data", "gtt", "gtt9_result.json"),
+            ],
+        ),
         # HGC
         (
             HGC,
diff --git a/tests/unit/test_parsers.py b/tests/unit/test_parsers.py
@@ -366,6 +366,16 @@ def default(self, o):
             Path(dir_path, "data", "gtt", "gtt7.eml"),
             Path(dir_path, "data", "gtt", "gtt7_html_parser_result.json"),
         ),
+        (
+            ICal,
+            Path(dir_path, "data", "gtt", "gtt8"),
+            Path(dir_path, "data", "gtt", "gtt8_result.json"),
+        ),
+        (
+            ICal,
+            Path(dir_path, "data", "gtt", "gtt9"),
+            Path(dir_path, "data", "gtt", "gtt9_result.json"),
+        ),
         # HGC
         (
             HtmlParserHGC1,

Original file line number	Diff line number	Diff line change
`@@ -307,10 +307,13 @@ class GTT(GenericProvider):`
`307`	`307`	`"""EXA (formerly GTT) provider custom class."""`
`308`	`308`
`309`	`309`	`# "Planned Work Notification", "Emergency Work Notification"`
`310`		`- _include_filter = PrivateAttr({EMAIL_HEADER_SUBJECT: ["Work Notification"]})`
	`310`	`+ _include_filter = PrivateAttr(`
	`311`	`+ {"Icalendar": ["BEGIN"], "ical": ["BEGIN"], EMAIL_HEADER_SUBJECT: ["Work Notification"]}`
	`312`	`+ )`
`311`	`313`
`312`	`314`	`_processors: List[GenericProcessor] = PrivateAttr(`
`313`	`315`	`[`
	`316`	`+ SimpleProcessor(data_parsers=[ICal]),`
`314`	`317`	`CombinedProcessor(data_parsers=[EmailDateParser, HtmlParserGTT1]),`
`315`	`318`	`]`
`316`	`319`	`)`