garm/test/integration/e2e/credentials.go

package e2e

import (
	"fmt"
	"log/slog"

	"github.com/cloudbase/garm/params"
)

func EnsureTestCredentials(name string, oauthToken string, endpointName string) {
	slog.Info("Ensuring test credentials exist")
	createCredsParams := params.CreateGithubCredentialsParams{
		Name:        name,
		Endpoint:    endpointName,
		Description: "GARM test credentials",
		AuthType:    params.GithubAuthTypePAT,
		PAT: params.GithubPAT{
			OAuth2Token: oauthToken,
		},
	}
	CreateGithubCredentials(createCredsParams)

	createCredsParams.Name = fmt.Sprintf("%s-clone", name)
	CreateGithubCredentials(createCredsParams)
}

func createDummyCredentials(name, endpointName string) *params.GithubCredentials {
	createCredsParams := params.CreateGithubCredentialsParams{
		Name:        name,
		Endpoint:    endpointName,
		Description: "GARM test credentials",
		AuthType:    params.GithubAuthTypePAT,
		PAT: params.GithubPAT{
			OAuth2Token: "dummy",
		},
	}
	return CreateGithubCredentials(createCredsParams)
}

func TestGithubCredentialsErrorOnDuplicateCredentialsName() {
	slog.Info("Testing error on duplicate credentials name")
	creds := createDummyCredentials(dummyCredentialsName, defaultEndpointName)
	defer DeleteGithubCredential(int64(creds.ID))

	createCredsParams := params.CreateGithubCredentialsParams{
		Name:        dummyCredentialsName,
		Endpoint:    defaultEndpointName,
		Description: "GARM test credentials",
		AuthType:    params.GithubAuthTypePAT,
		PAT: params.GithubPAT{
			OAuth2Token: "dummy",
		},
	}
	if _, err := createGithubCredentials(cli, authToken, createCredsParams); err == nil {
		panic("expected error when creating credentials with duplicate name")
	}
}

func TestGithubCredentialsFailsToDeleteWhenInUse() {
	slog.Info("Testing error when deleting credentials in use")
	creds := createDummyCredentials(dummyCredentialsName, defaultEndpointName)

	repo := CreateRepo("dummy-owner", "dummy-repo", creds.Name, "superSecret@123BlaBla")
	defer func() {
		deleteRepo(cli, authToken, repo.ID)
		deleteGithubCredentials(cli, authToken, int64(creds.ID))
	}()

	if err := deleteGithubCredentials(cli, authToken, int64(creds.ID)); err == nil {
		panic("expected error when deleting credentials in use")
	}
}

func TestGithubCredentialsFailsOnInvalidAuthType() {
	slog.Info("Testing error on invalid auth type")
	createCredsParams := params.CreateGithubCredentialsParams{
		Name:        dummyCredentialsName,
		Endpoint:    defaultEndpointName,
		Description: "GARM test credentials",
		AuthType:    params.GithubAuthType("invalid"),
		PAT: params.GithubPAT{
			OAuth2Token: "dummy",
		},
	}
	_, err := createGithubCredentials(cli, authToken, createCredsParams)
	if err == nil {
		panic("expected error when creating credentials with invalid auth type")
	}
	expectAPIStatusCode(err, 400)
}

func TestGithubCredentialsFailsWhenAuthTypeParamsAreIncorrect() {
	slog.Info("Testing error when auth type params are incorrect")
	createCredsParams := params.CreateGithubCredentialsParams{
		Name:        dummyCredentialsName,
		Endpoint:    defaultEndpointName,
		Description: "GARM test credentials",
		AuthType:    params.GithubAuthTypePAT,
		App: params.GithubApp{
			AppID:           123,
			InstallationID:  456,
			PrivateKeyBytes: getTestFileContents("certs/srv-key.pem"),
		},
	}
	_, err := createGithubCredentials(cli, authToken, createCredsParams)
	if err == nil {
		panic("expected error when creating credentials with invalid auth type params")
	}
	expectAPIStatusCode(err, 400)
}

func TestGithubCredentialsFailsWhenAuthTypeParamsAreMissing() {
	slog.Info("Testing error when auth type params are missing")
	createCredsParams := params.CreateGithubCredentialsParams{
		Name:        dummyCredentialsName,
		Endpoint:    defaultEndpointName,
		Description: "GARM test credentials",
		AuthType:    params.GithubAuthTypeApp,
	}
	_, err := createGithubCredentials(cli, authToken, createCredsParams)
	if err == nil {
		panic("expected error when creating credentials with missing auth type params")
	}
	expectAPIStatusCode(err, 400)
}

func TestGithubCredentialsUpdateFailsWhenBothPATAndAppAreSupplied() {
	slog.Info("Testing error when both PAT and App are supplied")
	creds := createDummyCredentials(dummyCredentialsName, defaultEndpointName)
	defer DeleteGithubCredential(int64(creds.ID))

	updateCredsParams := params.UpdateGithubCredentialsParams{
		PAT: &params.GithubPAT{
			OAuth2Token: "dummy",
		},
		App: &params.GithubApp{
			AppID:           123,
			InstallationID:  456,
			PrivateKeyBytes: getTestFileContents("certs/srv-key.pem"),
		},
	}
	_, err := updateGithubCredentials(cli, authToken, int64(creds.ID), updateCredsParams)
	if err == nil {
		panic("expected error when updating credentials with both PAT and App")
	}
	expectAPIStatusCode(err, 400)
}

func TestGithubCredentialsFailWhenAppKeyIsInvalid() {
	slog.Info("Testing error when app key is invalid")
	createCredsParams := params.CreateGithubCredentialsParams{
		Name:        dummyCredentialsName,
		Endpoint:    defaultEndpointName,
		Description: "GARM test credentials",
		AuthType:    params.GithubAuthTypeApp,
		App: params.GithubApp{
			AppID:           123,
			InstallationID:  456,
			PrivateKeyBytes: []byte("invalid"),
		},
	}
	_, err := createGithubCredentials(cli, authToken, createCredsParams)
	if err == nil {
		panic("expected error when creating credentials with invalid app key")
	}
	expectAPIStatusCode(err, 400)
}

func TestGithubCredentialsFailWhenEndpointDoesntExist() {
	slog.Info("Testing error when endpoint doesn't exist")
	createCredsParams := params.CreateGithubCredentialsParams{
		Name:        dummyCredentialsName,
		Endpoint:    "iDontExist.example.com",
		Description: "GARM test credentials",
		AuthType:    params.GithubAuthTypePAT,
		PAT: params.GithubPAT{
			OAuth2Token: "dummy",
		},
	}
	_, err := createGithubCredentials(cli, authToken, createCredsParams)
	if err == nil {
		panic("expected error when creating credentials with invalid endpoint")
	}
	expectAPIStatusCode(err, 404)
}

func TestGithubCredentialsFailsOnDuplicateName() {
	slog.Info("Testing error on duplicate credentials name")
	creds := createDummyCredentials(dummyCredentialsName, defaultEndpointName)
	defer DeleteGithubCredential(int64(creds.ID))

	createCredsParams := params.CreateGithubCredentialsParams{
		Name:        dummyCredentialsName,
		Endpoint:    defaultEndpointName,
		Description: "GARM test credentials",
		AuthType:    params.GithubAuthTypePAT,
		PAT: params.GithubPAT{
			OAuth2Token: "dummy",
		},
	}
	_, err := createGithubCredentials(cli, authToken, createCredsParams)
	if err == nil {
		panic("expected error when creating credentials with duplicate name")
	}
	expectAPIStatusCode(err, 409)
}