Skip to main content

PyKiso

Optional Text

Introduction

pykiso is an integration test framework. With it, it is possible to write

  • Whitebox integration tests directly on my target device
  • Graybox integration tests to make sure the communication-link with my target device is working as expected
  • Blackbox integration tests to make sure my external device interfaces are working as expected

The project will contain:

  • The core python framework (this repository)
  • Framework plugins that are generic enough to be integrated as "native" (this repository)
  • Additional "testApps" for different targets platforms (e.g. stm32, ...) or languages (C, C++, ...) . It could be pure SW or also HW (other repositories)

Requirements

  • Python 3.7+
  • pip/poetry (used to get the rest of the requirements)

Install

pip install pykiso

Poetry is more appropriate for developers as it automatically creates virtual environments.

cd kiso-testing
poetry install
poetry shell

Pre-Commit

To improve code-quality, a configuration of pre-commit hooks are available. The following pre-commit hooks are used:

  • black
  • flake8
  • isort
  • trailing-whitespace
  • end-of-file-fixer
  • check-docstring-first
  • check-json
  • check-added-large-files
  • check-yaml
  • debug-statements

If you don't have pre-commit installed, you can get it using pip:

pip install pre-commit

Start using the hooks with

pre-commit install

Commit message convention

Commits are sorted into multiple categories based on keywords that can occur at any position as part of the commit message. [Category] Keywords

  • [BREAKING CHANGES] BREAKING CHANGE
  • [Features] feat:
  • [Fixes] fix:
  • [Docs] docs:
  • [Styles] style:
  • [Refactors] refactor!:
  • [Performances] perf:
  • [Tests] test:
  • [Build] build:
  • [Ci] ci: Each commit is considered only once according to the order of the categories listed above. Merge commits are ignored.

The tool commitizen can help you to create commits which follows these standards.

# if not yet installed:
pip install -U commitizen==2.20.4
# helps you to create a commit:
cz commit
# or use equivalent short variant:
cz c

Generate Changelog

After you installed the dev dependencies from the pipfile you are able to autogenerate the Changelog.

invoke changelog

Usage

Once installed the application is bound to pykiso, it can be called with the following arguments:

Usage: pykiso [OPTIONS] [PATTERN]

  Embedded Integration Test Framework - CLI Entry Point.

  PATTERN: overwrite the test filter pattern from the YAML file (optional)

Options:
  -c, --test-configuration-file FILE
                                  path to the test configuration file (in YAML
                                  format)  [required]

  -l, --log-path PATH             path to log-file or folder. If not set will
                                  log to STDOUT

  --log-level [DEBUG|INFO|WARNING|ERROR]
                                  set the verbosity of the logging
  --version                       Show the version and exit.
  -h, --help                          Show this message and exit.
  --variant                       allow the user to execute a subset of tests
                                  based on variants
  --branch-level                  allow the user to execute a subset of tests
                                  based on branch levels
  --junit                         enables the generation of a junit report
  --text                          default, test results are only displayed in
                                  the console
  --failfast                      stop the test run on the first error or
                                  failure

Suitable config files are available in the examples folder.

Demo using example config

invoke run

Running the Tests

invoke test

or

pytest

Metadata

Release files for pykiso 0.17.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pykiso 0.17.0
File Size Uploaded Provenance Actions
pykiso-0.17.0.tar.gz 105.6 kB Without provenance Details for pykiso-0.17.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pykiso 0.17.0
File Interpreter ABI Platform Actions
pykiso-0.17.0-py3-none-any.whl Python 3 none any Details for pykiso-0.17.0-py3-none-any.whl

Total release size: 263.5 kB

Release files / pykiso-0.17.0.tar.gz

Download URL pykiso-0.17.0.tar.gz
Size 105.6 kB
Tags Source
SHA-256 checksum
How to use checksums
3e78f79a8c7caf5b959a0bda79d9adebb0a3428407d4fbed9441557dc6f0d36a
BLAKE2b-256 checksum
How to use checksums
2b8a97be6d2bd1c3265328ab02ff4f844a470e03d8625bbe123733f6f65fe3f0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.13 CPython/3.7.3 Linux/5.14.14-200.fc34.x86_64

Release files / pykiso-0.17.0-py3-none-any.whl

Download URL pykiso-0.17.0-py3-none-any.whl
Size 157.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f5eb28cf4acdf04278faa3983d54a29b6347d67f6a8ae1c536cdc4d3eb4ea561
BLAKE2b-256 checksum
How to use checksums
3c042e803d0d41e0acf68d7a66e2cd4d8fc0573f30c302ef7943cb43ca669e36
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.13 CPython/3.7.3 Linux/5.14.14-200.fc34.x86_64

Security for pykiso 0.17.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.17.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page