Add tests (#12)

.github/workflows/main.yml

@@ -0,0 +1,48 @@
+name: Test and Lint
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - dynamo/**/*.py
+      - tests/**/*.py
+  pull_request:
+    types: [opened, reopened, synchronize]
+    paths:
+      - dynamo/**/*.py
+      - tests/**/*.py
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ruff:
+    name: Lint with ruff
+    runs-on: ubuntu-22.04
+    concurrency: lint
+    steps:
+      - uses: actions/checkout@v4
+      - uses: jpetrucciani/ruff-check@main
+        with:
+          path: './dynamo/'
+          flags: '--config ./pyproject.toml'
+
+  tests:
+    name: Test with pytest
+    strategy:
+      matrix:
+        os: [ubuntu-22.04, windows-2022]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install poetry
+        run: pipx install poetry
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'poetry'
+      - run: poetry install --with=dev
+      - run: poetry run pytest tests --asyncio-mode=strict -n logical

.vscode/launch.json

@@ -10,6 +10,23 @@
             "request": "launch",
             "program": "${workspaceFolder}/dynamo/launcher.py",
             "console": "integratedTerminal"
+        },
+        {
+            "name": "Dynamo Tests",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "pytest",
+            "args": [
+                "tests",
+                "--asyncio-mode=strict",
+                "-n",
+                "logical",
+            ],
+            "console": "integratedTerminal",
+            "justMyCode": true,
+            "env": {
+                "PYDEVD_DISABLE_FILE_VALIDATION": "1",
+            }
         }
     ]
-}
+}

.vscode/settings.json

@@ -1,6 +1,8 @@
 {
     "python.REPL.enableREPLSmartSend": false,
-    "editor.defaultFormatter": "charliermarsh.ruff",
+    "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff",
+    },
     "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
         "source.organizeImports": "explicit"
@@ -11,5 +13,13 @@
         "**/.ruff_cache": true
     },
     "files.insertFinalNewline": true,
-    "files.trimTrailingWhitespace": true
+    "files.trimTrailingWhitespace": true,
+    "python.testing.pytestArgs": [
+        "tests",
+        "--asyncio-mode=strict",
+        "-n",
+        "logical",
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
 }

README.md

@@ -3,15 +3,34 @@ Personal use bot.
 
 ## Setup
 ### Prerequisites
-`poetry` is required to set up Dynamo. Find installation instructions [here](https://python-poetry.org/docs/) 
+`poetry` is required to set up Dynamo. Find installation instructions [here](https://python-poetry.org/docs/)
 ### Installing
 #### Clone the repository:
 ```shell
 git clone https://github.com/trumully/Dynamo
 ```
 #### Install and run:
 ```shell
-poetry install  
+poetry install
 poetry run dynamo setup
 poetry run dynamo
 ```
+
+## Development
+### Install dev dependencies
+```shell
+poetry install --with=dev
+```
+### Run tests
+#### CLI
+```shell
+poetry run pytest tests --asyncio-mode=strict -n logical
+```
+#### VSCode
+1. Open VSCode debugger `Ctrl+Shift+D`
+2. Run `Dynamo Tests` preset
+
+**or**
+
+1. Open Command Palette `Ctrl+Shift+P`
+2. Search and run: `Tests: Run All Tests`