allow volunteer import data to have council restrictions

so you can limit people to e.g. Welsh councils.

Author: struan

crowdsourcer/management/commands/import_volunteers.py

@@ -112,6 +112,12 @@ def add_arguments(self, parser):
             help="use the section count in the csv and not the map",
         )
 
+        parser.add_argument(
+            "--council_restrictions",
+            action="store_true",
+            help="the data contains a column with council restrictions, e.g Welsh councils.",
+        )
+
         parser.add_argument(
             "--add_users", action="store_true", help="add users to database"
         )
@@ -137,6 +143,10 @@ def init(self, file, options):
             self.column_names.append("section_count")
             self.usecols.append("How many sections?")
 
+        if options["council_restrictions"]:
+            self.column_names.append("council_restrictions")
+            self.usecols.append("Nations/London")
+
     def get_df(self, filename):
         df = pd.read_csv(
             filename,
@@ -281,13 +291,40 @@ def add_users_and_assignments(self, df, response_type, session, rt, options):
             own_council_list = list(own_council.values_list("id", flat=True))
             assigned_councils = assigned_councils + own_council_list
 
+            included_types = []
+            included_countries = []
+            if options["council_restrictions"]:
+                restrictions = row["council_restrictions"].split(",")
+
+                for r in restrictions:
+                    if r.lower() in [
+                        "scotland",
+                        "england",
+                        "wales",
+                        "northern ireland",
+                    ]:
+                        included_countries.append(r.lower())
+                    elif r == "London":
+                        included_types.append("LBO")
+
             councils_to_assign = PublicAuthority.objects.filter(
                 marking_session=session
             ).exclude(
                 Q(id__in=assigned_councils) | Q(type="COMB") | Q(do_not_mark=True)
-            )[
-                :num_councils
-            ]
+            )
+
+            if len(included_types) > 0 and len(included_countries) > 0:
+                councils_to_assign = councils_to_assign.filter(
+                    Q(country__in=included_countries) | Q(type__in=included_types)
+                )
+            elif len(included_types) > 0:
+                councils_to_assign = councils_to_assign.filter(type__in=included_types)
+            elif len(included_countries) > 0:
+                councils_to_assign = councils_to_assign.filter(
+                    country__in=included_countries
+                )
+
+            councils_to_assign = councils_to_assign[:num_councils]
 
             if councils_to_assign.count() == 0:
                 self.stdout.write(

crowdsourcer/tests/data/volunteers_with_council_restriction.csv

@@ -0,0 +1,2 @@
+First name,Last name,Email,Council Area,Type of Volunteering,Assigned Section,Nations/London
+First,Last,first_last@example.org,Aberdeenshire Council,Scorecards Volunteering,Transport,"Scotland,London"

crowdsourcer/tests/test_import_volunteers_script.py

@@ -441,3 +441,66 @@ def test_assignment_limits_in_file(self):
             ).count(),
             3,
         )
+
+    def test_council_restrictions(self):
+        data_file = (
+            pathlib.Path(__file__).parent.resolve()
+            / "data"
+            / "volunteers_with_council_restriction.csv"
+        )
+        self.add_extra_councils()
+
+        self.assertEquals(Assigned.objects.count(), 0)
+        self.call_command(
+            "import_volunteers",
+            session="Default",
+            file=data_file,
+            add_users=True,
+            make_assignments=True,
+            council_restrictions=True,
+        )
+        self.assertEquals(User.objects.count(), 1)
+        self.assertEquals(Marker.objects.count(), 1)
+        self.assertEquals(Assigned.objects.count(), 1)
+        self.assertEquals(
+            Assigned.objects.filter(
+                marking_session__label="Default", section__title="Transport"
+            ).count(),
+            1,
+        )
+
+        a = Assigned.objects.filter(
+            marking_session__label="Default", section__title="Transport"
+        ).first()
+        self.assertEquals(a.authority.name, "Aberdeen City Council")
+
+        # need to remove them all as won't assign to people with existing assignments
+        Assigned.objects.all().delete()
+
+        ob = PublicAuthority.objects.get(unique_id="E90008")
+        ob.type = "LBO"
+        ob.save()
+
+        self.call_command(
+            "import_volunteers",
+            session="Default",
+            file=data_file,
+            add_users=True,
+            make_assignments=True,
+            council_restrictions=True,
+        )
+        self.assertEquals(User.objects.count(), 1)
+        self.assertEquals(Marker.objects.count(), 1)
+        self.assertEquals(Assigned.objects.count(), 2)
+        self.assertEquals(
+            Assigned.objects.filter(
+                marking_session__label="Default", section__title="Transport"
+            ).count(),
+            2,
+        )
+
+        a = Assigned.objects.filter(
+            marking_session__label="Default", section__title="Transport"
+        )
+        self.assertEquals(a[0].authority.name, "Aberdeen City Council")
+        self.assertEquals(a[1].authority.name, "Old Borsetshire")