unified tests run

Logovskii Dmitrii · TheBits · commit 37ec5d494b3b · 2022-05-26T07:42:58.000+03:00
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -6,24 +6,6 @@ on:
     branches: [main]
 
 jobs:
-  pytest:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
-    - uses: actions/cache@v2
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-        restore-keys: |
-          ${{ runner.os }}-pip-
-    - name: Install dependencies
-      run: |
-        python -m pip install -r requirements.txt pytest
-        python -m pip install -e .
-    - name: Test with pytest
-      run: |
-        pytest
   pre-commit:
     runs-on: ubuntu-latest
     steps:
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,30 @@
+name: tests
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+env:
+  DRIVER_TOKEN: github-actions
+  TOX_PARALLEL_NO_SPINNER: 1
+
+jobs:
+  tox:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cache/pip
+            ~/.cache/pre-commit
+            .tox
+            .mypy_cache
+            ${{ env.pythonLocation }}
+          key: ${{ runner.os }}-${{ env.pythonLocation }}-pip-${{ hashFiles('**/requirements-tox.txt') }}
+      - name: Install dependencies
+        run: python -m pip install --progress-bar off tox
+      - name: Run all envs
+        run: tox -p auto -e 'libcloud{30,31,32,33,34,35},pre-commit'
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,5 @@ __pycache__/
 .tox/
 .vscode/
 *.egg-info/
