Merge ~jugmac00/launchpad:populate-signedcodeofconduct.affirmed into launchpad:master

[Jürgen Gmach]

Populate SignedCodeOfConduct.affirmed

[Jürgen Gmach (jugmac00)]

Attention: this is work in progress - the test currently does not pass.

It fails / errors with:

 lp.scripts.tests.test_garbo.TestGarbo.test_PopulateSignedCodeOfConductAffirmed

Error in test lp.scripts.tests.test_garbo.TestGarbo.test_PopulateSignedCodeOfConductAffirmed
Traceback (most recent call last):
testtools.testresult.real._StringException: librarian-log: {{{
2021-10-14 21:06:29+0530 [-] Loading /home/jugmac00/launchpad/launchpad/daemons/librarian.tac...
2021-10-14 21:06:31+0530 [-] Loaded.
2021-10-14 21:06:31+0530 [-] twistd 20.3.0 (/home/jugmac00/launchpad/launchpad/env/bin/python3 3.5.2) starting up.
2021-10-14 21:06:31+0530 [-] reactor class: twisted.internet.epollreactor.EPollReactor.
2021-10-14 21:06:31+0530 [-] FileUploadFactory starting on 46629
2021-10-14 21:06:31+0530 [-] Starting factory <lp.services.librarianserver.libraryprotocol.FileUploadFactory object at 0x7efd137e7048>
2021-10-14 21:06:31+0530 [-] Site starting on 33159
2021-10-14 21:06:31+0530 [-] Starting factory <twisted.web.server.Site object at 0x7efd13798cc0>
2021-10-14 21:06:31+0530 [-] FileUploadFactory starting on 40011
2021-10-14 21:06:31+0530 [-] Starting factory <lp.services.librarianserver.libraryprotocol.FileUploadFactory object at 0x7efd131386a0>
2021-10-14 21:06:31+0530 [-] Site starting on 40651
2021-10-14 21:06:31+0530 [-] Starting factory <twisted.web.server.Site object at 0x7efd130f1f98>
2021-10-14 21:06:31+0530 [-] Not using upstream librarian
2021-10-14 21:06:31+0530 [-] daemon ready!
}}}

Traceback (most recent call last):
  File "/home/jugmac00/launchpad/launchpad/lib/lp/scripts/tests/test_garbo.py", line 448, in setUp
    self.runHourly()
  File "/home/jugmac00/launchpad/launchpad/lib/lp/scripts/tests/test_garbo.py", line 479, in runHourly
    collector.main()
  File "/home/jugmac00/launchpad/launchpad/lib/lp/scripts/garbo.py", line 1877, in main
    raise SilentLaunchpadScriptFailure(self.failure_count)
lp.services.scripts.base.SilentLaunchpadScriptFailure: 1

The "populator" itself works, ie when instantiating it with `PopulateSignedCodeOfConductAffirmed(log=None)`, which is even more puzzling.

[Colin Watson (cjwatson)]

I think your problem is probably that the "garbo" database user doesn't have the necessary permissions on that table. You can fix this in `database/schema/security.cfg`: the `[garbo]` section will need something like `public.signedcodeofconduct = SELECT, UPDATE`.

security.cfg changes are applied automatically on rollouts to our various instances, but in a development setup you'll need to run `for db in launchpad_empty launchpad_dev_template launchpad_dev launchpad_ftest_template launchpad_ftest_playground; do database/schema/security.py -d $db; done` (or `make schema`, but that wipes and replaces your local database rather than changing its permissions in place).

[Jürgen Gmach (jugmac00)]

Thank you! Worked out nicely.

MP needs a new review.

[Colin Watson (cjwatson)]

review: Approve

[Jürgen Gmach (jugmac00)]

Thanks for the review!

diff --git a/database/schema/security.cfg b/database/schema/security.cfg
index 39822d1..03c81f2 100644
--- a/database/schema/security.cfg
+++ b/database/schema/security.cfg
@@ -2534,6 +2534,7 @@ public.potmsgset                        = SELECT, DELETE
 public.previewdiff                      = SELECT, DELETE
 public.revisionauthor                   = SELECT, UPDATE
 public.revisioncache                    = SELECT, DELETE
