4nth0 / golem

From a single config file Golem start a mock server

Hi there 👋

golem's Issues

Simulate protected routes (using token)

Collect inbound traffic stats

Handle CORS

Currently, Golem isn't able to handle CORS headers for the preflight request.
Preflight requests use the OPTIONS method to validate the ability of the third-party domain to fetch data.

CORS can be handled by service or by path.

By Service

port: "7171"
services: 
  - name: "Ping Server"
    http_config:
      cors: 
          origin: "*" | "${request.host}" | "https://mywebsite.com"
          methods: GET
      routes:
        "/ping": 
          body: '{"message": "pong!"}'

By Path

port: "7171"
services: 
  - name: "Ping Server"
    http_config:
      routes:
        cors: 
            origin: "*" | "${request.host}" | "https://mywebsite.com"
            methods: GET
        "/ping": 
          body: '{"message": "pong!"}'

Add logger

Handle multiple HTTP methods for the same path

Currently, there is no way to have multiple methods for the same path.

Routes are declared with the following format :

routes:
  "/foo":
    body: "bar"

By default, the GET method is used.
Here the way to set the method :

routes:
  "/foo":
    method: "POST"
    body: "bar"

To handle multiple methods for the same route it can be interesting to use the following declaration format :

routes:
  "/foo":
    methods:
      "GET"
        body: "bar from get method"
      "POST"
        body: "bar from post method"

Make Golem able to auto-generate mocks

Golem is able to send pre-defined mocks but is unable to generate automatic mocks.
With the help of Faker solutions such as https://github.com/brianvoe/gofakeit Golem should generate mocks on the fly depending on YAML declaration of the expected mock scheme :

port: "8181"
services:
  - name: "Autogen Mocks"
    http_config:
      routes:
        "/posts":
          generate:
            scheme:
              "title":
                type: LoremIpsumSentence
                word_count: 3
              "content":
                type: LoremIpsumParagraph
                word_count: 3
              "views":
                type: Number
                min: 0
                max: 99
              "published":
                type: boolean

Déployer golem sur Dockerhub

Afin de mieux intégrer golem dans la stack des différents projets, il pourrait être utile de le dockeriser et de le rendre disponible sur Dockerhub. Cela permettrait par exemple d'appeler directement l'image Docker de golem dans un docker-compose pour mocker les projets en local.

Make Golem able to use database for the configuration and mocks

Yaml is a great format for local use.
For server use it can be easier to connect Golem to a database (PG, MySQL, ..)

Handle Method Not Allowed

Golem send the wrong status code when we call it with an unallowed HTTP method

port: "8989"
services:
  - name: "Service Sample"
    http_config:
      routes:
        "/foo":
          body: "bar"

If I try to call the service with an unallowed method I have a 200 Ok status code instead of 405 Method Not Allowed

curl -X POST http://127.0.0.1:8989/foo

*   Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to 127.0.0.1 (127.0.0.1) port 8989 (#0)
> POST /foo HTTP/1.1
> Host: 127.0.0.1:8989
> User-Agent: curl/7.64.1
> Accept: */*
> 
< HTTP/1.1 200 OK
< Date: Fri, 25 Jun 2021 14:24:35 GMT
< Content-Length: 2
< Content-Type: text/plain; charset=utf-8
< 
* Connection #0 to host 127.0.0.1 left intact
Io* Closing connection 0

Add version command

to know which version of Golam we are using