diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..d7a5e07 --- /dev/null +++ b/README.md @@ -0,0 +1,98 @@ +# Trunks + +Trunks is a Go library that provide HTTP service with web user interface +to test HTTP and/or WebSocket endpoints and for load testing HTTP endpoints. + +For testing HTTP endpoints it use the +[lib/http](https://pkg.go.dev/github.com/shuLhan/share/lib/http) +package as the client, a wrapper for standard Go HTTP package. +For testing WebSocket endpoints it use the +[lib/websocket](https://pkg.go.dev/github.com/shuLhan/share/lib/websocket) +package as the client. +For the load testing we use +[vegeta](https://github.com/tsenart/vegeta) +as the backend. + +[Go documentation](https://pkg.go.dev/git.sr.ht/~shulhan/trunks) + +## Usage + +See the +[example](https://git.sr.ht/~shulhan/trunks/tree/main/item/example/) +package on how to programmatically use and create service using this module, +or, + +* clone this repository, +* execute `make dev`, and +* open <http://127.0.0.1:8217>. + + +## Screenshots + +The following screenshot display the main interface to Run or Attack the +registered HTTP service, + + + +The following screenshot display the result of attack in two forms, vegeta +metrics and vegeta histogram, + + + + +## Web user interface (WUI) + +By default, the Trunks user interface can be viewed by opening in browser at +<http://127.0.0.1:8217>. +One can change address through Environment's ListenAddress. + + +## File name format + +Each attack result is saved in Environment's ResultsDir with the following +file name format, + +``` +<Target.ID> "." <HttpTarget.ID> "." <DateTime> "." <Rate> "x" <Duration> "." <ResultsSuffix> +``` + +The "DateTime" is in the following layout, + +``` +YearMonthDate "_" HourMinuteSeconds +``` + +The "ResultsSuffix" is the one that defined in Environment. + + +## Development + +[Repository](https://git.sr.ht/~shulhan/trunks):: Link to the source code. + +[Mailing list](https://lists.sr.ht/~shulhan/trunks):: Link to discussion and +where to send patches. + +[Issues](https://todo.sr.ht/~shulhan/trunks):: Link to report for bug or +feature. + + +## Credits + +The Trunks icon and image is provided by <https://www.spriters-resource.com/>. + +## License + +Copyright (C) 2021 M. Shulhan <ms@kilabit.info> + +This program is free software: you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation, either version 3 of the License, or (at your option) any later +version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +details. + +You should have received a copy of the GNU General Public License along with +this program. If not, see <https://www.gnu.org/licenses/>. |