Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yuanqing/t
:coffee: A Bash utility for testing Java programs that read from `stdin` and write to `stdout`.
https://github.com/yuanqing/t
Last synced: 10 days ago
JSON representation
:coffee: A Bash utility for testing Java programs that read from `stdin` and write to `stdout`.
- Host: GitHub
- URL: https://github.com/yuanqing/t
- Owner: yuanqing
- License: mit
- Created: 2015-04-05T05:05:32.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2021-01-30T07:42:11.000Z (almost 4 years ago)
- Last Synced: 2023-08-10T22:43:01.264Z (about 1 year ago)
- Language: Shell
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# t [](https://github.com/yuanqing/t/releases) [](https://travis-ci.org/yuanqing/t)
> A Bash utility for testing Java programs that read from `stdin` and write to `stdout`.
## Usage
The following directory structure is required:
```
$ ls
Reverse.java input output
$ ls input
reverse1.in reverse2.in reverse3.in
$ ls output
reverse1.out reverse2.out reverse3.out
```
- The name of the source file must correspond to the driver program. So, if your `main` program is in the class `Reverse`, your source file must be named `Reverse.java`.
- Input files go in a directory named `input`, and have the `.in` extension. Expected output files go in a directory named `output`, and have the `.out` extension. Each input file must have a corresponding expected output file. Input and output files must be numbered starting from 1.
Note that in our example, [`Reverse.java`](https://github.com/yuanqing/t/blob/master/example/Reverse.java) is a program that reads lines from `stdin`, reverses the characters of each line, and prints the result to `stdout`.
### Feeding the program an input
To feed the program a particular input file (say, [`input/reverse1.in`](https://github.com/yuanqing/t/blob/master/example/input/reverse1.in)), invoke `t` with a single numeric argument:
```
$ t 1
oof
```
The above command is equivalent to doing:
```
$ javac Reverse.java && java Reverse < input/reverse1.in
oof
```
### Running tests
To feed your program all the input files (from the `input` directory), and compare the actual output with the corresponding expected output files (in the `output` directory), invoke `t` without any arguments:
```
$ t
1 ✔
2 ✔
3 ✔
3 / 3
```
- A `✔` means that the actual and expected outputs are identical.
- A `✗` means that a runtime error had occurred, or that the actual and expected outputs are different.
- The last line indicates the number of passes out of the total number of test cases.
A broken implementation of our example program might produce the following output when tested with `t`:
```
$ t
1 ✔
2 ✗ java: Exception in thread "main" java.lang.NullPointerException
at Reverse.main(Reverse.java:8)
3 ✗ cmp: output/reverse3.out - differ: char 1, line 1
1 / 3
```
Note that `t` exits with code 0 if and only if every test passes.
## Installation
To install `t` into `/usr/local/bin`, simply do:
```
$ curl -k -L -o /usr/local/bin/t https://raw.github.com/yuanqing/t/master/t
$ chmod +x /usr/local/bin/t
```
## Tests
To test `t`, you need [Bats](https://github.com/sstephenson/bats):
```
$ git clone https://github.com/yuanqing/t
$ cd t/test
$ bats *.bats
```
## Changelog
- 0.1.0
- Initial release
## License
[MIT](https://github.com/yuanqing/t/blob/master/LICENSE)