Merge ~roadmr/canonical-identity-provider:add-2fa-dev-creation-metrics into canonical-identity-provider:master

[Daniel Manrique]

Emit metrics when 2fa devices are added.

The metric includes the device type (automatically-added backup devices
have the fake "paper_auto" type) and subtype (for OATH devices which
can be TOTP or HOTP)

Emitted metrics look like flows.device.$DEVICE_TYPE.add.

Device types can be e.g. google_totp, google_hotp (and so on for oath devices), paper, paper_auto, for now.

[Maximiliano Bertacchini (maxiberta)]

LGTM!

review: Approve

diff --git a/src/webui/tests/test_views_devices.py b/src/webui/tests/test_views_devices.py
index 4c1586b..aadca90 100644
--- a/src/webui/tests/test_views_devices.py
+++ b/src/webui/tests/test_views_devices.py
@@ -50,6 +50,8 @@ class DeviceViewsTestCaseBase(AuthenticatedTestCase):
         self.switch_twofactor = switches(TWOFACTOR=True)
         self.switch_twofactor.patch()
         self.addCleanup(self.switch_twofactor.unpatch)
+        self.mock_increment = self.patch(
+            'webui.views.ui.stats.increment')
 
     def do_2fa_login(self, device):
         oath_token = self.factory.make_next_otp(device)
@@ -509,6 +511,11 @@ class DeviceAdditionViewTestCase(DeviceViewsTestCaseBase):
         )
         self.assertRedirects(response, redirect_to, status_code=303)
 
+        args_list = [
+            ((u'flows.device.generic_hotp',), {u'key': u'new'}),
+            ((u'flows.device.paper_auto',), {u'key': u'new'})]
+        self.assertEqual(self.mock_increment.call_args_list, args_list)
+
     # When the auto backup deviceflag is unset...
     @switches(TWOFACTOR_AUTO_BACKUP_DEVICE=False)
     def test_successful_post_generic_no_paper_no_auto_add(self):
@@ -521,6 +528,10 @@ class DeviceAdditionViewTestCase(DeviceViewsTestCaseBase):
         # Does not add a paper backup device
         self.assertEqual(devices.filter(device_type="paper").count(), 0)
 
+        args_list = [
+            ((u'flows.device.generic_hotp',), {u'key': u'new'})]
+        self.assertEqual(self.mock_increment.call_args_list, args_list)
+
     # When the auto backup deviceflag is set...
     @switches(TWOFACTOR_AUTO_BACKUP_DEVICE=True)
     def test_successful_post_generic_paper_no_add(self):
@@ -538,6 +549,13 @@ class DeviceAdditionViewTestCase(DeviceViewsTestCaseBase):
         # Does not add additional paper devices.
         self.assertEqual(devices.filter(device_type="paper").count(), 1)
 
+        # Args list changes a bit because we did an actual login
+        args_list = [
+            ((u'flows.login',), {u'rpconfig': None, u'key': u'success'}),
+            ((u'flows.2fa',), {u'rpconfig': None, u'key': u'success'}),
+            ((u'flows.device.generic_hotp',), {u'key': u'new'})]
+        self.assertEqual(self.mock_increment.call_args_list, args_list)
+
     # When the auto backup deviceflag is set...
     @switches(TWOFACTOR_AUTO_BACKUP_DEVICE=True)
     def test_successful_post_paper_main_no_add(self):
@@ -553,6 +571,10 @@ class DeviceAdditionViewTestCase(DeviceViewsTestCaseBase):
         # Does not add additional paper devices.
         self.assertEqual(devices.filter(device_type="paper").count(), 1)
 
+        args_list = [
+            ((u'flows.device.paper',), {u'key': u'new'})]
+        self.assertEqual(self.mock_increment.call_args_list, args_list)
+
     def test_unrecognised_type(self):
         data = {'type': 'foobar', 'hex_key': KEY, 'name': 'Some device',
                 'otp': 'some otp key'}
diff --git a/src/webui/views/devices.py b/src/webui/views/devices.py
index 3f7716b..c66a4a5 100644
--- a/src/webui/views/devices.py
+++ b/src/webui/views/devices.py
@@ -24,6 +24,7 @@ from identityprovider.forms import DeviceRenameForm, OATHDeviceForm
 from identityprovider.models import AuthenticationDevice
 from identityprovider.models import twofactor
 from identityprovider.models.twofactor import get_otp_type
+from identityprovider.stats import stats
 
 from webui.decorators import require_twofactor_enabled, sso_login_required
 from webui.views.const import (
@@ -187,7 +188,9 @@ def _device_addition_standard(request, device_type):
                             device_types['paper'],
                             request.user)
                         backup_device = _create_device(
-                            request, device_name, backup_hex_key, 0, 'paper')
+                            request, device_name, backup_hex_key, 0, 'paper',
+                            auto=True)
+
                         # If a device was auto-added, send to a nice page.
                         # Very similar to device-print view with some tweaks
                         # for auto-generated device.
@@ -222,20 +225,27 @@ def _device_addition_standard(request, device_type):
 
 
 def _create_device(
-        request, device_name, hex_key, counter, device_type, oath_type=None):
+        request, device_name, hex_key, counter, device_type, oath_type=None,
+        auto=False):
+
+    full_device_type = device_type + (
+            ':{}'.format(oath_type) if oath_type else '')
+    stats_device_type = (
+        "paper_auto" if device_type == 'paper' and auto else device_type) + (
+        '_{}'.format(oath_type) if oath_type else '')
     device = AuthenticationDevice.objects.create(
         account=request.user,
         name=device_name,
         key=hex_key,
         counter=counter,
-        device_type=device_type + (
-            ':{}'.format(oath_type) if oath_type else ''),
+        device_type=full_device_type,
     )
     twofactor.login(request)
     added_type = oath_type.upper() if oath_type else device_types[device_type]
     messages.success(
         request, DEVICE_ADDED.format(
             name=device_name, type=added_type), 'temporary')
+    stats.increment('flows.device.{}'.format(stats_device_type), key='new')
     return device