Normalize path-config key

README.md

@@ -351,11 +351,12 @@ nghttpx-ingress-controller understands
 `ingress.zlab.co.jp/path-config` key in Ingress
 `.metadata.annotations` to allow additional configuration per host and
 path pattern.  Its value is a serialized YAML or JSON dictionary.  The
-configuration is done per host and port pattern.  The key under the
-root dictionary is the concatenation of host and port.  For example,
+configuration is done per host and path pattern.  The key under the
+root dictionary is the concatenation of host and path.  For example,
 if host is "www.example.com" and path is "/foo", its key is
-"www.example.com/foo".  Its value is the dictionary and can contain
-the following key value pairs:
+"www.example.com/foo".  For convenience, if "www.example.com" is
+specified as a key, it is normalized as "www.example.com/".  Its value
+is the dictionary and can contain the following key value pairs:
 
 * `mruby`: Specify mruby script which is invoked when the given
   pattern is selected.  For mruby script, see [nghttpx manual

pkg/controller/annotation.go

@@ -11,6 +11,7 @@ package controller
 import (
 	"encoding/json"
 	"fmt"
+	"strings"
 
 	"github.com/ghodss/yaml"
 	"github.com/golang/glog"
@@ -87,6 +88,8 @@ func (ia ingressAnnotation) getPathConfig() (*nghttpx.PathConfig, map[string]*ng
 		}
 	}
 
+	config = normalizePathKey(config)
+
 	for _, v := range config {
 		nghttpx.FixupPathConfig(v)
 	}
@@ -111,6 +114,24 @@ func (ia ingressAnnotation) getPathConfig() (*nghttpx.PathConfig, map[string]*ng
 	return &defaultConfig, config
 }
 
+// normalizePathKey prepends "/" if key does not contain "/".
+func normalizePathKey(src map[string]*nghttpx.PathConfig) map[string]*nghttpx.PathConfig {
+	if len(src) == 0 {
+		return src
+	}
+
+	dst := make(map[string]*nghttpx.PathConfig)
+	for k, v := range src {
+		if strings.Index(k, "/") == -1 {
+			dst[k+"/"] = v
+		} else {
+			dst[k] = v
+		}
+	}
+
+	return dst
+}
+
 // unmarshal deserializes data into dest.  This function first tries yaml and then JSON.
 func unmarshal(data []byte, dest interface{}) error {
 	if err := yaml.Unmarshal(data, dest); err != nil {

pkg/controller/annotation_test.go

@@ -3,6 +3,9 @@ package controller
 import (
 	"reflect"
 	"testing"
+	"time"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	"github.com/zlabjp/nghttpx-ingress-lb/pkg/nghttpx"
 )
@@ -91,3 +94,75 @@ svc:
 		}
 	}
 }
+
+// TestGetPathConfig verifies getPathConfig.
+func TestGetPathConfig(t *testing.T) {
+	d120 := metav1.Duration{120 * time.Second}
+	rb := "rb"
+	tests := []struct {
+		annotationDefaultConfig string
+		annotationConfig        string
+		wantDefaultConfig       *nghttpx.PathConfig
+		wantConfig              map[string]*nghttpx.PathConfig
+	}{
+		// 0
+		{
+			annotationConfig: `{"example.com/alpha": {"readTimeout": "120s"}}`,
+			wantConfig: map[string]*nghttpx.PathConfig{
+				"example.com/alpha": &nghttpx.PathConfig{
+					ReadTimeout: &d120,
+				},
+			},
+		},
+		// 1
+		{
+			annotationDefaultConfig: `{"mruby": "rb"}`,
+			annotationConfig:        `{"example.com/alpha": {"readTimeout": "120s"}}`,
+			wantDefaultConfig: &nghttpx.PathConfig{
+				Mruby: &rb,
+			},
+			wantConfig: map[string]*nghttpx.PathConfig{
+				"example.com/alpha": &nghttpx.PathConfig{
+					ReadTimeout: &d120,
+					Mruby:       &rb,
+				},
+			},
+		},
+		// 3
+		{
+			annotationConfig: `
+example.com/alpha:
+  readTimeout: 120s
+`,
+			wantConfig: map[string]*nghttpx.PathConfig{
+				"example.com/alpha": &nghttpx.PathConfig{
+					ReadTimeout: &d120,
+				},
+			},
+		},
+		// 4
+		{
+			annotationConfig: `{"example.com": {"readTimeout": "120s"}}`,
+			wantConfig: map[string]*nghttpx.PathConfig{
+				"example.com/": &nghttpx.PathConfig{
+					ReadTimeout: &d120,
+				},
+			},
+		},
+	}
+
+	for i, tt := range tests {
+		ann := ingressAnnotation(map[string]string{
+			defaultPathConfigKey: tt.annotationDefaultConfig,
+			pathConfigKey:        tt.annotationConfig,
+		})
+		defaultConfig, config := ann.getPathConfig()
+
+		if !reflect.DeepEqual(defaultConfig, tt.wantDefaultConfig) {
+			t.Errorf("#%v: defaultConfig = %+v, want %+v", i, defaultConfig, tt.wantDefaultConfig)
+		}
+		if !reflect.DeepEqual(config, tt.wantConfig) {
+			t.Errorf("#%v: config = %+v, want %+v", i, config, tt.wantConfig)
+		}
+	}
+}