Add pre-commit (#22)

* remove trailing whitespace: clean up unnecessary whitespace in documentation, scripts, and configuration files

* remove lint-test workflow: delete obsolete workflow file, previously replaced by modular CI orchestrator

* refactor workflows: replace inline pre-commit configuration with reusable `stage-pre-commit.yml`, integrate pre-commit checks into CI orchestrator

* update workflows: remove redundant `os` input, set `ubuntu-latest` as default runner in pre-commit jobs

* update workflows: restructure pre-commit checks to run as a standalone job, update dependencies in CI orchestrator

* refactor tests: replace `list` method with `list_avds` in AVD management tests and integrations

* docs: add comprehensive development guide and update README/CONTRIBUTING with CI/CD details

Author: allnes

.gitattributes

@@ -33,4 +33,4 @@ Makefile text eol=lf
 .pre-commit-config.yaml export-ignore
 tests/ export-ignore
 docs/ export-ignore
-*.md export-ignore
+*.md export-ignore

.github/workflows/bench.yml

@@ -2,9 +2,9 @@ name: OVMobileBench CI
 
 on:
   push:
-    branches: [ main, develop ]
+    branches: [main, develop]
   pull_request:
-    branches: [ main ]
+    branches: [main]
   workflow_dispatch:
     inputs:
       device_serial:
@@ -17,7 +17,14 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  # Run pre-commit only once on ubuntu-latest
+  pre-commit:
+    uses: ./.github/workflows/stage-pre-commit.yml
+    secrets: inherit
+
+  # Run CI matrix for all OS after pre-commit passes
   ci-matrix:
+    needs: pre-commit
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]

.github/workflows/ci-orchestrator.yml

@@ -12,24 +12,24 @@ on:
         default: 'emulator-5554'
 
 jobs:
-  # Stage 1: Lint and Test
-  lint-test:
-    uses: ./.github/workflows/stage-lint-test.yml
+  # Stage 1: Test
+  test:
+    uses: ./.github/workflows/stage-test.yml
     with:
       os: ${{ inputs.os }}
     secrets: inherit
 
   # Stage 2: Build Package (runs in parallel with validation)
   build:
-    needs: lint-test
+    needs: test
     uses: ./.github/workflows/stage-build.yml
     with:
       os: ${{ inputs.os }}
     secrets: inherit
 
   # Stage 3: Validation (runs in parallel with build)
   validation:
-    needs: lint-test
+    needs: test
     uses: ./.github/workflows/stage-validation.yml
     with:
       os: ${{ inputs.os }}

.github/workflows/stage-device-tests.yml

@@ -57,8 +57,8 @@ jobs:
 
   device-test-adb:
     if: |
-      (github.event_name == 'workflow_dispatch' || 
-       contains(github.event.head_commit.message, '[device-test-adb]')) && 
+      (github.event_name == 'workflow_dispatch' ||
+       contains(github.event.head_commit.message, '[device-test-adb]')) &&
        inputs.os == 'ubuntu-latest'
     runs-on: self-hosted
     steps:

.github/workflows/stage-pre-commit.yml

@@ -0,0 +1,29 @@
+name: Pre-commit
+
+on:
+  workflow_call:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0  # Fetch all history for all branches
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+          cache-dependency-path: |
+            requirements.txt
+            setup.py
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install pre-commit
+
+      - name: Run pre-commit
+        run: pre-commit run --all-files --show-diff-on-failure

.github/workflows/stage-lint-test.yml .github/workflows/stage-test.yml.github/workflows/stage-lint-test.yml renamed to .github/workflows/stage-test.yml

@@ -1,4 +1,4 @@
-name: Lint and Test
+name: Test
 
 on:
   workflow_call:
@@ -8,7 +8,7 @@ on:
         type: string
 
 jobs:
-  lint-and-test:
+  test:
     runs-on: ${{ inputs.os }}
     steps:
       - uses: actions/checkout@v5
@@ -30,15 +30,6 @@ jobs:
           pip install -r requirements.txt
           pip install -e .
 
-      - name: Run Black
-        run: black --check ovmobilebench tests
-
-      - name: Run Ruff
-        run: ruff check ovmobilebench tests
-
-      - name: Run MyPy
-        run: mypy ovmobilebench --ignore-missing-imports
-
       - name: Run tests
         run: pytest tests/ -v --cov=ovmobilebench --cov=scripts --junitxml=junit.xml -o junit_family=legacy
 

.github/workflows/stage-validation.yml

@@ -30,7 +30,8 @@ jobs:
 
       - name: Validate example config
         run: |
-          python -c "from ovmobilebench.config.loader import load_experiment; load_experiment('experiments/android_example.yaml')"
+          python -c "from ovmobilebench.config.loader import load_experiment; \
+            load_experiment('experiments/android_example.yaml')"
 
       - name: CLI help test
         run: |

.gitignore

@@ -136,3 +136,5 @@ experiments/results/
 ovmb_cache
 artifacts
 junit.xml
+
+*.DS_Store*

.markdownlint.json

@@ -0,0 +1,18 @@
+{
+  "default": true,
+  "MD013": false,
+  "MD033": {
+    "allowed_elements": ["br", "sup", "sub", "details", "summary", "img", "API", "arch", "target"]
+  },
+  "MD041": false,
+  "MD024": {
+    "siblings_only": true
+  },
+  "MD040": false,
+  "MD025": false,
+  "MD036": false,
+  "MD028": false,
+  "MD051": false,
+  "MD046": false,
+  "MD001": false
+}

.pre-commit-config.yaml

@@ -18,6 +18,12 @@ repos:
       - id: name-tests-test
         args: ['--pytest-test-first']
 
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.19.1
+    hooks:
+      - id: pyupgrade
+        args: ['--py311-plus']
+
   - repo: https://github.com/psf/black
     rev: 24.4.2
     hooks:
@@ -35,28 +41,43 @@ repos:
     rev: v1.10.0
     hooks:
       - id: mypy
-        additional_dependencies: [types-all]
+        additional_dependencies: [types-PyYAML, types-paramiko]
         args: ['--ignore-missing-imports']
-        exclude: '^tests/'
+        files: '^ovmobilebench/(?!android/installer/).*\.py$'
 
   - repo: https://github.com/pycqa/isort
     rev: 5.13.2
     hooks:
       - id: isort
         args: ['--profile', 'black', '--line-length', '100']
 
-  - repo: https://github.com/pycqa/docformatter
-    rev: v1.7.5
-    hooks:
-      - id: docformatter
-        args: ['--in-place', '--wrap-summaries', '100', '--wrap-descriptions', '100']
-
   - repo: https://github.com/commitizen-tools/commitizen
     rev: v3.27.0
     hooks:
       - id: commitizen
         stages: [commit-msg]
 
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.35.1
+    hooks:
+      - id: yamllint
+        args: ['--strict']
+
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.43.0
+    hooks:
+      - id: markdownlint
+        args: ['--fix']
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        args: ['--skip=*.json,*.yaml,*.yml,*.txt,*.csv,*.lock', '--ignore-words-list=nd,teh,hist']
+
 ci:
   autofix_prs: false
-  autoupdate_schedule: monthly
+  autoupdate_schedule: weekly
+  autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
+  skip: []
+  submodules: false