Merge lp:~stub/launchpad/botbake into lp:launchpad

[Stuart Bishop]

Command line tool to create bot accounts, for Canonical IS automation work.

Please let me know if this is an acceptable approach. If ok I'll add
tests.

[Colin Watson (cjwatson)]

I don't see anything obviously terrible here, though William should definitely take a look as well.

[lp:~stub/launchpad/botbake]

18335. By Stuart Bishop on 2017-03-13

Indentation

18336. By Stuart Bishop on 2017-03-13

Correct copyright statement

[lp:~stub/launchpad/botbake]

18337. By Stuart Bishop on 2017-03-21

Remove custom creation rationale and other review feedback

[William Grant (wgrant)]

I'd marginally prefer that the team stuff were moved into an API script, but if you don't care then this is fine.

review: Approve (code)

=== added file 'lib/lp/registry/scripts/createbotaccount.py'
--- lib/lp/registry/scripts/createbotaccount.py	1970-01-01 00:00:00 +0000
+++ lib/lp/registry/scripts/createbotaccount.py	2017-03-21 07:36:10 +0000
@@ -0,0 +1,123 @@
+# Copyright 2017 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Create a bot account."""
+
+from zope.component import getUtility
+
+from lp.registry.interfaces.person import IPersonSet
+from lp.registry.interfaces.ssh import ISSHKeySet
+from lp.services.scripts.base import (
+    LaunchpadScript,
+    LaunchpadScriptFailure,
+    )
+from lp.services.webapp import canonical_url
+
+
+class CreateBotAccountScript(LaunchpadScript):
+
+    description = "Create a bot account."
+    output = None
+
+    def add_my_options(self):
+        self.parser.add_option(
+            '-u', '--username', metavar='NAME', action='store',
+            type='string', dest='username', default='',
+            help='Username for the bot')
+        self.parser.add_option(
+            '--openid', metavar='SUFFIX', action='store',
+            type='string', dest='openid', default='',
+            help=('OpenID identifier suffix. Normally unnecessary because '
+                  'SSO account creation handles it'))
+        self.parser.add_option(
+            '-e', '--email', metavar='ADDR', action='store',
+            type='string', dest='email', default='',
+            help='Email address. Defaults to [e-mail]')
+        self.parser.add_option(
+            '-k', '--sshkey', metavar='TXT', action='store',
+            type='string', dest='sshkey', default='',
+            help='SSH public key. Defaults to no ssh key.')
+        self.parser.add_option(
+            '-t', '--teams', metavar='TEAMS', action='store',
+            type='string', dest='teams',
+            default='canonical-is-devopsolution-bots',
+            help='Add bot to this comma separated list of teams')
+
+    def main(self):
+        username = unicode(self.options.username)
+        if not username:
+            raise LaunchpadScriptFailure('--username is required')
+        openid_suffix = unicode(self.options.openid)
+        if '/' in openid_suffix:
+            raise LaunchpadScriptFailure(
+                'Invalid OpenID suffix {}'.format(openid_suffix))
+
+        displayname = u'\U0001f916 {}'.format(username)  # U+1f916==ROBOT FACE
+
+        if self.options.email:
+            emailaddress = unicode(self.options.email)
+        else:
+            emailaddress = u'webops+{}@canonical.com'.format(username)
+
+        if self.options.teams:
+            teamnames = [unicode(t.strip())
+                         for t in self.options.teams.split(',')
+                         if t.strip()]
+        else:
+            teamnames = []
+
+        sshkey_text = unicode(self.options.sshkey)  # Optional
+
+        person_set = getUtility(IPersonSet)
+
+        if openid_suffix and person_set.getByName(username) is None:
+            # Normally the SSO has already called this method.
+            # This codepath is really only used for testing.
+            person_set.createPlaceholderPerson(openid_suffix, username)
+
+        person = person_set.getByName(username)
+        if person is None:
+            raise LaunchpadScriptFailure(
+                'Account {} does not exist'.format(username))
+        if person.account is None:
+            raise LaunchpadScriptFailure(
+                'Person {} has no Account'.format(username))
+        if person.account.openid_identifiers.count() != 1:
+            raise LaunchpadScriptFailure(
+                'Account {} has invalid OpenID identifiers'.format(username))
+        openid_identifier = person.account.openid_identifiers.one()
+
+        # Create the IPerson
+        person, _ = person_set.getOrCreateByOpenIDIdentifier(
+            openid_identifier.identifier,
+            emailaddress,
+            displayname,
+            None,
+            'when the create-bot-account launchpad script was run')
+
+        # person.name = username
+        person.selfgenerated_bugnotifications = True
+        person.expanded_notification_footers = True
+        person.description = 'Canonical IS created bot'
+        person.hide_email_addresses = True
+
+        # The email address must be fully validated.
+        assert person.preferredemail is not None
+
+        # Add team memberships
+        for teamname in teamnames:
+            team = person_set.getByName(teamname)
+            if team is None or not team.is_team:
+                raise LaunchpadScriptFailure(
+                    '{} is not a team'.format(teamname))
+            team.addMember(person, person)
+
+        # Add ssh key
+        sshkey_set = getUtility(ISSHKeySet)
+        if sshkey_text and (
+                sshkey_set.getByPersonAndKeyText(person,
+                                                 sshkey_text).count() == 0):
+            sshkey_set.new(person, sshkey_text, send_notification=False)
+
+        self.logger.info('Created or updated {}'.format(canonical_url(person)))
+        self.txn.commit()

