mac641 / gotep

gotep is a terminal-based REST client designed to execute HTTP tests based on the Jetbrains HTTP-Client.

Hi there 👋

I'm Marcel. Welcome to my GitHub profile!

👷 Check out what I'm currently working on

🌱 My latest projects

• mac641/gotep - gotep is a terminal-based REST client designed to execute HTTP tests based on the Jetbrains HTTP-Client.
• mac641/audio-converter - audio-converter allows you to convert audio files from within your web browser.
• mac641/tab-split-merger - Tab Split Merger for Firefox splits tabs into multiple windows and merges them back together into one.

📓 Gists I wrote

• Install Alpine Linux on WSL and connect it to Docker Desktop
• Installing Fedora CoreOS on VirtualBox on Windows 10

📫 How to reach me

Feel free to shoot me a message anytime! :)

• LinkedIn: https://www.linkedin.com/in/mac641/
• Mastodon: https://mastodon.art/@mac641

gotep's Issues

I want to be able to add a list of all request names and execute the request with the specified name

I want to be able to add a list of all request names and execute the request with the specified name

Add git hook to check LICENSE section in go files

release in package managers

• Homebrew
• dnf
• apt
  - [ ] winget -> insufficient docs to setup private repo

As gotep developer I want all test files to be parsed within golang itself.

Acceptance criteria

• http files based on the Jetbrains specification are being parsed without issues and return a object / list of objects which can be used to send http request tests
• json configs are being parsed, preferably using viper

Helpful info

• antlr explained: https://blog.gopheracademy.com/advent-2017/parsing-with-antlr4-and-go/
• antlr docs - get started with go: https://github.com/antlr/antlr4/blob/master/doc/go-target.md
• how to set up antlr grammar debugging: https://github.com/mike-lischke/vscode-antlr4/blob/master/doc/grammar-debugging.md#actions-and-semantic-predicates
• predefined http request grammar: https://github.com/antlr/grammars-v4/blob/master/http/http.g4
• predefined json4 grammar: https://github.com/antlr/grammars-v4/blob/master/json/JSON.g4
• predefined json5 grammar: https://github.com/antlr/grammars-v4/blob/master/json5/JSON5.g4
• predefined ecam- / java- / typescript and jsx grammars: https://github.com/antlr/grammars-v4/tree/master/javascript
• HTTP-Client definition by Jetbrains: https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html
• HTTP-Client specification: https://github.com/JetBrains/http-request-in-editor-spec/blob/master/spec.md
• ASCII to Unicode table: http://www.endmemo.com/unicode/ascii.php

Literature

• antlr 4 definitive book: https://learning.oreilly.com/library/view/the-definitive-antlr/9781941222621/f_0055.xhtml#sec.call-graph

Examples

• incomplete: https://github.com/char0n/http-request-in-editor/tree/master/src
• seems to be complete, but implemented in Kotlin: https://github.com/restcli/restcli

Jetbrains Youtrack issue

update supported / unsupported http-client features

add table to README.md

As gotep user I want to use a clean and handy cli tooling to run tests within a CI pipeline.

Acceptance criteria

Running tests

• gotep run executes tests
  • can be executed with no arguments -> looking for test file and config file in current working directory
  • can be executed with arguments -> looking for test file and config file based on the given arguments (absolute and relative paths possible)
    • Test file can be specified: -f, --file
    • Config file can be specified: -c, --config

Getting help

Help can be printed to the terminal: -h, --help, running the program with no arguments at all or running gotep help

Debugging

• All run commands can be executed verbose showing debug log messages: -v, --verbose
• gotep check checks test files for syntax errors
  • can be executed with no arguments -> looking for test file and config file in current working directory
  • can be executed with arguments -> looking for test file and config file based on the given arguments (absolute and relative paths possible)
    • Test file can be specified: -f, --file
    • Config file can be specified: -c, --config

Add ci build badge to README.md

• Go report card

Add docker dev environment

Migrate net/http to requests

https://github.com/carlmjohnson/requests

Improve exiting app through global error handling / exit codes

https://stackoverflow.com/questions/18963984/exit-with-error-code-in-go

add user guide to README.md

Check support for different OS'

x86_64

• UNIX
• Windows

As gotep developer I want to send http request based on parsed test files.

Acceptance criteria

• every parsed test will be executed by sending a http request to the backend

add flag for writing test results to a file rather than printing it directly to the console

Use live menu if mandatory options haven't been provided

https://github.com/charmbracelet/bubbletea

accept urls / hosted files as tests / configs

As gotep user I want to check my test files for syntax errors.

Acceptance criteria

• parser is used to check syntax errors.

allow test file contents to be piped

for example cat ./tests.http | gotep run

As gotep user I want to be printed a short and clean overview on the console summarizing all test results.

Acceptance criteria

• collected request results will be printed to the console after every request was executed
• results only contain
  • how many total requests have been sent
  • how many request were succesful
  • how many request failed
• succesful requests will be highlighted with green
• failed requests will be highlighted with red

Helpful info

• https://github.com/Sirupsen/logrus

add version command

add support for request separators in body or document how it can be done using an external file

e.g. using < input.json