rename home to remote

2022-02-24 21:50:37 +00:00
parent 7807e3b1e8
commit 9e873ac5f7
11 changed files with 806 additions and 145 deletions
@@ -0,0 +1,405 @@
+from copy import deepcopy
+from black import main
+import pytest
+from rota.shifts import NoWorkers, RotaBuilder, SingleShift, days
+
+import datetime
+
+from rota.workers import Worker
+
+
+def weeks_from_list(lst):
+    """Yield successive n-sized chunks from a lst."""
+    for i in range(0, len(lst), 7):
+        yield lst[i : i + 7]
+
+
+class TestDemoRota:
+    def test_nwd(self):
+        # Set up rota
+        weeks_to_rota = 10
+        start_date = datetime.date(2022, 3, 7)
+
+        self.Rota = RotaBuilder(
+            start_date,
+            weeks_to_rota=weeks_to_rota,
+        )
+
+        # Add a few workers
+        worker1 = Worker(self.Rota, "worker1", "group1", 1, nwd=["Mon"])
+        worker2 = Worker(self.Rota, "worker2", "group1", 1, nwd=["Fri"])
+
+        self.Rota.add_workers((worker1, worker2))
+
+        # Add a weekday and weekend shift
+        self.Rota.add_shifts(
+            SingleShift(
+                ("group1",),
+                "d",
+                12.5,
+                days[:5],
+                balance_offset=10,
+                workers_required=1,
+            ),
+            SingleShift(
+                ("group1",),
+                "w",
+                12.5,
+                days[5:],
+                workers_required=2,
+            ),
+        )
+
+        self.Rota.build_and_solve(options={"ratio": 0.00})
+
+        self.Rota.export_rota_to_html("nwd")
+
+        assert self.Rota.results.solver.status == "ok"
+        assert self.Rota.results.solver.termination_condition == "optimal"
+
+        for worker in self.Rota.workers:
+            shifts = self.Rota.get_worker_shift_list(worker)
+
+            # Convert shift to a string representation
+            shifts_string = "".join([i if i != "" else "-" for i in shifts])
+
+            if worker.name == "worker1":
+                assert "wwd" not in shifts_string
+
+            if worker.name == "worker2":
+                assert "dww" not in shifts_string
+
+    def test_nwd_simple_fail(self):
+        # Set up rota
+        weeks_to_rota = 10
+        start_date = datetime.date(2022, 3, 7)
+
+        self.Rota = RotaBuilder(
+            start_date,
+            weeks_to_rota=weeks_to_rota,
+        )
+
+        # Add a few workers
+        worker1 = Worker(self.Rota, "worker1", "group1", 1, nwd=["Mon"])
+        worker2 = Worker(self.Rota, "worker2", "group1", 1, nwd=["Mon"])
+
+        self.Rota.add_workers((worker1, worker2))
+
+        # Add a weekday and weekend shift
+        self.Rota.add_shifts(
+            SingleShift(
+                ("group1",),
+                "d",
+                12.5,
+                days[:5],
+                balance_offset=10,
+                workers_required=1,
+            ),
+        )
+
+        self.Rota.build_and_solve(options={"ratio": 0.00})
+
+        self.Rota.export_rota_to_html("nwd")
+
+        assert self.Rota.results.solver.status == "warning"
+
+    def test_nwd_partial_rota(self):
+        # Set up rota
+        weeks_to_rota = 10
+        start_date = datetime.date(2022, 3, 7)
+
+        self.Rota = RotaBuilder(
+            start_date,
+            weeks_to_rota=weeks_to_rota,
+        )
+
+        d = start_date + datetime.timedelta(weeks=5)
+        # Add a few workers
+        worker1 = Worker(
+            self.Rota, "worker1", "group1", 1, nwd=[("Mon", start_date, d)]
+        )
+        worker2 = Worker(
+            self.Rota, "worker2", "group1", 1, nwd=[("Mon", d, self.Rota.rota_end_date)]
+        )
+
+        self.Rota.add_workers((worker1, worker2))
+
+        # Add a weekday and weekend shift
+        self.Rota.add_shifts(
+            SingleShift(
+                ("group1",),
+                "d",
+                12.5,
+                days[:5],
+                balance_offset=10,
+                workers_required=1,
+            ),
+        )
+
+        self.Rota.build_and_solve(options={"ratio": 0.00})
+
+        self.Rota.export_rota_to_html("nwd")
+
+        assert self.Rota.results.solver.status == "ok"
+
+    def test_nwd_partial_overlay(self):
+        # Set up rota
+        weeks_to_rota = 10
+        start_date = datetime.date(2022, 3, 7)
+
+        self.Rota = RotaBuilder(
+            start_date,
+            weeks_to_rota=weeks_to_rota,
+        )
+
+        d = start_date + datetime.timedelta(weeks=5)
+        d2 = start_date + datetime.timedelta(weeks=6)
+        # Add a few workers
+        worker1 = Worker(
+            self.Rota, "worker1", "group1", 1, nwd=[("Mon", start_date, d2)]
+        )
+        worker2 = Worker(
+            self.Rota, "worker2", "group1", 1, nwd=[("Mon", d, self.Rota.rota_end_date)]
+        )
+
+        self.Rota.add_workers((worker1, worker2))
+
+        # Add a weekday and weekend shift
+        self.Rota.add_shifts(
+            SingleShift(
+                ("group1",),
+                "d",
+                12.5,
+                days[:5],
+                balance_offset=10,
+                workers_required=1,
+            ),
+        )
+
+        self.Rota.build_and_solve(options={"ratio": 0.00})
+
+        assert self.Rota.results.solver.status == "warning"
+
+    def test_nwd_force_as_block(self):
+        # Set up rota
+        weeks_to_rota = 10
+        start_date = datetime.date(2022, 3, 7)
+
+        self.Rota = RotaBuilder(
+            start_date,
+            weeks_to_rota=weeks_to_rota,
+        )
+
+        d = start_date + datetime.timedelta(weeks=4)
+        worker1 = Worker(
+            self.Rota, "worker1", "group1", 1, nwd=[("Mon", start_date, d)]
+        )
+        worker2 = Worker(
+            self.Rota,
+            "worker2",
+            "group1",
+            1,
+        )
+        worker3 = Worker(
+            self.Rota,
+            "worker3",
+            "group1",
+            1,
+        )
+        worker4 = Worker(
+            self.Rota,
+            "worker4",
+            "group1",
+            1,
+        )
+
+        self.Rota.add_workers((worker1, worker2, worker3, worker4))
+
+        # Add a weekday and weekend shift
+        self.Rota.add_shifts(
+            SingleShift(
+                ("group1",),
+                "d",
+                12.5,
+                days[:5],
+                balance_offset=10,
+                workers_required=2,
+                force_as_block_unless_nwd=True,
+                assign_as_block=True,
+            ),
+        )
+
+        self.Rota.build_and_solve(options={"ratio": 0.00})
+        self.Rota.export_rota_to_html("nwd")
+
+        assert self.Rota.results.solver.status == "ok"
+
+        for worker in self.Rota.workers:
+            shifts = self.Rota.get_worker_shift_list(worker)
+
+            # Convert shift to a string representation
+            shifts_string = "".join([i if i != "" else "-" for i in shifts])
+
+            for week in weeks_from_list(shifts_string):
+                assert week in ("-------", "ddddd--")
+
+            assert shifts_string.count("d") == 25
+
+    def test_nwd_force_as_block_force_split(self):
+        # Set up rota
+        weeks_to_rota = 10
+        start_date = datetime.date(2022, 3, 7)
+
+        self.Rota = RotaBuilder(
+            start_date,
+            weeks_to_rota=weeks_to_rota,
+        )
+
+        d = start_date + datetime.timedelta(weeks=5)
+        worker1 = Worker(
+            self.Rota, "worker1", "group1", 1, nwd=[("Mon", start_date, d)]
+        )
+        worker2 = Worker(
+            self.Rota,
+            "worker2",
+            "group1",
+            1,
+        )
+        worker3 = Worker(
+            self.Rota,
+            "worker3",
+            "group1",
+            1,
+        )
+        worker4 = Worker(
+            self.Rota,
+            "worker4",
+            "group1",
+            1,
+        )
+
+        self.Rota.add_workers((worker1, worker2, worker3, worker4))
+
+        # Add a weekday and weekend shift
+        self.Rota.add_shifts(
+            SingleShift(
+                ("group1",),
+                "d",
+                12.5,
+                days[:5],
+                balance_offset=10,
+                workers_required=2,
+                force_as_block_unless_nwd=True,
+                assign_as_block=True,
+            ),
+            SingleShift(
+                ("group1",),
+                "w",
+                12.5,
+                days[5:],
+                balance_offset=10,
+                workers_required=4,
+                force_as_block_unless_nwd=True,
+                assign_as_block=True,
+            ),
+        )
+
+        self.Rota.build_and_solve(options={"ratio": 0.00})
+        self.Rota.export_rota_to_html("nwd")
+
+        assert self.Rota.results.solver.status == "ok"
+
+        for worker in self.Rota.workers:
+            shifts = self.Rota.get_worker_shift_list(worker)
+
+            # Convert shift to a string representation
+            shifts_string = "".join([i if i != "" else "-" for i in shifts])
+
+            for week in weeks_from_list(shifts_string[7 * 5 :]):
+                assert week in ("-----ww", "dddddww")
+
+            if worker.name == "worker1":
+                assert shifts_string[: 7 * 5].count("ww-") == 4
+
+            assert shifts_string.count("d") == 25
+            assert shifts_string.count("w") == 20
+
+    def test_nwd_testing(self):
+        # Set up rota
+        weeks_to_rota = 10
+        start_date = datetime.date(2022, 3, 7)
+
+        self.Rota = RotaBuilder(
+            start_date,
+            weeks_to_rota=weeks_to_rota,
+        )
+
+        d = start_date + datetime.timedelta(weeks=5)
+        worker1 = Worker(
+            self.Rota,
+            "worker1",
+            "group1",
+            1,
+            nwd=[
+            ("Mon", d, self.Rota.rota_end_date), 
+            ("Tue", d, self.Rota.rota_end_date),
+            ("Wed", d, self.Rota.rota_end_date),
+            ("Thu", d, self.Rota.rota_end_date),
+            ("Fri", d, self.Rota.rota_end_date),
+            ],
+        )
+        worker2 = Worker(
+            self.Rota,
+            "worker2",
+            "group1",
+            1,
+        )
+
+        self.Rota.add_workers((worker1, worker2))
+
+        # Add a weekday and weekend shift
+        self.Rota.add_shifts(
+            SingleShift(
+                ("group1",),
+                "d",
+                12.5,
+                days[:5],
+                balance_offset=10,
+                workers_required=1,
+                force_as_block_unless_nwd=True,
+                assign_as_block=True,
+            ),
+            SingleShift(
+                ("group1",),
+                "w",
+                12.5,
+                days[5:],
+                balance_offset=10,
+                workers_required=2,
+                force_as_block_unless_nwd=True,
+                assign_as_block=True,
+            ),
+        )
+
+        self.Rota.build_and_solve(options={"ratio": 0.00})
+        self.Rota.export_rota_to_html("nwd")
+
+        assert self.Rota.results.solver.status == "ok"
+
+        for worker in self.Rota.workers:
+            shifts = self.Rota.get_worker_shift_list(worker)
+
+            # Convert shift to a string representation
+            shifts_string = "".join([i if i != "" else "-" for i in shifts])
+
+            for week in weeks_from_list(shifts_string[7 * 5 :]):
+                if worker.name == "worker1":
+                    assert week == "-----ww"
+                else:
+                    assert week == "dddddww"
+
+            for week in weeks_from_list(shifts_string[:7 * 5 ]):
+                if worker.name == "worker1":
+                    assert week == "dddddww"
+                else:
+                    assert week == "-----ww"
@@ -49,7 +49,7 @@ class TestDemoRota:
            "weekday",
            12.5,
            days[:5],
