pytest-embedded-arduino-cli 0.2.0__tar.gz

pytest_embedded_arduino_cli-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,157 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Release version (X.Y.Z)"
+        required: true
+      publish_pypi:
+        description: "Publish package to PyPI"
+        required: true
+        type: boolean
+        default: true
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Run release preparation
+        run: uv run python tools/prepare_release.py --version "${{ github.event.inputs.version }}"
+
+      - name: Run tests
+        run: uv run pytest tests
+
+      - name: Build package
+        run: uv build
+
+      - name: Commit release changes
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add pyproject.toml src/pytest_embedded_arduino_cli/__init__.py CHANGELOG.md
+          git commit -m "chore(release): v${{ github.event.inputs.version }}"
+
+      - name: Create tag
+        run: git tag "v${{ github.event.inputs.version }}"
+
+      - name: Push commit and tag
+        run: |
+          git push origin HEAD
+          git push origin "v${{ github.event.inputs.version }}"
+
+  create_github_release:
+    runs-on: ubuntu-latest
+    needs: prepare
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout tag
+        uses: actions/checkout@v4
+        with:
+          ref: "v${{ github.event.inputs.version }}"
+          fetch-depth: 0
+
+      - name: Build release body from CHANGELOG
+        run: |
+          VERSION="${{ github.event.inputs.version }}" python - <<'PY'
+          import os
+          import subprocess
+          from pathlib import Path
+
+          version = os.environ["VERSION"]
+          current_tag = f"v{version}"
+
+          changelog = Path("CHANGELOG.md").read_text(encoding="utf-8").splitlines()
+          section_header = f"## {version}"
+
+          try:
+              start = changelog.index(section_header)
+          except ValueError as exc:
+              raise SystemExit(f"Version section {section_header} not found in CHANGELOG.md") from exc
+
+          end = len(changelog)
+          for i in range(start + 1, len(changelog)):
+              if changelog[i].startswith("## "):
+                  end = i
+                  break
+
+          section = "\n".join(changelog[start:end]).strip()
+          body = section + "\n\nRepository: https://github.com/tanakamasayuki/pytest-embedded-arduino-cli"
+
+          tags = (
+              subprocess.check_output(
+                  ["git", "tag", "--list", "v*", "--sort=v:refname"],
+                  text=True,
+              )
+              .strip()
+              .splitlines()
+          )
+
+          prev_tag = ""
+          for i, tag in enumerate(tags):
+              if tag == current_tag and i > 0:
+                  prev_tag = tags[i - 1]
+                  break
+
+          if prev_tag:
+              body += (
+                  "\n\nFull Changelog: "
+                  "https://github.com/tanakamasayuki/pytest-embedded-arduino-cli/compare/"
+                  f"{prev_tag}...{current_tag}"
+              )
+
+          Path("release_body.md").write_text(body + "\n", encoding="utf-8")
+          PY
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: "v${{ github.event.inputs.version }}"
+          body_path: release_body.md
+          generate_release_notes: false
+
+  publish_pypi:
+    runs-on: ubuntu-latest
+    needs: prepare
+    if: ${{ github.event.inputs.publish_pypi == 'true' }}
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout tag
+        uses: actions/checkout@v4
+        with:
+          ref: "v${{ github.event.inputs.version }}"
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI (Trusted Publishing)
+        uses: pypa/gh-action-pypi-publish@release/v1

pytest_embedded_arduino_cli-0.2.0/.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Run tests
+        run: uv run pytest tests
+
+      - name: Build package
+        run: uv build

pytest_embedded_arduino_cli-0.2.0/.gitignore

@@ -0,0 +1,37 @@
+# Python
+__pycache__/
+*.py[cod]
+*.so
+.Python
+
+# Build / packaging
+build/
+dist/
+*.egg-info/
+.eggs/
+pip-wheel-metadata/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Test / tooling caches
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.mypy_cache/
+.ruff_cache/
+
+# IDE / OS
+.DS_Store
+.idea/
+.vscode/
+
+# Local dependency locks
+uv.lock
+
+# Arduino CLI build outputs inside sketch directories
+examples/**/build/
+tests/**/build/

pytest_embedded_arduino_cli-0.2.0/.python-version

@@ -0,0 +1 @@
+3.13

pytest_embedded_arduino_cli-0.2.0/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog / 変更履歴
+
+## Unreleased
+
+## 0.2.0
+- (EN) Initial release.
+- (JA) 初期リリース。

pytest_embedded_arduino_cli-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 TANAKA Masayuki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pytest_embedded_arduino_cli-0.2.0/PKG-INFO

