feat: Add tests for the repository picking behaviour

internal/repo/client.go

@@ -0,0 +1,111 @@
+package repo
+
+import (
+	"fmt"
+	"io"
+	"net/http"
+	"time"
+
+	"code.gitea.io/sdk/gitea"
+
+	"git.polynom.me/rio/internal/dns"
+)
+
+// Returns true if the repository at <username>/<repository> exists, false if it
+// does not.
+type GetRepositoryMethod func(username, repositoryName string) (Repository, error)
+
+// Returns <file content>, nil if the file exists at path <path> (relative to the repository) in
+// <username>/<repository>@<branch> exists. If not, returns "", error.
+type GetFileMethod func(username, repositoryName, branch, path string, since *time.Time) ([]byte, bool, error)
+
+type LookupCNAMEMethod func(domain string) (string, error)
+
+type LookupRepoTXTMethod func(domain string) (string, error)
+
+type HasBranchMethod func(username, repositoryName, branchName string) bool
+
+type HasUserMethod func(username string) bool
+
+type Repository struct {
+	Name string
+}
+
+type GiteaClient struct {
+	getRepository GetRepositoryMethod
+	hasBranch     HasBranchMethod
+	hasUser       HasUserMethod
+	GetFile       GetFileMethod
+	lookupCNAME   LookupCNAMEMethod
+	lookupRepoTXT LookupRepoTXTMethod
+}
+
+func NewGiteaClient(giteaUrl string, giteaClient *gitea.Client) GiteaClient {
+	return GiteaClient{
+		getRepository: func(username, repositoryName string) (Repository, error) {
+			repo, _, err := giteaClient.GetRepo(username, repositoryName)
+			if err != nil {
+				return Repository{}, err
+			}
+
+			return Repository{
+				Name: repo.Name,
+			}, nil
+		},
+		hasBranch: func(username, repositoryName, branchName string) bool {
+			res, _, err := giteaClient.ListRepoBranches(username, repositoryName, gitea.ListRepoBranchesOptions{})
+			if err != nil {
+				return false
+			}
+
+			for _, branch := range res {
+				if branch.Name == branchName {
+					return true
+				}
+			}
+			return false
+		},
+		hasUser: func(username string) bool {
+			_, _, err := giteaClient.GetUserInfo(username)
+			return err == nil
+		},
+		GetFile: func(username, repositoryName, branch, path string, since *time.Time) ([]byte, bool, error) {
+			// We have to do the raw request manually because the Gitea SDK does not allow
+			// passing the If-Modfied-Since header.
+			apiUrl := fmt.Sprintf(
+				"%s/api/v1/repos/%s/%s/raw/%s?ref=%s",
+				giteaUrl,
+				username,
+				repositoryName,
+				path,
+				branch,
+			)
+			client := &http.Client{}
+			req, err := http.NewRequest("GET", apiUrl, nil)
+			if since != nil {
+				sinceFormat := since.Format(time.RFC1123)
+				req.Header.Add("If-Modified-Since", sinceFormat)
+			}
+			resp, err := client.Do(req)
+			if err != nil {
+				return []byte{}, true, err
+			}
+			defer resp.Body.Close()
+			content, err := io.ReadAll(resp.Body)
+
+			if err != nil {
+				return []byte{}, true, err
+			} else if resp.StatusCode == 302 {
+				return []byte{}, false, nil
+			} else {
+				return content, true, err
+			}
+		},
+		lookupCNAME: func(domain string) (string, error) {
+			return dns.LookupCNAME(domain)
+		},
+		lookupRepoTXT: func(domain string) (string, error) {
+			return dns.LookupRepoTXT(domain)
+		},
+	}
+}

internal/repo/repo.go

@@ -1,14 +1,14 @@
 package repo
 
+//go:generate mockgen -destination mock_repo_test.go -package repo code.gitea.io/sdk/gitea Client
+
 import (
 	"errors"
 	"strings"
 	"time"
 
-	"git.polynom.me/rio/internal/dns"
-	"git.polynom.me/rio/internal/pages"
+	"git.polynom.me/rio/internal/constants"
 
-	"code.gitea.io/sdk/gitea"
 	"github.com/patrickmn/go-cache"
 	log "github.com/sirupsen/logrus"
 )
