regr-tests

Basic Station Regression Tests

This directory contains the regression test suite for Basic Station.

Quick Start

# Run all tests
./run-regression-tests

# Run with verbose output
./run-regression-tests -v

# Run specific test
./run-regression-tests --tests="test3-updn-tls"

# Force rebuild before testing
./run-regression-tests -b

# Clean run (remove previous test logs)
./run-regression-tests -c

Test Variants

Tests are run against multiple build variants:

Variant	Description
`testsim`	Simulated SX1301 gateway (libloragw in master process)
`testsim1302`	Simulated SX1302/SX1303 with SF5/SF6 support
`testms`	Master/slave model simulation
`testms1302`	Master/slave with SF5/SF6 support

Building Variants

# Build testsim variant
make platform=linux variant=testsim

# Build testsim1302 variant (SF5/SF6 support)
make platform=linux variant=testsim1302

# Build testms variant
make platform=linux variant=testms

# Build testms1302 variant (master/slave with SF5/SF6)
make platform=linux variant=testms1302

Test Structure

Each test is in a directory named test<N>-<name>/ containing:

File	Purpose
`test.sh`	Main test script (shell-based tests)
`test.py`	Main test script (Python-based tests)
`makefile`	Build integration (typically includes `testlib.mk`)
`station.conf`	Station configuration for the test
`slave-0.conf`	Radio/HAL configuration
`.gitignore`	Files to clean up after test

Available Tests

Core Tests

Test	Description
`test1-selftests`	Built-in self-tests
`test2-fs`	File system operations
`test2-gps`	GPS functionality
`test2-pps`	PPS (Pulse Per Second) timing

Uplink/Downlink Tests

Test	Description
`test3-updn-tls`	Uplink/downlink with TLS
`test3a-updn-tls`	Additional TLS tests
`test3b-dnC`	Class C downlink
`test3b-dnC_2ant`	Class C downlink with 2 antennas
`test3b-rx2_2ant`	RX2 window with 2 antennas
`test3c-cca`	Clear Channel Assessment
`test3d-bcns`	Beacon tests

Protocol Tests

Test	Description
`test4-cups`	CUPS (Configuration and Update Server)
`test5-rmtsh`	Remote shell
`test5-runcmd`	Remote command execution

RP2 1.0.5 Tests

These tests verify LoRaWAN Regional Parameters 2 1.0.5 support:

Test	Description	Variants
`test6-asym-drs`	US915 asymmetric DR support (DRs_up/DRs_dn)	all
`test6a-sf5sf6`	US915 SF5/SF6 uplinks (DR7/DR8)	testsim1302, testms1302
`test6b-au915-asym-drs`	AU915 asymmetric DR support	all
`test6c-au915-sf5sf6`	AU915 SF5/SF6 uplinks (DR9/DR10)	testsim1302, testms1302
`test6d-eu868-sf5sf6`	EU868 SF5/SF6 uplinks (DR12/DR13)	testsim1302, testms1302
`test6e-as923-sf5sf6`	AS923 SF5/SF6 uplinks (DR12/DR13)	testsim1302, testms1302
`test6f-kr920-sf5sf6`	KR920 SF5/SF6 uplinks (DR12/DR13)	testsim1302, testms1302
`test6g-in865-sf5sf6`	IN865 SF5/SF6 uplinks (DR12/DR13)	testsim1302, testms1302
`test6h-as923-compat`	AS923 RP2 1.0.5 backward compatibility	all
`test6i-kr920-compat`	KR920 RP2 1.0.5 backward compatibility	all
`test6j-in865-compat`	IN865 RP2 1.0.5 backward compatibility	all

Regional SF5/SF6 DR Mapping (RP2 1.0.5)

Region	SF6 Uplink	SF5 Uplink	Downlink	Notes
US915	DR7	DR8	DR0=SF5/500, DR14=SF6/500	Asymmetric up/down
AU915	DR9	DR10	DR0=SF5/500, DR14=SF6/500	Asymmetric up/down
EU868	DR12	DR13	Same as uplink	Symmetric
AS923	DR12	DR13	Same as uplink	Symmetric
KR920	DR12	DR13	Same as uplink	Symmetric
IN865	DR12	DR13	Same as uplink	Symmetric

Configuration Key Tests

Test	Description	Variants
`test7a-radio-conf`	Tests `radio_conf` key name (alternative to sx1301_conf/sx1302_conf)	all

