Merge pull request #144 from Thiht/proxy/ignore/certificate

feat: add skip_verify_tls option on proxy mocks to authorize insecure…

docs/.vuepress/public/smocker.schema.json

@@ -127,6 +127,7 @@
         "host": { "type": "string" },
         "delay": { "type": "string" },
         "follow_redirect": { "type": "boolean" },
+        "skip_verify_tls": { "type": "boolean" },
         "keep_host": { "type": "boolean" },
         "headers": { "$ref": "#/definitions/headers" }
       }

docs/technical-documentation/mock-definition.md

@@ -139,7 +139,7 @@ query_params:
     - matcher: ShouldMatch
       value: bar.*
     - matcher: ShouldContainSubstring
-      value:  baz
+      value: baz
 ```
 
 ---
@@ -312,6 +312,7 @@ It has the following format:
 proxy:
   host: # destination host
   follow_redirect: # optional boolean
+  skip_verify_tls: # optional boolean
   keep_host: # optional boolean
   headers: # optional map of string lists
     Forwarded: "for=unknown;host=www.example.com;proto=http"
@@ -320,7 +321,9 @@ proxy:
 By default, redirect responses from the destination host are returned as any other response. Setting `follow_redirect` to `true`
 makes Smocker follow any redirect response before responding.
 
-Host header is overriden using destination host value by default. With `keep_host` set to `true`, request sent to the 
+If you need to deal with hosts using HTTPS and self-signed certificates, you can define the proxy mock as **insecure** by setting `skip_verify_tls` to `true`.
+
+Host header is overriden using destination host value by default. With `keep_host` set to `true`, request sent to the
 destination host have same `Host` HTTP header as incoming request.
 
 Headers defined in the proxy mock definition are injected in the request sent to the destination host. If the header is already

server/types/mock.go

@@ -1,6 +1,7 @@
 package types
 
 import (
+	"crypto/tls"
 	"errors"
 	"fmt"
 	"io/ioutil"
@@ -151,6 +152,7 @@ type MockProxy struct {
 	Host           string         `json:"host" yaml:"host"`
 	Delay          time.Duration  `json:"delay,omitempty" yaml:"delay,omitempty"`
 	FollowRedirect bool           `json:"follow_redirect,omitempty" yaml:"follow_redirect,omitempty"`
+	SkipVerifyTLS  bool           `json:"skip_verify_tls,omitempty" yaml:"skip_verify_tls,omitempty"`
 	KeepHost       bool           `json:"keep_host,omitempty" yaml:"keep_host,omitempty"`
 	Headers        MapStringSlice `json:"headers,omitempty" yaml:"headers,omitempty"`
 }
@@ -184,6 +186,12 @@ func (mp MockProxy) Redirect(req Request) (*MockResponse, error) {
 	if !mp.FollowRedirect {
 		client.CheckRedirect = noFollow
 	}
+	if mp.SkipVerifyTLS {
+		// we clone to avoid overwriting the default transport configuration
+		customTransport := http.DefaultTransport.(*http.Transport).Clone()
+		customTransport.TLSClientConfig = &tls.Config{InsecureSkipVerify: true}
+		client.Transport = customTransport
+	}
 	resp, err := client.Do(proxyReq)
 	if err != nil {
 		return nil, err

tests/data/proxy_mock_list.yml

@@ -39,3 +39,19 @@
       multi:
         - "foo"
         - "baz"
+- request:
+    method: GET
+    headers:
+      X-Filter: badssl
+      X-Value: insecure
+  proxy:
+    host: https://self-signed.badssl.com
+    skip_verify_tls: true
+- request:
+    method: GET
+    headers:
+      X-Filter: badssl
+      X-Value: secure
+  proxy:
+    host: https://self-signed.badssl.com
+    skip_verify_tls: false

tests/features/set_mocks.yml

@@ -170,11 +170,13 @@ testcases:
         url: http://localhost:8081/mocks
         assertions:
           - result.statuscode ShouldEqual 200
-          - result.bodyjson.__len__ ShouldEqual 7
-          - result.bodyjson.bodyjson6.proxy.host ShouldEqual https://jsonplaceholder.typicode.com
-          - result.bodyjson.bodyjson5.proxy.host ShouldEqual https://jsonplaceholder.typicode.com
+          - result.bodyjson.__len__ ShouldEqual 9
+          - result.bodyjson.bodyjson8.proxy.host ShouldEqual https://jsonplaceholder.typicode.com
+          - result.bodyjson.bodyjson7.proxy.host ShouldEqual https://jsonplaceholder.typicode.com
+          - result.bodyjson.bodyjson6.proxy.host ShouldEqual https://httpbin.org
+          - result.bodyjson.bodyjson5.proxy.host ShouldEqual https://httpbin.org
           - result.bodyjson.bodyjson4.proxy.host ShouldEqual https://httpbin.org
           - result.bodyjson.bodyjson3.proxy.host ShouldEqual https://httpbin.org
           - result.bodyjson.bodyjson2.proxy.host ShouldEqual https://httpbin.org
-          - result.bodyjson.bodyjson1.proxy.host ShouldEqual https://httpbin.org
-          - result.bodyjson.bodyjson0.proxy.host ShouldEqual https://httpbin.org
+          - result.bodyjson.bodyjson1.proxy.host ShouldEqual https://self-signed.badssl.com
+          - result.bodyjson.bodyjson0.proxy.host ShouldEqual https://self-signed.badssl.com

tests/features/use_mocks.yml

@@ -267,4 +267,20 @@ testcases:
         assertions:
           - result.statuscode ShouldEqual 200
           - result.bodyjson.headers.custom ShouldEqual foobar
-          - result.bodyjson.headers.multi ShouldEqual foo,baz
+          - result.bodyjson.headers.multi ShouldEqual foo,baz
+      - type: http
+        method: GET
+        url: http://localhost:8080/
+        headers:
+          X-Filter: badssl
+          X-Value: insecure
+        assertions:
+          - result.statuscode ShouldEqual 200
+      - type: http
+        method: GET
+        url: http://localhost:8080/
+        headers:
+          X-Filter: badssl
+          X-Value: secure
+        assertions:
+          - result.statuscode ShouldEqual 602