[loadgen] Add authentication & fix checkoutLocation

Author: Furisto

dev/loadgen/README.md

@@ -41,6 +41,9 @@ In order to configure the benchmark, you can use the configuration file
 | successRate | Percentage of started workspaces that should enter running state to count as a successful run |
 | environment | Global environment variables that will be set for all repositories |
 | workspaceClass | The workspace class to use for workspaces. This setting can be overriden for individual repositories |
+| repoAuth | The authentication for a repository. This setting can be overriden for individual repositories |
+| repoAuth.authUser | The user that should be used for authentication |
+| repoAuth.authPassword | The password that should be used for authentication |
 | featureFlags | The feature flag passed when creating the workspace |
 | repos | The repositories that will be used to create workspaces |
 | repo.cloneURL | The url of the repository |
@@ -49,6 +52,9 @@ In order to configure the benchmark, you can use the configuration file
 | repo.workspaceImage | The docker image that will be used for the workspace |
 | repo.environment | Environment variables that will only be set for this repository |
 | repo.workspaceClass | The workspace class to use for the workspace that will be created for this repository |
+| repo.auth | The authentication for the repository |
+| repo.auth.authUser | The user that should be used for authentication |
+| repo.auth.authPassword | The password that should be used for authentication |
 
 After the benchmark has completed, you will find a benchmark-result.json file in your working directory, that contains information about every started workspace.
 

dev/loadgen/cmd/benchmark.go

@@ -74,12 +74,11 @@ var benchmarkCommand = &cobra.Command{
 					Email:    "[email protected]",
 					Username: "foobar",
 				},
-				FeatureFlags:      scenario.FeatureFlags,
-				Timeout:           "5m",
-				WorkspaceImage:    "will-be-overriden",
-				WorkspaceLocation: "workspace-stress",
-				Envvars:           scenario.Environment,
-				Class:             scenario.WorkspaceClass,
+				FeatureFlags:   scenario.FeatureFlags,
+				Timeout:        "5m",
+				WorkspaceImage: "will-be-overriden",
+				Envvars:        scenario.Environment,
+				Class:          scenario.WorkspaceClass,
 			},
 			Type: api.WorkspaceType_REGULAR,
 		}
