Metadata-Version: 2.4
Name: boardfarm3_docsis
Version: 1.1.0
Summary: An add-on to boardfarm that contains DOCSIS specific libraries.
Author: Various
Author-email: Various <t&iconnectivityboardfarm@libertyglobal.com>
License-Expression: BSD-3-Clause-Clear
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Testing :: Acceptance
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Dist: boardfarm3>=1.0.0
Requires-Dist: pandas
Requires-Dist: pexpect>=4.9
Requires-Dist: termcolor
Requires-Dist: pytest-boardfarm3 ; extra == 'demo-test'
Requires-Dist: mypy>=1.13 ; extra == 'dev'
Requires-Dist: nox>=2024.10.9 ; extra == 'dev'
Requires-Dist: pandas-stubs ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: ruff>=0.13 ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'doc'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-mock ; extra == 'test'
Requires-Dist: pytest-randomly ; extra == 'test'
Requires-Python: >=3.13
Project-URL: Source, https://github.com/lgirdk/boardfarm-docsis
Provides-Extra: demo-test
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test
Description-Content-Type: text/markdown

# Boardfarm DOCSIS

This is the repo  that will contain DOCSIS specific tests and libraries for use for testing a docsis CM, CMTS, or other devices in a typical DOCSIS environment

To use this boardfarm plugin on Ubuntu, you must install:

```sh
# TCL for encoding of an MTA config file
sudo apt update
sudo apt install tcllib

# docsis for running docsis commands
sudo apt install automake libtool libsnmp-dev bison make gcc flex git libglib2.0-dev libfl-dev
git clone https://github.com/rlaager/docsis.git
cd docsis
./autogen.sh
./configure
make
sudo make install
```

## Execute tests

Please see the the demo test suite that utilizes some of the use-cases
from the ```boardfarm-docsis``` plugin.

```bash
.
└── tests
    ├── __init__.py
    ├── docsis
    │   ├── __init__.py
    │   └── test_demo_docsis_1.py
    ├── pytest.ini
    └── tr069
        ├── __init__.py
        └── test_demo_tr069_1.py
```

**_NOTE:_**  In order to run these test you will have to install pytest-boardfarm.

```bash
pip install boardfarm3[docsis,pytest]
```

Sample run command:

```bash
pytest \
    --rootdir=. \
    --capture=tee-sys \
    --board-name <cpe-name> \
    --env-config <testbed_env.json>  \
    --junitxml ./results/pytest_run_report.xml \
    --ldap-credentials "username:password"  \
    --inventory-config <lab_devices.json> \
    --html=./results/pytest_run_report.html  \
    --self-contained-html  \
    --save-console-logs=./results  \
    ./boardfarm-docsis/tests/ \
    --skip-contingency-checks
```
