https://tinkerbus.org/docs/architecture/Recent content in Architecture and contributing on TinkerbusHugoenhttps://tinkerbus.org/docs/architecture/testing/Mon, 01 Jan 0001 00:00:00 +0000https://tinkerbus.org/docs/architecture/testing/<h2 id="go-tests">Go tests</h2> <p><code>go test ./...</code> runs the tests of all packages. Most packages have unit tests next to the code (<code>*_test.go</code>): the protocol frames, datapoint types, project reading, editing and saving, group address exchange, parameter handling, the routing calculation and the send gate.</p> <p>Test data lives in the repository:</p> <ul> <li><code>internal/project/testdata/</code> has <code>plain.knxproj</code> and <code>protected.knxproj</code> with the sources and a build script.</li> <li><code>internal/knxprod/testdata/</code> has <code>sample.knxprod</code> and <code>dummy.knxprod</code> with their sources and build scripts.</li> <li><code>internal/download/testdata/</code> has about 35 capture fixtures.</li> </ul> <h2 id="reference-downloads">Reference downloads</h2> <p>The device load plans are tested against <strong>recorded reference downloads</strong>. A fixture is a text file of what a download sent to a device: load control, property and memory writes, function property commands and the restart, in the format <code>knxcap -fixture</code> prints. The tests (<code>capture_*_test.go</code>) build the plan for the same device and settings and require that it equals the fixture, step by step and octet by octet. There is one family of tests per mask: <code>capture_test.go</code> (<code>0x0021</code>), <code>capture_m112_test.go</code> (<code>0x0705</code>), <code>capture_sysb_test.go</code> (<code>0x07B0</code>), <code>capture_router_test.go</code> (<code>0x091A</code>), <code>capture_bcu1_test.go</code> (<code>0x0012</code>) and <code>capture_partial_test.go</code> for partial downloads.</p>https://tinkerbus.org/docs/architecture/contributing/Mon, 01 Jan 0001 00:00:00 +0000https://tinkerbus.org/docs/architecture/contributing/<p>Tinkerbus is early and welcomes help, in particular from people with KNX devices and installations the author does not have.</p> <h2 id="the-repository">The repository</h2> <p>The source lives on <a href="https://git.tinkerbus.org/">git.tinkerbus.org</a>. A written contribution process does not exist yet. Problems and requests go to the <a href="https://git.tinkerbus.org/tinkerbus/tinkerbus/issues/new">issue tracker</a>. Until a contribution process exists, you can also reach the maintainer at <a href="mailto:lukas@matt.wf">lukas@matt.wf</a>.</p> <h2 id="report-a-problem">Report a problem</h2> <p>Open an issue on the tracker above. The application can prepare one for a <a href="../../gui/reports-to-the-project/">missing product or an unsupported device</a>. Useful reports contain:</p>