@@ -0,0 +1,229 @@
+Metadata-Version: 2.4
+Name: pytest-embedded-arduino-cli
+Version: 0.2.0
+Summary: A pytest plugin to test Arduino projects using pytest-embedded and arduino-cli
+Project-URL: Homepage, https://github.com/tanakamasayuki/pytest-embedded-arduino-cli
+Project-URL: Repository, https://github.com/tanakamasayuki/pytest-embedded-arduino-cli
+Author: TANAKA Masayuki
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: pytest-embedded-serial>=2.0
+Requires-Dist: pytest-embedded>=2.0
+Requires-Dist: pytest>=8
+Requires-Dist: pyyaml>=6.0
+Description-Content-Type: text/markdown
+
+# pytest-embedded-arduino-cli
+
+[日本語版 README](README.ja.md)
+
+A pytest plugin to test Arduino projects using `pytest-embedded` and `arduino-cli`.
+
+## Overview
+
+`pytest-embedded-arduino-cli` is a small plugin that keeps `pytest-embedded`'s generic DUT / serial / expect flow and replaces Arduino-specific build and upload with `arduino-cli`.
+
+This package does not depend on `pytest-embedded-arduino`. It is intended to stay generic enough to work well for Arduino projects beyond ESP32-specific assumptions.
+
+## Design
+
+- Build with `arduino-cli compile`
+- Upload with `arduino-cli upload`
+- Use `pytest-embedded` as the runtime foundation
+- Avoid `EspSerial` and ESP-specific flashing services
+- Resolve sketch settings from `sketch.yaml` and `--profile`
+- Treat the test file directory as the sketch directory
+
+## Setup
+
+```bash
+uv init
+uv add pytest-embedded-arduino-cli
+uv sync
+```
+
+Runtime dependencies include:
+
+- `pytest`
+- `pytest-embedded`
+- `pytest-embedded-serial`
+- `PyYAML`
+
+## Requirements
+
+- `arduino-cli` available in `PATH`
+- Installed Arduino board core(s)
+- A serial port accessible from the host when running hardware tests
+
+## Project Layout
+
+The expected layout is one sketch directory per test app.
+
+```text
+tests/
+  my_app/
+    sketch.yaml
+    my_app.ino
+    test_my_app.py
+```
+
+When pytest runs a specific `.py` file, this plugin treats that file's directory as the sketch directory. Build settings are resolved from the nearest `sketch.yaml`.
+
+## Usage
+
+Build, upload, and run tests:
+
+```bash
+uv run pytest tests/my_app --port /dev/ttyACM0
+```
+
+Select an Arduino CLI profile from `sketch.yaml`:
+
+```bash
+uv run pytest tests/my_app --profile esp32s3 --port /dev/ttyACM0
+```
+
+Build only:
+
+```bash
+uv run pytest tests/my_app --run-mode=build
+```
+
+Upload and test against an already-built image:
+
+```bash
+uv run pytest tests/my_app --run-mode=test --port /dev/ttyACM0
+```
+
+`--run-mode=test` skips compile, reuses the existing build output, uploads it, and then runs the test.
+
+Run this package's own tests:
+
+```bash
+uv run pytest
+```
+
+## Main Options
+
+- `--run-mode=all|build|test`
+- `--profile`
+
+Use `pytest-embedded` standard options for runtime control, such as:
+
+- `--port`
+- `--flash-port`
+- `--baud`
+- `--embedded-services`
+
+`pytest-embedded-serial` is installed as a normal dependency so hardware tests can use the serial service without extra package installation.
+If `--embedded-services` is not specified, this plugin enables `serial` by default.
+
+For profile-specific serial ports, the plugin resolves ports in this order:
+
+1. `--flash-port`
+2. `--port`
+3. `TEST_SERIAL_PORT_<PROFILE>`
+4. `TEST_SERIAL_PORT`
+
+Example:
+
+```bash
+export TEST_SERIAL_PORT_ESP32S3=/dev/ttyUSB1
+uv run pytest tests/my_app --profile esp32s3
+```
+
+If `--profile` is omitted, the plugin uses the resolved profile from `sketch.yaml`, including `default_profile`.
+
+For compile-time defines, place a `build_config.toml` in the sketch directory:
+
+```toml
+[defines]
+TEST_WIFI_SSID = "WIFI_SSID"
+TEST_WIFI_PASSWORD = "WIFI_PASSWORD"
+```
+
+Here, the left side is the environment variable name and the right side is the C/C++ define name.
+For example, `TEST_WIFI_SSID` becomes `-DWIFI_SSID="..."` at compile time.
+
+Set values before running pytest:
+
+```bash
+export TEST_WIFI_SSID=my-ssid
+export TEST_WIFI_PASSWORD=my-password
+uv run pytest tests/my_app
+```
+
+If an environment variable is missing, the plugin still passes the define with an empty string value.
+This allows the test or sketch code to decide how to handle missing settings.
+
+For command visibility, follow pytest's standard verbosity:
+
+- `-v` shows the `arduino-cli compile` / `arduino-cli upload` command line
+- `-vv` also shows execution context such as `cwd`, `sketch_dir`, `build_path`, `profile`, and `port`
+
+## Example
+
+```python
+def test_hello(dut):
+    dut.expect_exact("hello from arduino")
+```
+
+```cpp
+void setup() {
+  Serial.begin(115200);
+  delay(1000);
+  Serial.println("hello from arduino");
+}
+
+void loop() {}
+```
+
+Additional sample:
+
+- `examples/wifi`
+  - Connects to Wi-Fi on ESP32/ESP32-S3
+  - Includes `uno` as a skip example for a non-Wi-Fi profile
+  - Expects `TEST_WIFI_SSID` and `TEST_WIFI_PASSWORD`
+  - Verifies that the board prints `WIFI_OK <ip-address>`
+
+## What This Plugin Does Not Try To Be
+
+- A drop-in replacement for `pytest-embedded-arduino`
+- An ESP-specific flashing layer
+- A board auto-discovery tool
+
+## Future Extensions
+
+- Board-family-specific upload strategies
+- Smarter artifact discovery
+- Serial reset / monitor helpers
+- Multi-device support
+- Optional `fqbn` or sketch path overrides
+
+## Release
+
+This repository uses GitHub Actions for releases.
+
+Before triggering a release:
+
+- Update the `## Unreleased` section in `CHANGELOG.md`
+- Make sure `uv run pytest tests` passes locally if needed
+
+Release flow:
+
+1. Open GitHub Actions
+2. Run the `Release` workflow manually
+3. Enter the release version such as `0.1.0`
+4. Choose whether to publish to PyPI
+
+The workflow will:
+
+- Update versions in `pyproject.toml` and `src/pytest_embedded_arduino_cli/__init__.py`
+- Move `CHANGELOG.md` unreleased entries into `## <version>`
+- Run tests and build the package
+- Commit the release changes and create tag `v<version>`
+- Create a GitHub Release
+- Publish to PyPI when enabled
+
+PyPI publishing is configured for Trusted Publishing via GitHub Actions.

