Skip to content

Commit

Permalink
docs: Adding a description about the automated tests
Browse files Browse the repository at this point in the history
  • Loading branch information
mgm8 committed Dec 12, 2022
1 parent 8105191 commit 954ccb0
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 18 deletions.
40 changes: 40 additions & 0 deletions docs/development.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
****************************************
Development Instructions and Information
****************************************

Automated Tests
===============

The project contains some automated tests for improve the correctness and the confiability of the source code, by testing key functional aspects of the code.

All tests are presented in the "tests" folder, and are divided in three parts:

* **Extension tests**: The extension tests contains tests for encoding and decoding most part of the extension packets. The packets are encoded and decoded using random data.
* **RF tests**: The RF tests contains the main test of the library. This test ensure the proper functioning of the encoding and decoding of NGHam packets, by generating packets with random data and with all possible quantity of bytes (1 to 220).
* **SPP tests**: The Serial Port Protocol tests (SPP) tests the encoding and decoding of SPP packets, similarly to the RF tests.

The tests are executed using the PyTests tool [1]_ and are integrated into the GitHub repository, using GitHub Actions. This way, at every new commit or merge to the main branch, the tests are performed automatically.

Together with the code tests, the documentation is also built and deployed automatically when a merge to the main branch is made.

Packaging the Project
=====================

This page presents the instructions to packaging the source files of the project.

Generating a RPM Package
------------------------

To generate an RPM package, execute the command below:

::

python setup.py bdist_rpm


If successful, the generated RPM package will be available in *dist/*.

References
==========

.. [1] https://pytest.org/
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Contents
extension
install
usage
packaging
development
17 changes: 0 additions & 17 deletions docs/packaging.rst

This file was deleted.

0 comments on commit 954ccb0

Please sign in to comment.