-            balance_offset=10,
+            balance_offset=1,
            workers_required=1,
            # We use a different balance weighting for each shift as otherwise
            # the shifts can be treated equally (and no target diff)
@@ -60,7 +60,7 @@ class TestDemoRota:
            "weekend",
            12.5,
            days[5:],
-            balance_offset=40,
+            balance_offset=4,
            # balance_weighting=0.5
        ),
    )
@@ -595,12 +595,12 @@ class TestLimitConstraints:
    )
    # Rota.constraint_options["max_shifts_per_week"] = 5
    # Rota.constraint_options["max_shifts_per_month"] = 20
-    worker1 = Worker(Rota, "worker1", "group1", 2, home_site="group1")
-    worker2 = Worker(Rota, "worker2", "group1", 2, home_site="group1")
-    worker3 = Worker(Rota, "worker3", "group1", 2, home_site="group1")
-    worker4 = Worker(Rota, "worker4", "group3", 3, home_site="group2")
-    worker5 = Worker(Rota, "worker5", "group3", 3, home_site="group2")
-    worker6 = Worker(Rota, "worker6", "group3", 3, home_site="group2")
+    worker1 = Worker(Rota, "worker1", "group1", 2, remote_site="group1")
+    worker2 = Worker(Rota, "worker2", "group1", 2, remote_site="group1")
+    worker3 = Worker(Rota, "worker3", "group1", 2, remote_site="group1")
+    worker4 = Worker(Rota, "worker4", "group3", 3, remote_site="group2")
+    worker5 = Worker(Rota, "worker5", "group3", 3, remote_site="group2")
+    worker6 = Worker(Rota, "worker6", "group3", 3, remote_site="group2")

    Rota.add_workers((worker1, worker2, worker3, worker4))
    Rota.add_workers((worker5, worker6))
