Merge pull request #48 from A-Baji/dev

3.0.2 add unit tests

Author: A-Baji

.github/workflows/package.yml

@@ -21,11 +21,21 @@ jobs:
     - uses: actions/checkout@v3
     - uses: actions/setup-python@v4
       with:
-        python-version: ${{matrix.py_ver}}
+        python-version: ${{ matrix.py_ver }}
     - name: Install Package
       run: pip install .
     - name: Test Package
-      run: discordai_modelizer -V
+      env:
+        PY_VER: ${{ matrix.py_ver }}
+        DISCORD_BOT_TOKEN: ${{ secrets.DISCORD_BOT_TOKEN }}
+        OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+        CHANNEL_ID: ${{ secrets.CHANNEL_ID }}
+        USERNAME: ${{ secrets.USERNAME }}
+        PYTHONUNBUFFERED: 1
+      run: |
+        touch .env.test
+        export VERSION=$(cat discordai_modelizer/version.py | grep -oP '\d+\.\d+\.\d+')
+        docker compose -f docker-compose-test.yaml up --build --exit-code-from tests
   release:
     if: |
       github.event_name == 'push' &&
@@ -41,10 +51,10 @@ jobs:
       - name: Create release
         uses: actions/create-release@v1
         env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          tag_name: ${{steps.version.outputs.discordai_modelizer_version}}
-          release_name: Release ${{steps.version.outputs.discordai_modelizer_version}}
-          body: Release ${{steps.version.outputs.discordai_modelizer_version}}
+          tag_name: ${{ steps.version.outputs.discordai_modelizer_version }}
+          release_name: Release ${{ steps.version.outputs.discordai_modelizer_version }}
+          body: Release ${{ steps.version.outputs.discordai_modelizer_version }}
           draft: false
           prerelease: false

.gitignore

