Automatically check and update docker-registry configuration

We made changes in docker-registry configuration, without which the server will
not work correctly. In order not to disrupt the user experience we must change
the old config.

Author: legionus

pkg/cmd/dockerregistry/dockerregistry.go

@@ -43,8 +43,9 @@ import (
 func Execute(configFile io.Reader) {
 	config, err := configuration.Parse(configFile)
 	if err != nil {
-		log.Fatalf("Error parsing configuration file: %s", err)
+		log.Fatalf("error parsing configuration file: %s", err)
 	}
+	setDefaultMiddleware(config)
 
 	ctx := context.Background()
 	ctx, err = configureLogging(ctx, config)
@@ -242,3 +243,28 @@ func panicHandler(handler http.Handler) http.Handler {
 		handler.ServeHTTP(w, r)
 	})
 }
+
+func setDefaultMiddleware(config *configuration.Configuration) {
+	// Default to openshift middleware for relevant types
+	// This allows custom configs based on old default configs to continue to work
+	if config.Middleware == nil {
+		config.Middleware = map[string][]configuration.Middleware{}
+	}
+	for _, middlewareType := range []string{"registry", "repository", "storage"} {
+		found := false
+		for _, middleware := range config.Middleware[middlewareType] {
+			if middleware.Name == "openshift" {
+				found = true
+				break
+			}
+		}
+		if found {
+			continue
+		}
+		config.Middleware[middlewareType] = append(config.Middleware[middlewareType], configuration.Middleware{
+			Name: "openshift",
+		})
+		log.Errorf("obsolete configuration detected, please add openshift %s middleware into registry config file", middlewareType)
+	}
+	return
+}

pkg/cmd/dockerregistry/dockerregistry_test.go

@@ -0,0 +1,102 @@
+package dockerregistry
+
+import (
+	"reflect"
+	"strings"
+	"testing"
+
+	"github.com/docker/distribution/configuration"
+)
+
+func TestDefaultMiddleware(t *testing.T) {
+	checks := []struct {
+		title, input, expect string
+	}{
+		{
+			title: "miss all middlewares",
+			input: `
+version: 0.1
+storage:
+  inmemory: {}
+`,
+			expect: `
+version: 0.1
+storage:
+  inmemory: {}
+middleware:
+  registry:
+    - name: openshift
+  repository:
+    - name: openshift
+  storage:
+    - name: openshift
+`,
+		},
+		{
+			title: "miss some middlewares",
+			input: `
+version: 0.1
+storage:
+  inmemory: {}
+middleware:
+  registry:
+    - name: openshift
+`,
+			expect: `
+version: 0.1
+storage:
+  inmemory: {}
+middleware:
+  registry:
+    - name: openshift
+  repository:
+    - name: openshift
+  storage:
+    - name: openshift
+`,
+		},
+		{
+			title: "all middlewares are in place",
+			input: `
+version: 0.1
+storage:
+  inmemory: {}
+middleware:
+  registry:
+    - name: openshift
+  repository:
+    - name: openshift
+  storage:
+    - name: openshift
+`,
+			expect: `
+version: 0.1
+storage:
+  inmemory: {}
+middleware:
+  registry:
+    - name: openshift
+  repository:
+    - name: openshift
+  storage:
+    - name: openshift
+`,
+		},
+	}
+
+	for _, check := range checks {
+		currentConfig, err := configuration.Parse(strings.NewReader(check.input))
+		if err != nil {
+			t.Fatal(err)
+		}
+		expectConfig, err := configuration.Parse(strings.NewReader(check.expect))
+		if err != nil {
+			t.Fatal(err)
+		}
+		setDefaultMiddleware(currentConfig)
+
+		if !reflect.DeepEqual(currentConfig, expectConfig) {
+			t.Errorf("%s: expected\n\t%#v\ngot\n\t%#v", check.title, expectConfig, currentConfig)
+		}
+	}
+}