#!/usr/bin/python3 # (C) 2017 Canonical Ltd. # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. import os import sys import unittest from unittest.mock import DEFAULT, patch, call PROJECT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) sys.path.insert(0, PROJECT_DIR) from britney2.policies.policy import PolicyVerdict from britney2.policies.email import EmailPolicy, person_chooser, address_chooser from tests.test_sourceppa import FakeOptions # Example of a direct upload by core dev: openstack-doc-tools 1.5.0-0ubuntu1 # https://api.launchpad.net/1.0/ubuntu/+archive/primary/+sourcepub/7524835 UPLOAD = dict( creator_link=None, package_creator_link='https://api.launchpad.net/1.0/~zulcss', package_signer_link='https://api.launchpad.net/1.0/~zulcss', sponsor_link=None, ) # Example of a sponsored upload: kerneloops 0.12+git20140509-2ubuntu1 # https://api.launchpad.net/1.0/ubuntu/+archive/primary/+sourcepub/7013597 SPONSORED_UPLOAD = dict( creator_link=None, package_creator_link='https://api.launchpad.net/1.0/~smb', package_signer_link='https://api.launchpad.net/1.0/~apw', sponsor_link=None, ) # Example of a bileto upload: autopilot 1.6.0+17.04.20170302-0ubuntu1 # https://api.launchpad.net/1.0/ubuntu/+archive/primary/+sourcepub/7525085 # (dobey clicked 'build' and sil2100 clicked 'publish') BILETO = dict( creator_link='https://api.launchpad.net/1.0/~sil2100', package_creator_link='https://api.launchpad.net/1.0/~dobey', package_signer_link='https://api.launchpad.net/1.0/~ci-train-bot', sponsor_link='https://api.launchpad.net/1.0/~ubuntu-archive-robot', ) # Example of a non-sponsored copy: linux 4.10.0-11.13 # https://api.launchpad.net/1.0/ubuntu/+archive/primary/+sourcepub/7522481 # (the upload to the PPA was sponsored but the copy was done directly) UNSPONSORED_COPY = dict( creator_link='https://api.launchpad.net/1.0/~timg-tpi', package_creator_link='https://api.launchpad.net/1.0/~sforshee', package_signer_link='https://api.launchpad.net/1.0/~timg-tpi', sponsor_link=None, ) # Example of a sponsored copy: pagein 0.00.03-1 # https://api.launchpad.net/1.0/ubuntu/+archive/primary/+sourcepub/7533336 SPONSORED_COPY = dict( creator_link='https://api.launchpad.net/1.0/~colin-king', package_creator_link='https://api.launchpad.net/1.0/~colin-king', package_signer_link=None, sponsor_link='https://api.launchpad.net/1.0/~mapreri', ) # Example of a manual debian sync: systemd 232-19 # https://api.launchpad.net/1.0/ubuntu/+archive/primary/+sourcepub/7522736 MANUAL_SYNC = dict( creator_link='https://api.launchpad.net/1.0/~costamagnagianfranco', package_creator_link='https://api.launchpad.net/1.0/~pkg-systemd-maintainers', package_signer_link=None, sponsor_link=None, ) # Example of a sponsored manual debian sync: python-pymysql 0.7.9-2 # https://api.launchpad.net/1.0/ubuntu/+archive/primary/+sourcepub/7487820 SPONSORED_MANUAL_SYNC = dict( creator_link='https://api.launchpad.net/1.0/~lars-tangvald', package_creator_link='https://api.launchpad.net/1.0/~openstack-1.0', package_signer_link=None, sponsor_link='https://api.launchpad.net/1.0/~racb', ) # Example of an automatic debian sync: gem2deb 0.33.1 # https://api.launchpad.net/1.0/ubuntu/+archive/primary/+sourcepub/7255529 AUTO_SYNC = dict( creator_link='https://api.launchpad.net/1.0/~katie', package_creator_link='https://api.launchpad.net/1.0/~pkg-ruby-extras-maintainers', package_signer_link=None, sponsor_link='https://api.launchpad.net/1.0/~ubuntu-archive-robot', ) # address lists UBUNTU = ['personal@gmail.com', 'ubuntu@ubuntu.com', 'work@canonical.com'] CANONICAL = ['personal@gmail.com', 'work@canonical.com'] COMMUNITY = ['personal@gmail.com', 'other@gmail.com'] def retvals(retvals): """Return different retvals on different calls of mock.""" def returner(*args, **kwargs): return retvals.pop() return returner class FakeSourceData: version = '55.0' class FakeExcuse: is_valid = True daysold = 0 class T(unittest.TestCase): maxDiff = None def test_person_chooser(self): """Find the correct person to blame for an upload.""" self.assertEqual(person_chooser(UPLOAD), { 'https://api.launchpad.net/1.0/~zulcss', }) self.assertEqual(person_chooser(SPONSORED_UPLOAD), { 'https://api.launchpad.net/1.0/~apw', 'https://api.launchpad.net/1.0/~smb' }) self.assertEqual(person_chooser(BILETO), { 'https://api.launchpad.net/1.0/~dobey', 'https://api.launchpad.net/1.0/~sil2100', }) self.assertEqual(person_chooser(UNSPONSORED_COPY), { 'https://api.launchpad.net/1.0/~timg-tpi', }) self.assertEqual(person_chooser(SPONSORED_COPY), { 'https://api.launchpad.net/1.0/~colin-king', 'https://api.launchpad.net/1.0/~mapreri', }) self.assertEqual(person_chooser(MANUAL_SYNC), { 'https://api.launchpad.net/1.0/~costamagnagianfranco', }) self.assertSequenceEqual(person_chooser(SPONSORED_MANUAL_SYNC), { 'https://api.launchpad.net/1.0/~lars-tangvald', 'https://api.launchpad.net/1.0/~racb', }) self.assertEqual(person_chooser(AUTO_SYNC), set()) def test_address_chooser(self): """Prioritize email addresses correctly.""" self.assertEqual(address_chooser(UBUNTU), 'ubuntu@ubuntu.com') self.assertEqual(address_chooser(CANONICAL), 'work@canonical.com') self.assertEqual(address_chooser(COMMUNITY), 'personal@gmail.com') @patch('britney2.policies.email.EmailPolicy.query_rest_api') @patch('britney2.policies.email.EmailPolicy.query_lp_rest_api') def test_email_scraping(self, lp, rest): """Poke correct REST APIs to find email addresses.""" lp.side_effect = retvals([ dict(entries=[dict(fingerprint='DEFACED_ED1F1CE')]), dict(entries=[UPLOAD]), ]) rest.return_value = 'uid:Defaced Edifice :12345::' e = EmailPolicy(FakeOptions, None) self.assertEqual(e.lp_get_emails('openstack-doct-tools', '1.5.0-0ubuntu1'), ['ex@example.com']) self.assertSequenceEqual(lp.mock_calls, [ call('testbuntu/+archive/primary', { 'distro_series': '/testbuntu/zazzy', 'exact_match': 'true', 'order_by_date': 'true', 'pocket': 'Proposed', 'source_name': 'openstack-doct-tools', 'version': '1.5.0-0ubuntu1', 'ws.op': 'getPublishedSources', }), call('https://api.launchpad.net/1.0/~zulcss/gpg_keys', {}) ]) self.assertSequenceEqual(rest.mock_calls, [ call('http://keyserver.ubuntu.com/pks/lookup', { 'exact': 'on', 'op': 'index', 'options': 'mr', 'search': '0xDEFACED_ED1F1CE', }) ]) @patch('britney2.policies.email.EmailPolicy.lp_get_emails') @patch('britney2.policies.email.smtplib') def test_smtp_not_sent(self, smtp, lp): """Know when not to send any emails.""" lp.return_value = ['example@email.com'] e = EmailPolicy(FakeOptions, None) FakeExcuse.is_valid = False FakeExcuse.daysold = 0 e.apply_policy_impl(None, None, 'chromium-browser', None, FakeSourceData, FakeExcuse) FakeExcuse.is_valid = True FakeExcuse.daysold = 4 e.apply_policy_impl(None, None, 'chromium-browser', None, FakeSourceData, FakeExcuse) # Would email but no address found FakeExcuse.daysold = 10 lp.return_value = [] e.apply_policy_impl(None, None, 'chromium-browser', None, FakeSourceData, FakeExcuse) self.assertEqual(smtp.mock_calls, []) @patch('britney2.policies.email.EmailPolicy.lp_get_emails') @patch('britney2.policies.email.smtplib') def test_smtp_sent(self, smtp, lp): """Send emails correctly.""" lp.return_value = ['email@address.com'] e = EmailPolicy(FakeOptions, None) FakeExcuse.is_valid = False FakeExcuse.daysold = 100 e.apply_policy_impl(None, None, 'chromium-browser', None, FakeSourceData, FakeExcuse) smtp.SMTP.assert_called_once_with('localhost') @patch('britney2.policies.email.EmailPolicy.lp_get_emails') @patch('britney2.policies.email.smtplib', autospec=True) def test_smtp_days(self, smtp, lp): """Pluralize correctly.""" lp.return_value = ['email@address.com'] e = EmailPolicy(FakeOptions, None) FakeExcuse.is_valid = False FakeExcuse.daysold = 1.01 e.apply_policy_impl(None, None, 'chromium-browser', None, FakeSourceData, FakeExcuse) smtp.SMTP.assert_called_once_with('localhost') name, args, kwargs = smtp.SMTP().sendmail.mock_calls[0] text = args[2] self.assertIn(' 1 day.', text) FakeExcuse.daysold = 4.9 e.apply_policy_impl(None, None, 'chromium-browser', None, FakeSourceData, FakeExcuse) name, args, kwargs = smtp.SMTP().sendmail.mock_calls[-1] text = args[2] self.assertIn(' 4 days.', text) if __name__ == '__main__': unittest.main()