@@ -1,4 +1,4 @@
-/.env
+/*.env*
 /files/
 
 config.json

CHANGELOG.md

@@ -2,6 +2,20 @@
 
 Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.
 
+## [3.0.2] - 06-29-2024
+
+### Added
+
+- unit tests
+
+### Changed
+
+- model deletion returns valid JSON on permission error
+
+### Fixed
+
+- multiple bugs for dataset generation, model creation, and cli
+
 ## [3.0.1] - 06-27-2024
 
 ### Changed
@@ -81,6 +95,7 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
 
 - switched to `pathlib` for file path parsing
 
+[3.0.2]: https://github.com/A-Baji/discordAI-modelizer/compare/3.0.1...3.0.2
 [3.0.1]: https://github.com/A-Baji/discordAI-modelizer/compare/3.0.0...3.0.1
 [3.0.0]: https://github.com/A-Baji/discordAI-modelizer/compare/2.0.1...3.0.0
 [2.0.1]: https://github.com/A-Baji/discordAI-modelizer/compare/1.2.2...2.0.1

Dockerfile

@@ -1,4 +1,5 @@
-FROM python:3.12
+ARG PY_VER
+FROM python:${PY_VER}
 WORKDIR /main
 RUN apt-get install git -y
 COPY ./requirements.txt ./setup.py ./README.md /main/

discordai_modelizer/command_line/command_line.py

@@ -34,23 +34,18 @@ def discordai_modelizer():
     subparsers.setup_job_cancel(job_subcommand)
 
     args = parser.parse_args()
-    try:
-        os.environ["OPENAI_API_KEY"] = args.openai_key or os.environ["OPENAI_API_KEY"]
-    except KeyError:
-        raise argparse.ArgumentError(
-            None,
-            "Your OpenaAI API key must either be passed in as an argument or set as an environment variable",
-        )
+    if hasattr(args, "openai_key"):
+        openai_wrapper.set_openai_api_key(args.openai_key)
 
     if args.command == "model":
         if args.subcommand == "list":
             display(openai_wrapper.list_models(os.environ["OPENAI_API_KEY"], args.full))
         elif args.subcommand == "create":
             customize.create_model(
-                args.discord_token,
-                os.environ["OPENAI_API_KEY"],
                 args.channel,
                 args.user,
+                args.discord_token,
+                os.environ["OPENAI_API_KEY"],
                 thought_time=args.thought_time,
                 thought_max=args.thought_max,
                 thought_min=args.thought_min,
@@ -87,9 +82,6 @@ def discordai_modelizer():
             display(
                 openai_wrapper.cancel_job(args.job_id, os.environ["OPENAI_API_KEY"])
             )
-            display(
-                openai_wrapper.delete_model(args.model_id, os.environ["OPENAI_API_KEY"])
-            )
         else:
             raise argparse.ArgumentError(
                 job_subcommand,

discordai_modelizer/customize.py

@@ -7,30 +7,41 @@
 from openai import OpenAI
 from argparse import ArgumentError
 from discordai_modelizer.gen_dataset import parse_logs, get_lines
+from discordai_modelizer.openai import set_openai_api_key
 
 MODEL_MAP = {
     "davinci": "davinci-002",
     "babbage": "babbage-002",
 }
 
 
+def set_bot_token(token):
+    if token:
+        os.environ["DISCORD_BOT_TOKEN"] = token
+    elif "DISCORD_BOT_TOKEN" not in os.environ:
+        raise ValueError(
+            "Your Discord bot token must either be passed in as an argument or set as an environment variable",
+        )
+
+
 def create_model(
-    bot_token: str,
-    openai_key: str,
     channel_id: str,
     user_id: str,
+    bot_token: str = None,
+    openai_key: str = None,
     thought_time=10,
     thought_max: int = None,
     thought_min=4,
     max_entry_count=1000,
-    offset="start",
+    offset=0,
     select_mode="sequential",
     base_model="none",
     reverse=False,
     clean=False,
     redownload=False,
     use_existing=False,
 ):
+    set_openai_api_key(openai_key)
     client = OpenAI()
     channel_user = f"{channel_id[:4]}_{user_id}"
     files_path = pathlib.Path(appdirs.user_data_dir(appname="discordai"))
@@ -43,13 +54,7 @@ def create_model(
 
     # Download logs
     if (not os.path.isfile(full_logs_path) or redownload) and not use_existing:
-        try:
-            bot_token = bot_token or os.environ["DISCORD_BOT_TOKEN"]
-        except KeyError:
-            raise ArgumentError(
-                None,
-                "Your Discord bot token must either be passed in as an argument or set as an environment variable",
-            )
+        set_bot_token(bot_token)
 
         print("INFO: Exporting chat logs using DiscordChatExporter...")
         print(
@@ -71,7 +76,7 @@ def create_model(
                 "-c",
                 channel_id,
                 "-t",
-                bot_token,
+                os.environ["DISCORD_BOT_TOKEN"],
                 "-o",
                 f"{channel_id}_logs.json",
                 "-f",
@@ -140,9 +145,6 @@ def create_model(
 
     # Clean up generated files
     if clean and not use_existing:
-        try:
-            os.remove(full_dataset_path)
-        except FileNotFoundError:
-            pass
+        full_dataset_path.unlink()
 
     client.close()

discordai_modelizer/gen_dataset.py

@@ -81,7 +81,7 @@ def add_to_dataset(thought: str):
         thought = build_thought("", messages[0])
         for i, msg in enumerate(messages[1::]):
             if msg["content"]:
-                prev_timestamp = parser.parse(messages[i - 1]["timestamp"])
+                prev_timestamp = parser.parse(messages[i]["timestamp"])
                 curr_timestamp = parser.parse(msg["timestamp"])
                 differentiation = (curr_timestamp - prev_timestamp) / timedelta(
                     milliseconds=1
@@ -107,8 +107,6 @@ def get_lines(
     f.close()
 
     num_lines = len(lines)
-    if N > num_lines:
-        return
 
     if select_mode == "sequential":
         step = 1
@@ -118,7 +116,7 @@ def get_lines(
     if reverse:
         lines = lines[::-1]
 
-    selected_lines = lines[offset:][::step][:N]
+    selected_lines = lines[offset:][:: step or 1][:N]
 
     with open(file_name, "w") as f:
         f.writelines(selected_lines)

discordai_modelizer/openai.py

@@ -1,7 +1,6 @@
-import json
 import os
 
-from openai import OpenAI
+from openai import OpenAI, PermissionDeniedError
 from datetime import datetime, timezone
 
 
@@ -17,11 +16,11 @@ def convert_in_place(obj, key: str):
 
 
 def set_openai_api_key(key: str):
-    try:
-        os.environ["OPENAI_API_KEY"] = key or os.environ["OPENAI_API_KEY"]
-    except KeyError:
+    if key:
+        os.environ["OPENAI_API_KEY"] = key
+    elif "OPENAI_API_KEY" not in os.environ:
         raise ValueError(
-            "Your OpenaAI API key must either be passed in as an argument or set as an environment variable",
+            "Your OpenAI API key must either be passed in as an argument or set as an environment variable",
         )
 
 
@@ -117,6 +116,11 @@ def delete_model(model_name: str, openai_key: str = None) -> dict:
         return
     set_openai_api_key(openai_key)
     client = OpenAI()
-    deleted = client.models.delete(model_name).model_dump()
+    try:
+        deleted = client.models.delete(model_name).model_dump()
+    except PermissionDeniedError:
+        deleted = {
+            "error": "You have insufficient permissions for this operation. Missing scopes: api.delete"
+        }
     client.close()
     return deleted

discordai_modelizer/version.py

@@ -1 +1 @@
-__version__ = "3.0.1"
+__version__ = "3.0.2"

docker-compose-test.yaml

@@ -0,0 +1,30 @@
+# PY_VER=3.12 VERSION=$(cat discordai_modelizer/version.py | grep -oP '\d+\.\d+\.\d+') docker compose -f docker-compose-test.yaml --env-file .env.test up --build
+# docker exec -it discordai-modelizer-tests-1 bash
+services:
+  tests:
+    build:
+      context: .
+      dockerfile: Dockerfile
+      args:
+        - PY_VER
+    image: discord-ai/discordai_modelizer:py${PY_VER}-v${VERSION}
+    privileged: true
+    network_mode: host
+    working_dir: /main
+    environment:
+      - DISCORD_BOT_TOKEN
+      - OPENAI_API_KEY
+      - CHANNEL_ID
+      - USERNAME
+      - PYTHONUNBUFFERED=1
+    env_file: .env.test
+    volumes:
+      - ./discordai_modelizer:/usr/local/lib/python${PY_VER}/site-packages/discordai_modelizer
+      - ./tests:/main/tests
+    command:
+      - sh
+      - -c
+      - |
+        pip install pytest pytest-cov pytest-console-scripts --root-user-action ignore
+        pytest --cov-report term-missing --cov=discordai_modelizer tests
+        # tail -f /dev/null