Add tests from original PR, and restructure for pytest-homeassistant-custom-component (#2)

PaarthShah · web-flow · commit d9f1d96f5639 · 2023-06-07T23:00:25.000-07:00
* Add tests from original PR, and restructure for pytest-homeassistant-custom-component

* Update workflows

* Satisfy ruff
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,15 +1,15 @@
 # https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
 version: 2
 updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
+  - package-ecosystem: github-actions
+    directory: /
     schedule:
-      interval: "weekly"
+      interval: weekly
 
-  - package-ecosystem: "pip"
-    directory: "/"
+  - package-ecosystem: pip
+    directory: /
     schedule:
-      interval: "weekly"
+      interval: weekly
     ignore:
       # Dependabot should not update Home Assistant as that should match the homeassistant key in hacs.json
-      - dependency-name: "homeassistant"
+      - dependency-name: homeassistant
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -1,29 +1,27 @@
-name: "Lint"
+name: Lint
 
 on:
   push:
-    branches:
-      - "main"
+    branches: [ main ]
   pull_request:
-    branches:
-      - "main"
+    branches: [ main ]
 
 jobs:
   ruff:
-    name: "Ruff"
-    runs-on: "ubuntu-latest"
+    name: Ruff
+    runs-on: ubuntu-latest
     steps:
-        - name: "Checkout the repository"
-          uses: "actions/checkout@v3.5.2"
+        - name: Checkout the repository
+          uses: actions/checkout@v3
 
-        - name: "Set up Python"
-          uses: actions/setup-python@v4.6.1
+        - name: Set up Python
+          uses: actions/setup-python@v4
           with:
             python-version: "3.10"
-            cache: "pip"
+            cache: pip
 
-        - name: "Install requirements"
+        - name: Install requirements
           run: python3 -m pip install -r requirements.txt
 
-        - name: "Run"
+        - name: Run
           run: python3 -m ruff check .
diff --git a/.github/workflows/pytest.yml b/.github/workflows/pytest.yml
@@ -0,0 +1,26 @@
+name: Pytest
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: pip
+    - name: Install requirements
+      run: pip install -r requirements_test.txt
+    - name: Test with pytest
+      run: pytest
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,35 +1,35 @@
-name: "Release"
+name: Release
 
 on:
   release:
     types:
-      - "published"
+      - published
 
 permissions: {}
 
 jobs:
   release:
-    name: "Release"
-    runs-on: "ubuntu-latest"
+    name: Release
+    runs-on: ubuntu-latest
     permissions:
       contents: write
     steps:
-      - name: "Checkout the repository"
-        uses: "actions/checkout@v3.5.2"
+      - name: Checkout the repository
+        uses: actions/checkout@v3
 
-      - name: "Adjust version number"
-        shell: "bash"
+      - name: Adjust version number
+        shell: bash
         run: |
           yq -i -o json '.version="${{ github.event.release.tag_name }}"' \
             "${{ github.workspace }}/custom_components/matrix/manifest.json"
 
-      - name: "ZIP the integration directory"
-        shell: "bash"
+      - name: ZIP the integration directory
+        shell: bash
         run: |
           cd "${{ github.workspace }}/custom_components/matrix"
           zip matrix-nio-hacs.zip -r ./
 
-      - name: "Upload the ZIP file to the release"
+      - name: Upload the ZIP file to the release
         uses: softprops/action-gh-release@v0.1.15
         with:
           files: ${{ github.workspace }}/custom_components/matrix/matrix-nio-hacs.zip
diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml
@@ -1,37 +1,35 @@
-name: "Validate"
+name: Validate
 
 on:
   workflow_dispatch:
   schedule:
-    - cron:  "0 0 * * *"
+    - cron:  0 0 * * *
   push:
-    branches:
-      - "main"
+    branches: [ main ]
   pull_request:
-    branches:
-      - "main"
+    branches: [ main ]
 
 jobs:
   hassfest: # https://developers.home-assistant.io/blog/2020/04/16/hassfest
-    name: "Hassfest Validation"
-    runs-on: "ubuntu-latest"
+    name: Hassfest Validation
+    runs-on: ubuntu-latest
     steps:
-        - name: "Checkout the repository"
-          uses: "actions/checkout@v3.5.2"
+        - name: Checkout the repository
+          uses: actions/checkout@v3
 
-        - name: "Run hassfest validation"
-          uses: "home-assistant/actions/hassfest@master"
+        - name: Run hassfest validation
+          uses: home-assistant/actions/hassfest@master
 
   hacs: # https://github.com/hacs/action
-    name: "HACS Validation"
-    runs-on: "ubuntu-latest"
+    name: HACS Validation
+    runs-on: ubuntu-latest
     steps:
-        - name: "Checkout the repository"
-          uses: "actions/checkout@v3.5.2"
+        - name: Checkout the repository
+          uses: actions/checkout@v3
 
-        - name: "Run HACS validation"
-          uses: "hacs/action@main"
+        - name: Run HACS validation
+          uses: hacs/action@main
           with:
-            category: "integration"
+            category: integration
             # Remove this 'ignore' key when you have added brand images for your integration to https://github.com/home-assistant/brands
-            ignore: "brands"
+            ignore: brands
diff --git a/custom_components/__init__.py b/custom_components/__init__.py
@@ -0,0 +1 @@
+"""Custom Components."""
diff --git a/hacs.json b/hacs.json
@@ -2,7 +2,7 @@
     "name": "Matrix Nio",
     "filename": "matrix-nio-hacs.zip",
     "hide_default_branch": true,
-    "homeassistant": "2023.5.4",
+    "homeassistant": "2023.6.0",
     "render_readme": true,
     "zip_release": true
 }
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,3 @@
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
diff --git a/requirements.txt b/requirements.txt
@@ -1,6 +1,6 @@
 colorlog==6.7.0
-homeassistant==2023.5.4
+homeassistant>=2023.5.4
 pip>=21.0,<23.2
-ruff==0.0.270
+ruff>=0.0.271
 matrix-nio==0.20.2
-Pillow==9.5.0
+Pillow==9.5.0
diff --git a/requirements_test.txt b/requirements_test.txt
@@ -0,0 +1,3 @@
+-r requirements.txt
+pytest>=7.3.1
+pytest-homeassistant-custom-component>=0.13.35
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -0,0 +1 @@
+"""Tests for the Matrix component."""
diff --git a/tests/conftest.py b/tests/conftest.py
diff --git a/tests/test_join_rooms.py b/tests/test_join_rooms.py
diff --git a/tests/test_login.py b/tests/test_login.py
diff --git a/tests/test_matrix_bot.py b/tests/test_matrix_bot.py
diff --git a/tests/test_send_message.py b/tests/test_send_message.py

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`"name": "Matrix Nio",`
`3`	`3`	`"filename": "matrix-nio-hacs.zip",`
`4`	`4`	`"hide_default_branch": true,`
`5`		`- "homeassistant": "2023.5.4",`
	`5`	`+ "homeassistant": "2023.6.0",`
`6`	`6`	`"render_readme": true,`
`7`	`7`	`"zip_release": true`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[tool.pytest.ini_options]`
	`2`	`+testpaths = ["tests"]`
	`3`	`+asyncio_mode = "auto"`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+-r requirements.txt`
	`2`	`+pytest>=7.3.1`
	`3`	`+pytest-homeassistant-custom-component>=0.13.35`