Third attempt to explore CI failures

.github/workflows/ci.yml

@@ -28,10 +28,6 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: "3.9"
-          cache: pip
-          cache-dependency-path: |
-            requirements/base.txt
-            requirements/dev.txt
 
       - name: Run pre-commit
         uses: pre-commit/[email protected]
@@ -41,7 +37,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
-      max-parallel: 5
+      max-parallel: 10
       matrix:
         python-version: ["3.8", "3.9", "3.10", "3.11"]
 
@@ -59,7 +55,15 @@ jobs:
         python -m pip install --upgrade tox tox-gh-actions
 
     - name: Test with tox
-      run: tox
+      # Sometimes tox fails to build the package correctly and intermittently throws an OSError or BadZipFile error.
+      # Upon retry, it seems to work.
+      uses: nick-fields/retry@v2
+      id: retry-sqlite
+      with:
+        timeout_minutes: 10
+        max_attempts: 3
+        retry_on: error
+        command: tox
       env:
         DBBACKEND: sqlite3
         DBNAME: ":memory:"
@@ -75,10 +79,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
-      max-parallel: 5
+      max-parallel: 10
       matrix:
         python-version: ["3.8", "3.9", "3.10", "3.11"]
-        mariadb-version: ["10.3", "10.5"]
+        mariadb-version: ["10.4"]
 
     services:
       database:
@@ -103,19 +107,16 @@ jobs:
         python -m pip install --upgrade pip
         python -m pip install --upgrade tox tox-gh-actions
 
-    - name: Test with tox - 10.3
-      if: ${{ matrix.mariadb-version == '10.3' }}
-      run: tox --skip-env ".+?-django42-mysql"
-      env:
-        DBBACKEND: mysql
-        DBNAME: test
-        DBUSER: root
-        DBPASSWORD: rootpw
-        DBHOST: 127.0.0.1
-
-    - name: Test with tox - not 10.3
-      if: ${{ matrix.mariadb-version != '10.3' }}
-      run: tox
+    - name: Test with tox
+      # Sometimes tox fails to build the package correctly and intermittently throws an OSError or BadZipFile error.
+      # Upon retry, it seems to work.
+      uses: nick-fields/retry@v2
+      id: retry-sqlite
+      with:
+        timeout_minutes: 10
+        max_attempts: 3
+        retry_on: error
+        command: tox
       env:
         DBBACKEND: mysql
         DBNAME: test
@@ -143,7 +144,6 @@ jobs:
 
       - run: python -m pip install --upgrade coverage[toml] django==3.2.16 django-coverage-plugin
 
-
       - name: Download coverage data.
         uses: actions/download-artifact@v3
         with:

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## Devel
+
+* Add filtering in list views.
+
 ## 0.18 (2023-10-03)
 
 * Include a workspace_data_object context variable for the `WorkspaceDetail` and `WorkspaceUpdate` views.

MANIFEST.in

@@ -2,3 +2,7 @@ include LICENSE
 include README.md
 recursive-include anvil_consortium_manager/templates *
 recursive-include docs *
+recursive-exclude docs/_build *
+recursive-include anvil_consortium_manager/tests/test_app/templates *
+recursive-exclude example_site *
+exclude .coverage

anvil_consortium_manager/__init__.py

@@ -1 +1 @@
-__version__ = "0.18"
+__version__ = "0.19dev1"

anvil_consortium_manager/adapters/account.py

@@ -5,6 +5,9 @@
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.utils.module_loading import import_string
+from django_filters import FilterSet
+
+from .. import models
 
 
 class BaseAccountAdapter(ABC):
@@ -15,6 +18,11 @@ def list_table_class(self):
         """Table class to use in a list of Accounts."""
         ...
 
+    @abstractproperty
+    def list_filterset_class(self):
+        """FilterSet subclass to use for Account filtering in the AccountList view."""
+        ...
+
     def get_list_table_class(self):
         """Return the table class to use for the AccountList view."""
         if not self.list_table_class:
@@ -23,6 +31,23 @@ def get_list_table_class(self):
             )
         return self.list_table_class
 
