mac641 / gotep Goto Github PK

Acceptance criteria

• parser is used to check syntax errors.

https://github.com/carlmjohnson/requests

x86_64

• UNIX
• Windows

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

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

• Go report card

Acceptance criteria

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

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

for example cat ./tests.http | gotep run

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

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

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

https://github.com/charmbracelet/bubbletea

e.g. using < input.json

add table to README.md