Adding Test Cases & Cache Updates (#18)

* adding caching usage * Addomg first test cases for Bullet class * Adding documentation to tests * Updating test script name to better match the class * Adding check tests * Adding documentation for check tests * first revision of tests for client * adding documentation to tests * Adding cursor tests * Adding keyhandler tests * Adding utils tests and updated getchar with optimizations/corrections * adding pytest to pre-commit and fixing the test file names * Adding validation workflow * adding pip install * removing caching for tests * Adding required packages * version bump
danner26 · Jan 22, 2025 · 3ef4dbb · 3ef4dbb
1 parent 8376fa1
commit 3ef4dbb
Show file tree

Hide file tree

Showing 22 changed files with 2,239 additions and 36 deletions.
diff --git a/.github/workflows/build-cache.yml b/.github/workflows/build-cache.yml
@@ -31,8 +31,8 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install -r requirements.txt
         if: steps.cache-venv.outputs.cache-hit != 'true'
-  build-pytest-cache:
-    name: Build PyTest Cache
+  build-publish-cache:
+    name: Build Publish Cache
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -45,16 +45,16 @@ jobs:
           python-version: '3.12'
       - name: cache virtualenv
         uses: actions/cache@v4
-        id: cache-venv-pytest
+        id: cache-venv-publish
         with:
           path: ${{ env.pythonLocation }}
-          key: ${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.pythonLocation }}-pytest-${{ hashFiles('requirements.txt') }}
+          key: ${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.pythonLocation }}-publish-${{ hashFiles('requirements.txt') }}
           restore-keys: |
-            ${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.pythonLocation }}-pytest-
+            ${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.pythonLocation }}-publish-
       - name: Install dependencies
         shell: bash
         run: |
           python -m pip install --upgrade pip
           python -m pip install -r requirements.txt
           python -m pip install pytest-github-actions-annotate-failures
-        if: steps.cache-venv-pytest.outputs.cache-hit != 'true'
+        if: steps.cache-venv-publish.outputs.cache-hit != 'true'
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -25,14 +25,26 @@ jobs:
       previous_tag: ${{ steps.check_pypi.outputs.previous_tag }}
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
       - name: Set up Python
         uses: actions/setup-python@v5
+        id: setup_python
+        with:
+          python-version: "3.12"
+      - name: cache virtualenv
+        uses: actions/cache@v4
+        id: cache-venv-publish
         with:
