Merge pull request #1657 from caberos/issue1654

add firewall monitoring command

Author: allmightyspiff

SoftLayer/CLI/firewall/monitoring.py

@@ -0,0 +1,51 @@
+"""Get monitoring for a firewall device."""
+# :license: MIT, see LICENSE for more details.
+import datetime
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+
+
+@click.command(cls=SoftLayer.CLI.command.SLCommand, )
+@click.argument('identifier')
+@environment.pass_env
+def cli(env, identifier):
+    """Gets bandwidth details for a firewall from the past 30 days."""
+
+    mgr = SoftLayer.FirewallManager(env.client)
+
+    _firewall = mgr.get_instance(identifier)
+
+    table = formatting.KeyValueTable(['name', 'value'])
+    table.align['name'] = 'r'
+    table.align['value'] = 'l'
+
+    end = datetime.date.today()
+    start = end.replace(day=1)
+    last_month = start - datetime.timedelta(days=30)
+
+    monitoring = mgr.get_summary(_firewall['metricTrackingObject']['id'],
+                                 last_month.strftime('%Y-%m-%d'), end.strftime('%Y-%m-%d'))
+    public_out = 0
+    public_in = 0
+    for monitor in monitoring:
+
+        if monitor['type'] == 'publicOut_net_octet':
+            public_out += monitor['counter']
+
+        if monitor['type'] == 'publicIn_net_octet':
+            public_in += monitor['counter']
+
+    table.add_row(['Id', _firewall.get('id')])
+    table.add_row(['Name', _firewall['networkGateway']['name']])
+    table.add_row(['Stard Date', last_month.strftime('%Y-%m-%d')])
+    table.add_row(['End Date', end.strftime('%Y-%m-%d')])
+    table.add_row(['Out', formatting.b_to_gb(public_out)])
+    table.add_row(['In', formatting.b_to_gb(public_in)])
+    table.add_row(['Total', formatting.b_to_gb(public_out + public_in)])
+    table.add_row(['Status', _firewall['networkGateway']['status']['name']])
+
+    env.fout(table)

SoftLayer/CLI/routes.py

@@ -180,6 +180,7 @@
     ('firewall:detail', 'SoftLayer.CLI.firewall.detail:cli'),
     ('firewall:edit', 'SoftLayer.CLI.firewall.edit:cli'),
     ('firewall:list', 'SoftLayer.CLI.firewall.list:cli'),
+    ('firewall:monitoring', 'SoftLayer.CLI.firewall.monitoring:cli'),
 
     ('globalip', 'SoftLayer.CLI.globalip'),
     ('globalip:assign', 'SoftLayer.CLI.globalip.assign:cli'),

SoftLayer/fixtures/SoftLayer_Network_Vlan_Firewall.py

@@ -174,6 +174,12 @@
             "modifyDate": "2022-05-17T14:00:42-06:00",
             "primarySubnetId": 2623338,
             "vlanNumber": 1255
+        },
+        "status": {
+            "description": "Gateway is ready to accept commands and actions",
+            "id": 1,
+            "keyName": "ACTIVE",
+            "name": "Active"
         }
     },
     "rules": [
@@ -212,7 +218,16 @@
             'action': 'permit',
             'sourceIpAddress': '0.0.0.0'
         }
-    ]
+    ],
+    "metricTrackingObject": {
+        "id": 147258369,
+        "resourceTableId": 17438,
+        "startDate": "2022-05-17T14:01:48-06:00",
+        "type": {
+            "keyname": "FIREWALL_CONTEXT",
+            "name": "Firewall Module Context"
+        }
+    }
 
 }
 

SoftLayer/managers/firewall.py

@@ -297,8 +297,9 @@ def get_instance(self, firewall_id, mask=None):
         :param integer firewall_id: the instance ID of the standard firewall
         """
         if not mask:
-            mask = 'mask[firewallType,networkGateway[insideVlans,members,privateIpAddress,publicIpAddress,' \
-                   'publicIpv6Address,privateVlan,publicVlan],datacenter,managementCredentials,networkVlan]'
+            mask = 'mask[firewallType,datacenter,managementCredentials,networkVlan,' \
+                   'metricTrackingObject[data,type],networkGateway[insideVlans,members,privateIpAddress,' \
+                   'publicIpAddress,publicIpv6Address,privateVlan,publicVlan,status]]'
 
         svc = self.client['Network_Vlan_Firewall']
 
@@ -319,3 +320,20 @@ def get_firewalls_gatewalls(self):
         _filter = {"networkGateways": {"networkFirewall": {"operation": "not null"}}}
 
         return self.account.getNetworkGateways(mask=mask, filter=_filter)
+
+    def get_summary(self, identifier, start_date, end_date):
+        """Returns the metric data for the date range provided
+
+        :param integer metric_tracking_id
+        """
+        body = [{
+            "keyName": "PUBLICIN",
+            "summaryType": "sum"
+
+        }, {
+            "keyName": "PUBLICOUT",
+            "summaryType": "sum"
+        }]
+
+        return self.client['Metric_Tracking_Object'].getSummaryData(start_date,
+                                                                    end_date, body, 86400, id=identifier)

docs/cli/firewall.rst

@@ -22,3 +22,7 @@ Firewall Management
 .. click:: SoftLayer.CLI.firewall.list:cli
     :prog: firewall list
     :show-nested:
+
+.. click:: SoftLayer.CLI.firewall.monitoring:cli
+    :prog: firewall monitoring
+    :show-nested:

tests/CLI/modules/firewall_tests.py

@@ -154,3 +154,7 @@ def test_edit(self, confirm_mock):
         confirm_mock.return_value = True
         result = self.run_command(['firewall', 'edit', 'vlan:1234'])
         print(result.output)
+
+    def test_monitoring(self):
+        result = self.run_command(['firewall', 'monitoring', '123456'])
+        print(result.output)

tests/managers/firewall_tests.py

@@ -46,7 +46,6 @@ def test_get_standard_fwl_rules(self):
                                 identifier=1234)
 
     def test_get_dedicated_fwl_rules(self):
-
         rules = self.firewall.get_dedicated_fwl_rules(1234)
 
         self.assertEqual(rules,