pytest_embedded_arduino_cli-0.2.0/README.ja.md

@@ -0,0 +1,217 @@
+# pytest-embedded-arduino-cli
+
+[English README](README.md)
+
+`pytest-embedded` と `arduino-cli` を使って Arduino プロジェクトをテストするための pytest plugin です。
+
+## 概要
+
+`pytest-embedded-arduino-cli` は、`pytest-embedded` の汎用的な DUT / serial / expect の流れを活かしつつ、Arduino 向けの build / upload を `arduino-cli` に置き換える小さな plugin です。
+
+このパッケージは `pytest-embedded-arduino` には依存しません。ESP32 固有の前提に寄せず、より広い Arduino プロジェクトで使いやすい構成を目指しています。
+
+## 設計方針
+
+- build は `arduino-cli compile`
+- upload は `arduino-cli upload`
+- test runtime は `pytest-embedded` を土台にする
+- `EspSerial` や ESP 固有の flashing service は使わない
+- sketch 設定は `sketch.yaml` と `--profile` から解決する
+- テストファイルのあるディレクトリを sketch ディレクトリとして扱う
+
+## セットアップ
+
+```bash
+uv init
+uv add pytest-embedded-arduino-cli
+uv sync
+```
+
+通常依存として次を含みます。
+
+- `pytest`
+- `pytest-embedded`
+- `pytest-embedded-serial`
+- `PyYAML`
+
+## 前提条件
+
+- `arduino-cli` が `PATH` に入っていること
+- 必要な Arduino board core がインストール済みであること
+- 実機テスト時にホストからアクセスできる serial port があること
+
+## 想定レイアウト
+
+基本は 1 つのテストアプリごとに 1 つの sketch ディレクトリを想定します。
+
+```text
+tests/
+  my_app/
+    sketch.yaml
+    my_app.ino
+    test_my_app.py
+```
+
+pytest が特定の `.py` を実行したとき、この plugin はそのファイルがあるディレクトリを sketch ディレクトリとして扱います。build 設定は最も近い `sketch.yaml` から解決します。
+
+## 使い方
+
+build・upload・test をまとめて実行する例:
+
+```bash
+uv run pytest tests/my_app --port /dev/ttyACM0
+```
+
+`sketch.yaml` の profile を選ぶ例:
+
+```bash
+uv run pytest tests/my_app --profile esp32s3 --port /dev/ttyACM0
+```
+
+build のみ:
+
+```bash
+uv run pytest tests/my_app --run-mode=build
+```
+
+既存 build artifact を使って upload してから test:
+
+```bash
+uv run pytest tests/my_app --run-mode=test --port /dev/ttyACM0
+```
+
+`--run-mode=test` は compile を行わず、既存 build 出力を使って upload してから test を実行します。
+
+このパッケージ自身のテストを実行する例:
+
+```bash
+uv run pytest
+```
+
+## 主な option
+
+- `--run-mode=all|build|test`
+- `--profile`
+
+実行時の制御には `pytest-embedded` 標準 option を使います。主なものは次です。
+
+- `--port`
+- `--flash-port`
+- `--baud`
+- `--embedded-services`
+
+`pytest-embedded-serial` は通常依存に含めているため、実機テストで serial service を追加インストールなしで使えます。
+`--embedded-services` を指定しない場合、この plugin は `serial` をデフォルトで有効化します。
+
+profile ごとの serial port は次の順で解決します。
+
+1. `--flash-port`
+2. `--port`
+3. `TEST_SERIAL_PORT_<PROFILE>`
+4. `TEST_SERIAL_PORT`
+
+例:
+
+```bash
+export TEST_SERIAL_PORT_ESP32S3=/dev/ttyUSB1
+uv run pytest tests/my_app --profile esp32s3
+```
+
+`--profile` を省略した場合でも、plugin は `sketch.yaml` から解決した profile を使います。`default_profile` もこの対象です。
+
+compile-time define を渡したい場合は、sketch ディレクトリに `build_config.toml` を置きます。
+
+```toml
+[defines]
+TEST_WIFI_SSID = "WIFI_SSID"
+TEST_WIFI_PASSWORD = "WIFI_PASSWORD"
+```
+
+左側は環境変数名、右側は C/C++ 側で使う define 名です。
+例えば `TEST_WIFI_SSID` は compile 時に `-DWIFI_SSID="..."` に変換されます。
+
+実行前に対応する環境変数を設定しておくと、plugin が `arduino-cli compile --build-property build.extra_flags=...` に変換して渡します。
+
+```bash
+export TEST_WIFI_SSID=my-ssid
+export TEST_WIFI_PASSWORD=my-password
+uv run pytest tests/my_app
+```
+
+環境変数が未設定でも、その define には空文字が渡されます。
+未設定をどう扱うかは、テスト側または sketch 側で判断できます。
+
+## verbosity とログ
+
+コマンド表示には pytest 標準の verbosity を使います。
+
+- `-v`
+  - `arduino-cli compile` / `arduino-cli upload` の実行コマンドを表示
+- `-vv`
+  - 上記に加えて `cwd`、`sketch_dir`、`build_path`、`profile`、`port` なども表示
+
+## 例
+
+```python
+def test_hello(dut):
+    dut.expect_exact("hello from arduino")
+```
+
+```cpp
+void setup() {
+  Serial.begin(115200);
+  delay(1000);
+  Serial.println("hello from arduino");
+}
+
+void loop() {}
+```
+
+追加サンプル:
+
+- `examples/wifi`
+  - ESP32 / ESP32-S3 で Wi-Fi 接続を行う
+  - Wi-Fi 非対応 profile の例として `uno` では skip する
+  - `TEST_WIFI_SSID` と `TEST_WIFI_PASSWORD` を使う
+  - ボードが `WIFI_OK <ip-address>` を出力することを検証する
+
+## この plugin が目指していないもの
+
+- `pytest-embedded-arduino` の drop-in replacement
+- ESP 固有の flashing layer
+- board 自動検出ツール
+
+## 今後の拡張候補
+
+- board family ごとの upload strategy
+- artifact 探索の改善
+- serial reset / monitor helper
+- 複数デバイス対応
+- `fqbn` や sketch path の override
+
+## リリース方法
+
+このリポジトリは GitHub Actions ベースでリリースします。
+
+リリース前に最低限やること:
+
+- `CHANGELOG.md` の `## Unreleased` を更新する
+- 必要ならローカルで `uv run pytest tests` を通しておく
+
+リリース手順:
+
+1. GitHub Actions を開く
+2. `Release` workflow を手動実行する
+3. `0.1.0` のような version を入力する
+4. PyPI に publish するかを選ぶ
+
+workflow が行うこと:
+
+- `pyproject.toml` と `src/pytest_embedded_arduino_cli/__init__.py` の version 更新
+- `CHANGELOG.md` の `## Unreleased` を `## <version>` に反映
+- テストとパッケージ build の実行
+- release 用 commit と `v<version>` tag の作成
+- GitHub Release の作成
+- 必要に応じて PyPI への publish
+
+PyPI publish は GitHub Actions の Trusted Publishing を前提にしています。