Support for MQ-based Chatbots

.github/workflows/license_tests.yml

@@ -0,0 +1,12 @@
+name: Run License Tests
+on:
+  push:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - master
+jobs:
+  license_tests:
+    uses: neongeckocom/.github/.github/workflows/license_tests.yml@master
+    with:
+      packages-exclude: '^(bs4|nvidia|bitstruct|audioread|klat-connector|neon-chatbot-core|tqdm|dnspython).*'

.github/workflows/propose_release.yml

@@ -0,0 +1,28 @@
+name: Propose Stable Release
+on:
+  workflow_dispatch:
+    inputs:
+      release_type:
+        type: choice
+        description: Release Type
+        options:
+          - patch
+          - minor
+          - major
+jobs:
+  update_version:
+    uses: neongeckocom/.github/.github/workflows/propose_semver_release.yml@master
+    with:
+      branch: dev
+      release_type: ${{ inputs.release_type }}
+      update_changelog: True
+      version_file: "chatbot_core/version.py"
+  pull_changes:
+    uses: neongeckocom/.github/.github/workflows/pull_master.yml@master
+    needs: update_version
+    with:
+      pr_reviewer: neonreviewers
+      pr_assignee: ${{ github.actor }}
+      pr_draft: false
+      pr_title: ${{ needs.update_version.outputs.version }}
+      pr_body: ${{ needs.update_version.outputs.changelog }}

.github/workflows/publish_release.yml

@@ -1,21 +1,12 @@
 # This workflow will generate a release distribution and upload it to PyPI
 
-name: Publish GitHub Release
+name: Publish Build and GitHub Release
 on:
   push:
     branches:
       - master
 
 jobs:
-  tag_release:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Get Version
-        run: |
-          VERSION=$(python setup.py --version)
-          echo "VERSION=${VERSION}" >> $GITHUB_ENV
-      - uses: ncipollo/release-action@v1
-        with:
-          token: ${{secrets.GITHUB_TOKEN}}
-          tag: ${{env.VERSION}}
+  build_and_publish_pypi_and_release:
+    uses: neongeckocom/.github/.github/workflows/publish_stable_release.yml@master
+    secrets: inherit

.github/workflows/publish_test_build.yml

@@ -1,6 +1,6 @@
 # This workflow will generate a distribution and upload it to PyPI
 
-name: Increment Alpha Version
+name: Publish Alpha Build
 on:
   push:
     branches:
@@ -9,21 +9,9 @@ on:
       - 'version.py'
 
 jobs:
-  build_and_publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          ref: ${{ github.head_ref }}
-      - name: Setup Python
-        uses: actions/setup-python@v1
-        with:
-          python-version: 3.8
-      - name: Increment Version
-        run: |
-          VER=$(python setup.py --version)
-          python version_bump.py
-      - name: Push Version Change
-        uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          commit_message: Increment Version
+  publish_alpha_release:
+    uses: neongeckocom/.github/.github/workflows/publish_alpha_release.yml@master
+    secrets: inherit
+    with:
+      version_file: "chatbot_core/version.py"
+      publish_prerelease: true

.github/workflows/unit_tests.yml

@@ -9,29 +9,58 @@ jobs:
   unit_tests:
     strategy:
       matrix:
-        python-version: [ 3.6, 3.7, 3.8, 3.9 ]
+        python-version: [ 3.8, 3.9]
+        # TODO: 3.10 and 3.11 need support in klat-connector
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[lang] -r requirements/test_requirements.txt
+          python -m nltk.downloader punkt_tab
+        env:
+          GITHUB_TOKEN: ${{secrets.neon_token}}
+      - name: Test with pytest
+        run: |
+          pip install pytest pytest-timeout pytest-cov
+          pytest tests/units --doctest-modules --junitxml=tests/unit-test-results.xml
+      - name: Upload pytest unit test results
+        uses: actions/upload-artifact@v4
+        with:
+          name: unit-test-results-${{ matrix.python-version }}
+          path: tests/unit-test-results.xml
+  integration_tests:
+    strategy:
+      matrix:
+        python-version: [ 3.8, 3.9 ]
+        # TODO: 3.10 and 3.11 need support in klat-connector
       max-parallel: 1
     runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements/test_requirements.txt
-          pip install .
+          pip install . -r requirements/test_requirements.txt
         env:
           GITHUB_TOKEN: ${{secrets.neon_token}}
       - name: Test with pytest
         run: |
           pip install pytest pytest-timeout pytest-cov
-          pytest tests/chatbot_core_tests.py --doctest-modules --junitxml=tests/test-results.xml
-      - name: Upload pytest test results
-        uses: actions/upload-artifact@v2
+          pytest tests/integration --doctest-modules --junitxml=tests/integration-test-results.xml
+      - name: Upload integration test results
+        uses: actions/upload-artifact@v4
         with:
-          name: test-results
-          path: tests/test-results.xml
+          name: integration-test-results-${{ matrix.python-version }}
+          path: tests/integration-test-results.xml

README.md

@@ -1,6 +1,4 @@
 # Chatbot Core
-![Unit Tests](https://github.com/NeonGeckoCom/chatbot-core/workflows/Run%20Unit%20Tests/badge.svg)
-
 Bots using this framework connect to the Klat server and respond to user shouts. Bots will respond individually,
 like any other user in the conversation.
 
@@ -17,11 +15,49 @@ To utilize this repository for creating your own chat bots, install this package
 
 You can install this package with the following command:
 
-`pip install git+https://github.com/neongeckocom/chatbot-core`
+`pip install neon-chatbot-core`
 
 *Note*: It is recommended to install this to a virtual environment to avoid conflicts with package versions and commandline 
 entry points. Most IDE's (i.e. [PyCharm](https://www.jetbrains.com/pycharm/)) handle this for individual projects.
 
+### Configuration
+
+#### Bot-specific configuration
+Configuration for chatbots should be defined in `~/.config/neon/chatbots.yaml`
+by default. Chatbots may be configured as:
+```yaml
+chatbots:
+  <bot_id>: {}
+```
+> For Klat v1, `bot_id` is the `username` the bot connects as, for MQ connected
+> bots, `bot_id` is the MQ `service_name`.
+
+Any bot-specific configuration will be accessible as `self.bot_config`. For Klat
+v1 connections, `password` should be specified in the `chatbots`
+config section.
+
+#### MQ Connection configuration
+For v2 bots, MQ connections must also be configured. This should be completed in
+the same `~/.config/neon/chatbots.yaml` file as the bot-specific config.
+
+```yaml
+MQ:
+  server: mq.neonaiservices.com
+  port: 5672
+  users:
+    <bot_id>:
+      user: neon_bot_submind
+      password: <MQ user `neon_bot_submind`'s password>
+```
+
+#### SocketIO Connection configuration
+For v1 bots, SIO connections may be configured in `~/.config/neon/chatbots.yaml`:
+```yaml
+socket_io:
+  server: 2222.us
+  port: 8888
+```
+
 ### Organizing your bots
 It is recommended to create a module for each of your bots. You should use subdirectories, each containing `__init__.py`
 that includes your `ChatBot` as well as any supporting configuration files, etc. You may also organize this as a
@@ -49,7 +85,7 @@ my_bots
 └--my_bot.py
 ```
 
-### Klat.com Credentials
+### Legacy Klat.com Credentials
 Bots should be able to login to [klat.com](https://klat.com); a YAML file containing credentials for each bot can be used
 to save usernames and passwords for each bot. Each bot module should have a key matching the module name, a `username`,
 and a `password`.