Merge remote-tracking branch 'upstream/main' into cleanup

Author: alanbriolat

.github/workflows/main.yml

@@ -0,0 +1,71 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  tests:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        include:
+          - python-version: "3.7"
+            toxenv: py37
+          - python-version: "3.8"
+            toxenv: py38
+          - python-version: "3.9"
+            toxenv: py39
+          - python-version: "3.10"
+            toxenv: py310-flake8
+    env:
+      PYTHON: ${{ matrix.python-version }}
+    steps:
+      - name: examine environment
+        run: env
+      - uses: actions/checkout@v1
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install tox
+      - name: Test with tox
+        run: python -m tox
+        env:
+          TOXENV: ${{ matrix.toxenv }}
+      - uses: codecov/codecov-action@v1
+        with:
+          env_vars: PYTHON
+
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build Docker image
+        uses: docker/build-push-action@v2
+        with:
+          load: true
+          push: false
+          tags: csbot:latest
+      - name: Run tests inside Docker
+        run: docker run --rm csbot:latest pytest
+      - name: Login to GitHub Container Registry
+        if: github.event_name == 'push' && github.repository == 'HackSoc/csbot' && github.ref == 'refs/heads/main'
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Publish Docker image
+        if: github.event_name == 'push' && github.repository == 'HackSoc/csbot' && github.ref == 'refs/heads/main'
+        uses: docker/build-push-action@v2
+        with:
+          push: true
+          tags: |
+            ghcr.io/hacksoc/csbot/csbot:latest

.gitignore

@@ -42,6 +42,7 @@ pip-log.txt
 
 # Unit test / coverage reports
 .coverage
+coverage*.xml
 .tox
 nosetests.xml
 _trial_temp/

.travis.yml

@@ -1,4 +1,4 @@
-FROM python:3.7
+FROM python:3.10
 
 ARG UID=9000
 ARG GID=9000

Dockerfile