@@ -853,7 +853,7 @@ class TestLimitConstraints:
        with pytest.raises(ValueError):
            self.Rota.build_and_solve(options={"ratio": 0.1})

-    def test_constraint_require_home_site_presence(self):
+    def test_constraint_require_remote_site_presence(self):
        self.Rota.shifts = []
        self.Rota.add_shifts(
            SingleShift(
@@ -864,7 +864,7 @@ class TestLimitConstraints:
                balance_offset=40,
                workers_required=2,
                force_as_block=True,
-                constraints=[("require_home_site_presence", ("group1", 2))],
+                constraints=[("require_remote_site_presence", ("group1", 2))],
            ),
        )
        self.Rota.build_and_solve(options={"ratio": 0.00})
@@ -887,7 +887,7 @@ class TestLimitConstraints:
        assert self.Rota.results.solver.status == "ok"
        assert self.Rota.results.solver.termination_condition == "optimal"

-    def test_constraint_require_home_site_presence2(self):
+    def test_constraint_require_remote_site_presence2(self):
        self.Rota.shifts = []
        self.Rota.add_shifts(
            SingleShift(
@@ -898,7 +898,7 @@ class TestLimitConstraints:
                balance_offset=40,
                workers_required=3,
                force_as_block=True,
-                constraints=[("require_home_site_presence", ("group2", 2))],
+                constraints=[("require_remote_site_presence", ("group2", 2))],
            ),
        )
        self.Rota.build_and_solve(options={"ratio": 0.00})