=== added file 'lib/lp/registry/scripts/tests/test_createbotaccount.py'
--- lib/lp/registry/scripts/tests/test_createbotaccount.py	1970-01-01 00:00:00 +0000
+++ lib/lp/registry/scripts/tests/test_createbotaccount.py	2017-03-21 07:36:10 +0000
@@ -0,0 +1,65 @@
+# Copyright 2017 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Tests for PersonSet."""
+
+__metaclass__ = type
+
+
+from mock import MagicMock
+from zope.component import getUtility
+from lp.registry.interfaces.person import IPersonSet
+from lp.registry.interfaces.ssh import ISSHKeySet
+from lp.registry.scripts.createbotaccount import CreateBotAccountScript
+from lp.services.identity.interfaces.emailaddress import EmailAddressStatus
+from lp.testing import TestCase
+from lp.testing.layers import ZopelessDatabaseLayer
+
+
+class CreateBotAccountTests(TestCase):
+    """Test `IPersonSet`."""
+    layer = ZopelessDatabaseLayer
+
+    def test_createbotaccount(self):
+        script = CreateBotAccountScript()
+
+        class _opt:
+            username = 'botty'
+            openid = 'bottyid'
+            email = ''
+            teams = 'rosetta-admins,simple-team'
+            sshkey = ('ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIEA9BC4zfVrGsve6zh'
+                      'jOiEftyNMjqV8YMv1lLMpbWqa7Eqr0ZL+oAoJQMq2w8Dk/1hrgJ'
+                      '1pxdwxwQWogDHZTer8YDa89OSBWGenl++s6bk28h/ysZettSS82'
+                      'BrfpoSUc8Cfz2K1SbI9kz5OhmE4nBVsJgsdiHp9WwwQiyRrjfAu'
+                      'NhE= [e-mail].')
+
+        script.options = _opt
+        script.logger = MagicMock()
+        script.txn = MagicMock()
+        script.main()
+
+        person_set = getUtility(IPersonSet)
+
+        person = person_set.getByName(u'botty')
+        self.assertEqual(person.name, u'botty')
+        self.assertTrue(person.hide_email_addresses)
+        # Bots tend to flood email, so filtering is important.
+        self.assertTrue(person.expanded_notification_footers)
+
+        account = person.account
+        openid = account.openid_identifiers.one()
+        self.assertEqual(openid.identifier, u'bottyid')
+
+        sshkey_set = getUtility(ISSHKeySet)
+        self.assertIsNotNone(
+            sshkey_set.getByPersonAndKeyText(person, _opt.sshkey))
+
+        email = person.preferredemail
+        self.assertEqual(email.email, '[e-mail]')
+        self.assertEqual(email.status, EmailAddressStatus.PREFERRED)
+
+        self.assertTrue(person.inTeam(person_set.getByName('rosetta-admins')))
+        self.assertTrue(person.inTeam(person_set.getByName('simple-team')))
+
+        self.assertTrue(script.txn.commit.called)

=== added file 'scripts/create-bot-account.py'
--- scripts/create-bot-account.py	1970-01-01 00:00:00 +0000
+++ scripts/create-bot-account.py	2017-03-21 07:36:10 +0000
@@ -0,0 +1,13 @@
+#!/usr/bin/python -S
+#
+# Copyright 2017 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+import _pythonpath
+
+from lp.registry.scripts.createbotaccount import CreateBotAccountScript
+
+
+if __name__ == '__main__':
+    script = CreateBotAccountScript('create-bot-account', dbuser='launchpad')
+    script.run()