pkgdev mask: offer to send email to gentoo-dev ML

Resolves: #36
Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>

Author: arthurzam

.github/workflows/test.yml

@@ -64,6 +64,7 @@ jobs:
         pytest --cov --cov-report=term --cov-report=xml -v
 
     - name: Submit code coverage to codecov
+      if: ${{ matrix.os == 'ubuntu-latest' }}
       uses: codecov/codecov-action@v1
       with:
         file: ./coverage.xml

completion/bash/pkgdev

@@ -113,10 +113,12 @@ _pkgdev() {
         mask)
             subcmd_options="
                 -r --rites
+                -b --bugs
+                --email
             "
 
             case "${prev}" in
-                -r | --rites)
+                -[rb] | --rites | --bugs)
                     COMPREPLY=()
                     ;;
                 *)

completion/zsh/_pkgdev

@@ -65,6 +65,8 @@ case $state in
         _arguments -C -A '-*' \
           $base_options \
           {'(--rites)-r','(-r)--rites'}'[mark for last rites]' \
+          {'(--bugs)-b','(-b)--bugs'}'[reference bug in the mask comment]' \
+          '--email[spawn email composer with prepared email for sending to mailing lists]' \
           && ret=0
         ;;
       (push)

src/pkgdev/scripts/pkgdev_mask.py

@@ -51,12 +51,27 @@
         Add a reference to a bug in the mask comment. May be specified multiple
         times to reference multiple bugs.
     """)
+mask_opts.add_argument(
+    '--email', action='store_true',
+    help='spawn email composer with prepared email for sending to mailing lists',
+    docs="""
+        Spawn user's preferred email composer with a prepared email for
+        sending a last rites message to Gentoo's mailing list (``gentoo-dev``
+        and ``gentoo-dev-announce``). The user should manually set the Reply-to
+        field for the message to be accepted by ``gentoo-dev-announce``.
+
+        For spawning the preferred email composer, the ``xdg-email`` tool from
+        ``x11-misc/xdg-utils`` package.
+    """)
 
 
 @mask.bind_final_check
 def _mask_validate(parser, namespace):
     atoms = []
 
+    if namespace.email and not namespace.rites:
+        mask.error('last rites required for email support')
+
     if namespace.targets:
         for x in namespace.targets:
             if os.path.exists(x) and x.endswith('.ebuild'):
@@ -223,6 +238,20 @@ def get_comment(bugs):
     return comment
 
 
+def send_last_rites_email(m: Mask, subject_prefix: str):
+    try:
+        atoms = ', '.join(map(str, m.atoms))
+        subprocess.run(args=[
+            'xdg-email', '--utf8',
+            '--cc', 'gentoo-dev@lists.gentoo.org',
+            '--subject', f'{subject_prefix}: {atoms}',
+            '--body', str(m),
+            'gentoo-dev-announce@lists.gentoo.org'
+        ], check=True)
+    except subprocess.CalledProcessError:
+        mask.error('failed opening email composer')
+
+
 @mask.bind_main_func
 def _mask(options, out, err):
     mask_file = MaskFile(pjoin(options.repo.location, 'profiles/package.mask'))
@@ -248,7 +277,11 @@ def _mask(options, out, err):
         removal = removal_date.strftime('%Y-%m-%d')
         mask_args['comment'].append(f'Removal: {removal}')
 
-    mask_file.add(Mask(**mask_args))
+    m = Mask(**mask_args)
+    mask_file.add(m)
     mask_file.write()
 
+    if options.email:
+        send_last_rites_email(m, 'Last rites')
+
     return 0

tests/scripts/test_pkgdev_mask.py

@@ -1,4 +1,5 @@
 import os
+import sys
 import textwrap
 from datetime import datetime, timedelta, timezone
 from functools import partial
@@ -83,6 +84,18 @@ def test_targets(self, repo, make_git_repo, capsys, tool):
             options, _ = tool.parse_args(['mask', 'cat/pkg'])
         assert options.atoms == [atom_cls('cat/pkg')]
 
+    def test_email_not_rites(self, repo, make_git_repo, capsys, tool):
+        git_repo = make_git_repo(repo.location)
+
+        # masked pkg
+        repo.create_ebuild('cat/pkg-0')
+        git_repo.add_all('cat/pkg-0')
+        with pytest.raises(SystemExit), \
+                chdir(repo.location):
+            tool.parse_args(['mask', '--email', 'cat/pkg'])
+        _, err = capsys.readouterr()
+        assert err.strip() == "pkgdev mask: error: last rites required for email support"
+
 
 class TestPkgdevMask:
 
@@ -202,6 +215,31 @@ def test_last_rites(self):
                 """)
                 self.masks_path.write_text("")  # Reset the contents of package.mask
 
+    @pytest.mark.skipif(sys.platform == "darwin", reason="no xdg-email on mac os")
+    def test_last_rites_with_email(self, tmp_path):
+        output_file = tmp_path / 'mail.txt'
+        for rflag in ('-r', '--rites'):
+            with os_environ(EDITOR="sed -i '1s/$/mask comment/'", MAILER=f"> {output_file} echo"), \
+                    patch('sys.argv', self.args + ['cat/pkg', rflag, '--email']), \
+                    pytest.raises(SystemExit), \
+                    chdir(pjoin(self.repo.path)):
+                self.script()
+            out = output_file.read_text()
+            assert 'mailto:gentoo-dev-announce@lists.gentoo.org' in out
+
+            self.masks_path.write_text("")  # Reset the contents of package.mask
+
+    @pytest.mark.skipif(sys.platform == "darwin", reason="no xdg-email on mac os")
+    def test_last_email_bad_mailer(self, capsys):
+        for rflag in ('-r', '--rites'):
+            with os_environ(EDITOR="sed -i '1s/$/mask comment/'", MAILER="false"), \
+                    patch('sys.argv', self.args + ['cat/pkg', rflag, '--email']), \
+                    pytest.raises(SystemExit), \
+                    chdir(pjoin(self.repo.path)):
+                self.script()
+            _, err = capsys.readouterr()
+            assert err.strip() == "pkgdev mask: error: failed opening email composer"
+
     def test_mask_bugs(self):
         removal_date = self.today + timedelta(days=30)
         today = self.today.strftime('%Y-%m-%d')