ci: add automation to python repo (#94)

* ci: add automation to python repo

* fix: config update due to updated pytest-asyncio

Author: peterdeme

.github/CODEOWNERS

@@ -1 +1 @@
-* @mahboubii @gumuz
+* @ferhatelmas @gumuz

.github/workflows/ci.yml

@@ -11,6 +11,7 @@ concurrency:
 
 jobs:
   build:
+    name: 🧪 Test & lint
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 1

.github/workflows/initiate_release.yml

@@ -0,0 +1,47 @@
+name: Create release PR
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "The new version number with 'v' prefix. Example: v1.40.1"
+        required: true
+
+jobs:
+  init_release:
+    name: 🚀 Create release PR
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # gives the changelog generator access to all previous commits
+
+      - name: Update CHANGELOG.md, __pkg__.py and push release branch
+        env:
+          VERSION: ${{ github.event.inputs.version }}
+        run: |
+          npx --yes [email protected] --release-as "$VERSION" --skip.tag --skip.commit --tag-prefix=v
+          git config --global user.name 'github-actions' 
+          git config --global user.email '[email protected]'
+          git checkout -q -b "release-$VERSION"
+          git commit -am "chore(release): $VERSION"
+          git push -q -u origin "release-$VERSION"
+
+      - name: Get changelog diff
+        uses: actions/github-script@v5
+        with:
+          script: |
+            const get_change_log_diff = require('./scripts/get_changelog_diff.js')
+            core.exportVariable('CHANGELOG', get_change_log_diff())
+
+      - name: Open pull request
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr create \
+            -t "Release ${{ github.event.inputs.version }}" \
+            -b "# :rocket: ${{ github.event.inputs.version }}
+            Make sure to use squash & merge when merging!
+            Once this is merged, another job will kick off automatically and publish the package.
+            # :memo: Changelog
+            ${{ env.CHANGELOG }}"

.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: Release
+
+on:
+  pull_request:
+    types: [closed]
+    branches:
+      - master
+
+jobs:
+  Release:
+    name: 🚀 Release
+    if: github.event.pull_request.merged && startsWith(github.head_ref, 'release-')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - uses: actions/github-script@v5
+        with:
+          script: |
+            const get_change_log_diff = require('./scripts/get_changelog_diff.js')
+            core.exportVariable('CHANGELOG', get_change_log_diff())
+
+            // Getting the release version from the PR source branch
+            // Source branch looks like this: release-1.0.0
+            const version = context.payload.pull_request.head.ref.split('-')[1]
+            core.exportVariable('VERSION', version)
+
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+
+      - name: Publish to PyPi
+        env:
+          TWINE_USERNAME: "__token__"
+          TWINE_PASSWORD: "${{ secrets.PYPI_TOKEN }}"
+        run: |
+          pip install -q twine==3.7.1
+          python setup.py sdist bdist_wheel
+          twine upload --non-interactive dist/*
+
+      - name: Create release on GitHub
+        uses: ncipollo/release-action@v1
+        with:
+          body: ${{ env.CHANGELOG }}
+          tag: ${{ env.VERSION }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/reviewdog.yml

@@ -8,6 +8,7 @@ concurrency:
 
 jobs:
   reviewdog:
+    name: 🐶 Reviewdog
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

.versionrc.js

@@ -0,0 +1,16 @@
+const pkgUpdater = {
+    VERSION_REGEX: /__version__ = "(.+)"/,
+
+    readVersion: function (contents) {
+        const version = this.VERSION_REGEX.exec(contents)[1];
+        return version;
+    },
+
+    writeVersion: function (contents, version) {
+        return contents.replace(this.VERSION_REGEX.exec(contents)[0], `__version__ = "${version}"`);
+    }
+}
+
+module.exports = {
+    bumpFiles: [{ filename: './stream_chat/__pkg__.py', updater: pkgUpdater }],
+}

CHANGELOG.md

@@ -1,4 +1,8 @@
-## Jan 6, 2022 - 3.17.0
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [3.17.0](https://github.com/GetStream/stream-chat-python/compare/v3.16.0...v3.17.0) (2022-01-06)
 
 - Add options support into channel truncate
 - Add options support into add members

pyproject.toml

@@ -24,6 +24,10 @@ exclude = '''
 )/
 '''
 
+[tool.pytest.ini_options]
+testpaths = ["stream_chat/tests"]
+asyncio_mode = "auto"
+
 [tool.mypy]
 disallow_untyped_defs = true
 disallow_untyped_calls = true

scripts/get_changelog_diff.js

@@ -0,0 +1,26 @@
+/*
+Here we're trying to parse the latest changes from CHANGELOG.md file.
+The changelog looks like this:
+
+## 0.0.3
+- Something #3
+## 0.0.2
+- Something #2
+## 0.0.1
+- Something #1
+
+In this case we're trying to extract "- Something #3" since that's the latest change.
+*/
+module.exports = () => {
+    const fs = require('fs')
+
+    changelog = fs.readFileSync('CHANGELOG.md', 'utf8')
+    releases = changelog.match(/## [?[0-9](.+)/g)
+
+    current_release = changelog.indexOf(releases[0])
+    previous_release = changelog.indexOf(releases[1])
+
+    latest_changes = changelog.substr(current_release, previous_release - current_release)
+
+    return latest_changes
+}

stream_chat/tests/async_chat/test_channel.py

@@ -10,7 +10,6 @@
 
 @pytest.mark.incremental
 class TestChannel(object):
-    @pytest.mark.asyncio
     async def test_ban_user(
         self, channel: Channel, random_user: Dict, server_user: Dict
     ):
@@ -23,7 +22,6 @@ async def test_ban_user(
         )
         await channel.unban_user(random_user["id"])
 
-    @pytest.mark.asyncio
     async def test_create_without_id(
         self, client: StreamChatAsync, random_users: List[Dict]
     ):
@@ -35,21 +33,18 @@ async def test_create_without_id(
         await channel.create(random_users[0]["id"])
         assert channel.id is not None
 
-    @pytest.mark.asyncio
     async def test_send_message_with_options(self, channel: Channel, random_user: Dict):
         response = await channel.send_message(
             {"text": "hi"}, random_user["id"], skip_push=True
         )
         assert "message" in response
         assert response["message"]["text"] == "hi"
 
-    @pytest.mark.asyncio
     async def test_send_event(self, channel: Channel, random_user: Dict):
         response = await channel.send_event({"type": "typing.start"}, random_user["id"])
         assert "event" in response
         assert response["event"]["type"] == "typing.start"
 
-    @pytest.mark.asyncio
     async def test_send_reaction(self, channel: Channel, random_user: Dict):
         msg = await channel.send_message({"text": "hi"}, random_user["id"])
         response = await channel.send_reaction(
@@ -59,7 +54,6 @@ async def test_send_reaction(self, channel: Channel, random_user: Dict):
         assert len(response["message"]["latest_reactions"]) == 1
         assert response["message"]["latest_reactions"][0]["type"] == "love"
 
-    @pytest.mark.asyncio
     async def test_delete_reaction(self, channel: Channel, random_user: Dict):
         msg = await channel.send_message({"text": "hi"}, random_user["id"])
         await channel.send_reaction(
@@ -71,13 +65,11 @@ async def test_delete_reaction(self, channel: Channel, random_user: Dict):
         assert "message" in response
         assert len(response["message"]["latest_reactions"]) == 0
 
-    @pytest.mark.asyncio
     async def test_update(self, channel: Channel):
         response = await channel.update({"motd": "one apple a day..."})
         assert "channel" in response
         assert response["channel"]["motd"] == "one apple a day..."
 
-    @pytest.mark.asyncio
     async def test_update_partial(self, channel: Channel):
         response = await channel.update({"color": "blue", "age": 30})
         assert "channel" in response
@@ -91,18 +83,15 @@ async def test_update_partial(self, channel: Channel):
         assert response["channel"]["color"] == "red"
         assert "age" not in response["channel"]
 
-    @pytest.mark.asyncio
     async def test_delete(self, channel: Channel):
         response = await channel.delete()
         assert "channel" in response
         assert response["channel"].get("deleted_at") is not None
 
-    @pytest.mark.asyncio
     async def test_truncate(self, channel: Channel):
         response = await channel.truncate()
         assert "channel" in response
 
-    @pytest.mark.asyncio
     async def test_truncate_with_options(self, channel: Channel, random_user: Dict):
         response = await channel.truncate(
             skip_push=True,
@@ -113,7 +102,6 @@ async def test_truncate_with_options(self, channel: Channel, random_user: Dict):
         )
         assert "channel" in response
 
-    @pytest.mark.asyncio
     async def test_add_members(self, channel: Channel, random_user: Dict):
         response = await channel.remove_members([random_user["id"]])
         assert len(response["members"]) == 0
@@ -122,15 +110,13 @@ async def test_add_members(self, channel: Channel, random_user: Dict):
         assert len(response["members"]) == 1
         assert not response["members"][0].get("is_moderator", False)
 
-    @pytest.mark.asyncio
     async def test_add_members_with_options(self, channel: Channel, random_user: Dict):
         response = await channel.remove_members([random_user["id"]])
         assert len(response["members"]) == 0
 
         response = await channel.add_members([random_user["id"]], hide_history=True)
         assert len(response["members"]) == 1
 
-    @pytest.mark.asyncio
     async def test_invite_members(self, channel: Channel, random_user: Dict):
         response = await channel.remove_members([random_user["id"]])
         assert len(response["members"]) == 0
@@ -139,15 +125,13 @@ async def test_invite_members(self, channel: Channel, random_user: Dict):
         assert len(response["members"]) == 1
         assert response["members"][0].get("invited", True)
 
-    @pytest.mark.asyncio
     async def test_add_moderators(self, channel: Channel, random_user: Dict):
         response = await channel.add_moderators([random_user["id"]])
         assert response["members"][0]["is_moderator"]
 
         response = await channel.demote_moderators([random_user["id"]])
         assert not response["members"][0].get("is_moderator", False)
 
-    @pytest.mark.asyncio
     async def test_assign_roles_moderators(self, channel: Channel, random_user: Dict):
         member = {"user_id": random_user["id"], "channel_role": "channel_moderator"}
         response = await channel.add_members([member])
@@ -159,13 +143,11 @@ async def test_assign_roles_moderators(self, channel: Channel, random_user: Dict
         assert len(response["members"]) == 1
         assert response["members"][0]["channel_role"] == "channel_member"
 
-    @pytest.mark.asyncio
     async def test_mark_read(self, channel: Channel, random_user: Dict):
         response = await channel.mark_read(random_user["id"])
         assert "event" in response
         assert response["event"]["type"] == "message.read"
 
-    @pytest.mark.asyncio
     async def test_get_replies(self, channel: Channel, random_user: Dict):
         msg = await channel.send_message({"text": "hi"}, random_user["id"])
         response = await channel.get_replies(msg["message"]["id"])
@@ -187,7 +169,6 @@ async def test_get_replies(self, channel: Channel, random_user: Dict):
         assert len(response["messages"]) == 3
         assert response["messages"][0]["index"] == 7
 
-    @pytest.mark.asyncio
     async def test_get_reactions(self, channel: Channel, random_user: Dict):
         msg = await channel.send_message({"text": "hi"}, random_user["id"])
         response = await channel.get_reactions(msg["message"]["id"])
@@ -211,14 +192,12 @@ async def test_get_reactions(self, channel: Channel, random_user: Dict):
 
         assert response["reactions"][0]["count"] == 42
 
-    @pytest.mark.asyncio
     async def test_send_and_delete_file(self, channel: Channel, random_user: Dict):
         url = "helloworld.jpg"
         resp = await channel.send_file(url, "helloworld.jpg", random_user)
         assert "helloworld.jpg" in resp["file"]
         await channel.delete_file(resp["file"])
 
-    @pytest.mark.asyncio
     async def test_send_and_delete_image(self, channel: Channel, random_user: Dict):
         url = "helloworld.jpg"
         resp = await channel.send_image(
@@ -227,7 +206,6 @@ async def test_send_and_delete_image(self, channel: Channel, random_user: Dict):
         assert "helloworld.jpg" in resp["file"]
         await channel.delete_image(resp["file"])
 
-    @pytest.mark.asyncio
     async def test_channel_hide_show(
         self, client: StreamChatAsync, channel: Channel, random_users: List[Dict]
     ):
@@ -271,7 +249,6 @@ async def test_channel_hide_show(
         )
         assert len(response["channels"]) == 1
 
-    @pytest.mark.asyncio
     async def test_invites(self, client: StreamChatAsync, channel: Channel):
         members = ["john", "paul", "george", "pete", "ringo", "eric"]
         await client.update_users([{"id": m} for m in members])
@@ -301,7 +278,6 @@ async def test_invites(self, client: StreamChatAsync, channel: Channel):
         # can reject again, noop
         await channel.reject_invite("eric")
 
-    @pytest.mark.asyncio
     async def test_query_members(self, client: StreamChatAsync, channel: Channel):
         members = ["paul", "george", "john", "jessica", "john2"]
         await client.update_users([{"id": m, "name": m} for m in members])
@@ -319,7 +295,6 @@ async def test_query_members(self, client: StreamChatAsync, channel: Channel):
         assert response[0]["user"]["id"] == "jessica"
         assert response[1]["user"]["id"] == "john2"
 
-    @pytest.mark.asyncio
     async def test_mute_unmute(
         self, client: StreamChatAsync, channel: Channel, random_users: List[Dict]
     ):
@@ -342,7 +317,6 @@ async def test_mute_unmute(
         )
         assert len(response["channels"]) == 0
 
-    @pytest.mark.asyncio
     async def test_export_channel_status(
         self, client: StreamChatAsync, channel: Channel
     ):
@@ -352,7 +326,6 @@ async def test_export_channel_status(
         with pytest.raises(StreamAPIException, match=r".*Can't find channel.*"):
             await client.export_channel("messaging", str(uuid.uuid4()))
 
-    @pytest.mark.asyncio
     async def test_export_channel(
         self, client: StreamChatAsync, channel: Channel, random_users: List[Dict]
     ):