+public.signedcodeofconduct              = SELECT, UPDATE
 public.snap                             = SELECT, UPDATE
 public.snapbase                         = SELECT
 public.snapbuild                        = SELECT, UPDATE
diff --git a/lib/lp/scripts/garbo.py b/lib/lp/scripts/garbo.py
index e2471dc..ce28426 100644
--- a/lib/lp/scripts/garbo.py
+++ b/lib/lp/scripts/garbo.py
@@ -75,6 +75,7 @@ from lp.code.model.revision import (
     )
 from lp.oci.model.ocirecipebuild import OCIFile
 from lp.registry.interfaces.person import IPersonSet
+from lp.registry.model.codeofconduct import SignedCodeOfConduct
 from lp.registry.model.person import Person
 from lp.registry.model.product import Product
 from lp.registry.model.sourcepackagename import SourcePackageName
@@ -1764,6 +1765,29 @@ class PopulateSnapBuildStoreRevision(TunableLoop):
         transaction.commit()
 
 
+class PopulateSignedCodeOfConductAffirmed(TunableLoop):
+    """Populates SignedCodeOfConduct.affirmed if not set"""
+
+    maximum_chunk_size = 5000
+
+    def __init__(self, log, abort_time=None):
+        super().__init__(log, abort_time)
+        self.store = IMasterStore(SignedCodeOfConduct)
+
+    def findSignedCodeOfConducts(self):
+        return self.store.find(
+            SignedCodeOfConduct,
+            SignedCodeOfConduct.affirmed == None
+        )
+
+    def isDone(self):
+        return self.findSignedCodeOfConducts().is_empty()
+
+    def __call__(self, chunk_size):
+        self.findSignedCodeOfConducts()[:chunk_size].set(affirmed=False)
+        transaction.commit()
+
+
 class BaseDatabaseGarbageCollector(LaunchpadCronScript):
     """Abstract base class to run a collection of TunableLoops."""
     script_name = None  # Script name for locking and database user. Override.
@@ -2024,6 +2048,7 @@ class HourlyDatabaseGarbageCollector(BaseDatabaseGarbageCollector):
         GitRepositoryPruner,
         RevisionCachePruner,
         UnusedSessionPruner,
+        PopulateSignedCodeOfConductAffirmed,
         ]
     experimental_tunable_loops = []
 
diff --git a/lib/lp/scripts/tests/test_garbo.py b/lib/lp/scripts/tests/test_garbo.py
index bb2bfb2..220d439 100644
--- a/lib/lp/scripts/tests/test_garbo.py
+++ b/lib/lp/scripts/tests/test_garbo.py
@@ -84,6 +84,7 @@ from lp.registry.enums import (
 from lp.registry.interfaces.accesspolicy import IAccessPolicySource
 from lp.registry.interfaces.person import IPersonSet
 from lp.registry.interfaces.teammembership import TeamMembershipStatus
+from lp.registry.model.codeofconduct import SignedCodeOfConduct
 from lp.registry.model.commercialsubscription import CommercialSubscription
 from lp.registry.model.teammembership import TeamMembership
 from lp.scripts.garbo import (
@@ -96,6 +97,7 @@ from lp.scripts.garbo import (
     load_garbo_job_state,
     LoginTokenPruner,
     OpenIDConsumerAssociationPruner,
+    PopulateSignedCodeOfConductAffirmed,
     PopulateSnapBuildStoreRevision,
     ProductVCSPopulator,
     save_garbo_job_state,
@@ -2045,6 +2047,21 @@ class TestGarbo(FakeAdapterMixin, TestCaseWithFactory):
         switch_dbuser('testadmin')
         self.assertEqual(build1._store_upload_revision, 1)
 
+    def test_PopulateSignedCodeOfConductAffirmed(self):
+        switch_dbuser('testadmin')
+        populator = PopulateSignedCodeOfConductAffirmed(log=None)
+        for _ in range(5):
+            person = self.factory.makePerson()
+            SignedCodeOfConduct(owner=person).affirmed = None
+
+        result_set = populator.findSignedCodeOfConducts()
+        self.assertGreater(result_set.count(), 0)
+
+        self.runHourly()
+
+        result_set = populator.findSignedCodeOfConducts()
+        self.assertTrue(result_set.is_empty())
+
 
 class TestGarboTasks(TestCaseWithFactory):
     layer = LaunchpadZopelessLayer