volkswagencarnet 5.0.0b2__tar.gz → 5.0.0b4__tar.gz

volkswagencarnet-5.0.0b4/.github/workflows/codecov.yaml

@@ -0,0 +1,35 @@
+name: "CodeCov"
+on: [push]
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    env:
+      OS: ubuntu-latest
+      PYTHON: '3.11'
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Generate coverage report
+        run: |
+          pip install -r requirements-test.txt
+          pytest --cov=./ --cov-report=xml
+
+      # documentation: https://github.com/codecov/codecov-action
+      - name: Upload Coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          directory: ./coverage/reports/
+          env_vars: OS,PYTHON
+          fail_ci_if_error: true
+          files: ./coverage.xml
+          flags: unittests
+          name: codecov-volkswagencarnet
+          verbose: true

{volkswagencarnet-5.0.0b2 → volkswagencarnet-5.0.0b4}/.github/workflows/codeql-analysis.yml

@@ -22,7 +22,7 @@ jobs:
       fail-fast: false
       matrix:
         language: ["python"]
-        python-version: ["3.11", "3.12"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
       - name: Checkout repository

{volkswagencarnet-5.0.0b2 → volkswagencarnet-5.0.0b4}/.github/workflows/release.yaml

@@ -37,4 +37,4 @@ jobs:
         if: startsWith(github.ref, 'refs/tags')
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          print-hash: true
+          print_hash: true

{volkswagencarnet-5.0.0b2 → volkswagencarnet-5.0.0b4}/.github/workflows/testrelease.yaml

@@ -36,6 +36,6 @@ jobs:
       - name: Publish package to Test PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          repository-url: https://test.pypi.org/legacy/
-          print-hash: true
-          skip-existing: true
+          repository_url: https://test.pypi.org/legacy/
+          print_hash: true
+          skip_existing: true

{volkswagencarnet-5.0.0b2 → volkswagencarnet-5.0.0b4}/.github/workflows/validate.yml

@@ -1,4 +1,4 @@
-# This workflow will install Python dependencies, run tests and ruff with a variety of Python versions
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
 name: Validate
@@ -14,25 +14,43 @@ on:
       - master
 
 jobs:
-  ruff:
-    name: Ruff
+  lint:
+    name: Lint
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Check ruff
-        uses: chartboost/ruff-action@v1
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
         with:
-          args: 'format --diff'
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 black
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --select=E9,F63,F7,F82,F841,E266
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --exit-zero --max-complexity=10 --max-line-length=127
+
+      - name: Lint with black
+        #uses: psf/black@stable
+        run: |
+          black --check --diff --color .
 
   test-n-build:
     name: Test and Build
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.11", "3.12"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
       - name: Checkout code

{volkswagencarnet-5.0.0b2 → volkswagencarnet-5.0.0b4}/.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 default_language_version:
-  python: python3.11
+  python: python3.9
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -18,6 +18,17 @@ repos:
       - id: requirements-txt-fixer
       - id: trailing-whitespace
 
+  -   repo: https://github.com/psf/black
+      rev: '22.10.0'
+      hooks:
+        - id: black
+
+  - repo: https://github.com/pycqa/flake8
+    rev: '4.0.1'
+    hooks:
+      - id: flake8
+        additional_dependencies: [ flake8-docstrings ]
+
   - repo: https://github.com/asottile/pyupgrade
     rev: v2.31.0
     hooks:

{volkswagencarnet-5.0.0b2 → volkswagencarnet-5.0.0b4}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: volkswagencarnet
-Version: 5.0.0b2
-Summary: Communicate with Volkswagen Connect
+Version: 5.0.0b4
+Summary: Communicate with Volkswagen WeConnect
 Home-page: https://github.com/robinostlund/volkswagencarnet
 Author: Robin Ostlund
 Author-email: me@robinostlund.name
@@ -10,7 +10,7 @@ Project-URL: Bug Tracker, https://github.com/robinostlund/volkswagencarnet/issue
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.11
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: lxml
@@ -25,7 +25,7 @@ Requires-Dist: pyjwt
 ![Release](https://img.shields.io/github/workflow/status/robinostlund/volkswagencarnet/Release)
 ![PyPi](https://img.shields.io/pypi/v/volkswagencarnet)
 ![Version](https://img.shields.io/github/v/release/robinostlund/volkswagencarnet)
-![CodeStyle](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)
+![CodeStyle](https://img.shields.io/badge/code%20style-black-black)
 ![Known Vulnerabilities](https://snyk.io/test/github/robinostlund/volkswagencarnet/badge.svg)
 [![CodeQL](https://github.com/robinostlund/volkswagencarnet/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/robinostlund/volkswagencarnet/actions/workflows/codeql-analysis.yml)
 [![codecov](https://codecov.io/gh/robinostlund/volkswagencarnet/branch/master/graph/badge.svg?token=NH1Q1GH4I3)](https://codecov.io/gh/robinostlund/volkswagencarnet)
@@ -37,7 +37,7 @@ Requires-Dist: pyjwt
 
 ## Help Wanted
 
-As i don't have a car with Volkswagen Connect anymore i would appreciate if it would be possible to get help to keep this repository maintained. So if you feel that you have some time over and is interested in helping out with this. Please feel to contact me! Thanks
+As i don't have a car with we connect anymore i would appreciate if it would be possible to get help to keep this repository maintained. So if you feel that you have some time over and is interested in helping out with this. Please feel to contact me! Thanks
 
 ## Information
 

{volkswagencarnet-5.0.0b2 → volkswagencarnet-5.0.0b4}/README.md

@@ -5,7 +5,7 @@
 ![Release](https://img.shields.io/github/workflow/status/robinostlund/volkswagencarnet/Release)
 ![PyPi](https://img.shields.io/pypi/v/volkswagencarnet)
 ![Version](https://img.shields.io/github/v/release/robinostlund/volkswagencarnet)
-![CodeStyle](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)
+![CodeStyle](https://img.shields.io/badge/code%20style-black-black)
 ![Known Vulnerabilities](https://snyk.io/test/github/robinostlund/volkswagencarnet/badge.svg)
 [![CodeQL](https://github.com/robinostlund/volkswagencarnet/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/robinostlund/volkswagencarnet/actions/workflows/codeql-analysis.yml)
 [![codecov](https://codecov.io/gh/robinostlund/volkswagencarnet/branch/master/graph/badge.svg?token=NH1Q1GH4I3)](https://codecov.io/gh/robinostlund/volkswagencarnet)
@@ -17,7 +17,7 @@
 
 ## Help Wanted
 
-As i don't have a car with Volkswagen Connect anymore i would appreciate if it would be possible to get help to keep this repository maintained. So if you feel that you have some time over and is interested in helping out with this. Please feel to contact me! Thanks
+As i don't have a car with we connect anymore i would appreciate if it would be possible to get help to keep this repository maintained. So if you feel that you have some time over and is interested in helping out with this. Please feel to contact me! Thanks
 
 ## Information
 

{volkswagencarnet-5.0.0b2 → volkswagencarnet-5.0.0b4}/pyproject.toml

@@ -10,6 +10,19 @@ build-backend = "setuptools.build_meta"
 fallback_version = "0.0.0"
 write_to = "volkswagencarnet/version.py"
 
+[tool.black]
+line-length = 120
+target-version = ['py37', 'py38', 'py39', 'py310']
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # The following are specific to Black, you probably don't want those.
+  | blib2to3
+  | tests/data
+  | profiling
+)/
+'''
+
 [tool.pytest.ini_options]
 minversion = "6.0"
 addopts = "-ra"

{volkswagencarnet-5.0.0b2 → volkswagencarnet-5.0.0b4}/requirements-test.txt

@@ -1,4 +1,7 @@
 -r requirements.txt
+black
+flake8
+flake8-docstrings
 freezegun>=1.0.0
 pre-commit
 pytest>=7.0.0

{volkswagencarnet-5.0.0b2 → volkswagencarnet-5.0.0b4}/setup.cfg

@@ -2,7 +2,7 @@
 name = volkswagencarnet
 author = Robin Ostlund
 author_email = me@robinostlund.name
-description = Communicate with Volkswagen Connect
+description = Communicate with Volkswagen WeConnect
 long_description = file: README.md
 long_description_content_type = text/markdown
 url = https://github.com/robinostlund/volkswagencarnet
@@ -23,7 +23,7 @@ install_requires =
 package_dir = 
 	= .
 packages = find:
-python_requires = >= 3.11
+python_requires = >= 3.7
 
 [options.packages.find]
 where = .
@@ -31,6 +31,32 @@ exclude =
 	tests
 	tests.*
 
+[flake8]
+ignore = 
+	E722,
+	I201,
+	W503,
+	CFQ001,
+	CFQ002,
+	E501,
+	W503,
+	E203,
+	D202,
+	W504
+filename = 
+	*.py
+exclude = 
+	.git,
+	__pycache__,
+	*.txt,
+	*.md,
+	*.cfg
+max_line_length = 120
+count = True
+inline_quotes = double
+show_source = True
+statistics = True
+
 [pycodestyle]
 max_line_length = 120
 statistics = True

volkswagencarnet-5.0.0b4/tests/conftest.py

@@ -0,0 +1,8 @@
+"""Configure tests."""
+
+import sys
+
+pytest_plugins = ["pytest_cov"]
+
+if sys.version_info >= (3, 8):
+    pytest_plugins.append("tests.fixtures.connection")

{volkswagencarnet-5.0.0b2 → volkswagencarnet-5.0.0b4}/tests/dummy_test.py

@@ -1,7 +1,8 @@
 """Dummy tests. Might be removed once there are proper ones."""
 
-from aiohttp import ClientSession
 import pytest
+from aiohttp import ClientSession
+
 from volkswagencarnet import vw_connection
 
 
@@ -9,8 +10,6 @@ from volkswagencarnet import vw_connection
 async def test_volkswagencarnet():
     """Dummy test to ensure logged in status is false by default."""
     async with ClientSession() as session:
-        connection = vw_connection.Connection(
-            session, "test@example.com", "test_password"
-        )
+        connection = vw_connection.Connection(session, "test@example.com", "test_password")
         # if await connection._login():
         assert connection.logged_in is False

{volkswagencarnet-5.0.0b2 → volkswagencarnet-5.0.0b4}/tests/fixtures/connection.py

@@ -2,11 +2,11 @@
 
 import os
 
-from aiohttp import ClientSession, CookieJar
 import pytest
 import pytest_asyncio
-from volkswagencarnet.vw_connection import Connection
+from aiohttp import CookieJar, ClientSession
 
+from volkswagencarnet.vw_connection import Connection
 from .constants import resource_path
 
 
@@ -23,11 +23,4 @@ async def session():
 @pytest.fixture
 def connection(session):
     """Real connection for integration tests."""
-    return Connection(
-        session=session,
-        username="",
-        password="",
-        country="DE",
-        interval=999,
-        fulldebug=True,
-    )
+    return Connection(session=session, username="", password="", country="DE", interval=999, fulldebug=True)

{volkswagencarnet-5.0.0b2 → volkswagencarnet-5.0.0b4}/tests/integration_test.py

@@ -1,4 +1,5 @@
-"""Integration tests.
+"""
+Integration tests.
 
 These tests use actual credentials, and should thus be used with care.
 Credentials have to be specified in credentials.py.
@@ -6,22 +7,22 @@ Credentials have to be specified in credentials.py.
 
 import logging
 
-from aiohttp import ClientSession
 import pytest
+from aiohttp import ClientSession
+
 from volkswagencarnet import vw_connection
 
 try:
-    from credentials import password, spin, username, vin
+    from credentials import username, password, spin, vin
 except ImportError:
     username = password = spin = vin = None
 
 
 @pytest.mark.skipif(
-    username is None or password is None,
-    reason="Username or password is not set. Check credentials.py.sample",
+    username is None or password is None, reason="Username or password is not set. Check credentials.py.sample"
 )
 @pytest.mark.asyncio
-async def test_successful_login() -> None:
+async def test_successful_login():
     """Test that login succeeds."""
     async with ClientSession() as session:
         connection = vw_connection.Connection(session, username, password)
@@ -30,14 +31,14 @@ async def test_successful_login() -> None:
 
 
 @pytest.mark.skipif(
-    username is None or password is None,
-    reason="Username or password is not set. Check credentials.py.sample",
+    username is None or password is None, reason="Username or password is not set. Check credentials.py.sample"
 )
 @pytest.mark.asyncio
 @pytest.mark.skip("Not yet implemented")
-async def test_spin_action() -> None:
-    """Test something that uses s-pin.
+async def test_spin_action():
+    """
+    Test something that uses s-pin.
 
     Not yet implemented...
     """
-    logging.getLogger().debug("using vin: %s and s-pin: %s", vin, spin)
+    logging.getLogger().debug(f"using vin: {vin} and s-pin: {spin}")

volkswagencarnet-5.0.0b4/tests/vw_connection_test.py

@@ -0,0 +1,178 @@
+"""Tests for main connection class."""
+
+import sys
+
+import aiohttp
+from aiohttp import client_exceptions
+
+from volkswagencarnet import vw_connection
+from volkswagencarnet.vw_connection import Connection
+
+if sys.version_info >= (3, 8):
+    # This won't work on python versions less than 3.8
+    from unittest import IsolatedAsyncioTestCase
+else:
+    from unittest import TestCase
+
+    class IsolatedAsyncioTestCase(TestCase):
+        """Dummy class to use instead (tests might need to skipped separately also)."""
+
+        pass
+
+
+from io import StringIO
+from unittest.mock import patch, MagicMock
+
+import pytest
+
+
+class TwoVehiclesConnection(Connection):
+    """Connection that return two vehicles."""
+
+    ALLOW_RATE_LIMIT_DELAY = False
+
+    # noinspection PyUnusedLocal
+    # noinspection PyMissingConstructor
+    def __init__(self, sess, username="", password="", **kwargs):
+        """Init."""
+        super().__init__(session=sess, username=username, password=password)
+        self._jarCookie = MagicMock()
+
+    async def doLogin(self, tries=1):
+        """No-op update."""
+        return True
+
+    async def update(self):
+        """No-op update."""
+        return True
+
+    @property
+    def vehicles(self):
+        """Return the vehicles."""
+        vehicle1 = vw_connection.Vehicle(None, "vin1")
+        vehicle2 = vw_connection.Vehicle(None, "vin2")
+        return [vehicle1, vehicle2]
+
+
+@pytest.mark.skipif(condition=sys.version_info < (3, 8), reason="Test incompatible with Python < 3.8")
+def test_clear_cookies(connection):
+    """Check that we can clear old cookies."""
+    assert len(connection._session._cookie_jar._cookies) > 0
+    connection._clear_cookies()
+    assert len(connection._session._cookie_jar._cookies) == 0
+
+
+class CmdLineTest(IsolatedAsyncioTestCase):
+    """Tests mostly for testing how to test..."""
+
+    class FailingLoginConnection:
+        """This connection always fails login."""
+
+        # noinspection PyUnusedLocal
+        def __init__(self, sess, **kwargs):
+            """Init."""
+            self._session = sess
+
+        # noinspection PyPep8Naming,PyMethodMayBeStatic
+        async def doLogin(self):
+            """Failed login attempt."""
+            return False
+
+    @pytest.mark.asyncio
+    @patch.object(vw_connection.logging, "basicConfig")
+    @patch("volkswagencarnet.vw_connection.Connection", spec_set=vw_connection.Connection, new=FailingLoginConnection)
+    @pytest.mark.skipif(condition=sys.version_info < (3, 8), reason="Test incompatible with Python < 3.8")
+    async def test_main_argv(self, logger_config):
+        """Test verbosity flags."""
+        from logging import ERROR
+        from logging import INFO
+        from logging import DEBUG
+
+        cases = [
+            ["none", [], ERROR],
+            ["-v", ["-v"], INFO],
+            ["-v2", ["-v2"], ERROR],
+            ["-vv", ["-vv"], DEBUG],
+        ]
+        for c in cases:
+            args = ["dummy"]
+            args.extend(c[1])
+            with patch.object(vw_connection.sys, "argv", args), self.subTest(msg=c[0]):
+                await vw_connection.main()
+                logger_config.assert_called_with(level=c[2])
+                logger_config.reset()
+
+    @pytest.mark.asyncio
+    @patch("sys.stdout", new_callable=StringIO)
+    @patch("volkswagencarnet.vw_connection.Connection", spec_set=vw_connection.Connection, new=FailingLoginConnection)
+    @pytest.mark.skipif(condition=sys.version_info < (3, 8), reason="Test incompatible with Python < 3.8")
+    async def test_main_output_failed(self, stdout: StringIO):
+        """Verify empty stdout on failed login."""
+        await vw_connection.main()
+        assert stdout.getvalue() == ""
+
+    @pytest.mark.asyncio
+    @patch("sys.stdout", new_callable=StringIO)
+    @patch("volkswagencarnet.vw_connection.Connection", spec_set=vw_connection.Connection, new=TwoVehiclesConnection)
+    @pytest.mark.skipif(condition=sys.version_info < (3, 8), reason="Test incompatible with Python < 3.8")
+    async def test_main_output_two_vehicles(self, stdout: StringIO):
+        """Get console output for two vehicles."""
+        await vw_connection.main()
+        assert (
+            stdout.getvalue()
+            == """Vehicle id: vin1
+Supported sensors:
+ - Force data refresh (domain:switch) - Off
+ - Request results (domain:sensor) - Unknown
+ - Requests remaining (domain:sensor) - -1
+ - Request in progress (domain:binary_sensor) - Off
+Vehicle id: vin2
+Supported sensors:
+ - Force data refresh (domain:switch) - Off
+ - Request results (domain:sensor) - Unknown
+ - Requests remaining (domain:sensor) - -1
+ - Request in progress (domain:binary_sensor) - Off
+"""
+        )
+
+
+class SendCommandsTest(IsolatedAsyncioTestCase):
+    """Test command sending."""
+
+    async def test_set_schedule(self):
+        """Test set schedule."""
+        pass
+
+
+class RateLimitTest(IsolatedAsyncioTestCase):
+    """Test that rate limiting towards VW works."""
+
+    invocations = 0
+
+    async def rateLimitedFunction(self, url, vin=""):
+        """Limit calls test function."""
+        ri = MagicMock(aiohttp.RequestInfo)
+        e = client_exceptions.ClientResponseError(request_info=ri, history=tuple([]))
+        e.status = 429
+        self.invocations = self.invocations + 1
+        raise e
+
+    @pytest.mark.asyncio
+    @pytest.mark.skipif(condition=sys.version_info < (3, 9), reason="Test incompatible with Python < 3.9")
+    @patch("volkswagencarnet.vw_connection.Connection", spec_set=vw_connection.Connection, new=TwoVehiclesConnection)
+    @patch("volkswagencarnet.vw_connection.MAX_RETRIES_ON_RATE_LIMIT", 1)
+    async def test_rate_limit(self):
+        """Test rate limiting functionality."""
+
+        from unittest.mock import AsyncMock
+
+        sess = AsyncMock()
+
+        # noinspection PyArgumentList
+        conn = vw_connection.Connection(sess, "", "")
+
+        self.invocations = 0
+        with patch.object(conn, "_request", self.rateLimitedFunction):
+            res = await conn.get("foo")
+            assert res == {"status_code": 429}
+        assert self.invocations == vw_connection.MAX_RETRIES_ON_RATE_LIMIT + 1

volkswagencarnet-5.0.0b4/tests/vw_exceptions_test.py

@@ -0,0 +1,14 @@
+"""Misc tests for exception and their handling."""
+
+from unittest import TestCase
+
+from volkswagencarnet.vw_exceptions import AuthenticationException
+
+
+class ExceptionTests(TestCase):
+    """Unit tests for exceptions."""
+
+    def test_auth_exception(self):
+        """Test that message matches. Dummy test."""
+        ex = AuthenticationException("foo failed")
+        self.assertEqual("foo failed", ex.__str__())