-          python-version: "3.x"
+          path: ${{ env.pythonLocation }}
+          key: ${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.pythonLocation }}-publish-${{ hashFiles('requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.pythonLocation }}-publish-
       - name: Install dependencies
         run: |
           python3 -m pip install --upgrade pip
           pip3 install setuptools wheel ultralytics-actions
+        if: steps.cache-venv-publish.outputs.cache-hit != 'true'
       - id: check_pypi
         shell: python3 -u {0}
         run: |
@@ -67,14 +79,26 @@ jobs:
       id-token: write # for PyPI trusted publishing
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
       - name: Set up Python
         uses: actions/setup-python@v5
+        id: setup_python
+        with:
+          python-version: "3.12"
+      - name: cache virtualenv
+        uses: actions/cache@v4
+        id: cache-venv-publish
         with:
-          python-version: "3.x"
+          path: ${{ env.pythonLocation }}
+          key: ${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.pythonLocation }}-publish-${{ hashFiles('requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.pythonLocation }}-publish-
       - name: Install dependencies
         run: |
           python3 -m pip install --upgrade pip
           pip3 install setuptools wheel
+        if: steps.cache-venv-publish.outputs.cache-hit != 'true'
       - name: Build package
         run: |
           python3 setup.py sdist bdist_wheel

diff --git a/.github/workflows/validation.yml b/.github/workflows/validation.yml
@@ -0,0 +1,60 @@
+---
+name: Validate definitions
+on:
+  pull_request:
+    branches:
+      - master
+jobs:
+  format-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        id: setup_python
+        with:
+          python-version: '3.12'
+      - name: cache virtualenv
+        uses: actions/cache@v4
+        id: cache-venv
+        with:
+          path: ${{ env.pythonLocation }}
+          key: ${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.pythonLocation }}-${{ hashFiles('requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ env.pythonLocation }}-
+      - name: Install dependencies
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -r requirements.txt
+        if: steps.cache-venv.outputs.cache-hit != 'true'
+      - name: Run Ruff Formatting and Checks
+        uses: astral-sh/ruff-action@v3
+        with:
+          args: "format --check"
+  test:
+    runs-on: ubuntu-latest
+    needs: [format-checks]
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        id: setup_python
+        with:
+          python-version: '3.12'
+      - name: Install dependencies
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -r requirements.txt
+          python -m pip install pytest-github-actions-annotate-failures
+          python -m pip install .
+      - name: Run Test Cases
+        id: pytest
+        run: pytest --tb=short -v
diff --git a/.gitignore b/.gitignore
@@ -6,8 +6,6 @@ __pycache__/
 # C extensions
 *.so
 .DS_Store
-# Tests
-tests/
 # Distribution / packaging
 .Python
 build/

diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,4 @@
+[submodule "tests"]
+	path = tests
+	url = https://github.com/danner26/BulletPrompt
+	branch = master/tests
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -17,3 +17,12 @@ repos:
         args: [ --fix ]
       # Run the formatter.
       - id: ruff-format
+  - repo: local
+    hooks:
+      - id: pytest
+        name: Run PyTest Case Checks
+        entry: pytest
+        language: system
+        args: [--tb=short, -v]
+        pass_filenames: false
+        always_run: true
diff --git a/bullet/__init__.py b/bullet/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "2.2.2"
+__version__ = "2.2.3"
 
 from .client import Bullet  # noqa: F401
 from .client import Check  # noqa: F401

diff --git a/bullet/utils.py b/bullet/utils.py
@@ -35,41 +35,23 @@ def mygetc():
 def getchar():
     """Character input parser."""
     c = mygetc()
-    if (
-        ord(c) == LINE_BEGIN_KEY  # noqa: F405
-        or ord(c) == LINE_END_KEY  # noqa: F405
-        or ord(c) == TAB_KEY  # noqa: F405
-        or ord(c) == INTERRUPT_KEY  # noqa: F405
-        or ord(c) == NEWLINE_KEY  # noqa: F405
-    ):
+    if ord(c) in {LINE_BEGIN_KEY, LINE_END_KEY, TAB_KEY, INTERRUPT_KEY, NEWLINE_KEY, BACK_SPACE_KEY}:  # noqa: F405
         return c
 
-    elif ord(c) == BACK_SPACE_KEY:  # noqa: F405
-        return c
-
-    elif ord(c) == ESC_KEY:  # noqa: F405
+    if ord(c) == ESC_KEY:  # noqa: F405
         combo = mygetc()
         if ord(combo) == MOD_KEY_INT:  # noqa: F405
             key = mygetc()
-            if ord(key) >= MOD_KEY_BEGIN - MOD_KEY_FLAG and ord(key) <= MOD_KEY_END - MOD_KEY_FLAG:  # noqa: F405
+            if MOD_KEY_BEGIN - MOD_KEY_FLAG <= ord(key) <= MOD_KEY_END - MOD_KEY_FLAG:  # noqa: F405
                 if ord(mygetc()) == MOD_KEY_DUMMY:  # noqa: F405
                     return chr(ord(key) + MOD_KEY_FLAG)  # noqa: F405
-                else:
-                    return UNDEFINED_KEY  # noqa: F405
-            elif ord(key) >= ARROW_KEY_BEGIN - ARROW_KEY_FLAG and ord(key) <= ARROW_KEY_END - ARROW_KEY_FLAG:  # noqa: F405
-                return chr(ord(key) + ARROW_KEY_FLAG)  # noqa: F405
-            else:
                 return UNDEFINED_KEY  # noqa: F405
-        else:
-            return getchar()
-
-    else:
-        if is_printable(c):
-            return c
-        else:
+            if ARROW_KEY_BEGIN - ARROW_KEY_FLAG <= ord(key) <= ARROW_KEY_END - ARROW_KEY_FLAG:  # noqa: F405
+                return chr(ord(key) + ARROW_KEY_FLAG)  # noqa: F405
             return UNDEFINED_KEY  # noqa: F405
+        return getchar()
 
-    return UNDEFINED_KEY  # noqa: F405
+    return c if is_printable(c) else UNDEFINED_KEY  # noqa: F405
 
 
 # Basic command line functions

diff --git a/pyproject.toml b/pyproject.toml
@@ -30,6 +30,7 @@ dev = [
     "ruff",
     "pytest",
     "pre-commit",
+    "pytest-mock",
     "uv",
 ]
 

diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,5 @@
 pre_commit==4.1.0
 pytest==8.3.4
+pytest-mock==3.14.0
 ruff==0.9.2
+uv==0.5.22
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,8 +6,6 @@ __pycache__/ @@
     # C extensions
     *.so
     .DS_Store
-    # Tests
-    tests/
     # Distribution / packaging
     .Python
     build/
@@ Expand Down @@