https://github.com/tamada/omelette
Unit tests runner/coverage calculator on the CLI environment for the Java platform.
https://github.com/tamada/omelette
coverage jacoco java junit4 unittest
Last synced: 2 months ago
JSON representation
Unit tests runner/coverage calculator on the CLI environment for the Java platform.
- Host: GitHub
- URL: https://github.com/tamada/omelette
- Owner: tamada
- License: wtfpl
- Created: 2020-04-11T13:12:51.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-30T14:45:29.000Z (over 4 years ago)
- Last Synced: 2024-06-19T15:06:44.944Z (11 months ago)
- Topics: coverage, jacoco, java, junit4, unittest
- Language: Go
- Homepage: https://tamada.github.io/omelette
- Size: 1.04 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://codebeat.co/projects/github-com-tamada-omelette-master)
[](https://github.com/tamada/omelette/blob/master/LICENSE)
[](https://github.com/tamada/omelette/releases/tag/v1.1.1)
# Omelette
An agent for running the unit tests on the CLI environment for the Java platform.
## :speaking_head: Overview
In the Java platform, we usually run the unit tests through some build tool, such as [Maven](https://maven.apache.org), [Gradle](https://gradle.org), and so on.
However, it is hard to run the unit tests on the CLI environment.
Calculating test coverages is also complicated for novice programmers.
Since, it requires understanding how to use several libraries (unit test library, coverage measuring library, and the build tool).
Running the unit tests and calculating test coverages usually requires software projects.
It is generally tiresome for calculating test coverages of toy programs with their unit tests.
Therefore, we developed `omelette` for running unit tests and calculating test coverages in the CLI environment for the Java platform.
## :runner: Usage
```sh
omelette version 1.0.0
omelette [OPTIONS]
or
omelette [OPTIONS] -p -t [PROJECT_NAME]
OPTIONS
-c, --classpath specifies classpath list separated with a colon, or defines several options.
-d, --delete-tempfiles deletes temporary files after running.
-e, --excludes specifies target exclusion rules for unit tests. Default is "" (no filtering).
-i, --includes specifies target inclusion rules for unit tests. Default is "" (no filtering).
-n, --no-coverage calculates no coverage of test codes.
-p, --product-code specifies the directory contains the product codes.
-t, --test-code specifies the directory contains the test codes.
-v, --verbose verbose mode.
-h, --help prints this message.
ARGUMENTS
PROJECT_DIR specifies the directory contains the product codes and the unit test codes.
PROJECT_NAME specifies the project name for destination file. Default is "unknown".
```
### :briefcase: Requirements
* Runtime
* bash completion 2.x or later.
* Java 10 or later.
* [JUnit 4](https://junit.org/junit4/) 4.13, [hamcrest-all](https://mvnrepository.com/artifact/org.hamcrest/hamcrest-all) 1.3
* [JaCoCo](https://www.eclemma.org/jacoco/) 0.8.5
* Development
* Go lang 10.x or later.
* Dependent Libraries
* [pflag](https://github.com/spf13/pflag) v1.0.5
## :anchor: Install
### :beer: Homebrew (macOS)
```sh
brew install tamada/brew/omelette
```
### Go lang
```
go get github.com/tamada/omelette
```
After downloading `omelette`, run the following script.
```sh
cd ~/go/src/github.com/tamada/omelette; ./bin/download_dependencies.sh
```
### :hammer_and_wrench: Build from source
```sh
git clone https://github.com/tamada/omelette.git
cd omelette
make
```
## :smile: About
### :scroll: License
[Do What The F*ck You Want To Public License](https://github.com/tamada/omelette/blob/master/LICENSE)
[](https://github.com/tamada/omelette/blob/master/LICENSE)
* This license permits
* :+1: Commercial use,
* :+1: Modification,
* :+1: Distribution, and
* :+1: Private use.
### :man_office_worker: Developers :woman_office_worker:
* [Haruaki Tamada](https://github.com/tamada) [:globe_with_meridians:](https://tamada.github.io)
## :question: Why does the product names omelette?
Because the lunch was omelette, when I developed this product.
### :handshake: Attributions
Icons made by [Nhor Phai](https://www.flaticon.com/authors/nhor-phai) from [www.flaticon.com](https://www.flaticon.com/).