+    def get_list_filterset_class(self):
+        """Return the FilterSet subclass to use for Account filtering in the AccountList view."""
+        if not self.list_filterset_class:
+            raise ImproperlyConfigured(
+                "Set `list_filterset_class` in `{}`.".format(type(self))
+            )
+        if not issubclass(self.list_filterset_class, FilterSet):
+            raise ImproperlyConfigured(
+                "list_filterset_class must be a subclass of FilterSet."
+            )
+        # Make sure it has the correct model set.
+        if self.list_filterset_class.Meta.model != models.Account:
+            raise ImproperlyConfigured(
+                "list_filterset_class Meta model field must be anvil_consortium_manager.models.Account."
+            )
+        return self.list_filterset_class
+
     def get_autocomplete_queryset(self, queryset, q):
         """Filter the Account `queryset` using the query `q` for use in the autocomplete."""
         queryset = queryset.filter(email__icontains=q)

anvil_consortium_manager/adapters/default.py

@@ -1,6 +1,6 @@
 """Default adapters for the app."""
 
-from .. import forms, models, tables
+from .. import filters, forms, models, tables
 from .account import BaseAccountAdapter
 from .workspace import BaseWorkspaceAdapter
 
@@ -9,6 +9,7 @@ class DefaultAccountAdapter(BaseAccountAdapter):
     """Default account adapter for use with the app."""
 
     list_table_class = tables.AccountTable
+    list_filterset_class = filters.AccountListFilter
 
 
 class DefaultWorkspaceAdapter(BaseWorkspaceAdapter):

anvil_consortium_manager/filters.py

@@ -0,0 +1,27 @@
+from django_filters import FilterSet
+
+from . import models
+
+
+class AccountListFilter(FilterSet):
+    class Meta:
+        model = models.Account
+        fields = {"email": ["icontains"]}
+
+
+class BillingProjectListFilter(FilterSet):
+    class Meta:
+        model = models.BillingProject
+        fields = {"name": ["icontains"]}
+
+
+class ManagedGroupListFilter(FilterSet):
+    class Meta:
+        model = models.ManagedGroup
+        fields = {"name": ["icontains"]}
+
+
+class WorkspaceListFilter(FilterSet):
+    class Meta:
+        model = models.Workspace
+        fields = {"name": ["icontains"]}

anvil_consortium_manager/templates/anvil_consortium_manager/account_list.html

@@ -2,6 +2,7 @@
 {% load static %}
 
 {% load render_table from django_tables2 %}
+{% load crispy_forms_tags %}
 
 {% block title %}Accounts{% endblock %}
 
@@ -13,6 +14,13 @@
 
       <h2>Accounts</h2>
 
+      <div class="my-3 p-3 bg-light border rounded shadow-sm">
+        <form method="get">
+          {{ filter.form|crispy }}
+          <button type="submit" class="btn btn-primary">Filter</button>
+        </form>
+    </div>
+
       {% render_table table %}
 
     </div>

anvil_consortium_manager/templates/anvil_consortium_manager/billingproject_list.html

@@ -2,6 +2,7 @@
 {% load static %}
 
 {% load render_table from django_tables2 %}
+{% load crispy_forms_tags %}
 
 {% block title %}Billing Projects{% endblock %}
 
@@ -13,6 +14,13 @@
 
       <h2>Billing Projects</h2>
 
+      <div class="my-3 p-3 bg-light border rounded shadow-sm">
+        <form method="get">
+          {{ filter.form|crispy }}
+          <button type="submit" class="btn btn-primary">Filter</button>
+        </form>
+    </div>
+
       {% render_table table %}
 
     </div>

anvil_consortium_manager/templates/anvil_consortium_manager/managedgroup_list.html

@@ -2,17 +2,24 @@
 {% load static %}
 
 {% load render_table from django_tables2 %}
+{% load crispy_forms_tags %}
 
 {% block title %}Managed Groups{% endblock %}
 
 {% block content %}
-<div class="container">
 
   <div class="row">
     <div class="col-sm-12">
 
       <h2>Managed Groups</h2>
 
+      <div class="my-3 p-3 bg-light border rounded shadow-sm">
+        <form method="get">
+          {{ filter.form|crispy }}
+          <button type="submit" class="btn btn-primary">Filter</button>
+        </form>
+    </div>
+
       {% render_table table %}
 
     </div>

anvil_consortium_manager/templates/anvil_consortium_manager/workspace_list.html

@@ -2,17 +2,24 @@
 {% load static %}
 
 {% load render_table from django_tables2 %}
+{% load crispy_forms_tags %}
 
 {% block title %}{{workspace_type_display_name}}s{% endblock %}
 
 {% block content %}
-<div class="container">
 
   <div class="row">
     <div class="col-sm-12">
 
       <h2>{{workspace_type_display_name}}s</h2>
 
