ci-test-automation

Jenkinsfiles, Robot framework suites, libraries and requirements for running tests to ghaf-project nixOS with real HW.

Nix Flake usage

Basic test running

To enter a shell which has the ghaf-robot wrapper for running the Robot Framework, run nix shell.

Alternatively, you can build the package with nix build and the wrapper will appear at result/bin/ghaf-robot.

Devshell

To enter a devshell, where you can run robot (instead of the wrapper) and all the Python dependencies are available, run nix develop.

drcontrol.py

For more information, see drcontrol-README.md.

kmtronic_4ch_control.py and kmtronic_4ch_status.py

For more information, see README.md.

Git commit hook

When contributing to this repo you should take the git commit hook into use.

This hook will check the commit message for most trivial mistakes against current Ghaf commit message guidelines

Installing git hooks

Just run ./githooks/install-git-hooks.sh in repository main directory, and you should be good to go. Commit message checking script will then run when you commit something.

If you have branches before the git hooks were committed to the repo, you'll have to either rebase them on top of main branch or cherry pick the git hooks commit into your branch.

Also note that any existing commit messages in any branch won't be checked, only new commit messages will be checked.

If you encounter any issues with the git commit message hook, please report them. And while waiting for a fix, you may remove the hook by running rm -f .git/hooks/commit-msg in the main directory of the repository.

Licensing

This repository uses following licenses:

License Full Name	SPDX Short Identifier	Description
Apache License 2.0	Apache-2.0	Source code
GNU General Public License	GPLv3	Source code: drcontrol
Creative Commons Attribution Share Alike 4.0 International	CC-BY-SA-4.0	Documentation

See LICENSE.Apache-2.0, LICENSE.GPLv3, and LICENSE.CC-BY-SA-4.0 for the full license text.