@@ -69,15 +69,14 @@ Testing
 -------
 csbot has some unit tests.  (It'd be nice to have more.)  To run them::
 
-    $ pytest
+    $ tox
 
-We're also using Travis-CI for continuous integration and continuous deployment.
+We're also using GitHub Actions for continuous integration and continuous deployment.
 
-.. image:: https://travis-ci.org/HackSoc/csbot.svg?branch=master
-    :target: https://travis-ci.org/HackSoc/csbot
+.. image:: https://github.com/HackSoc/csbot/actions/workflows/main.yml/badge.svg
 
-.. image:: https://coveralls.io/repos/HackSoc/csbot/badge.png
-    :target: https://coveralls.io/r/HackSoc/csbot
+.. image:: https://codecov.io/gh/HackSoc/csbot/branch/main/graph/badge.svg?token=oMJcY9E9lj
+    :target: https://codecov.io/gh/HackSoc/csbot
 
 
 .. [1] csbot depends on lxml_, which is a compiled extension module based on
@@ -90,4 +89,4 @@ We're also using Travis-CI for continuous integration and continuous deployment.
 .. _lxml: http://lxml.de/
 .. _Docker Compose: https://docs.docker.com/compose/
 .. _published image: https://hub.docker.com/r/alanbriolat/csbot
-.. _Watchtower: https://containrrr.github.io/watchtower/
+.. _Watchtower: https://containrrr.github.io/watchtower/

README.rst

@@ -2,7 +2,7 @@
 ircv3 = true
 nickname = "Mathison"
 auth_method = "sasl_plain"
-irc_host = "irc.freenode.net"
+irc_host = "irc.libera.chat"
 channels = [
     "#cs-york",
     "#cs-york-dev",
@@ -39,15 +39,15 @@ scan_limit = 2
 [auth]
 "@everything" = "* *:*"
 Alan = "@everything"
-hjmills = "@everything"
+#hjmills = "@everything"
 barrucadu = "#cs-york:topic"
 Helzibah = "#cs-york:topic"
-DinCahill = "#cs-york:topic"
-jalada = "#cs-york:topic"
-kyubiko = "#cs-york:topic #hacksoc:*"
-eep = "#cs-york:topic #hacksoc:*"
+#DinCahill = "#cs-york:topic"
+#jalada = "#cs-york:topic"
+#kyubiko = "#cs-york:topic #hacksoc:*"
+#eep = "#cs-york:topic #hacksoc:*"
 fromankyra = "#hacksoc-bottest:*"
-ldm = "#hacksoc:* #hacksoc-bottest:*" 
+luke = "#hacksoc:* #hacksoc-bottest:*"
 
 "*" = "#compsoc-uk:topic"
 

csbot.deploy.toml

@@ -2,7 +2,7 @@ version: "3"
 
 services:
   bot:
-    image: alanbriolat/csbot:latest
+    image: ghcr.io/hacksoc/csbot/csbot:latest
     volumes:
       - ${CSBOT_CONFIG_LOCAL:-./csbot.toml}:/app/csbot.toml
     links:

docker-compose.test.yml

@@ -1,5 +1,6 @@
 [pytest]
 testpaths = tests/
-addopts = --cov=src/ -W ignore::schematics.deprecated.SchematicsDeprecationWarning
+addopts = --cov=src/ --cov-report=xml -W ignore::schematics.deprecated.SchematicsDeprecationWarning
 markers =
     bot: mark a test as Bot-based rather than IRCClient-based
+asyncio_mode = auto

docker-compose.yml

@@ -1,11 +1,12 @@
 # Requirements for unit testing
-pytest>=5.2.2,<6.0
-pytest-asyncio==0.10.0
-pytest-aiohttp==0.3.0
-aioresponses==0.6.1
+pytest>=7.0.1,<8
+pytest-asyncio==0.18.1
+pytest-aiohttp==1.0.4
+aioresponses==0.7.3
 pytest-cov
 asynctest==0.13.0
 aiofastforward==0.0.24
+time-machine==2.6.0
 mongomock
 
 # Requirements for documentation

pytest.ini

@@ -15,7 +15,7 @@
     ],
     install_requires=[
         'click>=6.2,<7.0',
-        'pymongo>=3.6.0',
+        'pymongo>=4.0.1',
         'requests>=2.9.1,<3.0.0',
         'lxml>=2.3.5',
         'aiogoogle>=0.1.13',

requirements.txt

@@ -350,8 +350,8 @@ def _write(self, s, raw=False):
         """Write *s* to the current stream; if *raw* is True, don't apply comment filter."""
         if not raw and self._commented:
             lines = s.split("\n")
-            modified = [f"# {l}" if l and not l.startswith("#") else l
-                        for l in lines]
+            modified = [f"# {line}" if line and not line.startswith("#") else line
+                        for line in lines]
             s = "\n".join(modified)
         self._stream.write(s)
         self._at_start = False

setup.py

@@ -33,7 +33,7 @@ def __init__(self, get_handlers, loop=None):
         self.loop = loop
 
         self.events = deque()
-        self.new_events = asyncio.Event(loop=self.loop)
+        self.new_events = asyncio.Event()
         self.futures = set()
         self.future = None
 
@@ -91,11 +91,7 @@ def _run_handler(self, handler, event):
             result = handler(event)
         except Exception as e:
             self._handle_exception(exception=e, csbot_event=event)
-        future = maybe_future(
-            result,
-            log=LOG,
-            loop=self.loop,
-        )
+        future = maybe_future(result, log=LOG)
         if future:
             future = asyncio.ensure_future(self._finish_async_handler(future, event), loop=self.loop)
         return future
@@ -129,9 +125,7 @@ async def _run(self):
                 # Run until one or more futures complete (or new events are added)
                 new_events = self.loop.create_task(self.new_events.wait())
                 LOG.debug('waiting on %s futures', len(self.futures))
-                done, pending = await asyncio.wait(self.futures | {new_events},
-                                                   loop=self.loop,
-                                                   return_when=asyncio.FIRST_COMPLETED)
+                done, pending = await asyncio.wait(self.futures | {new_events}, return_when=asyncio.FIRST_COMPLETED)
                 # Remove done futures from the set of futures being waited on
                 done_futures = done - {new_events}
                 LOG.debug('%s of %s futures done', len(done_futures), len(self.futures))

src/csbot/config.py

@@ -276,9 +276,9 @@ def __init__(self, *, loop=None, **kwargs):
 
         self.reader, self.writer = None, None
         self._exiting = False
-        self.connected = asyncio.Event(loop=self.loop)
+        self.connected = asyncio.Event()
         self.connected.clear()
-        self.disconnected = asyncio.Event(loop=self.loop)
+        self.disconnected = asyncio.Event()
         self.disconnected.set()
         self._last_message_received = self.loop.time()
         self._client_ping = None
@@ -325,7 +325,6 @@ async def connect(self):
 
         self.reader, self.writer = await asyncio.open_connection(self.__config['host'],
                                                                  self.__config['port'],
-                                                                 loop=self.loop,
                                                                  local_addr=local_addr)
 
     def disconnect(self):

src/csbot/events.py

@@ -24,7 +24,9 @@ def last(self, nick, channel=None, msgtype=None):
         if msgtype is not None:
             search['type'] = msgtype
 
-        return self.db.find_one(search, sort=[('when', pymongo.DESCENDING)])
+        # Additional sorting by _id to make sort order stable for messages that arrive in the same millisecond
+        # (which sometimes happens during tests).
+        return self.db.find_one(search, sort=[('when', pymongo.DESCENDING), ('_id', pymongo.DESCENDING)])
 
     def last_message(self, nick, channel=None):
         """Get the last message sent by a nick, optionally filtering
@@ -104,8 +106,7 @@ def _schedule_update(self, e, query, update):
 
     @Plugin.hook('last.update')
     def _apply_update(self, e):
-        self.db.remove(e['query'])
-        self.db.insert(e['update'])
+        self.db.replace_one(e['query'], e['update'], upsert=True)
 
     @Plugin.command('seen', help=('seen nick [type]: show the last thing'
                                   ' said by a nick in this channel, optionally'