run-behave-tests

A Github action to run Behave Behavioral Driven Development tests for Python

Tests

Usage

Example Project Structure

• example_project/
  • requirements.txt
  • behave.ini
  • my_class_to_test.py
  • features/
    • my_tests.feature
    • steps/
      • my_steps.py

Minimal

steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
  with:
    python-version: 3.10.5
- uses: cryptic-wizard/run-behave-tests@v0.4.0
  with:
    test-path: example_project
    test-output-name: results.txt

OS Matrix Testing

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    
  steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-python@v5
    with:
      python-version: 3.10.5
  - uses: cryptic-wizard/run-behave-tests@v0.4.0
    with:
      test-path: example_project
      test-output-name: ${{ matrix.os }}.txt

Complex Matrix Testing

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
        python-version: ['3.8', '3.9', '3.10.5']
        exclude:
          - os: ubuntu-latest
            python-version: '3.9'
          - os: windows-latest
            python-version: '3.10.5'

  steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-python@v5
    with:
      python-version: ${{ matrix.python-version }}
  - uses: cryptic-wizard/run-behave-tests@v0.4.0
    with:
      test-path: example_project
      test-output-name: ${{ matrix.os }}-${{ matrix.python-version }}.txt

Features

Recently Added

• v0.4.0 - Update upload-artifact compatiblity, Fix test-output-name

test-output-name: MyTestResults.txt

• v0.3.0 - Automatic artifact upload
• ⚠️ Deprecated November 30, 2024 with actions/upload-artifact@v3

upload-artifact: true by default

• v0.2.0 - Basic inputs
• ⚠️ Deprecated November 30, 2024 with actions/upload-artifact@v3

requirements-name:
test-path:
test-output-name:

Planned Automation Features

• Additional behave arguments

Tools

• Python 3.10.5
• Behave
• Gherkin
• Flake8
• inkpot

License

• MIT License