@@ -21,7 +21,7 @@ var (
 )
 
 type PageCacheEntry struct {
-	Repository *gitea.Repository
+	Repository Repository
 	Path       string
 }
 
@@ -33,24 +33,36 @@ func makePageCacheKey(domain, path string) string {
 // / is not "", then it also verifies that the repository contains a "CNAME" with
 // / the value of @cname as its content. @host, @domain, and @path are passed for
 // / caching on success.
-func lookupRepositoryAndCache(username, reponame, host, domain, path, cname string, giteaClient *gitea.Client) (*gitea.Repository, error) {
+func lookupRepositoryAndCache(username, reponame, branchName, host, domain, path, cname string, giteaClient *GiteaClient) (*Repository, error) {
+	log.Debugf("CNAME: %s", cname)
 	log.Debugf("Looking up repository %s/%s", username, reponame)
-	repo, _, err := giteaClient.GetRepo(username, reponame)
+	repo, err := giteaClient.getRepository(username, reponame)
 	if err != nil {
 		return nil, err
 	}
 
+	if !giteaClient.hasBranch(username, reponame, branchName) {
+		return nil, errors.New("Specified branch does not exist")
+	}
+
 	// Check if the CNAME file matches
 	if cname != "" {
+		log.Debug("Checking CNAME")
 		file, _, err := giteaClient.GetFile(
 			username,
-			repo.Name,
-			pages.PagesBranch,
+			reponame,
+			constants.PagesBranch,
 			"CNAME",
-			false,
+			nil,
 		)
 		if err != nil {
-			log.Errorf("Could not verify CNAME of %s/%s: %v\n", username, repo.Name, err)
+			log.Errorf(
+				"Could not verify CNAME of %s/%s@%s: %v\n",
+				username,
+				reponame,
+				constants.PagesBranch,
+				err,
+			)
 			return nil, err
 		}
 
@@ -58,6 +70,8 @@ func lookupRepositoryAndCache(username, reponame, host, domain, path, cname stri
 			string(file[:]),
 			"\n",
 		)
+
+		log.Debugf("CNAME Content: %s", cnameContent)
 		if cnameContent != cname {
 			return nil, errors.New("CNAME mismatch")
 		}
@@ -72,10 +86,10 @@ func lookupRepositoryAndCache(username, reponame, host, domain, path, cname stri
 		},
 		cache.DefaultExpiration,
 	)
-	return repo, nil
+	return &repo, nil
 }
 
-func RepoFromPath(username, host, cname, path string, giteaClient *gitea.Client) (*gitea.Repository, string, error) {
+func RepoFromPath(username, host, cname, path string, giteaClient *GiteaClient) (*Repository, string, error) {
 	domain := host
 
 	// Guess the repository
@@ -83,16 +97,31 @@ func RepoFromPath(username, host, cname, path string, giteaClient *gitea.Client)
 	entry, found := pathCache.Get(key)
 	if found {
 		pageEntry := entry.(PageCacheEntry)
-		return pageEntry.Repository, pageEntry.Path, nil
+		return &pageEntry.Repository, pageEntry.Path, nil
+	}
+
+	// Allow specifying the repository name in the TXT record
+	reponame := ""
+	if cname != "" {
+		repoLookup, err := giteaClient.lookupRepoTXT(cname)
+		if err == nil && repoLookup != "" {
+			log.Infof(
+				"TXT lookup for %s resulted in choosing repository %s",
+				cname,
+				repoLookup,
+			)
+			reponame = repoLookup
+		}
 	}
 
 	pathParts := strings.Split(path, "/")
-	if len(pathParts) > 1 {
+	if reponame == "" && len(pathParts) > 1 {
 		log.Debugf("Trying repository %s", pathParts[0])
 		modifiedPath := strings.Join(pathParts[1:], "/")
 		repo, err := lookupRepositoryAndCache(
 			username,
 			pathParts[0],
+			constants.PagesBranch,
 			host,
 			domain,
 			modifiedPath,
@@ -104,29 +133,14 @@ func RepoFromPath(username, host, cname, path string, giteaClient *gitea.Client)
 		}
 	}
 
-	// Allow specifying the repository name in the TXT record
-	reponame := domain
-	lookupDomain := domain
-	if cname != "" {
-		lookupDomain = cname
+	if reponame == "" {
+		reponame = domain
 	}
-	repoLookup, err := dns.LookupRepoTXT(lookupDomain)
-	if err != nil && repoLookup != "" {
-		log.Infof(
-			"TXT lookup for %s resulted in choosing repository %s",
-			lookupDomain,
-			repoLookup,
-		)
-		reponame = repoLookup
-	} else if cname != "" {
-		// Allow naming the repository "example.org" (But give the TXT record preference)
-		reponame = cname
-	}
-
 	log.Debugf("Trying repository %s/%s", username, reponame)
 	repo, err := lookupRepositoryAndCache(
 		username,
 		reponame,
+		constants.PagesBranch,
 		host,
 		domain,
 		path,
@@ -139,15 +153,14 @@ func RepoFromPath(username, host, cname, path string, giteaClient *gitea.Client)
 // Checks if the username exists as an organisation or an user on the Gitea
 // instance, so that an attacker can't just request certificates for random
 // usernames.
-func CanRequestCertificate(username string, giteaClient *gitea.Client) bool {
+func CanRequestCertificate(username string, giteaClient *GiteaClient) bool {
 	if _, found := userCache.Get(username); found {
 		return true
 	}
 
-	user, _, err := giteaClient.GetUserInfo(username)
-	if user != nil && err == nil {
+	hasUser := giteaClient.hasUser(username)
+	if hasUser {
 		userCache.Set(username, true, cache.DefaultExpiration)
-		return true
 	}
-	return false
+	return hasUser
 }

internal/repo/repo_test.go

@@ -1,39 +1,373 @@
 package repo
 
 import (
-	"net/http"
+	"errors"
 	"testing"
 	"time"
 
-	"code.gitea.io/sdk/gitea"
+	log "github.com/sirupsen/logrus"
 )
 
-var (
-	giteaClient, _ = gitea.NewClient(
-		"https://git.polynom.me",
-		gitea.SetHTTPClient(&http.Client{Timeout: 10 * time.Second}),
-		gitea.SetToken(""),
-		gitea.SetUserAgent("rio/testing"),
-	)
-)
+func clearCache() {
+	pathCache.Flush()
+	userCache.Flush()
+}
 
-func TestCanRequestCertificatePositiveUser(t *testing.T) {
-	res := CanRequestCertificate("papatutuwawa", giteaClient)
-	if !res {
-		t.Fatalf("User papatutuwawa should be servable")
+func TestPickingCorrectRepositoryDefault(t *testing.T) {
+	// Test that we default to the <username>.<pages domain> repository, if we have only
+	// one path component.
+	defer clearCache()
+
+	log.SetLevel(log.DebugLevel)
+	client := GiteaClient{
+		getRepository: func(username, repositoryName string) (Repository, error) {
+			if username != "example-user" {
+				t.Fatalf("Called with unknown user %s", username)
+			}
+			if repositoryName != "example-user.pages.example.org" {
+				t.Fatalf("Called with unknown repository %s", repositoryName)
+			}
+
+			return Repository{}, nil
+		},
+		hasBranch: func(username, repositoryName, branchName string) bool {
+			if username == "example-user" && repositoryName == "example-user.pages.example.org" && branchName == "pages" {
+				return true
+			}
+
+			return false
+		},
+		GetFile: func(username, repositoryName, branch, path string, since *time.Time) ([]byte, bool, error) {
+			t.Fatal("getFile called")
+			return []byte{}, true, nil
+		},
+		lookupCNAME: func(domain string) (string, error) {
+			t.Fatal("lookupCNAME called")
+			return "", nil
+		},
+		lookupRepoTXT: func(domain string) (string, error) {
+			t.Fatal("lookupRepoTXT called")
+			return "", nil
+		},
+	}
+
+	res, path, err := RepoFromPath("example-user", "example-user.pages.example.org", "", "index.html", &client)
+	if err != nil {
+		t.Fatalf("An error occured: %v", err)
+	}
+	if res == nil {
+		t.Fatal("Result is nil")
+	}
+	if path != "index.html" {
+		t.Fatalf("Returned path is invalid: %s", path)
 	}
 }
 
-func TestCanRequestCertificatePositiveOrganisation(t *testing.T) {
-	res := CanRequestCertificate("moxxy", giteaClient)
-	if !res {
-		t.Fatalf("Organisation moxxy should be servable")
+func TestPickingCorrectRepositoryDefaultSubdirectory(t *testing.T) {
+	// Test that we return the default repository when the first path component does
+	// not correspong to an existing repository.
+	defer clearCache()
+
+	log.SetLevel(log.DebugLevel)
+	client := GiteaClient{
+		getRepository: func(username, repositoryName string) (Repository, error) {
+			if username != "example-user" {
+				t.Fatalf("Called with unknown user %s", username)
+			}
+			if repositoryName == "assets" {
+				return Repository{}, errors.New("Repository does not exist")
+			} else if repositoryName == "example-user.pages.example.org" {
+				return Repository{}, nil
+			} else {
+				t.Fatalf("Called with unknown repository %s", repositoryName)
+				return Repository{}, nil
+			}
+		},
+		hasBranch: func(username, repositoryName, branchName string) bool {
+			if username == "example-user" && repositoryName == "example-user.pages.example.org" && branchName == "pages" {
+				return true
+			}
+
+			return false
+		},
+		GetFile: func(username, repositoryName, branch, path string, since *time.Time) ([]byte, bool, error) {
+			t.Fatal("getFile called")
+			return []byte{}, true, nil
+		},
+		lookupCNAME: func(domain string) (string, error) {
+			t.Fatal("lookupCNAME called")
+			return "", nil
+		},
+		lookupRepoTXT: func(domain string) (string, error) {
+			t.Fatal("lookupRepoTXT called")
+			return "", nil
+		},
+	}
+
+	res, path, err := RepoFromPath("example-user", "example-user.pages.example.org", "", "assets/index.css", &client)
+	if err != nil {
+		t.Fatalf("An error occured: %v", err)
+	}
+	if res == nil {
+		t.Fatal("Result is nil")
+	}
+	if path != "assets/index.css" {
+		t.Fatalf("Returned path is invalid: %s", path)
 	}
 }
 
-func TestCanRequestCertificateNegative(t *testing.T) {
-	res := CanRequestCertificate("user-who-does-not-exist", giteaClient)
-	if res {
-		t.Fatalf("User user-who-does-not-exist should not be servable")
+func TestPickingCorrectRepositorySubdirectoryNoPagesBranch(t *testing.T) {
+	// Test that we're picking the correct repository when the first path component
+	// returns a repository without a pages branch.
+	defer clearCache()
+
+	log.SetLevel(log.DebugLevel)
+	client := GiteaClient{
+		getRepository: func(username, repositoryName string) (Repository, error) {
+			if username != "example-user" {
+				t.Fatalf("Called with unknown user %s", username)
+			}
+			if repositoryName == "blog" {
+				return Repository{
+					Name: "blog",
+				}, nil
+			} else if repositoryName == "example-user.pages.example.org" {
+				return Repository{
+					Name: "example-user.pages.example.org",
+				}, nil
+			} else {
+				t.Fatalf("Called with unknown repository %s", repositoryName)
+				return Repository{}, nil
+			}
+		},
+		hasBranch: func(username, repositoryName, branchName string) bool {
+			if username == "example-user" && repositoryName == "example-user.pages.example.org" && branchName == "pages" {
+				return true
+			}
+
+			return false
+		},
+		GetFile: func(username, repositoryName, branch, path string, since *time.Time) ([]byte, bool, error) {
+			t.Fatal("getFile called")
+			return []byte{}, true, nil
+		},
+		lookupCNAME: func(domain string) (string, error) {
+			t.Fatal("lookupCNAME called")
+			return "", nil
+		},
+		lookupRepoTXT: func(domain string) (string, error) {
+			t.Fatal("lookupRepoTXT called")
+			return "", nil
+		},
+	}
+
+	res, path, err := RepoFromPath("example-user", "example-user.pages.example.org", "", "blog/post1.html", &client)
+	if err != nil {
+		t.Fatalf("An error occured: %v", err)
+	}
+	if res == nil {
+		t.Fatal("Result is nil")
+	}
+	if res.Name != "example-user.pages.example.org" {
+		t.Fatalf("Invalid repository selected: %s", res.Name)
+	}
+	if path != "blog/post1.html" {
+		t.Fatalf("Returned path is invalid: %s", path)
+	}
+}
+
+func TestPickingNoRepositoryInvalidCNAME(t *testing.T) {
+	// Test that we're not picking a repository if the CNAME validation fails.
+	defer clearCache()
+
+	log.SetLevel(log.DebugLevel)
+	client := GiteaClient{
+		getRepository: func(username, repositoryName string) (Repository, error) {
+			if username == "example-user" && repositoryName == "example-user.pages.example.org" {
+				return Repository{
+					Name: "example-user.pages.example.org",
+				}, nil
+			} else {
+				t.Fatalf("Called with unknown repository %s", repositoryName)
+				return Repository{}, nil
+			}
+		},
+		hasBranch: func(username, repositoryName, branchName string) bool {
+			if username == "example-user" && repositoryName == "example-user.pages.example.org" && branchName == "pages" {
+				return true
+			}
+
+			return false
+		},
+		GetFile: func(username, repositoryName, branch, path string, since *time.Time) ([]byte, bool, error) {
+			if username == "example-user" && repositoryName == "example-user.pages.example.org" && branch == "pages" && path == "CNAME" {
+				return []byte("some-other-domain.local"), true, nil
+			}
+
+			t.Fatalf("Invalid file requested: %s/%s@%s:%s", username, repositoryName, branch, path)
+			return []byte{}, true, nil
+		},
+		lookupCNAME: func(domain string) (string, error) {
+			return "", errors.New("No CNAME")
+		},
+		lookupRepoTXT: func(domain string) (string, error) {
+			return "", nil
+		},
+	}
+
+	_, _, err := RepoFromPath("example-user", "example-user.pages.example.org", "example-user.local", "index.html", &client)
+	if err == nil {
+		t.Fatal("Repository returned even though CNAME validation should fail")
+	}
+}
+
+func TestPickingRepositoryValidCNAME(t *testing.T) {
+	// Test that we're picking a repository, given a CNAME, if the CNAME validation succeeds.
+	defer clearCache()
+
+	log.SetLevel(log.DebugLevel)
+	client := GiteaClient{
+		getRepository: func(username, repositoryName string) (Repository, error) {
+			if username == "example-user" && repositoryName == "example-user.pages.example.org" {
+				return Repository{
+					Name: "example-user.pages.example.org",
+				}, nil
+			} else {
+				t.Fatalf("Called with unknown repository %s", repositoryName)
+				return Repository{}, nil
+			}
+		},
+		hasBranch: func(username, repositoryName, branchName string) bool {
+			if username == "example-user" && repositoryName == "example-user.pages.example.org" && branchName == "pages" {
+				return true
+			}
+
+			return false
+		},
+		GetFile: func(username, repositoryName, branch, path string, since *time.Time) ([]byte, bool, error) {
+			if username == "example-user" && repositoryName == "example-user.pages.example.org" && branch == "pages" && path == "CNAME" {
+				return []byte("example-user.local"), true, nil
+			}
+
+			t.Fatalf("Invalid file requested: %s/%s@%s:%s", username, repositoryName, branch, path)
+			return []byte{}, true, nil
+		},
+		lookupCNAME: func(domain string) (string, error) {
+			return "", errors.New("No CNAME")
+		},
+		lookupRepoTXT: func(domain string) (string, error) {
+			return "", nil
+		},
+	}
+
+	repo, _, err := RepoFromPath("example-user", "example-user.pages.example.org", "example-user.local", "index.html", &client)
+	if err != nil {
+		t.Fatalf("Error returned: %v", err)
+	}
+	if repo.Name != "example-user.pages.example.org" {
+		t.Fatalf("Invalid repository name returned: %s", repo.Name)
+	}
+}
+
+func TestPickingRepositoryValidCNAMEWithTXTLookup(t *testing.T) {
+	// Test that we're picking a repository, given a CNAME, if the CNAME validation succeeds
+	// and the TXT lookup returns something different.
+	defer clearCache()
+
+	log.SetLevel(log.DebugLevel)
+	client := GiteaClient{
+		getRepository: func(username, repositoryName string) (Repository, error) {
+			if username == "example-user" && repositoryName == "some-different-repository" {
+				return Repository{
+					Name: "some-different-repository",
+				}, nil
+			} else {
+				t.Fatalf("Called with unknown repository %s", repositoryName)
+				return Repository{}, nil
+			}
+		},
+		hasBranch: func(username, repositoryName, branchName string) bool {
+			if username == "example-user" && repositoryName == "some-different-repository" && branchName == "pages" {
+				return true
+			}
+
+			return false
+		},
+		GetFile: func(username, repositoryName, branch, path string, since *time.Time) ([]byte, bool, error) {
+			if username == "example-user" && repositoryName == "some-different-repository" && branch == "pages" && path == "CNAME" {
+				return []byte("example-user.local"), true, nil
+			}
+
+			t.Fatalf("Invalid file requested: %s/%s@%s:%s", username, repositoryName, branch, path)
+			return []byte{}, true, nil
+		},
+		lookupCNAME: func(domain string) (string, error) {
+			return "", errors.New("No CNAME")
+		},
+		lookupRepoTXT: func(domain string) (string, error) {
+			if domain == "example-user.local" {
+				return "some-different-repository", nil
+			}
+			return "", nil
+		},
+	}
+
+	repo, _, err := RepoFromPath("example-user", "example-user.pages.example.org", "example-user.local", "index.html", &client)
+	if err != nil {
+		t.Fatalf("Error returned: %v", err)
+	}
+	if repo.Name != "some-different-repository" {
+		t.Fatalf("Invalid repository name returned: %s", repo.Name)
+	}
+}
+
+func TestPickingRepositoryValidCNAMEWithTXTLookupAndSubdirectory(t *testing.T) {
+	// Test that we're picking a repository, given a CNAME, if the CNAME validation succeeds
+	// and the TXT lookup returns something different. Additionally, we now have a subdirectory
+	defer clearCache()
+
+	log.SetLevel(log.DebugLevel)
+	client := GiteaClient{
+		getRepository: func(username, repositoryName string) (Repository, error) {
+			if username == "example-user" && repositoryName == "some-different-repository" {
+				return Repository{
+					Name: "some-different-repository",
+				}, nil
+			}
+
+			return Repository{}, errors.New("Unknown repository")
+		},
+		hasBranch: func(username, repositoryName, branchName string) bool {
+			if username == "example-user" && repositoryName == "some-different-repository" && branchName == "pages" {
+				return true
+			}
+
+			return false
+		},
+		GetFile: func(username, repositoryName, branch, path string, since *time.Time) ([]byte, bool, error) {
+			if username == "example-user" && repositoryName == "some-different-repository" && branch == "pages" && path == "CNAME" {
+				return []byte("example-user.local"), true, nil
+			}
+
+			t.Fatalf("Invalid file requested: %s/%s@%s:%s", username, repositoryName, branch, path)
+			return []byte{}, true, nil
+		},
+		lookupCNAME: func(domain string) (string, error) {
+			return "", errors.New("No CNAME")
+		},
+		lookupRepoTXT: func(domain string) (string, error) {
+			if domain == "example-user.local" {
+				return "some-different-repository", nil
+			}
+			return "", nil
+		},
+	}
+
+	repo, _, err := RepoFromPath("example-user", "example-user.pages.example.org", "example-user.local", "blog/index.html", &client)
+	if err != nil {
+		t.Fatalf("Error returned: %v", err)
+	}
+	if repo.Name != "some-different-repository" {
+		t.Fatalf("Invalid repository name returned: %s", repo.Name)
 	}
 }