Other Tests

Test	Description
`test7-respawn`	Station respawn behavior
`test8-web`	Web interface

Test Environment Variables

Variable	Description	Default
`TEST_VARIANT`	Build variant to test	`testsim`
`IGNORE`	Regex pattern for tests to skip	`livecups`
`BUILD_DIR`	Build directory path	Auto-detected

Writing Tests

Shell-based Test

#!/bin/bash
. ../testlib.sh

# Your test logic here
station -p --temp . &
sleep 2

# Verify something
if grep "expected" station.log; then
    banner "Test passed"
else
    banner "Test FAILED"
    exit 1
fi

collect_gcda

Python-based Test

import asyncio
import tcutils as tu
import simutils as su

class TestMuxs(tu.Muxs):
    async def handle_updf(self, ws, msg):
        # Handle uplink
        pass

async def test_start():
    muxs = TestMuxs()
    await muxs.start_server()
    # Start station...

asyncio.ensure_future(test_start())
asyncio.get_event_loop().run_forever()

Variant-Specific Tests

To run a test only with specific variants:

#!/bin/bash

# Skip if not the required variant
if [[ "$TEST_VARIANT" != "testsim1302" ]]; then
    echo "Skipping test - requires testsim1302 variant"
    exit 0
fi

. ../testlib.sh
# ... rest of test

Test Utilities

Python Modules

Located in ../pysys/:

Module	Purpose
`tcutils.py`	TC (Traffic Controller) server utilities, router configs
`simutils.py`	LGW simulator utilities
`testutils.py`	Common test helpers

Router Configurations

Available in tcutils.py:

Legacy Configs

Config	Description
`router_config_EU863_6ch`	EU868 6-channel
`router_config_US902_8ch`	US915 8-channel
`router_config_KR920`	KR920

RP2 1.0.5 Configs (Asymmetric DRs)

Config	Description
`router_config_US902_8ch_RP2`	US915 RP2 1.0.5 (SX1302, DR0-8 upchannels)
`router_config_US902_8ch_RP2_sx1301`	US915 RP2 1.0.5 (SX1301, DR0-4 upchannels)
`router_config_US902_8ch_RP2_sf5sf6`	US915 RP2 1.0.5 for SF5/SF6 testing (DR0-8)
`router_config_AU915_8ch_RP2`	AU915 RP2 1.0.5 (SX1302, DR0-10 upchannels)
`router_config_AU915_8ch_RP2_sx1301`	AU915 RP2 1.0.5 (SX1301, DR0-6 upchannels)
`router_config_AU915_8ch_RP2_sf5sf6`	AU915 RP2 1.0.5 for SF5/SF6 testing (DR0-10)
`router_config_EU868_6ch_RP2_sx1301`	EU868 RP2 1.0.5 (SX1301, DR0-5 upchannels)
`router_config_EU868_6ch_RP2_sf5sf6`	EU868 RP2 1.0.5 for SF5/SF6 testing (DR0-13)
`router_config_EU868_6ch_radio_conf`	EU868 RP2 1.0.5 using `radio_conf` key (tests alternate config key name)
`router_config_AS923_8ch_RP2_sx1301`	AS923 RP2 1.0.5 (SX1301, DR0-5 upchannels)
`router_config_AS923_8ch_RP2_sf5sf6`	AS923 RP2 1.0.5 for SF5/SF6 testing (DR0-13)
`router_config_KR920_3ch_RP2_sx1301`	KR920 RP2 1.0.5 (SX1301, DR0-5 upchannels)
`router_config_KR920_3ch_RP2_sf5sf6`	KR920 RP2 1.0.5 for SF5/SF6 testing (DR0-13)
`router_config_IN865_3ch_RP2_sx1301`	IN865 RP2 1.0.5 (SX1301, DR0-5 upchannels)
`router_config_IN865_3ch_RP2_sf5sf6`	IN865 RP2 1.0.5 for SF5/SF6 testing (DR0-13)

Configuration Key Names

Basic Station accepts these configuration key names interchangeably:

sx1301_conf - Originally for SX1301 hardware
sx1302_conf / SX1302_conf - For SX1302/SX1303 hardware
radio_conf - Generic name, works with any hardware

The router_config_EU868_6ch_radio_conf config and test7a-radio-conf test ensure the radio_conf key is exercised in the test suite.

Example Configurations

