https://github.com/apjanke/octave-testify
New BIST (Built-In Self Test) functions for GNU Octave
https://github.com/apjanke/octave-testify
gnu-octave octave
Last synced: about 1 month ago
JSON representation
New BIST (Built-In Self Test) functions for GNU Octave
- Host: GitHub
- URL: https://github.com/apjanke/octave-testify
- Owner: apjanke
- License: gpl-3.0
- Created: 2019-01-30T03:33:54.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-09-11T22:05:13.000Z (over 2 years ago)
- Last Synced: 2025-04-06T12:02:54.370Z (about 2 months ago)
- Topics: gnu-octave, octave
- Language: MATLAB
- Size: 302 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: COPYING
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Testify – New test/BIST functions for GNU Octave
This is a collection of new and enhanced BIST (Built-In Self-Test) related functions for Octave.
These override and replace some of Octave’s current test functions.
This is intentional - this package started out as just a patch to Octave’s `__run_test_suite__`. But it grew into a full rewrite of the testing code.
The goal here is to prototype something that might be a step forward for Octave’s current testing functionality.
## Goals
The goals of Testify’s new test functions are:
* Richer abstractions for representing test results
* Nicer output format
* Including summary results that make it easier to copy-paste meaningful test failure reports to the octave-maintainers list
* Convenience functions for testing packages and related code units
* Integration with CI (“continuous integration”) platforms/harnesses
See files in the `doc-project` directory for more documentation.
### Non-Goals
Testify does _not_ implement [Matlab’s unit test framework](https://www.mathworks.com/help/matlab/matlab-unit-test-framework.html), or attempt to be compatible with it.
This is just a “richer” way of doing Octave’s current BIST tests, using its existing data model.
If you _are_ interested in seeing a clone of xUnit or Matlab’s unit test framework, go [add a comment on Issue #5](https://github.com/apjanke/octave-testify/issues/5) to indicate your interest.
If enough people want it, I’ll try to make it happen.
## Installation and usage
### Quick start
To get started using or testing this project, install it and its dependencies using Octave’s `pkg` function:
```octave
pkg install -forge doctest
pkg install https://github.com/apjanke/octave-testify/releases/download/v0.3.3/testify-0.3.3.tar.gz
pkg load doctest testify
```
The `doctest` package is optional.
### Installation for development
* Install the `doctest` package
* `pkg install -forge doctest`
* Clone the repo.
* `git clone https://github.com/apjanke/octave-testify`
* Add its `inst` directory to the Octave path
* `addpath ("/path/to/my/cloned/octave-testify/inst")`
### Usage
Then, call one of Testify’s functions:
* `runtests2` – Run tests in files, directories, classes, pkg packages, or in Octave itself.
* `test2` – A replacement for Octave’s regular `test`, with slight enhancements. Tests a single file.
* `__run_test_suite2__` – Just like Octave’s regular `__run_test_suite__`, but with (IMHO) nicer output.
* `__run_tests_and_exit__` – Runs tests and exits, like it says.
* `testify.install_and_test_forge_pkgs` – Tests Forge packages
See the helptext of these functions for details. (E.g. `help runtests2` in Octave.)
## What's In Here
Conceptually, all the code in `inst` here could drop right in to `scripts/testfun/` in the `octave` hg repo. The main test functions users are expected to use are in the root namespace.
There's a whole object-oriented interface to the tests under the `+testify` namespace, but that's intended primarily for Testify's internal use. Once it's stable and proven to be useful, perhaps we'll make it public.
### Externally Visible Stuff
runtests2- Runs tests on one or more files, directories, classes, or pkg packages.
test2- A replacement for Octave’s current
test. Nothing special about it just yet. __run_test_suite2__- A replacement for Octave’s current
__run_test_suite__.
Nothing much new here; just internal changes to support theBistRunResultabstraction. __run_tests_and_exit__- A function for running tests and using
octave’s exit status to indicate success or failure.
For use in Continuous Integration or automated testing environments. testify.install_and_test_forge_pkgs- A function for testing the installation and internal package tests/BISTs of Octave Forge packages.
### Notable Internal Stuff
testify.internal.BistRunResult- An object that collects the various counters and lists associated with BIST run results.
This is a replacement for the current technique of managing a half dozen primitive variables in parallel.
## Authors
Testify is primarily written and maintained by [Andrew Janke](https://github.com/apjanke).
## Acknowledgments
Thanks to [Polkadot Stingray](https://www.youtube.com/watch?v=3ad4NsEy1tg), [BAND-MAID](https://bandmaid.tokyo/), and [Brian Eno](https://en.wikipedia.org/wiki/Ambient_1:_Music_for_Airports) for powering my coding.
Thanks to [Mike Miller](https://github.com/mtmiller) and and [Colin B. Macdonald](https://github.com/cbm755) for taking an interest in this project.