Refactored token parsing for YAML config (#599)

test/test_plugin_opsgenie.py

@@ -22,7 +22,10 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
-from apprise import plugins
+import mock
+import requests
+from apprise.plugins.NotifyOpsgenie import OpsgeniePriority
+import apprise
 from helpers import AppriseURLTester
 
 # Disable logging for a cleaner testing output
@@ -52,72 +55,72 @@ apprise_url_tests = (
     }),
     ('opsgenie://apikey/', {
         # No targets specified; this is allowed
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
     }),
     ('opsgenie://apikey/user', {
         # Valid user
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
         'privacy_url': 'opsgenie://a...y/%40user',
     }),
     ('opsgenie://apikey/@user?region=eu', {
         # European Region
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
     }),
     ('opsgenie://apikey/@user?entity=A%20Entity', {
         # Assign an entity
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
     }),
     ('opsgenie://apikey/@user?alias=An%20Alias', {
         # Assign an alias
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
     }),
     ('opsgenie://apikey/@user?priority=p3', {
         # Assign our priority
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
     }),
     ('opsgenie://apikey/?tags=comma,separated', {
         # Test our our 'tags' (tag is reserved in Apprise) but not 'tags'
         # Also test the fact we do not need to define a target
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
     }),
     ('opsgenie://apikey/@user?priority=invalid', {
         # Invalid priority (loads using default)
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
     }),
     ('opsgenie://apikey/user@email.com/#team/*sche/^esc/%20/a', {
         # Valid user (email), valid schedule, Escalated ID,
         # an invalid entry (%20), and too short of an entry (a)
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
     }),
     ('opsgenie://apikey/{}/@{}/#{}/*{}/^{}/'.format(
         UUID4, UUID4, UUID4, UUID4, UUID4), {
         # similar to the above, except we use the UUID's
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
     }),
     ('opsgenie://apikey?to=#team,user&+key=value&+type=override', {
         # Test to= and details (key/value pair) also override 'type'
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
     }),
     ('opsgenie://apikey/#team/@user/?batch=yes', {
         # Test batch=
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
     }),
     ('opsgenie://apikey/#team/@user/?batch=no', {
         # Test batch=
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
     }),
     ('opsgenie://?apikey=abc&to=user', {
         # Test Kwargs
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
     }),
     ('opsgenie://apikey/#team/user/', {
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
         # throw a bizzare code forcing us to fail to look it up
         'response': False,
         'requests_response_code': 999,
     }),
     ('opsgenie://apikey/#topic1/device/', {
-        'instance': plugins.NotifyOpsgenie,
+        'instance': apprise.plugins.NotifyOpsgenie,
         # Throws a series of connection and transfer exceptions when this flag
         # is set and tests that we gracfully handle them
         'test_requests_exceptions': True,
@@ -131,5 +134,80 @@ def test_plugin_opsgenie_urls():
 
     """
 
+    # Disable Throttling to speed testing
+    apprise.plugins.NotifyOpsgenie.request_rate_per_sec = 0
+
     # Run our general tests
     AppriseURLTester(tests=apprise_url_tests).run_all()
+
+
+@mock.patch('requests.post')
+def test_plugin_opsgenie_config_files(mock_post):
+    """
+    NotifyOpsgenie() Config File Cases
+    """
+    content = """
+    urls:
+      - opsgenie://apikey/user:
+          - priority: 1
+            tag: opsgenie_int low
+          - priority: "1"
+            tag: opsgenie_str_int low
+          - priority: "p1"
+            tag: opsgenie_pstr_int low
+          - priority: low
+            tag: opsgenie_str low
+
+          # This will take on moderate (default) priority
+          - priority: invalid
+            tag: opsgenie_invalid
+
+      - opsgenie://apikey2/user2:
+          - priority: 5
+            tag: opsgenie_int emerg
+          - priority: "5"
+            tag: opsgenie_str_int emerg
+          - priority: "p5"
+            tag: opsgenie_pstr_int emerg
+          - priority: emergency
+            tag: opsgenie_str emerg
+    """
+
+    # Disable Throttling to speed testing
+    apprise.plugins.NotifyOpsgenie.request_rate_per_sec = 0
+
+    # Prepare Mock
+    mock_post.return_value = requests.Request()
+    mock_post.return_value.status_code = requests.codes.ok
+
+    # Create ourselves a config object
+    ac = apprise.AppriseConfig()
+    assert ac.add_config(content=content) is True
+
+    aobj = apprise.Apprise()
+
+    # Add our configuration
+    aobj.add(ac)
+
+    # We should be able to read our 9 servers from that
+    # 4x low
+    # 4x emerg
+    # 1x invalid (so takes on normal priority)
+    assert len(ac.servers()) == 9
+    assert len(aobj) == 9
+    assert len([x for x in aobj.find(tag='low')]) == 4
+    for s in aobj.find(tag='low'):
+        assert s.priority == OpsgeniePriority.LOW
+
+    assert len([x for x in aobj.find(tag='emerg')]) == 4
+    for s in aobj.find(tag='emerg'):
+        assert s.priority == OpsgeniePriority.EMERGENCY
+
+    assert len([x for x in aobj.find(tag='opsgenie_str')]) == 2
+    assert len([x for x in aobj.find(tag='opsgenie_str_int')]) == 2
+    assert len([x for x in aobj.find(tag='opsgenie_pstr_int')]) == 2
+    assert len([x for x in aobj.find(tag='opsgenie_int')]) == 2
+
+    assert len([x for x in aobj.find(tag='opsgenie_invalid')]) == 1
+    assert next(aobj.find(tag='opsgenie_invalid')).priority == \
+        OpsgeniePriority.NORMAL