source-controller/pkg/git/libgit2/managed/http_test.go

/*
Copyright 2022 The Flux authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package managed

import (
	"fmt"
	"net/http"
	"os"
	"path/filepath"
	"testing"

	"github.com/fluxcd/pkg/gittestserver"
	"github.com/fluxcd/source-controller/pkg/git"
	"github.com/go-logr/logr"
	. "github.com/onsi/gomega"

	git2go "github.com/libgit2/git2go/v33"
)

func TestHttpAction_CreateClientRequest(t *testing.T) {
	opts := &TransportOptions{
		TargetURL: "https://final-target/abc",
	}

	optsWithAuth := &TransportOptions{
		TargetURL: "https://final-target/abc",
		AuthOpts: &git.AuthOptions{
			Username: "user",
			Password: "pwd",
		},
	}
	id := "https://obj-id"

	tests := []struct {
		name       string
		assertFunc func(g *WithT, req *http.Request, client *http.Client)
		action     git2go.SmartServiceAction
		opts       *TransportOptions
		transport  *http.Transport
		wantedErr  error
	}{
		{
			name:      "Uploadpack: URL and method are correctly set",
			action:    git2go.SmartServiceActionUploadpack,
			transport: &http.Transport{},
			assertFunc: func(g *WithT, req *http.Request, _ *http.Client) {
				g.Expect(req.URL.String()).To(Equal("https://final-target/abc/git-upload-pack"))
				g.Expect(req.Method).To(Equal("POST"))
			},
			opts:      opts,
			wantedErr: nil,
		},
		{
			name:      "UploadpackLs: URL and method are correctly set",
			action:    git2go.SmartServiceActionUploadpackLs,
			transport: &http.Transport{},
			assertFunc: func(g *WithT, req *http.Request, _ *http.Client) {
				g.Expect(req.URL.String()).To(Equal("https://final-target/abc/info/refs?service=git-upload-pack"))
				g.Expect(req.Method).To(Equal("GET"))
			},
			opts:      opts,
			wantedErr: nil,
		},
		{
			name:      "Receivepack: URL and method are correctly set",
			action:    git2go.SmartServiceActionReceivepack,
			transport: &http.Transport{},
			assertFunc: func(g *WithT, req *http.Request, _ *http.Client) {
				g.Expect(req.URL.String()).To(Equal("https://final-target/abc/git-receive-pack"))
				g.Expect(req.Method).To(Equal("POST"))
			},
			opts:      opts,
			wantedErr: nil,
		},
		{
			name:      "ReceivepackLs: URL and method are correctly set",
			action:    git2go.SmartServiceActionReceivepackLs,
			transport: &http.Transport{},
			assertFunc: func(g *WithT, req *http.Request, _ *http.Client) {
				g.Expect(req.URL.String()).To(Equal("https://final-target/abc/info/refs?service=git-receive-pack"))
				g.Expect(req.Method).To(Equal("GET"))
			},
			opts:      opts,
			wantedErr: nil,
		},
		{
			name:      "credentials are correctly configured",
			action:    git2go.SmartServiceActionUploadpack,
			transport: &http.Transport{},
			opts:      optsWithAuth,
			assertFunc: func(g *WithT, req *http.Request, client *http.Client) {
				g.Expect(req.URL.String()).To(Equal("https://final-target/abc/git-upload-pack"))
				g.Expect(req.Method).To(Equal("POST"))

				username, pwd, ok := req.BasicAuth()
				if !ok {
					t.Errorf("could not find Authentication header in request.")
				}
				g.Expect(username).To(Equal("user"))
				g.Expect(pwd).To(Equal("pwd"))
			},
			wantedErr: nil,
		},
		{
			name:      "error when no http.transport provided",
			action:    git2go.SmartServiceActionUploadpack,
			transport: nil,
			opts:      opts,
			wantedErr: fmt.Errorf("failed to create client: transport cannot be nil"),
		},
		{
			name:      "error when no transport options are registered",
			action:    git2go.SmartServiceActionUploadpack,
			transport: &http.Transport{},
			opts:      nil,
			wantedErr: fmt.Errorf("failed to create client: could not find transport options for the object: https://obj-id"),
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			g := NewWithT(t)
			if tt.opts != nil {
				AddTransportOptions(id, *tt.opts)
			}

			client, req, err := createClientRequest(id, tt.action, tt.transport)
			if err != nil {
				t.Log(err)
			}
			if tt.wantedErr != nil {
				g.Expect(err).To(Equal(tt.wantedErr))
			} else {
				tt.assertFunc(g, req, client)
			}

			if tt.opts != nil {
				RemoveTransportOptions(id)
			}
		})
	}
}

func TestHTTPManagedTransport_E2E(t *testing.T) {
	g := NewWithT(t)

	server, err := gittestserver.NewTempGitServer()
	g.Expect(err).ToNot(HaveOccurred())
	defer os.RemoveAll(server.Root())

	user := "test-user"
	pwd := "test-pswd"
	server.Auth(user, pwd)
	server.KeyDir(filepath.Join(server.Root(), "keys"))

	err = server.ListenSSH()
	g.Expect(err).ToNot(HaveOccurred())

	err = server.StartHTTP()
	g.Expect(err).ToNot(HaveOccurred())
	defer server.StopHTTP()

	go func() {
		server.StartSSH()
	}()
	defer server.StopSSH()

	// Force managed transport to be enabled
	InitManagedTransport(logr.Discard())

	repoPath := "test.git"
	err = server.InitRepo("../../testdata/git/repo", git.DefaultBranch, repoPath)
	g.Expect(err).ToNot(HaveOccurred())

	tmpDir := t.TempDir()

	// Register the auth options and target url mapped to a unique id.
	id := "http://obj-id"
	AddTransportOptions(id, TransportOptions{
		TargetURL: server.HTTPAddress() + "/" + repoPath,
		AuthOpts: &git.AuthOptions{
			Username: user,
			Password: pwd,
		},
	})

	// We call Clone with id instead of the actual url, as the transport action
	// will fetch the actual url and the required credentials using the id as
	// a identifier.
	repo, err := git2go.Clone(id, tmpDir, &git2go.CloneOptions{
		CheckoutOptions: git2go.CheckoutOptions{
			Strategy: git2go.CheckoutForce,
		},
	})
	g.Expect(err).ToNot(HaveOccurred())
	repo.Free()
}

func TestHTTPManagedTransport_HandleRedirect(t *testing.T) {
	g := NewWithT(t)

	tmpDir := t.TempDir()

	// Force managed transport to be enabled
	InitManagedTransport(logr.Discard())

	id := "http://obj-id"
	AddTransportOptions(id, TransportOptions{
		TargetURL: "http://github.com/stefanprodan/podinfo",
	})

	// GitHub will cause a 301 and redirect to https
	repo, err := git2go.Clone(id, tmpDir, &git2go.CloneOptions{
		CheckoutOptions: git2go.CheckoutOptions{
			Strategy: git2go.CheckoutForce,
		},
	})

	g.Expect(err).ToNot(HaveOccurred())
	repo.Free()
}