@@ -125,7 +124,10 @@ var benchmarkCommand = &cobra.Command{
 			Load: load,
 			Specs: &loadgen.MultiWorkspaceGenerator{
 				Template: template,
-				Repos:    scenario.Repos,
+				Config: loadgen.MultiGeneratorConfig{
+					Repos: scenario.Repos,
+					Auth:  scenario.RepositoryAuth,
+				},
 			},
 			Worker: 5,
 			Observer: []chan<- *loadgen.SessionEvent{
@@ -198,6 +200,7 @@ type BenchmarkScenario struct {
 	SuccessRate     float32                    `json:"successRate"`
 	WorkspaceClass  string                     `json:"workspaceClass"`
 	FeatureFlags    []api.WorkspaceFeatureFlag `json:"featureFlags"`
+	RepositoryAuth  *loadgen.RepositoryAuth    `json:"repoAuth,omitempty"`
 }
 
 func handleWorkspaceDeletion(timeout string, executor loadgen.Executor, canceled bool) error {

dev/loadgen/configs/prod-benchmark-pvc.yaml

@@ -14,6 +14,9 @@ featureFlags:
 # https://github.com/gitpod-io/gitpod/blob/e437e1868072dfad1d195031a4709a254bd60dc8/components/ws-manager-api/core.proto#L596
 # from core.proto: PERSISTENT_VOLUME_CLAIM = 7;
   - 7
+# repoAuth:
+#   authUser: ""
+#   authPassword: ""
 repos:
   - cloneURL: https://github.com/Furisto/workspace-stress
     cloneTarget: main
@@ -79,7 +82,7 @@ repos:
     workspaceClass: "g1-large-pvc"
   - cloneURL: https://github.com/gitpod-io/template-python-django
     cloneTarget: main
-    score: 20
+    score: 0
     workspaceImage: eu.gcr.io/gitpod-dev/workspace-images:e764b1a602dc4123d9a027358367b5c4a35b62043e3c630731702144b7d37f77
   - cloneURL: https://github.com/gitpod-io/template-python-flask
     score: 20

dev/loadgen/pkg/loadgen/generator.go

@@ -6,6 +6,9 @@ package loadgen
 
 import (
 	"math/rand"
+	"net/url"
+	"path"
+	"strings"
 	"sync/atomic"
 	"time"
 
@@ -161,11 +164,22 @@ type WorkspaceCfg struct {
 	Score          int                        `json:"score"`
 	Environment    []*api.EnvironmentVariable `json:"environment"`
 	WorkspaceClass string                     `json:"workspaceClass"`
+	RepositoryAuth *RepositoryAuth            `json:"auth,omitempty"`
+}
+
+type RepositoryAuth struct {
+	AuthUser     string `json:"authUser"`
+	AuthPassword string `json:"authPassword"`
 }
 
 type MultiWorkspaceGenerator struct {
 	Template *api.StartWorkspaceRequest
-	Repos    []WorkspaceCfg
+	Config   MultiGeneratorConfig
+}
+
+type MultiGeneratorConfig struct {
+	Repos []WorkspaceCfg
+	Auth  *RepositoryAuth
 }
 
 func (f *MultiWorkspaceGenerator) Generate() (*StartWorkspaceSpec, error) {
@@ -178,7 +192,7 @@ func (f *MultiWorkspaceGenerator) Generate() (*StartWorkspaceSpec, error) {
 		return nil, err
 	}
 
-	repo := selectRepo(f.Repos)
+	repo := selectRepo(f.Config.Repos)
 	log.Infof("selecting repo %s", repo.CloneURL)
 
 	out := proto.Clone(f.Template).(*api.StartWorkspaceRequest)
@@ -187,21 +201,29 @@ func (f *MultiWorkspaceGenerator) Generate() (*StartWorkspaceSpec, error) {
 	if out.Metadata.Annotations == nil {
 		out.Metadata.Annotations = make(map[string]string)
 	}
+
+	cloneUrl, err := url.Parse(repo.CloneURL)
+	if err != nil {
+		return nil, err
+	}
+	repositoryName := strings.TrimRight(path.Base(cloneUrl.Path), ".git")
+	gitConfig := f.prepareGitConfig(repo)
+
 	out.Metadata.Annotations["context-url"] = repo.CloneURL
 	out.ServicePrefix = workspaceID
+	out.Spec.WorkspaceLocation = repositoryName
 	out.Spec.Initializer = &csapi.WorkspaceInitializer{
 		Spec: &csapi.WorkspaceInitializer_Git{
 			Git: &csapi.GitInitializer{
-				CheckoutLocation: "",
+				CheckoutLocation: repositoryName,
 				CloneTaget:       repo.CloneTarget,
 				RemoteUri:        repo.CloneURL,
 				TargetMode:       csapi.CloneTargetMode_REMOTE_BRANCH,
-				Config: &csapi.GitConfig{
-					Authentication: csapi.GitAuthMethod_NO_AUTH,
-				},
+				Config:           gitConfig,
 			},
 		},
 	}
+
 	out.Spec.WorkspaceImage = repo.WorkspaceImage
 	if len(repo.WorkspaceClass) > 0 {
 		out.Spec.Class = repo.WorkspaceClass
@@ -229,3 +251,22 @@ func selectRepo(repos []WorkspaceCfg) WorkspaceCfg {
 
 	return repos[len(repos)-1]
 }
+
+func (f *MultiWorkspaceGenerator) prepareGitConfig(repo WorkspaceCfg) *csapi.GitConfig {
+	gitConfig := &csapi.GitConfig{
+		Authentication: csapi.GitAuthMethod_NO_AUTH,
+	}
+	if f.Config.Auth != nil {
+		gitConfig.Authentication = csapi.GitAuthMethod_BASIC_AUTH
+		gitConfig.AuthUser = f.Config.Auth.AuthUser
+		gitConfig.AuthPassword = f.Config.Auth.AuthPassword
+	}
+
+	if repo.RepositoryAuth != nil {
+		gitConfig.Authentication = csapi.GitAuthMethod_BASIC_AUTH
+		gitConfig.AuthUser = repo.RepositoryAuth.AuthUser
+		gitConfig.AuthPassword = repo.RepositoryAuth.AuthPassword
+	}
+
+	return gitConfig
+}