Add ability to filter for active users

app/main/views/users.py

@@ -156,6 +156,10 @@ def list_users():
     if user_research_opted_in is not None:
         user_query = user_query.filter(User.user_research_opted_in == convert_to_boolean(user_research_opted_in))
 
+    active = request.args.get('active')
+    if active is not None:
+        user_query = user_query.filter(User.active == convert_to_boolean(active))
+
     return paginated_result_response(
         result_name=RESOURCE_NAME,
         results_query=user_query,

tests/main/views/test_users.py

@@ -1,3 +1,4 @@
+import itertools
 from datetime import datetime
 from logging import Logger
 import mock
@@ -1537,19 +1538,17 @@ class TestUsersBooleanFilters(BaseUserTest):
 
     def setup(self):
         super(TestUsersBooleanFilters, self).setup()
+        self.app.config['DM_API_SERVICES_PAGE_SIZE'] = 10
         now = datetime.utcnow()
-        for personal_data_removed, user_research_opted_in in zip(
-            (True, True, False, False, False,),
-            (False, True, False, False, True,),
-        ):
+        for personal_data_removed, user_research_opted_in, active in itertools.product((True, False), repeat=3):
             from uuid import uuid4
             user = User(
                 email_address=f'{uuid4()}@digital.cabinet-office.gov.uk',
                 name='name',
                 phone_number='555-555-555',
                 role='admin',
                 password='password',
-                active=True,
+                active=active,
                 failed_login_count=0,
                 created_at=now,
                 updated_at=now,
@@ -1565,36 +1564,45 @@ def test_can_list_users_by_personal_data_removed_true(self):
         response = self.client.get('/users?personal_data_removed=true')
         assert response.status_code == 200
         data = json.loads(response.get_data())["users"]
-        assert len(data) == 2
+        assert len(data) == 4
         assert all(user["personalDataRemoved"] is True for user in data)
 
     def test_can_list_users_by_personal_data_removed_false(self):
         response = self.client.get('/users?personal_data_removed=false')
         assert response.status_code == 200
         data = json.loads(response.get_data())["users"]
-        assert len(data) == 3
+        assert len(data) == 4
         assert all(user["personalDataRemoved"] is False for user in data)
 
     def test_default_list_users_unfiltered(self):
         response = self.client.get('/users')
         assert response.status_code == 200
         data = json.loads(response.get_data())["users"]
-        assert len(data) == 5
+        assert len(data) == 8
 
     def test_can_list_users_by_user_research_opted_in_true(self):
         response = self.client.get('/users?user_research_opted_in=true')
         assert response.status_code == 200
         data = json.loads(response.get_data())["users"]
-        assert len(data) == 1  # because remove_personal_data() *also* sets this flag to false
+        assert len(data) == 2  # because remove_personal_data() *also* sets this flag to false
         assert all(user["userResearchOptedIn"] is True for user in data)
 
     def test_can_list_users_by_user_research_opted_in_false(self):
         response = self.client.get('/users?user_research_opted_in=false')
         assert response.status_code == 200
         data = json.loads(response.get_data())["users"]
-        assert len(data) == 4  # because remove_personal_data() *also* sets this flag to false
+        assert len(data) == 6  # because remove_personal_data() *also* sets this flag to false
         assert all(user["userResearchOptedIn"] is False for user in data)
 
+    # remove_personal_data() sets active to false
+    @pytest.mark.parametrize('active,expected_users', [(True, 2), (False, 6)])
+    def test_can_list_users_by_active(self, active, expected_users):
+        response = self.client.get(f'/users?active={str(active).lower()}')
+        assert response.status_code == 200
+        data = json.loads(response.get_data())["users"]
+        assert len(data) == expected_users
+        assert all(user["active"] is active for user in data)
+
 
 class TestUsersRemovePersonalData(BaseUserTest):
     """Test the `remove_user_personal_data` functionality for different roles."""