add support for specifying an entity type key/field without a pattern

src/dispatch/entity/service.py

@@ -194,6 +194,7 @@ def find_entities(
         >>> entity_types = [
         ...     EntityType(name="Name", field="name", regular_expression=r"\b[A-Z][a-z]+ [A-Z][a-z]+\b"),
         ...     EntityType(name="Phone", field=None, regular_expression=r"\b\\d{3}[-.]?\\d{3}[-.]?\\d{4}\b"),
+        ...     EntityType(name="Street", field="address.street"),
         ... ]
         >>> entities = find_entities(db_session, signal_instance, entity_types)
 
@@ -227,27 +228,33 @@ def _search(key, val, entity_type_pairs):
             for entity_type, entity_regex, field in entity_type_pairs:
                 # If a field was specified for this entity type, only search that field
                 if not field or key == field:
-                    # Search the string for matches to the entity type's regular expression
-                    if match := entity_regex.search(val):
-                        # If a match was found, create a new Entity object for it
+                    if entity_regex is None:
+                        # If no regular expression was specified, return the value of the field/key
                         entity = EntityCreate(
-                            value=match.group(0),
+                            value=val,
                             entity_type=entity_type,
                             project=signal_instance.project,
                         )
-                        # Add the entity to the list of entities found in this value
                         entities.append(entity)
+                    else:
+                        # Search the string for matches to the entity type's regular expression
+                        if match := entity_regex.search(val):
+                            entity = EntityCreate(
+                                value=match.group(0),
+                                entity_type=entity_type,
+                                project=signal_instance.project,
+                            )
+                            entities.append(entity)
 
         # Cache the entities found for this value
         cache[id(val)] = entities
-
         return entities
 
     # Create a list of (entity type, regular expression, field) tuples
     entity_type_pairs = [
-        (type, re.compile(type.regular_expression), type.field)
+        (type, re.compile(type.regular_expression) if type.regular_expression else None, type.field)
         for type in entity_types
-        if isinstance(type.regular_expression, str)
+        if isinstance(type.regular_expression, str) or type.field is not None
     ]
 
     # Initialize a cache of previously searched values

src/dispatch/static/dispatch/components.d.ts

@@ -3,104 +3,104 @@
 // Read more: https://github.com/vuejs/core/pull/3399
 export {}
 
-declare module "vue" {
+declare module 'vue' {
   export interface GlobalComponents {
-    AdminLayout: typeof import("./src/components/layouts/AdminLayout.vue")["default"]
-    AppDrawer: typeof import("./src/components/AppDrawer.vue")["default"]
-    AppToolbar: typeof import("./src/components/AppToolbar.vue")["default"]
-    BasicLayout: typeof import("./src/components/layouts/BasicLayout.vue")["default"]
-    ColorPickerInput: typeof import("./src/components/ColorPickerInput.vue")["default"]
-    DashboardLayout: typeof import("./src/components/layouts/DashboardLayout.vue")["default"]
-    DateTimePickerMenu: typeof import("./src/components/DateTimePickerMenu.vue")["default"]
-    DateWindowInput: typeof import("./src/components/DateWindowInput.vue")["default"]
-    DefaultLayout: typeof import("./src/components/layouts/DefaultLayout.vue")["default"]
-    InfoWidget: typeof import("./src/components/InfoWidget.vue")["default"]
-    Loading: typeof import("./src/components/Loading.vue")["default"]
-    NotificationSnackbarsWrapper: typeof import("./src/components/NotificationSnackbarsWrapper.vue")["default"]
-    PageHeader: typeof import("./src/components/PageHeader.vue")["default"]
-    Refresh: typeof import("./src/components/Refresh.vue")["default"]
-    RouterLink: typeof import("vue-router")["RouterLink"]
-    RouterView: typeof import("vue-router")["RouterView"]
-    SettingsBreadcrumbs: typeof import("./src/components/SettingsBreadcrumbs.vue")["default"]
-    StatWidget: typeof import("./src/components/StatWidget.vue")["default"]
-    VAlert: typeof import("vuetify/lib")["VAlert"]
-    VApp: typeof import("vuetify/lib")["VApp"]
-    VAppBar: typeof import("vuetify/lib")["VAppBar"]
-    VAutocomplete: typeof import("vuetify/lib")["VAutocomplete"]
-    VAvatar: typeof import("vuetify/lib")["VAvatar"]
-    VBadge: typeof import("vuetify/lib")["VBadge"]
-    VBottomSheet: typeof import("vuetify/lib")["VBottomSheet"]
-    VBreadcrumbs: typeof import("vuetify/lib")["VBreadcrumbs"]
-    VBreadcrumbsItem: typeof import("vuetify/lib")["VBreadcrumbsItem"]
-    VBtn: typeof import("vuetify/lib")["VBtn"]
-    VCard: typeof import("vuetify/lib")["VCard"]
-    VCardActions: typeof import("vuetify/lib")["VCardActions"]
+    AdminLayout: typeof import('./src/components/layouts/AdminLayout.vue')['default']
+    AppDrawer: typeof import('./src/components/AppDrawer.vue')['default']
+    AppToolbar: typeof import('./src/components/AppToolbar.vue')['default']
+    BasicLayout: typeof import('./src/components/layouts/BasicLayout.vue')['default']
+    ColorPickerInput: typeof import('./src/components/ColorPickerInput.vue')['default']
+    DashboardLayout: typeof import('./src/components/layouts/DashboardLayout.vue')['default']
+    DateTimePickerMenu: typeof import('./src/components/DateTimePickerMenu.vue')['default']
+    DateWindowInput: typeof import('./src/components/DateWindowInput.vue')['default']
+    DefaultLayout: typeof import('./src/components/layouts/DefaultLayout.vue')['default']
+    InfoWidget: typeof import('./src/components/InfoWidget.vue')['default']
+    Loading: typeof import('./src/components/Loading.vue')['default']
+    NotificationSnackbarsWrapper: typeof import('./src/components/NotificationSnackbarsWrapper.vue')['default']
+    PageHeader: typeof import('./src/components/PageHeader.vue')['default']
+    Refresh: typeof import('./src/components/Refresh.vue')['default']
+    RouterLink: typeof import('vue-router')['RouterLink']
+    RouterView: typeof import('vue-router')['RouterView']
+    SettingsBreadcrumbs: typeof import('./src/components/SettingsBreadcrumbs.vue')['default']
+    StatWidget: typeof import('./src/components/StatWidget.vue')['default']
+    VAlert: typeof import('vuetify/lib')['VAlert']
+    VApp: typeof import('vuetify/lib')['VApp']
+    VAppBar: typeof import('vuetify/lib')['VAppBar']
+    VAutocomplete: typeof import('vuetify/lib')['VAutocomplete']
+    VAvatar: typeof import('vuetify/lib')['VAvatar']
+    VBadge: typeof import('vuetify/lib')['VBadge']
+    VBottomSheet: typeof import('vuetify/lib')['VBottomSheet']
+    VBreadcrumbs: typeof import('vuetify/lib')['VBreadcrumbs']
+    VBreadcrumbsItem: typeof import('vuetify/lib')['VBreadcrumbsItem']
+    VBtn: typeof import('vuetify/lib')['VBtn']
+    VCard: typeof import('vuetify/lib')['VCard']
+    VCardActions: typeof import('vuetify/lib')['VCardActions']
     VCardSubtitle: typeof import("vuetify/lib")["VCardSubtitle"]
-    VCardText: typeof import("vuetify/lib")["VCardText"]
-    VCardTitle: typeof import("vuetify/lib")["VCardTitle"]
-    VCheckbox: typeof import("vuetify/lib")["VCheckbox"]
-    VChip: typeof import("vuetify/lib")["VChip"]
+    VCardText: typeof import('vuetify/lib')['VCardText']
+    VCardTitle: typeof import('vuetify/lib')['VCardTitle']
+    VCheckbox: typeof import('vuetify/lib')['VCheckbox']
+    VChip: typeof import('vuetify/lib')['VChip']
     VChipGroup: typeof import("vuetify/lib")["VChipGroup"]
-    VCol: typeof import("vuetify/lib")["VCol"]
-    VColorPicker: typeof import("vuetify/lib")["VColorPicker"]
-    VCombobox: typeof import("vuetify/lib")["VCombobox"]
-    VContainer: typeof import("vuetify/lib")["VContainer"]
-    VDataTable: typeof import("vuetify/lib")["VDataTable"]
-    VDatePicker: typeof import("vuetify/lib")["VDatePicker"]
-    VDialog: typeof import("vuetify/lib")["VDialog"]
-    VDivider: typeof import("vuetify/lib")["VDivider"]
+    VCol: typeof import('vuetify/lib')['VCol']
+    VColorPicker: typeof import('vuetify/lib')['VColorPicker']
+    VCombobox: typeof import('vuetify/lib')['VCombobox']
+    VContainer: typeof import('vuetify/lib')['VContainer']
+    VDataTable: typeof import('vuetify/lib')['VDataTable']
+    VDatePicker: typeof import('vuetify/lib')['VDatePicker']
+    VDialog: typeof import('vuetify/lib')['VDialog']
+    VDivider: typeof import('vuetify/lib')['VDivider']
     VExpansionPanel: typeof import("vuetify/lib")["VExpansionPanel"]
     VExpansionPanelContent: typeof import("vuetify/lib")["VExpansionPanelContent"]
     VExpansionPanelHeader: typeof import("vuetify/lib")["VExpansionPanelHeader"]
     VExpansionPanels: typeof import("vuetify/lib")["VExpansionPanels"]
-    VFlex: typeof import("vuetify/lib")["VFlex"]
-    VForm: typeof import("vuetify/lib")["VForm"]
-    VHover: typeof import("vuetify/lib")["VHover"]
-    VIcon: typeof import("vuetify/lib")["VIcon"]
+    VFlex: typeof import('vuetify/lib')['VFlex']
+    VForm: typeof import('vuetify/lib')['VForm']
+    VHover: typeof import('vuetify/lib')['VHover']
+    VIcon: typeof import('vuetify/lib')['VIcon']
     VItem: typeof import("vuetify/lib")["VItem"]
-    VLayout: typeof import("vuetify/lib")["VLayout"]
-    VList: typeof import("vuetify/lib")["VList"]
+    VLayout: typeof import('vuetify/lib')['VLayout']
+    VList: typeof import('vuetify/lib')['VList']
     VListGroup: typeof import("vuetify/lib")["VListGroup"]
-    VListItem: typeof import("vuetify/lib")["VListItem"]
-    VListItemAction: typeof import("vuetify/lib")["VListItemAction"]
-    VListItemAvatar: typeof import("vuetify/lib")["VListItemAvatar"]
-    VListItemContent: typeof import("vuetify/lib")["VListItemContent"]
-    VListItemGroup: typeof import("vuetify/lib")["VListItemGroup"]
-    VListItemIcon: typeof import("vuetify/lib")["VListItemIcon"]
-    VListItemSubtitle: typeof import("vuetify/lib")["VListItemSubtitle"]
-    VListItemTitle: typeof import("vuetify/lib")["VListItemTitle"]
-    VMain: typeof import("vuetify/lib")["VMain"]
-    VMenu: typeof import("vuetify/lib")["VMenu"]
-    VNavigationDrawer: typeof import("vuetify/lib")["VNavigationDrawer"]
-    VProgressLinear: typeof import("vuetify/lib")["VProgressLinear"]
+    VListItem: typeof import('vuetify/lib')['VListItem']
+    VListItemAction: typeof import('vuetify/lib')['VListItemAction']
+    VListItemAvatar: typeof import('vuetify/lib')['VListItemAvatar']
+    VListItemContent: typeof import('vuetify/lib')['VListItemContent']
+    VListItemGroup: typeof import('vuetify/lib')['VListItemGroup']
+    VListItemIcon: typeof import('vuetify/lib')['VListItemIcon']
+    VListItemSubtitle: typeof import('vuetify/lib')['VListItemSubtitle']
+    VListItemTitle: typeof import('vuetify/lib')['VListItemTitle']
+    VMain: typeof import('vuetify/lib')['VMain']
+    VMenu: typeof import('vuetify/lib')['VMenu']
+    VNavigationDrawer: typeof import('vuetify/lib')['VNavigationDrawer']
+    VProgressLinear: typeof import('vuetify/lib')['VProgressLinear']
     VRadio: typeof import("vuetify/lib")["VRadio"]
     VRadioGroup: typeof import("vuetify/lib")["VRadioGroup"]
-    VRow: typeof import("vuetify/lib")["VRow"]
-    VSelect: typeof import("vuetify/lib")["VSelect"]
-    VSimpleCheckbox: typeof import("vuetify/lib")["VSimpleCheckbox"]
-    VSnackbar: typeof import("vuetify/lib")["VSnackbar"]
-    VSpacer: typeof import("vuetify/lib")["VSpacer"]
-    VStepper: typeof import("vuetify/lib")["VStepper"]
-    VStepperContent: typeof import("vuetify/lib")["VStepperContent"]
-    VStepperHeader: typeof import("vuetify/lib")["VStepperHeader"]
-    VStepperItems: typeof import("vuetify/lib")["VStepperItems"]
-    VStepperStep: typeof import("vuetify/lib")["VStepperStep"]
-    VSubheader: typeof import("vuetify/lib")["VSubheader"]
-    VSwitch: typeof import("vuetify/lib")["VSwitch"]
-    VSystemBar: typeof import("vuetify/lib")["VSystemBar"]
-    VTab: typeof import("vuetify/lib")["VTab"]
-    VTabItem: typeof import("vuetify/lib")["VTabItem"]
-    VTabs: typeof import("vuetify/lib")["VTabs"]
-    VTabsItems: typeof import("vuetify/lib")["VTabsItems"]
+    VRow: typeof import('vuetify/lib')['VRow']
+    VSelect: typeof import('vuetify/lib')['VSelect']
+    VSimpleCheckbox: typeof import('vuetify/lib')['VSimpleCheckbox']
+    VSnackbar: typeof import('vuetify/lib')['VSnackbar']
+    VSpacer: typeof import('vuetify/lib')['VSpacer']
+    VStepper: typeof import('vuetify/lib')['VStepper']
+    VStepperContent: typeof import('vuetify/lib')['VStepperContent']
+    VStepperHeader: typeof import('vuetify/lib')['VStepperHeader']
+    VStepperItems: typeof import('vuetify/lib')['VStepperItems']
+    VStepperStep: typeof import('vuetify/lib')['VStepperStep']
+    VSubheader: typeof import('vuetify/lib')['VSubheader']
+    VSwitch: typeof import('vuetify/lib')['VSwitch']
+    VSystemBar: typeof import('vuetify/lib')['VSystemBar']
+    VTab: typeof import('vuetify/lib')['VTab']
+    VTabItem: typeof import('vuetify/lib')['VTabItem']
+    VTabs: typeof import('vuetify/lib')['VTabs']
+    VTabsItems: typeof import('vuetify/lib')['VTabsItems']
     VTabsSlider: typeof import("vuetify/lib")["VTabsSlider"]
-    VTextarea: typeof import("vuetify/lib")["VTextarea"]
-    VTextField: typeof import("vuetify/lib")["VTextField"]
-    VTimeline: typeof import("vuetify/lib")["VTimeline"]
-    VTimelineItem: typeof import("vuetify/lib")["VTimelineItem"]
-    VTimePicker: typeof import("vuetify/lib")["VTimePicker"]
+    VTextarea: typeof import('vuetify/lib')['VTextarea']
+    VTextField: typeof import('vuetify/lib')['VTextField']
+    VTimeline: typeof import('vuetify/lib')['VTimeline']
+    VTimelineItem: typeof import('vuetify/lib')['VTimelineItem']
+    VTimePicker: typeof import('vuetify/lib')['VTimePicker']
     VToolbar: typeof import("vuetify/lib")["VToolbar"]
-    VToolbarItems: typeof import("vuetify/lib")["VToolbarItems"]
-    VToolbarTitle: typeof import("vuetify/lib")["VToolbarTitle"]
-    VTooltip: typeof import("vuetify/lib")["VTooltip"]
+    VToolbarItems: typeof import('vuetify/lib')['VToolbarItems']
+    VToolbarTitle: typeof import('vuetify/lib')['VToolbarTitle']
+    VTooltip: typeof import('vuetify/lib')['VTooltip']
   }
 }

src/dispatch/static/dispatch/src/entity_type/NewEditSheet.vue

@@ -66,7 +66,6 @@
                     :success="valid"
                     hint="A regular expression pattern for your entity type. Multiple capture groups are not supported, the first group will be used."
                     clearable
-                    required
                   />
                 </ValidationProvider>
               </v-flex>

tests/conftest.py

@@ -35,6 +35,7 @@
     DefinitionFactory,
     DocumentFactory,
     EventFactory,
+    EntityTypeFactory,
     FeedbackFactory,
     GroupFactory,
     IncidentCostFactory,
@@ -56,6 +57,7 @@
     ReportFactory,
     SearchFilterFactory,
     ServiceFactory,
+    SignalInstanceFactory,
     StorageFactory,
     TagFactory,
     TagTypeFactory,
@@ -414,6 +416,21 @@ def reports(session):
     return [ReportFactory(), ReportFactory()]
 
 
+@pytest.fixture()
+def entity_type(session):
+    return EntityTypeFactory()
+
+
+@pytest.fixture()
+def entity_types(session):
+    return [EntityTypeFactory(), EntityTypeFactory()]
+
+
+@pytest.fixture()
+def signal_instance(session):
+    return SignalInstanceFactory()
+
+
 @pytest.fixture
 def storage(session):
     return StorageFactory()

tests/entity/test_entity_service.py

@@ -0,0 +1,76 @@
+from dispatch.entity_type.models import EntityType
+from dispatch.entity import service as entity_service
+
+
+def test_find_entities_with_field_and_regex(session, signal_instance, project):
+    signal_instance = _setup_project(
+        session=session, signal_instance=signal_instance, project=project
+    )
+
+    entity_types = [
+        EntityType(
+            name="AWS IAM Role ARN",
+            field="id",
+            regular_expression=r"^arn:aws:iam::\d{12}:role\/[a-zA-Z_0-9+=,.@\-_/]+$",
+            project=project,
+        ),
+    ]
+    entities = entity_service.find_entities(session, signal_instance, entity_types)
+    assert len(entities) == 1
+
+
+def test_find_entities_with_regex_only(session, signal_instance, project):
+    signal_instance = _setup_project(
+        session=session, signal_instance=signal_instance, project=project
+    )
+
+    entity_types = [
+        EntityType(
+            name="AWS IAM Role ARN",
+            field=None,
+            regular_expression=r"^arn:aws:iam::\d{12}:role\/[a-zA-Z_0-9+=,.@\-_/]+$",
+            project=project,
+        ),
+    ]
+    entities = entity_service.find_entities(session, signal_instance, entity_types)
+    assert len(entities) == 1
+
+
+def test_find_entities_with_field_only(session, signal_instance, project):
+    signal_instance = _setup_project(
+        session=session, signal_instance=signal_instance, project=project
+    )
+
+    entity_types = [
+        EntityType(
+            name="AWS IAM Role ARN",
+            field="id",
+            regular_expression=None,
+            project=project,
+        ),
+    ]
+    entities = entity_service.find_entities(session, signal_instance, entity_types)
+    assert len(entities) == 3
+
+
+def test_find_entities_with_no_regex_or_field(session, signal_instance, project):
+    signal_instance = _setup_project(
+        session=session, signal_instance=signal_instance, project=project
+    )
+    entity_types = [
+        EntityType(
+            name="AWS IAM Role ARN",
+            field=None,
+            regular_expression=None,
+            project=project,
+        ),
+    ]
+    entities = entity_service.find_entities(session, signal_instance, entity_types)
+    assert len(entities) == 0
+
+
+def _setup_project(session, signal_instance, project):
+    signal_instance.project = project
+    session.add(signal_instance)
+    session.commit()
+    return signal_instance