[PROPOSAL] [Draft] Start PIMO as web service mock

[adrienaury]

Start PIMO with a backend web service as source for mocks.

Related to #40 and #15

Find a way to define routes. Possibly use the mmock project (https://github.com/jmartin82/mmock/)

[adrienaury]

Drafts

$ echo '{"userid": "6022955c5e70a4fbbd9fcfae"}' | pimo mock get https://www.data.gouv.fr/api/1/users/{{.userid}}/
{"about": null,"active": true,"avatar": null,"avatar_thumbnail": null,"email": null,"first_name": "coralie","id": "6022955c5e70a4fbbd9fcfae","last_name": "spillebout","metrics": {"datasets": 0,"followers": 0,"following": 0,"reuses": 0},"organizations": [],"page": "https://www.data.gouv.fr/fr/users/coralie-spillebout-1/","roles": [],"since": "2021-02-09T14:59:56.271000","slug": "coralie-spillebout-1","uri": "https://www.data.gouv.fr/api/1/users/coralie-spillebout-1/","website": null}

$ echo '{"userid": "6022955c5e70a4fbbd9fcfae"}' | pimo --serve 8080/mockservice mock get https://www.data.gouv.fr/api/1/users/{{.userid}}/
1:53PM INF Serving data on port 8080 and route '/mockservice'

$ echo '{"body": {"first_name": "john", "last_name": "snow"}}' | pimo mock post --body {{.body}} https://www.data.gouv.fr/api/1/users/
{"about": null,"active": true,"avatar": null,"avatar_thumbnail": null,"email": null,"first_name": "coralie","id": "6022955c5e70a4fbbd9fcfae","last_name": "spillebout","metrics": {"datasets": 0,"followers": 0,"following": 0,"reuses": 0},"organizations": [],"page": "https://www.data.gouv.fr/fr/users/coralie-spillebout-1/","roles": [],"since": "2021-02-09T14:59:56.271000","slug": "coralie-spillebout-1","uri": "https://www.data.gouv.fr/api/1/users/coralie-spillebout-1/","website": null}

$ pimo --serve 8080/mockservice mock post --body {{.body}} https://www.data.gouv.fr/api/1/users/
1:53PM INF Serving data on port 8080 and route '/mockservice'

$ cat routes.yml
routes:
  - name: /mockservice/api/1/users/:{userid}/
    method: get
    masking:
      - ...
  - name: /mockservice/api/1/users/
    method: post
    masking:
      - ...
$ pimo --serve 8080
1:53PM INF Serving data on port 8080

[adrienaury]

Example 1 : Emulate fake web service

routes.yml

version: "1"
routes:
- name: api/users/:{userid}/
  method: get
  maskingfile: masking-user.yml

masking-user.yml

version: "1"
masking:
  - selector:
      jsonpath: "response.body.id"
    mask:
      add: "{{.params.url.userid}}"
  - selector:
      jsonpath: "response.body.name"
    masks:
      - add: "{{.params.url.userid}}"
      - hashInURI: "pimo://nameFR"

$ pimo mock --port 8080
listening on 0.0.0.0:8080
$ curl http://localhost:8080/api/users/1/
{"id":1, "name": "Geoffroy"}

Example 2 : Wrap existing web service

routes.yml

version: "1"
routes:
- name: api/users/:{userid}/
  method: get
  maskingfile: masking-user.yml

masking-user.yml

version: "1"
masking:
  - selector:
      jsonpath: "response"
    mask:
      http:
        url: "http://real-web-service/api/users/{{.params.url.userid}}/
        method: "get"
  - selector:
      jsonpath: "response.body.name"
    masks:
      - template: "{{.response.body.id}}"
      - hashInURI: "pimo://nameFR"

$ pimo mock --port 8080
listening on 0.0.0.0:8080
$ curl http://localhost:8080/api/users/1/
{"id":1, "name": "Geoffroy"}