[e2e]: Add tests for dockerv2

.travis.yml

@@ -12,6 +12,8 @@ cache:
 
 before_script:
   - docker pull k8s.gcr.io/coredns:1.6.2
+  - docker pull registry:2
+  - go get -u github.com/google/go-containerregistry/cmd/crane
 
 script:
   - go vet

Makefile

@@ -36,6 +36,7 @@ endtoend-test: docker-build
 	docker build -t $(IMAGE)-dirty .
 	cd e2e && \
 	docker build -t c.txtdirect.org/tester:dirty . && \
+ 	docker run -d -p 5000:5000 --name registry registry:2 && \
 	VERSION=$(VERSION)-dirty go run main.go
 
 version:

dockerv2.go

@@ -79,16 +79,6 @@ func (d *Dockerv2) Redirect() error {
 	return nil
 }
 
-// ValidAgent checks the User-Agent header to be sure it's Docker-Client
-func (d *Dockerv2) ValidAgent() bool {
-	if !strings.Contains(d.req.Header.Get("User-Agent"), "Docker-Client") {
-		log.Println("[txtdirect]: The request is not from docker client, fallback triggered.")
-		fallback(d.rw, d.req, "to", d.rec.Code, d.c)
-		return false
-	}
-	return true
-}
-
 func createDockerv2URI(to string, path string) (string, error) {
 	uri, err := url.Parse(to)
 	if err != nil {

e2e/Dockerfile

@@ -4,4 +4,6 @@ RUN apk --no-cache add git
 
 WORKDIR /e2e
 
+RUN GO111MODULE=on go get -u github.com/google/go-containerregistry/cmd/crane
+
 CMD [ "go" ]

e2e/dockerv2/main.go

@@ -1,34 +1,38 @@
 package main
 
 import (
+	"errors"
 	"fmt"
 	"log"
 	"net/http"
+	"os/exec"
 )
 
 type data struct {
-	host string
-	path string
+	host  string
+	path  string
+	image string
 }
 
+type Kind string
+
+const (
+	Pull Kind = "pull"
+	Push Kind = "push"
+)
+
 type test struct {
 	name     string
 	args     data
 	expected string
 	referer  bool
 	status   int
 	headers  http.Header
+	kind     Kind
+	fallback bool
 }
 
 var tests = []test{
-	{
-		name: "Fallback to \"to=\" when Docker-Client header is not set",
-		args: data{
-			host: "fallback.dockerv2.dockerv2.example.com",
-			path: "/",
-		},
-		expected: "https://fallback-to.dockerv2.dockerv2.example.com",
-	},
 	{
 		name: "Fallback to \"root=\"",
 		args: data{
@@ -39,6 +43,7 @@ var tests = []test{
 			"User-Agent": []string{"Docker-Client"},
 		},
 		expected: "https://fallback-root.dockerv2.dockerv2.example.com",
+		fallback: true,
 	},
 	{
 		name: "Fallback to 404 when \"to=\" is not linked to a Docker image or registry",
@@ -49,69 +54,104 @@ var tests = []test{
 		headers: http.Header{
 			"User-Agent": []string{"Docker-Client"},
 		},
-		status: 404,
+		status:   404,
+		fallback: true,
+	},
+	{
+		name: "Pull an image from the registry",
+		args: data{
+			image: "pull.dockerv2.dockerv2.example.com/txtdirect",
+		},
+		kind: Pull,
 	},
 }
 
 func main() {
 	result := make(map[bool][]test)
 	for _, test := range tests {
-		client := &http.Client{
-			CheckRedirect: func(req *http.Request, via []*http.Request) error {
-				return http.ErrUseLastResponse
-			},
-		}
-
-		req, err := http.NewRequest("GET", fmt.Sprintf("http://%s%s", test.args.host, test.args.path), nil)
-		if err != nil {
-			result[false] = append(result[false], test)
-			log.Printf("[%s]: Couldn't create the request: %s", test.name, err.Error())
-			continue
-		}
-
-		req.Header = test.headers
-
-		resp, err := client.Do(req)
-		if err != nil {
-			result[false] = append(result[false], test)
-			log.Printf("[%s]: Couldn't send the request: %s", test.name, err.Error())
-			continue
+		if test.fallback {
+			if err := fallbackTest(test, result); err != nil {
+				continue
+			}
 		}
 
-		// Check response's status code
-		if test.status != 0 {
-			if resp.StatusCode != test.status {
+		switch test.kind {
+		case Pull:
+			_, err := exec.Command("crane", "pull", "-i", test.args.image, "txtdirect_e2e").CombinedOutput()
+			if err != nil {
+				result[false] = append(result[false], test)
+				log.Printf("Couldn't pull the image from the custom Docker registry: %s", err.Error())
+				continue
+			}
+			_, err = exec.Command("rm", "./txtdirect_e2e").CombinedOutput()
+			if err != nil {
 				result[false] = append(result[false], test)
-				log.Printf("[%s]: Expected %d status code, got %d", test.name, test.status, resp.StatusCode)
+				log.Printf("Couldn't remove the pulled image: %s", err.Error())
 				continue
 			}
-			result[true] = append(result[true], test)
-			continue
 		}
 
-		// Check "Location" header for redirects
-		location, err := resp.Location()
+		result[true] = append(result[true], test)
+	}
+	log.Printf("TestCase: \"dockerv2\", Total: %d, Passed: %d, Failed: %d", len(tests), len(result[true]), len(result[false]))
+}
 
-		if err == http.ErrNoLocation {
-			result[false] = append(result[false], test)
-			log.Printf("[%s]: Location header is empty", test.name)
-			continue
-		}
+// fallbackTest handles the fallback tests and returns an empty non-nil error
+// in case of failure.
+func fallbackTest(test test, result map[bool][]test) error {
+	client := &http.Client{
+		CheckRedirect: func(req *http.Request, via []*http.Request) error {
+			return http.ErrUseLastResponse
+		},
+	}
 
-		if location.String() != test.expected {
-			result[false] = append(result[false], test)
-			log.Printf("[%s]: Expected %s, got %s", test.name, test.expected, location)
-			continue
-		}
+	req, err := http.NewRequest("GET", fmt.Sprintf("http://%s%s", test.args.host, test.args.path), nil)
+	if err != nil {
+		result[false] = append(result[false], test)
+		log.Printf("[%s]: Couldn't create the request: %s", test.name, err.Error())
+		return errors.New("")
+	}
 
-		// Check "Referer" header if enabled
-		if test.referer && resp.Header.Get("Referer") != req.Host {
+	req.Header = test.headers
+
+	resp, err := client.Do(req)
+	if err != nil {
+		result[false] = append(result[false], test)
+		log.Printf("[%s]: Couldn't send the request: %s", test.name, err.Error())
+		return errors.New("")
+	}
+
+	// Check response's status code
+	if test.status != 0 {
+		if resp.StatusCode != test.status {
 			result[false] = append(result[false], test)
-			log.Printf("Expected %s referer but got \"%s\"", req.Host, resp.Header.Get("Referer"))
-			continue
+			log.Printf("[%s]: Expected %d status code, got %d", test.name, test.status, resp.StatusCode)
+			return errors.New("")
 		}
-
 		result[true] = append(result[true], test)
+		return errors.New("")
 	}
-	log.Printf("TestCase: \"dockerv2\", Total: %d, Passed: %d, Failed: %d", len(tests), len(result[true]), len(result[false]))
+
+	// Check "Location" header for redirects
+	location, err := resp.Location()
+
+	if err == http.ErrNoLocation {
+		result[false] = append(result[false], test)
+		log.Printf("[%s]: Location header is empty", test.name)
+		return errors.New("")
+	}
+
+	if location.String() != test.expected {
+		result[false] = append(result[false], test)
+		log.Printf("[%s]: Expected %s, got %s", test.name, test.expected, location)
+		return errors.New("")
+	}
+
+	// Check "Referer" header if enabled
+	if test.referer && resp.Header.Get("Referer") != req.Host {
+		result[false] = append(result[false], test)
+		log.Printf("Expected %s referer but got \"%s\"", req.Host, resp.Header.Get("Referer"))
+		return errors.New("")
+	}
+	return nil
 }

e2e/dockerv2/zonefile

@@ -12,6 +12,9 @@ $TTL 1h
 
 example.com.                IN A 172.20.10.2
 
+pull.dockerv2.dockerv2.example.com.                    IN A 172.20.10.2
+_redirect.pull.dockerv2.dockerv2.example.com.          IN TXT "v=txtv0;to=http://172.20.10.3:5000/txtdirect;type=dockerv2" 
+
 fallback.dockerv2.dockerv2.example.com.                    IN A 172.20.10.2
 _redirect.fallback.dockerv2.dockerv2.example.com.          IN TXT "v=txtv0;to=https://fallback-to.dockerv2.dockerv2.example.com;root=https://fallback-root.dockerv2.dockerv2.example.com;type=dockerv2" 
 

e2e/main.go

@@ -9,6 +9,7 @@ import (
 	"path/filepath"
 	"regexp"
 	"strconv"
+	"strings"
 )
 
 const (
@@ -69,6 +70,10 @@ func main() {
 		log.Fatalf("[txtdirect_e2e]: Couldn't examine the logs and count the stats: %s", err.Error())
 	}
 
+	if err := d.RemoveNetwork(); err != nil {
+		log.Fatalf("[txtdirect_e2e]: Couldn't remove the network adaptor: %s", err.Error())
+	}
+
 	if d.stats.failed != 0 {
 		log.Fatalf("[txtdirect_e2e]: Tests failed because there were %d failed tests.", d.stats.failed)
 	}
@@ -162,10 +167,49 @@ func (d *dockerManager) StartContainers() error {
 		return fmt.Errorf("Couldn't create the TXTDirect container: %s", err.Error())
 	}
 
+	// Connect the Docker registry to the e2e network
+	if strings.Contains(d.dir, "dockerv2") {
+		_, err := exec.Command("docker", "network", "connect", "coretxtd", "registry").CombinedOutput()
+		if err != nil {
+			return fmt.Errorf("Couldn't connect Docker registry the network adaptor: %s", err.Error())
+		}
+
+		// Tag TXTDirect's image to use in custom registry
+		_, err = exec.Command("docker", "tag", txtdirectImage, "172.20.10.3:5000/txtdirect").CombinedOutput()
+		if err != nil {
+			return fmt.Errorf("Couldn't tag image to use in custom Docker registry: %s", err.Error())
+		}
+
+		_, err = exec.Command("docker", "save", "172.20.10.3:5000/txtdirect:latest", "-o", "txtdirect.tar").CombinedOutput()
+		if err != nil {
+			return fmt.Errorf("Couldn't export the image into a tarball: %s", err.Error())
+		}
+
+		// Push the TXTDirect image to the custom registry
+		_, err = exec.Command("crane", "push", "txtdirect.tar", "172.20.10.3:5000/txtdirect").CombinedOutput()
+		if err != nil {
+			return fmt.Errorf("Couldn't push the image to the custom Docker registry: %s", err.Error())
+		}
+
+		_, err = exec.Command("rm", "./txtdirect.tar").CombinedOutput()
+		if err != nil {
+			return fmt.Errorf("Couldn't remove the image tarball: %s", err.Error())
+		}
+	}
+
 	return nil
 }
 
 func (d *dockerManager) StopContainers() error {
+	if strings.Contains(d.dir, "dockerv2") {
+		_, err := exec.Command("docker",
+			"logs",
+			"e2e_txtdirect_container",
+		).CombinedOutput()
+		if err != nil {
+			return err
+		}
+	}
 	_, err := exec.Command("docker",
 		"container", "rm", "-f",
 		"e2e_coredns_container",
@@ -190,12 +234,15 @@ func (d *dockerManager) StopContainers() error {
 		return fmt.Errorf("Couldn't remove the tester container: %s", err.Error())
 	}
 
-	_, err = exec.Command("docker",
-		"network", "rm",
-		"coretxtd",
-	).CombinedOutput()
-	if err != nil {
-		return fmt.Errorf("Couldn't remove the TXTDirect container: %s", err.Error())
+	if strings.Contains(d.dir, "dockerv2") {
+		_, err = exec.Command("docker",
+			"network", "disconnect",
+			"coretxtd",
+			"registry",
+		).CombinedOutput()
+		if err != nil {
+			return fmt.Errorf("Couldn't disconnect the Docker registry container: %s", err.Error())
+		}
 	}
 
 	return nil
@@ -265,3 +312,14 @@ func (d *dockerManager) CountStats(stats []string) error {
 
 	return nil
 }
+
+func (d *dockerManager) RemoveNetwork() error {
+	_, err := exec.Command("docker",
+		"network", "rm",
+		"coretxtd",
+	).CombinedOutput()
+	if err != nil {
+		return fmt.Errorf("Couldn't remove the network adaptor: %s", err.Error())
+	}
+	return nil
+}

txtdirect.go

@@ -248,11 +248,6 @@ func Redirect(w http.ResponseWriter, r *http.Request, c Config) error {
 
 		docker := NewDockerv2(w, r, rec, c)
 
-		// Fallback gets triggered if the User-Agent isn't valid
-		if !docker.ValidAgent() {
-			return nil
-		}
-
 		if err := docker.Redirect(); err != nil {
 			log.Printf("[txtdirect]: couldn't redirect to the requested container: %s", err.Error())
 			fallback(w, r, "to", rec.Code, c)