Merge branch 'develop' into 2921-tags-select2

docs/development/release-checklist.md

@@ -33,6 +33,10 @@ Update the following static libraries to their most recent stable release:
 * jQuery
 * jQuery UI
 
+## Squash Schema Migrations
+
+Database schema migrations should be squashed for each new minor release. See the [squashing guide](squashing-migrations.md) for the detailed process.
+
 ## Create a new Release Notes Page
 
 Create a file at `/docs/release-notes/X.Y.md` to establish the release notes for the new release. Add the file to the table of contents within `mkdocs.yml`.

docs/development/squashing-migrations.md

@@ -0,0 +1,168 @@
+# Squashing Database Schema Migrations
+
+## What are Squashed Migrations?
+
+The Django framework on which NetBox is built utilizes [migration files](https://docs.djangoproject.com/en/stable/topics/migrations/) to keep track of changes to the PostgreSQL database schema. Each time a model is altered, the resulting schema change is captured in a migration file, which can then be applied to effect the new schema.
+
+As changes are made over time, more and more migration files are created. Although not necessarily problematic, it can be beneficial to merge and compress these files occasionally to reduce the total number of migrations that need to be applied upon installation of NetBox. This merging process is called _squashing_ in Django vernacular, and results in two parallel migration paths: individual and squashed.
+
+Below is an example showing both individual and squashed migration files within an app:
+
+| Individual | Squashed |
+|------------|----------|
+| 0001_initial       | 0001_initial_squashed_0004_add_field |
+| 0002_alter_field   |                   .                  |
+| 0003_remove_field  |                   .                  |
+| 0004_add_field     |                   .                  |
+| 0005_another_field | 0005_another_field                   |
+
+In the example above, a new installation can leverage the squashed migrations to apply only two migrations:
+
+* `0001_initial_squashed_0004_add_field`
+* `0005_another_field`
+
+This is because the squash file contains all of the operations performed by files `0001` through `0004`.
+
+However, an existing installation that has already applied some of the individual migrations contained within the squash file must continue applying individual migrations. For instance, an installation which currently has up to `0002_alter_field` applied must apply the following migrations to become current:
+
+* `0003_remove_field`
+* `0004_add_field`
+* `0005_another_field`
+
+Squashed migrations are opportunistic: They are used only if applicable to the current environment. Django will fall back to using individual migrations if the squashed migrations do not agree with the current database schema at any point.
+
+## Squashing Migrations
+
+During every minor (i.e. 2.x) release, migrations should be squashed to help simplify the migration process for new installations. The process below describes how to squash migrations efficiently and with minimal room for error.
+
+### 1. Create a New Branch
+
+Create a new branch off of the `develop-2.x` branch. (Migrations should be squashed _only_ in preparation for a new minor release.)
+
+```
+git checkout -B squash-migrations
+```
+
+### 2. Delete Existing Squash Files
+
+Delete the most recent squash file within each NetBox app. This allows us to extend squash files where the opportunity exists. For example, we might be able to replace `0005_to_0008` with `0005_to_0011`.
+
+### 3. Generate the Current Migration Plan
+
+Use Django's `showmigrations` utility to display the order in which all migrations would be applied for a new installation.
+
+```
+manage.py showmigrations --plan
+```
+
+From the resulting output, delete all lines which reference an external migration. Any migrations imposed by Django itself on an external package are not relevant.
+
+### 4. Create Squash Files
+
+Begin iterating through the migration plan, looking for successive sets of migrations within an app. These are candidates for squashing. For example:
+
+```
+[X]  extras.0014_configcontexts
+[X]  extras.0015_remove_useraction
+[X]  extras.0016_exporttemplate_add_cable
+[X]  extras.0017_exporttemplate_mime_type_length
+[ ]  extras.0018_exporttemplate_add_jinja2
+[ ]  extras.0019_tag_taggeditem
+[X]  dcim.0062_interface_mtu
+[X]  dcim.0063_device_local_context_data
+[X]  dcim.0064_remove_platform_rpc_client
+[ ]  dcim.0065_front_rear_ports
+[X]  circuits.0001_initial_squashed_0010_circuit_status
+[ ]  dcim.0066_cables
+...
+```
+
+Migrations `0014` through `0019` in `extras` can be squashed, as can migrations `0062` through `0065` in `dcim`. Migration `0066` cannot be included in the same squash file, because the `circuits` migration must be applied before it. (Note that whether or not each migration is currently applied to the database does not matter.)
+
+Squash files are created using Django's `squashmigrations` utility:
+
+```
+manage.py squashmigrations <app> <start> <end>
+```
+
+For example, our first step in the example would be to run `manage.py squashmigrations extras 0014 0019`.
+
+!!! note
+    Specifying a migration file's numeric index is enough to uniquely identify it within an app. There is no need to specify the full filename.
+
+This will create a new squash file within the app's `migrations` directory, named as a concatenation of its beginning and ending migration. Some manual editing is necessary for each new squash file for housekeeping purposes:
+
+* Remove the "automatically generated" comment at top (to indicate that a human has reviewed the file).
+* Reorder `import` statements as necessary per PEP8.
+* It may be necessary to copy over custom functions from the original migration files (this will be indicated by a comment near the top of the squash file). It is safe to remove any functions that exist solely to accomodate reverse migrations (which we no longer support).
+
+Repeat this process for each candidate set of migrations until you reach the end of the migration plan.
+
+### 5. Check for Missing Migrations
+
+If everything went well, at this point we should have a completed squashed path. Perform a dry run to check for any missing migrations:
+
+```
+manage.py migrate --dry-run
+```
+
+### 5. Run Migrations
+
+Next, we'll apply the entire migration path to an empty database. Begin by dropping and creating your development database.
+
+!!! warning
+    Obviously, first back up any data you don't want to lose.
+
+```
+sudo -u postgres psql -c 'drop database netbox'
+sudo -u postgres psql -c 'create database netbox'
+```
+
+Apply the migrations with the `migrate` management command. It is not necessary to specify a particular migration path; Django will detect and use the squashed migrations automatically. You can verify the exact migrations being applied by enabling verboes output with `-v 2`.
+
+```
+manage.py migrate -v 2
+```
+
+### 6. Commit the New Migrations
+
+If everything is successful to this point, commit your changes to the `squash-migrations` branch.
+
+### 7. Validate Resulting Schema
+
+To ensure our new squashed migrations do not result in a deviation from the original schema, we'll compare the two. With the new migration file safely commit, check out the `develop-2.x` branch, which still contains only the individual migrations.
+
+```
+git checkout develop-2.x
+```
+
+Temporarily install the [django-extensions](https://django-extensions.readthedocs.io/) package, which provides the `sqldiff utility`:
+
+```
+pip install django-extensions
+```
+
+Also add `django_extensions` to `INSTALLED_APPS` in `netbox/netbox/settings.py`.
+
+At this point, our database schema has been defined by using the squashed migrations. We can run `sqldiff` to see if it differs any from what the current (non-squashed) migrations would generate. `sqldiff` accepts a list of apps against which to run:
+
+```
+manage.py sqldiff circuits dcim extras ipam secrets tenancy users virtualization
+```
+
+It is safe to ignore errors indicating an "unknown database type" for the following fields:
+
+* `dcim_interface.mac_address`
+* `ipam_aggregate.prefix`
+* `ipam_prefix.prefix`
+
+It is also safe to ignore the message "Table missing: extras_script".
+
+Resolve any differences by correcting migration files in the `squash-migrations` branch.
+
+!!! warning
+    Don't forget to remove `django_extension` from `INSTALLED_APPS` before committing your changes.
+
+### 8. Merge the Squashed Migrations
+
+Once all squashed migrations have been validated and all tests run successfully, merge the `squash-migrations` branch into `develop-2.x`. This completes the squashing process.

docs/release-notes/version-2.6.md

@@ -3,6 +3,11 @@
 ## Enhancements
 
 * [#2921](https://github.com/netbox-community/netbox/issues/2921) - Replace tags filter with Select2 widget
+* [#3525](https://github.com/netbox-community/netbox/issues/3525) - Enable IP address filtering with multiple address terms
+
+## Bug Fixes
+
+* [#3914](https://github.com/netbox-community/netbox/issues/3914) - Fix interface filter field when unauthenticated
 
 ---
 
@@ -13,7 +18,7 @@
 * [#1982](https://github.com/netbox-community/netbox/issues/1982) - Improved NAPALM method documentation in Swagger (OpenAPI)
 * [#2050](https://github.com/netbox-community/netbox/issues/2050) - Preview image attachments when hovering over the link
 * [#2113](https://github.com/netbox-community/netbox/issues/2113) - Allow NAPALM driver settings to be changed with request headers
-* [#2589](https://github.com/netbox-community/netbox/issues/2589) - Toggle the display of child prefixes/IP addresses
+* [#2598](https://github.com/netbox-community/netbox/issues/2598) - Toggle the display of child prefixes/IP addresses
 * [#3009](https://github.com/netbox-community/netbox/issues/3009) - Search by description when assigning IP address to interfaces
 * [#3021](https://github.com/netbox-community/netbox/issues/3021) - Add `tenant` filter field for cables
 * [#3090](https://github.com/netbox-community/netbox/issues/3090) - Enable filtering of interfaces by name on the device view

mkdocs.yml

@@ -55,6 +55,7 @@ pages:
         - Utility Views: 'development/utility-views.md'
         - Extending Models: 'development/extending-models.md'
         - Release Checklist: 'development/release-checklist.md'
+        - Squashing Migrations: 'development/squashing-migrations.md'
     - Release Notes:
         - Version 2.6: 'release-notes/version-2.6.md'
         - Version 2.5: 'release-notes/version-2.5.md'

netbox/ipam/fields.py

@@ -1,6 +1,6 @@
 from django.core.exceptions import ValidationError
 from django.db import models
-from netaddr import AddrFormatError, IPNetwork
+from netaddr import AddrFormatError, IPNetwork, IPAddress
 
 from . import lookups
 from .formfields import IPFormField
@@ -23,7 +23,10 @@ class BaseIPField(models.Field):
         if not value:
             return value
         try:
-            return IPNetwork(value)
+            if '/' in str(value):
+                return IPNetwork(value)
+            else:
+                return IPAddress(value)
         except AddrFormatError as e:
             raise ValidationError("Invalid IP address format: {}".format(value))
         except (TypeError, ValueError) as e:
@@ -32,6 +35,8 @@ class BaseIPField(models.Field):
     def get_prep_value(self, value):
         if not value:
             return None
+        if isinstance(value, list):
+            return [str(self.to_python(v)) for v in value]
         return str(self.to_python(value))
 
     def form_class(self):
@@ -90,5 +95,6 @@ IPAddressField.register_lookup(lookups.NetContainedOrEqual)
 IPAddressField.register_lookup(lookups.NetContains)
 IPAddressField.register_lookup(lookups.NetContainsOrEquals)
 IPAddressField.register_lookup(lookups.NetHost)
+IPAddressField.register_lookup(lookups.NetIn)
 IPAddressField.register_lookup(lookups.NetHostContained)
 IPAddressField.register_lookup(lookups.NetMaskLength)

netbox/ipam/filters.py

@@ -7,7 +7,7 @@ from netaddr.core import AddrFormatError
 from dcim.models import Device, Interface, Region, Site
 from extras.filters import CustomFieldFilterSet, CreatedUpdatedFilterSet
 from tenancy.filtersets import TenancyFilterSet
-from utilities.filters import NameSlugSearchFilterSet, NumericInFilter, TagFilter, TreeNodeMultipleChoiceFilter
+from utilities.filters import NameSlugSearchFilterSet, NumericInFilter, TagFilter, TreeNodeMultipleChoiceFilter, MultiValueCharFilter
 from virtualization.models import VirtualMachine
 from .constants import *
 from .models import Aggregate, IPAddress, Prefix, RIR, Role, Service, VLAN, VLANGroup, VRF
@@ -284,7 +284,7 @@ class IPAddressFilter(TenancyFilterSet, CustomFieldFilterSet, CreatedUpdatedFilt
         method='search_by_parent',
         label='Parent prefix',
     )
-    address = django_filters.CharFilter(
+    address = MultiValueCharFilter(
         method='filter_address',
         label='Address',
     )
@@ -371,13 +371,8 @@ class IPAddressFilter(TenancyFilterSet, CustomFieldFilterSet, CreatedUpdatedFilt
             return queryset.none()
 
     def filter_address(self, queryset, name, value):
-        if not value.strip():
-            return queryset
         try:
-            # Match address and subnet mask
-            if '/' in value:
-                return queryset.filter(address=value)
-            return queryset.filter(address__net_host=value)
+            return queryset.filter(address__net_in=value)
         except ValidationError:
             return queryset.none()
 

netbox/ipam/lookups.py

@@ -100,6 +100,42 @@ class NetHost(Lookup):
         return 'HOST(%s) = %s' % (lhs, rhs), params
 
 
+class NetIn(Lookup):
+    lookup_name = 'net_in'
+
+    def as_sql(self, qn, connection):
+        lhs, lhs_params = self.process_lhs(qn, connection)
+        rhs, rhs_params = self.process_rhs(qn, connection)
+        with_mask, without_mask = [], []
+        for address in rhs_params[0]:
+            if '/' in address:
+                with_mask.append(address)
+            else:
+                without_mask.append(address)
+
+        address_in_clause = self.create_in_clause('{} IN ('.format(lhs), len(with_mask))
+        host_in_clause = self.create_in_clause('HOST({}) IN ('.format(lhs), len(without_mask))
+
+        if with_mask and not without_mask:
+            return address_in_clause, with_mask
+        elif not with_mask and without_mask:
+            return host_in_clause, without_mask
+
+        in_clause = '({}) OR ({})'.format(address_in_clause, host_in_clause)
+        with_mask.extend(without_mask)
+        return in_clause, with_mask
+
+    @staticmethod
+    def create_in_clause(clause_part, max_size):
+        clause_elements = [clause_part]
+        for offset in range(0, max_size):
+            if offset > 0:
+                clause_elements.append(', ')
+            clause_elements.append('%s')
+        clause_elements.append(')')
+        return ''.join(clause_elements)
+
+
 class NetHostContained(Lookup):
     """
     Check for the host portion of an IP address without regard to its mask. This allows us to find e.g. 192.0.2.1/24

netbox/ipam/tests/test_filters.py

@@ -337,16 +337,18 @@ class IPAddressTestCase(TestCase):
             IPAddress(family=4, address='10.0.0.2/24', vrf=vrfs[0], interface=interfaces[0], status=IPADDRESS_STATUS_ACTIVE, role=None, dns_name='ipaddress-b'),
             IPAddress(family=4, address='10.0.0.3/24', vrf=vrfs[1], interface=interfaces[1], status=IPADDRESS_STATUS_RESERVED, role=IPADDRESS_ROLE_VIP, dns_name='ipaddress-c'),
             IPAddress(family=4, address='10.0.0.4/24', vrf=vrfs[2], interface=interfaces[2], status=IPADDRESS_STATUS_DEPRECATED, role=IPADDRESS_ROLE_SECONDARY, dns_name='ipaddress-d'),
+            IPAddress(family=4, address='10.0.0.1/25', vrf=None, interface=None, status=IPADDRESS_STATUS_ACTIVE, role=None),
             IPAddress(family=6, address='2001:db8::1/64', vrf=None, interface=None, status=IPADDRESS_STATUS_ACTIVE, role=None, dns_name='ipaddress-a'),
             IPAddress(family=6, address='2001:db8::2/64', vrf=vrfs[0], interface=interfaces[3], status=IPADDRESS_STATUS_ACTIVE, role=None, dns_name='ipaddress-b'),
             IPAddress(family=6, address='2001:db8::3/64', vrf=vrfs[1], interface=interfaces[4], status=IPADDRESS_STATUS_RESERVED, role=IPADDRESS_ROLE_VIP, dns_name='ipaddress-c'),
             IPAddress(family=6, address='2001:db8::4/64', vrf=vrfs[2], interface=interfaces[5], status=IPADDRESS_STATUS_DEPRECATED, role=IPADDRESS_ROLE_SECONDARY, dns_name='ipaddress-d'),
+            IPAddress(family=6, address='2001:db8::1/65', vrf=None, interface=None, status=IPADDRESS_STATUS_ACTIVE, role=None),
         )
         IPAddress.objects.bulk_create(ipaddresses)
 
     def test_family(self):
         params = {'family': '6'}
-        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4)
+        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 5)
 
     def test_dns_name(self):
         params = {'dns_name': ['ipaddress-a', 'ipaddress-b']}
@@ -359,20 +361,24 @@ class IPAddressTestCase(TestCase):
 
     def test_parent(self):
         params = {'parent': '10.0.0.0/24'}
-        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4)
+        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 5)
         params = {'parent': '2001:db8::/64'}
-        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4)
+        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 5)
 
-    def filter_address(self):
+    def test_filter_address(self):
         # Check IPv4 and IPv6, with and without a mask
-        params = {'address': '10.0.0.1/24'}
+        params = {'address': ['10.0.0.1/24']}
         self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
-        params = {'address': '10.0.0.1'}
-        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
-        params = {'address': '2001:db8::1/64'}
-        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
-        params = {'address': '2001:db8::1'}
+        params = {'address': ['10.0.0.1']}
+        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+        params = {'address': ['10.0.0.1/24', '10.0.0.1/25']}
+        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+        params = {'address': ['2001:db8::1/64']}
         self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+        params = {'address': ['2001:db8::1']}
+        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+        params = {'address': ['2001:db8::1/64', '2001:db8::1/65']}
+        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
 
     def test_mask_length(self):
         params = {'mask_length': '24'}
@@ -411,7 +417,7 @@ class IPAddressTestCase(TestCase):
         params = {'assigned_to_interface': 'true'}
         self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6)
         params = {'assigned_to_interface': 'false'}
-        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4)
 
     def test_status(self):
         params = {'status': [PREFIX_STATUS_DEPRECATED, PREFIX_STATUS_RESERVED]}

netbox/project-static/js/interface_toggles.js

@@ -15,7 +15,7 @@ $('button.toggle-ips').click(function() {
 $('input.interface-filter').on('input', function() {
     var filter = new RegExp(this.value);
 
-    for (interface of $(this).closest('form').find('tbody > tr')) {
+    for (interface of $(this).closest('div.panel').find('tbody > tr')) {
         // Slice off 'interface_' at the start of the ID
         if (filter && filter.test(interface.id.slice(10))) {
             // Match the toggle in case the filter now matches the interface