mirror of
https://github.com/gitpod-io/gitpod.git
synced 2025-12-08 17:36:30 +00:00
f0763afc35
* Auto-configure default JVM Xmx based on workspace resources * Add max xmx and unit tests
155 lines
8.2 KiB
Go
155 lines
8.2 KiB
Go
// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
|
|
// Licensed under the GNU Affero General Public License (AGPL).
|
|
// See License.AGPL.txt in the project root for license information.
|
|
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
protocol "github.com/gitpod-io/gitpod/gitpod-protocol"
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/google/go-cmp/cmp/cmpopts"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestGetProductConfig(t *testing.T) {
|
|
expectation := &protocol.JetbrainsProduct{}
|
|
actual := getProductConfig(&protocol.GitpodConfig{
|
|
Jetbrains: &protocol.Jetbrains{
|
|
Intellij: expectation,
|
|
},
|
|
}, "intellij")
|
|
|
|
if diff := cmp.Diff(expectation, actual); diff != "" {
|
|
t.Errorf("unexpected output (-want +got):\n%s", diff)
|
|
}
|
|
}
|
|
|
|
func TestParseGitpodConfig(t *testing.T) {
|
|
gitpodConfig, _ := parseGitpodConfig("testdata")
|
|
assert.Equal(t, 1, len(gitpodConfig.Jetbrains.Intellij.Plugins))
|
|
assert.Equal(t, "both", gitpodConfig.Jetbrains.Intellij.Prebuilds.Version)
|
|
assert.Equal(t, "-Xmx3g", gitpodConfig.Jetbrains.Intellij.Vmoptions)
|
|
assert.Equal(t, "-Xmx4096m -XX:MaxRAMPercentage=75", gitpodConfig.Jetbrains.Goland.Vmoptions)
|
|
}
|
|
|
|
func TestUpdateVMOptions(t *testing.T) {
|
|
tests := []struct {
|
|
Desc string
|
|
Alias string
|
|
EnvVar map[string]string
|
|
Src string
|
|
Expectation string
|
|
}{
|
|
{"idea64.vmoptions (GITPOD_CPU_COUNT)", "intellij", map[string]string{"INTELLIJ_VMOPTIONS": "-Xmx4096m", "GITPOD_CPU_COUNT": "1"}, "-Xms128m\n-Xmx2g\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-Xmx4096m\n-Dsun.tools.attach.tmp.only=true\n-XX:+UseContainerSupport\n-XX:ActiveProcessorCount=1\n-Dfreeze.reporter.profiling=false\n-Dgtw.disable.exit.dialog=true\n-Djdk.configure.existing=true"},
|
|
{"idea64.vmoptions (GITPOD_CPU_COUNT 2)", "intellij", map[string]string{"INTELLIJ_VMOPTIONS": "-Xmx4096m", "GITPOD_CPU_COUNT": "12"}, "-Xms128m\n-Xmx2g\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-Xmx4096m\n-Dsun.tools.attach.tmp.only=true\n-XX:+UseContainerSupport\n-XX:ActiveProcessorCount=12\n-Dfreeze.reporter.profiling=false\n-Dgtw.disable.exit.dialog=true\n-Djdk.configure.existing=true"},
|
|
{"goland64.vmoptions", "goland", nil, "-Xms128m\n-Xmx750m\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-Xmx750m\n-Dsun.tools.attach.tmp.only=true\n-XX:+UseContainerSupport\n-Dfreeze.reporter.profiling=false\n-Dgtw.disable.exit.dialog=true"},
|
|
{"idea64.vmoptions", "intellij", nil, "-Xms128m\n-Xmx750m\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-Xmx750m\n-Dsun.tools.attach.tmp.only=true\n-XX:+UseContainerSupport\n-Dfreeze.reporter.profiling=false\n-Dgtw.disable.exit.dialog=true\n-Djdk.configure.existing=true"},
|
|
{"idea64.vmoptions (INTELLIJ_VMOPTIONS env set)", "intellij", map[string]string{"INTELLIJ_VMOPTIONS": "-Xmx2048m"}, "-Xms128m\n-Xmx750m\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-Xmx2048m\n-Dsun.tools.attach.tmp.only=true\n-XX:+UseContainerSupport\n-Dfreeze.reporter.profiling=false\n-Dgtw.disable.exit.dialog=true\n-Djdk.configure.existing=true"},
|
|
{"idea64.vmoptions (INTELLIJ_VMOPTIONS env set)", "intellij", map[string]string{"INTELLIJ_VMOPTIONS": "-Xmx4096m"}, "-Xms128m\n-Xmx2g\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-Xmx4096m\n-Dsun.tools.attach.tmp.only=true\n-XX:+UseContainerSupport\n-Dfreeze.reporter.profiling=false\n-Dgtw.disable.exit.dialog=true\n-Djdk.configure.existing=true"},
|
|
{"idea64.vmoptions (INTELLIJ_VMOPTIONS env set)", "intellij", map[string]string{"INTELLIJ_VMOPTIONS": "-Xmx4096m -XX:MaxRAMPercentage=75"}, "-Xms128m\n-Xmx2g\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-Xmx4096m\n-XX:MaxRAMPercentage=75\n-Dsun.tools.attach.tmp.only=true\n-XX:+UseContainerSupport\n-Dfreeze.reporter.profiling=false\n-Dgtw.disable.exit.dialog=true\n-Djdk.configure.existing=true"},
|
|
{"goland64.vmoptions (GOLAND_VMOPTIONS env set with conflicting options)", "goland", map[string]string{"GOLAND_VMOPTIONS": "-ea -XX:+IgnoreUnrecognizedVMOptions -XX:MaxRAMPercentage=75 -XX:MaxRAMPercentage=50"}, "-Xms128m\n-Xmx2g\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-Xmx2g\n-Dsun.tools.attach.tmp.only=true\n-Dfreeze.reporter.profiling=false\n-Dgtw.disable.exit.dialog=true\n-ea\n-XX:+IgnoreUnrecognizedVMOptions\n-XX:+UseContainerSupport\n-XX:MaxRAMPercentage=50"},
|
|
{"GITPOD_MEMORY with 1G", "intellij", map[string]string{"GITPOD_MEMORY": "1024"}, "-Xms128m\n-Xmx2g\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-Xmx2g\n-Dsun.tools.attach.tmp.only=true\n-Dfreeze.reporter.profiling=false\n-Dgtw.disable.exit.dialog=true\n-Djdk.configure.existing=true\n-XX:+UseContainerSupport\n"},
|
|
{"GITPOD_MEMORY with 4G", "intellij", map[string]string{"GITPOD_MEMORY": "4096"}, "-Xms128m\n-Xmx2g\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-Xmx2457m\n-Dsun.tools.attach.tmp.only=true\n-Dfreeze.reporter.profiling=false\n-Dgtw.disable.exit.dialog=true\n-Djdk.configure.existing=true\n-XX:+UseContainerSupport\n"},
|
|
{"GITPOD_MEMORY with 256G will use max 8G", "intellij", map[string]string{"GITPOD_MEMORY": "262144"}, "-Xms128m\n-Xmx2g\n-Dsun.tools.attach.tmp.only=true", "-Xms128m\n-Xmx8192m\n-Dsun.tools.attach.tmp.only=true\n-Dfreeze.reporter.profiling=false\n-Dgtw.disable.exit.dialog=true\n-Djdk.configure.existing=true\n-XX:+UseContainerSupport\n"},
|
|
}
|
|
os.Unsetenv("GITPOD_CPU_COUNT")
|
|
os.Unsetenv("GITPOD_MEMORY")
|
|
for _, test := range tests {
|
|
// compare vmoptions string content equality (i.e. split into slices and compare ignore order)
|
|
lessFunc := func(a, b string) bool { return a < b }
|
|
|
|
t.Run(test.Desc, func(t *testing.T) {
|
|
for v := range test.EnvVar {
|
|
t.Setenv(v, test.EnvVar[v])
|
|
}
|
|
actual := updateVMOptions(nil, test.Alias, strings.Fields(test.Src))
|
|
if diff := cmp.Diff(strings.Fields(test.Expectation), actual, cmpopts.SortSlices(lessFunc)); diff != "" {
|
|
t.Errorf("unexpected output (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
|
|
t.Run("updateVMOptions multiple time should be stable", func(t *testing.T) {
|
|
for v := range test.EnvVar {
|
|
t.Setenv(v, test.EnvVar[v])
|
|
}
|
|
actual := strings.Fields(test.Src)
|
|
for i := 0; i < 5; i++ {
|
|
actual = updateVMOptions(nil, test.Alias, actual)
|
|
if diff := cmp.Diff(strings.Fields(test.Expectation), actual, cmpopts.SortSlices(lessFunc)); diff != "" {
|
|
t.Errorf("unexpected output (-want +got):\n%s", diff)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestUpdatePlatformProperties(t *testing.T) {
|
|
platformProperties := `#---------------------------------------------------------------------
|
|
# Uncomment this option if you want to customize a path to the settings directory.
|
|
#---------------------------------------------------------------------
|
|
# idea.config.path=${user.home}/.IntelliJIdea/config
|
|
|
|
|
|
shared.indexes.download.auto.consent=true
|
|
`
|
|
configDir := "/workspace/.config/JetBrains/RemoteDev-IU"
|
|
systemDir := "/workspace/.cache/JetBrains/RemoteDev-IU"
|
|
|
|
t.Run("updatePlatformProperties multiple time should be stable", func(t *testing.T) {
|
|
|
|
updated, content := updatePlatformProperties(platformProperties, configDir, systemDir)
|
|
assert.Equal(t, true, updated)
|
|
assert.Equal(t, true, strings.Contains(content, "idea.config.path=/workspace/.config/JetBrains/RemoteDev-IU"))
|
|
for i := 0; i < 5; i++ {
|
|
updated, newContent := updatePlatformProperties(content, configDir, systemDir)
|
|
assert.Equal(t, false, updated)
|
|
assert.Equal(t, content, newContent)
|
|
}
|
|
})
|
|
}
|
|
|
|
func Test_safeLink(t *testing.T) {
|
|
type args struct {
|
|
changeSource bool
|
|
}
|
|
t.Log("link folders twice")
|
|
tests := []struct {
|
|
name string
|
|
args args
|
|
wantErr bool
|
|
}{
|
|
{name: "happy path", args: args{changeSource: true}, wantErr: false},
|
|
{name: "happy path 2", args: args{changeSource: false}, wantErr: false},
|
|
}
|
|
for index, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
source := createTempDir(t, fmt.Sprintf("source_%d", index))
|
|
target := createTempDir(t, fmt.Sprintf("target_%d", index))
|
|
safeLink(source, target)
|
|
os.RemoveAll(source)
|
|
if tt.args.changeSource {
|
|
source = createTempDir(t, fmt.Sprintf("source_new_%d", index))
|
|
} else {
|
|
source = createTempDir(t, fmt.Sprintf("source_%d", index))
|
|
}
|
|
if err := safeLink(source, target); (err != nil) != tt.wantErr {
|
|
t.Errorf("safeLink() error = %v, wantErr %v", err, tt.wantErr)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func createTempDir(t *testing.T, dir string) string {
|
|
path := filepath.Join(t.TempDir(), dir)
|
|
if err := os.Mkdir(path, 0o755); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
return path
|
|
}
|