From 87943db62c418cbe971c1df329f020fbb0efc8b6 Mon Sep 17 00:00:00 2001 From: Gabriel Adrian Samfira Date: Sat, 27 Apr 2024 18:10:03 +0000 Subject: [PATCH] Fix lint and add integration tests logging Signed-off-by: Gabriel Adrian Samfira --- test/integration/e2e/credentials.go | 70 ++++++++++++----------------- test/integration/e2e/endpoints.go | 7 +++ test/integration/e2e/utils.go | 2 +- 3 files changed, 37 insertions(+), 42 deletions(-) diff --git a/test/integration/e2e/credentials.go b/test/integration/e2e/credentials.go index 22c0e4fd..2ca027c5 100644 --- a/test/integration/e2e/credentials.go +++ b/test/integration/e2e/credentials.go @@ -2,11 +2,13 @@ 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, @@ -36,14 +38,13 @@ func createDummyCredentials(name, endpointName string) *params.GithubCredentials } func TestGithubCredentialsErrorOnDuplicateCredentialsName() { - name := "dummy" - endpointName := "github.com" - creds := createDummyCredentials(name, endpointName) + slog.Info("Testing error on duplicate credentials name") + creds := createDummyCredentials(dummyCredentialsName, defaultEndpointName) defer DeleteGithubCredential(int64(creds.ID)) createCredsParams := params.CreateGithubCredentialsParams{ - Name: name, - Endpoint: endpointName, + Name: dummyCredentialsName, + Endpoint: defaultEndpointName, Description: "GARM test credentials", AuthType: params.GithubAuthTypePAT, PAT: params.GithubPAT{ @@ -56,9 +57,8 @@ func TestGithubCredentialsErrorOnDuplicateCredentialsName() { } func TestGithubCredentialsFailsToDeleteWhenInUse() { - name := "dummy" - endpointName := "github.com" - creds := createDummyCredentials(name, endpointName) + 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() { @@ -72,12 +72,10 @@ func TestGithubCredentialsFailsToDeleteWhenInUse() { } func TestGithubCredentialsFailsOnInvalidAuthType() { - name := "dummy" - endpointName := "github.com" - + slog.Info("Testing error on invalid auth type") createCredsParams := params.CreateGithubCredentialsParams{ - Name: name, - Endpoint: endpointName, + Name: dummyCredentialsName, + Endpoint: defaultEndpointName, Description: "GARM test credentials", AuthType: params.GithubAuthType("invalid"), PAT: params.GithubPAT{ @@ -92,12 +90,10 @@ func TestGithubCredentialsFailsOnInvalidAuthType() { } func TestGithubCredentialsFailsWhenAuthTypeParamsAreIncorrect() { - name := "dummy" - endpointName := "github.com" - + slog.Info("Testing error when auth type params are incorrect") createCredsParams := params.CreateGithubCredentialsParams{ - Name: name, - Endpoint: endpointName, + Name: dummyCredentialsName, + Endpoint: defaultEndpointName, Description: "GARM test credentials", AuthType: params.GithubAuthTypePAT, App: params.GithubApp{ @@ -114,12 +110,10 @@ func TestGithubCredentialsFailsWhenAuthTypeParamsAreIncorrect() { } func TestGithubCredentialsFailsWhenAuthTypeParamsAreMissing() { - name := "dummy" - endpointName := "github.com" - + slog.Info("Testing error when auth type params are missing") createCredsParams := params.CreateGithubCredentialsParams{ - Name: name, - Endpoint: endpointName, + Name: dummyCredentialsName, + Endpoint: defaultEndpointName, Description: "GARM test credentials", AuthType: params.GithubAuthTypeApp, } @@ -131,9 +125,8 @@ func TestGithubCredentialsFailsWhenAuthTypeParamsAreMissing() { } func TestGithubCredentialsUpdateFailsWhenBothPATAndAppAreSupplied() { - name := "dummy" - endpointName := "github.com" - creds := createDummyCredentials(name, endpointName) + slog.Info("Testing error when both PAT and App are supplied") + creds := createDummyCredentials(dummyCredentialsName, defaultEndpointName) defer DeleteGithubCredential(int64(creds.ID)) updateCredsParams := params.UpdateGithubCredentialsParams{ @@ -154,12 +147,10 @@ func TestGithubCredentialsUpdateFailsWhenBothPATAndAppAreSupplied() { } func TestGithubCredentialsFailWhenAppKeyIsInvalid() { - name := "dummy" - endpointName := "github.com" - + slog.Info("Testing error when app key is invalid") createCredsParams := params.CreateGithubCredentialsParams{ - Name: name, - Endpoint: endpointName, + Name: dummyCredentialsName, + Endpoint: defaultEndpointName, Description: "GARM test credentials", AuthType: params.GithubAuthTypeApp, App: params.GithubApp{ @@ -176,12 +167,10 @@ func TestGithubCredentialsFailWhenAppKeyIsInvalid() { } func TestGithubCredentialsFailWhenEndpointDoesntExist() { - name := "dummy" - endpointName := "nonexistent" - + slog.Info("Testing error when endpoint doesn't exist") createCredsParams := params.CreateGithubCredentialsParams{ - Name: name, - Endpoint: endpointName, + Name: dummyCredentialsName, + Endpoint: defaultEndpointName, Description: "GARM test credentials", AuthType: params.GithubAuthTypePAT, PAT: params.GithubPAT{ @@ -196,14 +185,13 @@ func TestGithubCredentialsFailWhenEndpointDoesntExist() { } func TestGithubCredentialsFailsOnDuplicateName() { - name := "dummy" - endpointName := "github.com" - creds := createDummyCredentials(name, endpointName) + slog.Info("Testing error on duplicate credentials name") + creds := createDummyCredentials(dummyCredentialsName, defaultEndpointName) defer DeleteGithubCredential(int64(creds.ID)) createCredsParams := params.CreateGithubCredentialsParams{ - Name: name, - Endpoint: endpointName, + Name: dummyCredentialsName, + Endpoint: defaultEndpointName, Description: "GARM test credentials", AuthType: params.GithubAuthTypePAT, PAT: params.GithubPAT{ diff --git a/test/integration/e2e/endpoints.go b/test/integration/e2e/endpoints.go index 21c0dc1b..9a276627 100644 --- a/test/integration/e2e/endpoints.go +++ b/test/integration/e2e/endpoints.go @@ -8,6 +8,11 @@ import ( "github.com/cloudbase/garm/params" ) +const ( + defaultEndpointName string = "github.com" + dummyCredentialsName string = "dummy" +) + func MustDefaultGithubEndpoint() { ep := GetGithubEndpoint("github.com") if ep == nil { @@ -58,6 +63,7 @@ func getTestFileContents(relPath string) []byte { } func TestGithubEndpointOperations() { + slog.Info("Testing endpoint operations") MustDefaultGithubEndpoint() caBundle := getTestFileContents("certs/srv-pub.pem") @@ -119,6 +125,7 @@ func TestGithubEndpointOperations() { } func TestGithubEndpointMustFailToDeleteDefaultGithubEndpoint() { + slog.Info("Testing error when deleting default github.com endpoint") if err := deleteGithubEndpoint(cli, authToken, "github.com"); err == nil { panic("expected error when attempting to delete the default github.com endpoint") } diff --git a/test/integration/e2e/utils.go b/test/integration/e2e/utils.go index 84c9f9e7..3c449ddc 100644 --- a/test/integration/e2e/utils.go +++ b/test/integration/e2e/utils.go @@ -28,6 +28,6 @@ func expectAPIStatusCode(err error, expectedCode int) { log.Fatalf("expected API error, got %v (%T)", err, err) } if !apiErr.IsCode(expectedCode) { - log.Fatalf("expected status code %d", expectedCode) + log.Fatalf("expected status code %d: %v", expectedCode, err) } }