+.coverage
+bin/*
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -25,16 +25,16 @@ repos:
       - id: mixed-line-ending
       - id: name-tests-test
       - id: trailing-whitespace
-        args: ['--markdown-linebreak-ext=md']
+        args: ["--markdown-linebreak-ext=md"]
   - repo: https://github.com/asottile/add-trailing-comma
     rev: v2.2.3
     hooks:
       - id: add-trailing-comma
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.32.0
+    rev: v2.32.1
     hooks:
       - id: pyupgrade
-        args: ['--py3-plus']
+        args: ["--py3-plus"]
   - repo: https://gitlab.com/pycqa/flake8
     rev: 3.9.2
     hooks:
@@ -47,7 +47,7 @@ repos:
       - id: mypy
         additional_dependencies: [tokenize-rt]
         types: [python]
-        args: ['--follow-imports=skip', '--ignore-missing-imports']
+        args: ["--follow-imports=skip", "--ignore-missing-imports"]
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.9.0
     hooks:
@@ -56,18 +56,8 @@ repos:
       - id: python-no-eval
       - id: python-no-log-warn
       - id: python-use-type-annotations
-  - repo: https://github.com/Lucas-C/pre-commit-hooks-safety
-    rev: v1.2.4
-    hooks:
-      - id: python-safety-dependencies-check
-        stages: [manual]
-  - repo: https://github.com/Lucas-C/pre-commit-hooks-bandit
-    rev: v1.0.6
-    hooks:
-      - id: python-bandit-vulnerability-check
-        stages: [manual]
   - repo: https://github.com/Lucas-C/pre-commit-hooks
-    rev: v1.1.13
+    rev: v1.1.14
     hooks:
       - id: forbid-crlf
       - id: remove-crlf
@@ -83,11 +73,10 @@ repos:
     rev: 22.3.0
     hooks:
       - id: black
-        args: ['--target-version', 'py35', '--line-length', '128']
-  - repo: https://github.com/jazzband/pip-tools
-    rev: 6.6.0
+        args: ["--target-version", "py35", "--line-length", "128"]
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.6.2
     hooks:
-      - id: pip-compile
-        name: pip-compile requirements-dev.in
-        args: [requirements-dev.in]
-        files: ^requirements-dev\.(in|txt)$
+      - id: prettier
+        types: [markdown, yaml]
+        exclude: 'test/fixtures'
diff --git a/README.md b/README.md
@@ -278,6 +278,20 @@ libcloud драйвер для сервиса vdsina.ru
 
 ## Разработка
 
-В проекте настроена автоматическая проверка линтерами и тестами.
+Для запуска тестов настроен tox. Для проверки коммитов настроен pre-commit.
+Так же в проекте настроена автоматический запуск tox в GitHub Actions.
 
-Линтеры запускаются в `pre-commit`, тесты в `pytest`.
+### Тесты
+
+Тесты запускаются при помощи [pytest](https://pytest.org/).
+
+### Линтеры и форматтеры
+
+Для запуска линтеров необходимо установить [pre-commit](https://pre-commit.com/). Линтеры запускаются командой `$ pre-commit run -a`.
+
+#### Настройка `pre-commit`
+
+Github Actions запускаются в `stage: commit`, поэтому в `.pre-commit-config.yaml` проверка `id: no-commit-to-branch` установлена в `stage: push`. Что бы проверка запускалась локально и не срабатывала в CI. Локально надо установить pre-commit хуки на пуши и на коммиты следующей командой:
+
+```bash
+$ pre-commit install --hook-type pre-commit --hook-type pre-push
diff --git a/requirements-dev.in b/requirements-dev.in
diff --git a/requirements-dev.txt b/requirements-dev.txt
diff --git a/requirements-tox.txt b/requirements-tox.txt
@@ -0,0 +1,13 @@
+
+# Файл для обновления/сброса кеша в actions/cache
+#
+# actions/cache не имеет ручного механизма очистки кеша.
+# Для сброса нужно менять ключ кеша, в качестве ключа кеширования
+# используется хеш этого файла. Для сброса обновите дату.
+#
+# Обновлено: 23 мая 2022
+
+cryptography # используется в libcloud для ssh-key fingerprint
+pytest
+pytest-cov
+vcrpy
diff --git a/setup.py b/setup.py
@@ -13,6 +13,7 @@
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/thebits/libcloud-vdsina",
+    install_requires=["apache-libcloud>=3.0.0"],
     packages=setuptools.find_packages(),
     classifiers=[
         "Intended Audience :: System Administrators",
diff --git a/tests/fixtures/list_key_pairs.yaml b/tests/fixtures/list_key_pairs.yaml
@@ -16,7 +16,8 @@ interactions:
     uri: https://userapi.vdsina.ru/v1/ssh-key
   response:
     body:
-      string: '{"status":"ok","status_msg":"SSH keys list","data":[{"id":5496,"name":"barracude"}]}'
+      string: '{"status":"ok","status_msg":"SSH keys list","data":[{"id":46329,"name":"x200s", "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDLZvQS/4YLHQUKJJupgUuqP28ugEujpqRg7MBBTMRDdOdu+S8Qy0YZSURX6+/+OOXWvP0yICHaiNhyELOMFPXdOF33y1gYvm5YHVq+ehSEtJQQd0r6v+ngs/TEtM0hif7CvvGkVCCREkTV5sMW9agE8xmerlQIyEF280h0KrAemL9IKeVcpeEEF4uWUvElDcoUgOqY2Debwje4SWtfs7Ic73vmpZLJ7CPgxJVaEcLsjbdsm9TeJY7havDRldyh+QkGISyIYRHkxfSV3LA2Zv7I4Ckxx55ZegBwRRDbWALZp38FZ9NvdkbJMmcTM5P1HbNrKmgV/Rce9dtav8vuL2Xp
+        thebits@x200s"}]}'
     headers:
       Access-Control-Allow-Headers:
       - Authorization,Keep-Alive,Content-Type,Origin
@@ -26,8 +27,8 @@ interactions:
       - '1728000'
       Connection:
       - keep-alive
-      Content-Encoding:
-      - gzip
+#      Content-Encoding:
+#      - gzip
       Content-Type:
       - application/json
       Date:
diff --git a/tests/vdsina_test.py b/tests/vdsina_test.py
@@ -1,14 +1,28 @@
 import os
 
+import pytest
 import vcr
 
 from vdsinadriver import VdsinaDriver
 
 
+@pytest.fixture()
+def vdsina_key() -> str:
+    key = os.getenv("VDSINA_TOKEN")
+    if key is None:
+        pytest.exit("set up VDSINA_TOKEN environment variable")
+    return str(key)
+
+
+@pytest.fixture()
+def compute_conn(vdsina_key):
+    conn = VdsinaDriver(key=vdsina_key)
+    return conn
+
+
 @vcr.use_cassette("./tests/fixtures/list_key_pairs.yaml", filter_headers=["Authorization"])
-def test_list_key_pairs():
-    conn = VdsinaDriver(key=os.getenv("VDSINA_TOKEN"))
-    keys = conn.list_key_pairs()
+def test_list_key_pairs(compute_conn):
+    keys = compute_conn.list_key_pairs()
     key = keys.pop()
     assert key.name == "x200s"
     assert key.fingerprint == "ca:28:dc:6e:9e:72:48:d3:bc:73:76:19:d2:5f:c3:e8"
diff --git a/tox.ini b/tox.ini
@@ -1,24 +1,29 @@
 [tox]
-envlist = libcloud{30,31,32,33,34,35}, lint
+envlist = libcloud{30,31,32,33,34,35}
 # https://libcloud.apache.org/about.html#supported-python-versions
 # envlist = py35,py36,py37,py38,py39,py310,pypy35,pypy36,pypy37,pypy38
 
+[pytest]
+addopts = -ra -q
+testpaths = tests
+
+
 [testenv]
+description = Run pytest
 passenv =
     VDSINA_TOKEN
-description = Run pytest
 deps =
     libcloud30: apache-libcloud>=3.0.0,<3.1.0
     libcloud31: apache-libcloud>=3.1.0,<3.2.0
     libcloud32: apache-libcloud>=3.2.0,<3.3.0
     libcloud33: apache-libcloud>=3.3.0,<3.4.0
     libcloud34: apache-libcloud>=3.4.0,<3.5.0
     libcloud35: apache-libcloud>=3.5.0,<3.6.0
-    -rrequirements-dev.txt
+    -rrequirements-tox.txt
 commands =
-    pytest {posargs}
+    pytest --cov={envsitepackagesdir}/ruvdsdriver --cov-report=term-missing --cov-fail-under 0 {posargs}
 
-[testenv:lint]
+[testenv:pre-commit]
 description = Run all pre-commit hooks.
 skip_install = true
 deps = pre-commit
diff --git a/vdsinadriver/__init__.py b/vdsinadriver/__init__.py
@@ -48,7 +48,7 @@ def list_size(self):
     def list_key_pairs(self):
         response = self.connection.request("v1/ssh-key")
         key_pairs = []
-        for kp in response.object:
+        for kp in response.object.get("data"):
             key_pair = KeyPair(
                 name=kp["name"],
                 public_key=kp["key"],