The example-configs/ directory contains real-world station.conf files:

File	Gateway	Region	Hardware
`mtcap3-station.conf.A00`	MTCAP3	AU915	SX1303/SX1250
`mtcap3-station.conf.E00`	MTCAP3	EU868	SX1303/SX1250
`mtcap3-station.conf.U00`	MTCAP3	US915	SX1303/SX1250
`mtcdt-station.conf.A00`	MTCDT	AU915	SX1303/SX1250
`mtcdt-station.conf.E00`	MTCDT	EU868	SX1303/SX1250
`mtcdt-station.conf.U00`	MTCDT	US915	SX1303/SX1250

Source: MultiTechSystems/multitech-gateway-tx-power-tables

PKI Data

The pki-data/ directory contains test certificates and keys for TLS testing. These are for testing only - do not use in production.

Coverage Collection

Tests automatically collect code coverage data using lcov. Coverage files (.info) are saved in each test directory after running.

To generate a coverage report:

# After running tests
lcov -a test1-selftests/testsim.info -a test3-updn-tls/testsim.info -o combined.info
genhtml combined.info -o coverage-report

Troubleshooting

Test Timeout

Default timeout is 120 seconds. Increase with:

timeout=300 ./test.sh

Viewing Failed Test Logs

cat t.log/fail-test3-updn-tls__testsim.log

Keeping Test Files

To preserve generated files for debugging:

cd test3-updn-tls
./test.sh --keep

CI Integration

For GitHub Actions, use the --ghactions flag:

./run-regression-tests -g -n

This enables:

Grouped output sections
Skipping hardware-dependent tests (-n)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

Basic Station Regression Tests

Quick Start

Test Variants

Building Variants

Test Structure

Available Tests

Core Tests

Uplink/Downlink Tests

Protocol Tests

RP2 1.0.5 Tests

Regional SF5/SF6 DR Mapping (RP2 1.0.5)

Configuration Key Tests

Other Tests

Test Environment Variables

Writing Tests

Shell-based Test

Python-based Test

Variant-Specific Tests

Test Utilities

Python Modules

Router Configurations

Legacy Configs

RP2 1.0.5 Configs (Asymmetric DRs)

Configuration Key Names

Example Configurations

PKI Data

Coverage Collection

Troubleshooting

Test Timeout

Viewing Failed Test Logs

Keeping Test Files

CI Integration

Name		Name	Last commit message	Last commit date
parent directory ..
pki-data		pki-data
test1-selftests		test1-selftests
test2-fs		test2-fs
test2-gps		test2-gps
test2-pps		test2-pps
test3-updn-tls		test3-updn-tls
test3a-updn-tls		test3a-updn-tls
test3b-dnC		test3b-dnC
test3b-dnC_2ant		test3b-dnC_2ant
test3b-rx2_2ant		test3b-rx2_2ant
test3c-cca		test3c-cca
test3d-bcns		test3d-bcns
test4-cups		test4-cups
test5-rmtsh		test5-rmtsh
test5-runcmd		test5-runcmd
test7-respawn		test7-respawn
test8-web		test8-web
.gitignore		.gitignore
README.md		README.md
makefile		makefile
run-regression-tests		run-regression-tests
run-tests-all		run-tests-all
run-tests-common		run-tests-common
run-tests-core		run-tests-core
run-tests-pps		run-tests-pps
run-tests-tls-cups		run-tests-tls-cups
run-tests-updn		run-tests-updn
testlib.sh		testlib.sh

FilesExpand file tree

regr-tests

Directory actions

More options

Directory actions

More options

Latest commit

History

regr-tests

Folders and files

parent directory

README.md

Basic Station Regression Tests

Quick Start

Test Variants

Building Variants

Test Structure

Available Tests

Core Tests

Uplink/Downlink Tests

Protocol Tests

RP2 1.0.5 Tests

Regional SF5/SF6 DR Mapping (RP2 1.0.5)

Configuration Key Tests

Other Tests

Test Environment Variables

Writing Tests

Shell-based Test

Python-based Test

Variant-Specific Tests

Test Utilities

Python Modules

Router Configurations

Legacy Configs

RP2 1.0.5 Configs (Asymmetric DRs)

Configuration Key Names

Example Configurations

PKI Data

Coverage Collection

Troubleshooting

Test Timeout

Viewing Failed Test Logs

Keeping Test Files

CI Integration