+      <div class="my-3 p-3 bg-light border rounded shadow-sm">
+        <form method="get">
+          {{ filter.form|crispy }}
+          <button type="submit" class="btn btn-primary">Filter</button>
+        </form>
+    </div>
+
       {% render_table table %}
 
     </div>

anvil_consortium_manager/tests/test_adapters.py

@@ -10,11 +10,12 @@
     BaseWorkspaceAdapter,
     WorkspaceAdapterRegistry,
 )
+from ..filters import AccountListFilter, BillingProjectListFilter
 from ..forms import DefaultWorkspaceDataForm, WorkspaceForm
 from ..models import Account, DefaultWorkspaceData
 from ..tables import AccountTable, WorkspaceTable
 from . import factories
-from .test_app import forms, models, tables
+from .test_app import filters, forms, models, tables
 from .test_app.adapters import TestWorkspaceAdapter
 
 
@@ -26,6 +27,7 @@ def get_test_adapter(self):
 
         class TestAdapter(BaseAccountAdapter):
             list_table_class = tables.TestAccountTable
+            list_filterset_class = filters.TestAccountListFilter
 
         return TestAdapter
 
@@ -46,6 +48,45 @@ def test_list_table_class_none(self):
         with self.assertRaises(ImproperlyConfigured):
             TestAdapter().get_list_table_class()
 
+    def test_list_filterset_class_default(self):
+        """get_list_filterset_class returns the correct filter when using the default adapter."""
+        self.assertEqual(
+            DefaultAccountAdapter().get_list_filterset_class(), AccountListFilter
+        )
+
+    def test_list_filterset_class_custom(self):
+        """get_list_filterset_class returns the correct filter when using a custom adapter."""
+        TestAdapter = self.get_test_adapter()
+        setattr(TestAdapter, "list_filterset_class", filters.TestAccountListFilter)
+        self.assertEqual(
+            TestAdapter().get_list_filterset_class(), filters.TestAccountListFilter
+        )
+
+    def test_list_filterset_class_none(self):
+        """get_list_filterset_class raises ImproperlyConfigured when get_list_filterset_class is not set."""
+        TestAdapter = self.get_test_adapter()
+        setattr(TestAdapter, "list_filterset_class", None)
+        with self.assertRaises(ImproperlyConfigured):
+            TestAdapter().get_list_filterset_class()
+
+    def test_list_filterset_class_different_model(self):
+        """get_list_filterset_class raises ImproperlyConfigured when incorrect model is used."""
+        TestAdapter = self.get_test_adapter()
+        setattr(TestAdapter, "list_filterset_class", BillingProjectListFilter)
+        with self.assertRaises(ImproperlyConfigured):
+            TestAdapter().get_list_filterset_class()
+
+    def test_list_filterset_class_not_filterset(self):
+        """get_list_filterset_class raises ImproperlyConfigured when not a subclass of FilterSet."""
+
+        class Foo:
+            pass
+
+        TestAdapter = self.get_test_adapter()
+        setattr(TestAdapter, "list_filterset_class", Foo)
+        with self.assertRaises(ImproperlyConfigured):
+            TestAdapter().get_list_filterset_class()
+
     def test_get_autocomplete_queryset_default(self):
         """get_autocomplete_queryset returns the correct queryset when using the default adapter."""
         account_1 = factories.AccountFactory.create(email="[email protected]")

anvil_consortium_manager/tests/test_app/adapters.py

@@ -1,7 +1,7 @@
 from anvil_consortium_manager.adapters.account import BaseAccountAdapter
 from anvil_consortium_manager.adapters.workspace import BaseWorkspaceAdapter
 
-from . import forms, models, tables
+from . import filters, forms, models, tables
 
 
 class TestWorkspaceAdapter(BaseWorkspaceAdapter):
@@ -30,6 +30,7 @@ class TestAccountAdapter(BaseAccountAdapter):
     """Test adapter for accounts."""
 
     list_table_class = tables.TestAccountTable
+    list_filterset_class = filters.TestAccountListFilter
 
     def get_autocomplete_queryset(self, queryset, q):
         if q:

anvil_consortium_manager/tests/test_app/filters.py

@@ -0,0 +1,11 @@
+from django_filters import FilterSet
+
+from anvil_consortium_manager.models import Account
+
+
+class TestAccountListFilter(FilterSet):
+    """Test filter for Accounts."""
+
+    class Meta:
+        model = Account
+        fields = {"email": ["icontains"], "is_service_account": ["exact"]}