@@ -1058,4 +1058,4 @@ class TestNightUnavailable:

 if __name__ == "__main__":
    t = TestLimitConstraints()
-    t.test_constraint_require_home_site_presence()
+    t.test_constraint_require_remote_site_presence()
@@ -7,8 +7,140 @@ import datetime

 from rota.workers import Worker

+def weeks_from_list(lst):
+    """Yield successive n-sized chunks from a lst."""
+    for i in range(0, len(lst), 7):
+        yield lst[i : i + 7]

 class TestDemoRota:
+    def test_balance_weekend(self):
+        # Set up rota
+        weeks_to_rota = 10
+        start_date = datetime.date(2022, 3, 7)
+
+        self.Rota = RotaBuilder(
+            start_date,
+            weeks_to_rota=weeks_to_rota,
+        )
+        self.Rota.constraint_options["balance_weekends"] = True
+
+        # Add a few workers
+        worker1 = Worker(self.Rota, "worker1", "group1", 1)
+        worker2 = Worker(self.Rota, "worker2", "group1", 1)
+        worker3 = Worker(self.Rota, "worker3", "group1", 1)
+        worker4 = Worker(self.Rota, "worker4", "group1", 1)
+
+        self.Rota.add_workers((worker1, worker2, worker3, worker4))
+
+        # Add a weekday and weekend shift
+        self.Rota.add_shifts(
+            SingleShift(
+                ("group1",),
+                "a",
+                12.5,
+                days,
+                balance_offset=1,
+                workers_required=1,
+            ),
+            SingleShift(
+                ("group1",),
+                "b",
+                12.5,
+                days[5:],
+                balance_offset=0,
+                workers_required=1
+            ),
+        )
+
+        self.Rota.build_and_solve(options={"ratio": 0.00})
+
+        self.Rota.export_rota_to_html("balance_weekend")
+
+        assert self.Rota.results.solver.status == "ok"
+        assert self.Rota.results.solver.termination_condition == "optimal"
+
+        for worker in self.Rota.workers:
+            shifts = self.Rota.get_worker_shift_list(worker)
+
+            # Convert shift to a string representation
+            shifts_string = "".join([i if i != "" else "-" for i in shifts])
+
+            assert shifts_string.count("b") == 5
+            assert shifts_string.count("a") in (17,18)
+
+            weekend_count = 0
+            for week in weeks_from_list(shifts_string):
+                if week[5:] == "--":
+                    continue
+                weekend_count = weekend_count + 1
+
+            assert weekend_count == 5 == self.Rota.model.worker_weekend_count[worker.id].value
+
+    def test_balance_weekend2(self):
+        # Set up rota
+        weeks_to_rota = 10
+        start_date = datetime.date(2022, 3, 7)
+
+        self.Rota = RotaBuilder(
+            start_date,
+            weeks_to_rota=weeks_to_rota,
+        )
+        self.Rota.constraint_options["balance_weekends"] = True
+
+        # Add a few workers
+        worker1 = Worker(self.Rota, "worker1", "group1", 1)
+        worker2 = Worker(self.Rota, "worker2", "group1", 1)
+        worker3 = Worker(self.Rota, "worker3", "group1", 1)
+        worker4 = Worker(self.Rota, "worker4", "group1", 1)
+        worker5 = Worker(self.Rota, "worker5", "group1", 1)
+
+        self.Rota.add_workers((worker1, worker2, worker3, worker4, worker5))
+
+        # Add a weekday and weekend shift
+        self.Rota.add_shifts(
+            SingleShift(
+                ("group1",),
+                "a",
+                12.5,
+                days,
+                balance_offset=5,
+                workers_required=1,
+                force_as_block=True
+            ),
+            SingleShift(
+                ("group1",),
+                "b",
+                12.5,
+                days[5:],
+                balance_offset=0,
+                workers_required=2
+            ),
+        )
+
+        self.Rota.build_and_solve(options={"ratio": 0.00})
+
+        self.Rota.export_rota_to_html("balance_weekend2")
+
+        assert self.Rota.results.solver.status == "ok"
+        assert self.Rota.results.solver.termination_condition == "optimal"
+
+        for worker in self.Rota.workers:
+            shifts = self.Rota.get_worker_shift_list(worker)
+
+            # Convert shift to a string representation
+            shifts_string = "".join([i if i != "" else "-" for i in shifts])
+
+            assert shifts_string.count("b") == 8
+            assert shifts_string.count("a") == 14
+
+            weekend_count = 0
+            for week in weeks_from_list(shifts_string):
+                if week[5:] == "--":
+                    continue
+                weekend_count = weekend_count + 1
+
+            assert weekend_count == 6 == self.Rota.model.worker_weekend_count[worker.id].value
+
    def test_post_mon_tue(self):
        # Set up rota
        weeks_to_rota = 10