Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add 'platformName' to selenium-grid scaler #4105

Merged
merged 3 commits into from
Jan 16, 2023
Merged

Add 'platformName' to selenium-grid scaler #4105

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
85a58a5
platformName added selenium grid scaler metadata
gifflet Jan 13, 2023
55d320c
Fix missing expected platformName in Test_parseSeleniumGridScalerMeta…
gifflet Jan 13, 2023
f1f6cd1
Move change details to improvements section
gifflet Jan 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ To learn more about active deprecations, we recommend checking [GitHub Discussio

Here is an overview of all **stable** additions:

- **Selenium Grid Scaler**: Add 'platformName' to selenium-grid scaler metadata structure ([#4038](https://github.com/kedacore/keda/issues/4038))
zroubalik marked this conversation as resolved.
Show resolved Hide resolved
- **General**: Introduce admission webhooks to automatically validate resource changes to prevent misconfiguration and enforce best practices. ([#3755](https://github.com/kedacore/keda/issues/3755))
- **General**: Introduce new ArangoDB Scaler ([#4000](https://github.com/kedacore/keda/issues/4000))
- **Prometheus Metrics**: Introduce scaler latency in Prometheus metrics. ([#4037](https://github.com/kedacore/keda/issues/4037))
Expand Down
23 changes: 17 additions & 6 deletions pkg/scalers/selenium_grid_scaler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ type seleniumGridScalerMetadata struct {
browserVersion string
unsafeSsl bool
scalerIndex int
platformName string
}

type seleniumResponse struct {
Expand Down Expand Up @@ -65,10 +66,12 @@ type seleniumSession struct {
type capability struct {
BrowserName string `json:"browserName"`
BrowserVersion string `json:"browserVersion"`
PlatformName string `json:"platformName"`
}

const (
DefaultBrowserVersion string = "latest"
DefaultPlatformName string = "linux"
zroubalik marked this conversation as resolved.
Show resolved Hide resolved
)

func NewSeleniumGridScaler(config *ScalerConfig) (Scaler, error) {
Expand Down Expand Up @@ -143,6 +146,12 @@ func parseSeleniumGridScalerMetadata(config *ScalerConfig) (*seleniumGridScalerM
meta.unsafeSsl = parsedVal
}

if val, ok := config.TriggerMetadata["platformName"]; ok && val != "" {
meta.platformName = val
} else {
meta.platformName = DefaultPlatformName
}

meta.scalerIndex = config.ScalerIndex
return &meta, nil
}
Expand Down Expand Up @@ -206,14 +215,14 @@ func (s *seleniumGridScaler) getSessionsCount(ctx context.Context, logger logr.L
if err != nil {
return -1, err
}
v, err := getCountFromSeleniumResponse(b, s.metadata.browserName, s.metadata.browserVersion, s.metadata.sessionBrowserName, logger)
v, err := getCountFromSeleniumResponse(b, s.metadata.browserName, s.metadata.browserVersion, s.metadata.sessionBrowserName, s.metadata.platformName, logger)
if err != nil {
return -1, err
}
return v, nil
}

func getCountFromSeleniumResponse(b []byte, browserName string, browserVersion string, sessionBrowserName string, logger logr.Logger) (int64, error) {
func getCountFromSeleniumResponse(b []byte, browserName string, browserVersion string, sessionBrowserName string, platformName string, logger logr.Logger) (int64, error) {
var count int64
var seleniumResponse = seleniumResponse{}

Expand All @@ -226,9 +235,10 @@ func getCountFromSeleniumResponse(b []byte, browserName string, browserVersion s
var capability = capability{}
if err := json.Unmarshal([]byte(sessionQueueRequest), &capability); err == nil {
if capability.BrowserName == browserName {
if strings.HasPrefix(capability.BrowserVersion, browserVersion) {
var platformNameMatches = capability.PlatformName == "" || strings.EqualFold(capability.PlatformName, platformName)
if strings.HasPrefix(capability.BrowserVersion, browserVersion) && platformNameMatches {
count++
} else if browserVersion == DefaultBrowserVersion {
} else if browserVersion == DefaultBrowserVersion && platformNameMatches {
count++
}
}
Expand All @@ -241,10 +251,11 @@ func getCountFromSeleniumResponse(b []byte, browserName string, browserVersion s
for _, session := range sessions {
var capability = capability{}
if err := json.Unmarshal([]byte(session.Capabilities), &capability); err == nil {
var platformNameMatches = capability.PlatformName == "" || strings.EqualFold(capability.PlatformName, platformName)
if capability.BrowserName == sessionBrowserName {
if strings.HasPrefix(capability.BrowserVersion, browserVersion) {
if strings.HasPrefix(capability.BrowserVersion, browserVersion) && platformNameMatches {
count++
} else if browserVersion == DefaultBrowserVersion {
} else if browserVersion == DefaultBrowserVersion && platformNameMatches {
count++
}
}
Expand Down
150 changes: 148 additions & 2 deletions pkg/scalers/selenium_grid_scaler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ func Test_getCountFromSeleniumResponse(t *testing.T) {
browserName string
sessionBrowserName string
browserVersion string
platformName string
}
tests := []struct {
name string
Expand Down Expand Up @@ -82,6 +83,7 @@ func Test_getCountFromSeleniumResponse(t *testing.T) {
browserName: "",
sessionBrowserName: "",
browserVersion: "latest",
platformName: "linux",
},
want: 0,
wantErr: false,
Expand All @@ -104,6 +106,7 @@ func Test_getCountFromSeleniumResponse(t *testing.T) {
browserName: "chrome",
sessionBrowserName: "chrome",
browserVersion: "latest",
platformName: "linux",
},
want: 2,
wantErr: false,
Expand Down Expand Up @@ -137,6 +140,7 @@ func Test_getCountFromSeleniumResponse(t *testing.T) {
browserName: "chrome",
sessionBrowserName: "chrome",
browserVersion: "latest",
platformName: "linux",
},
want: 3,
wantErr: false,
Expand Down Expand Up @@ -170,6 +174,7 @@ func Test_getCountFromSeleniumResponse(t *testing.T) {
browserName: "chrome",
sessionBrowserName: "chrome",
browserVersion: "latest",
platformName: "linux",
},
want: 2,
wantErr: false,
Expand Down Expand Up @@ -203,6 +208,7 @@ func Test_getCountFromSeleniumResponse(t *testing.T) {
browserName: "chrome",
sessionBrowserName: "chrome",
browserVersion: "latest",
platformName: "linux",
},
want: 5,
wantErr: false,
Expand Down Expand Up @@ -231,12 +237,13 @@ func Test_getCountFromSeleniumResponse(t *testing.T) {
browserName: "chrome",
sessionBrowserName: "chrome",
browserVersion: "91.0",
platformName: "linux",
},
want: 2,
wantErr: false,
},
{
name: "1 active msedge session with matching browsername/sessionBroswerName should return count as 3",
name: "1 active msedge session with matching browsername/sessionBrowserName should return count as 3",
args: args{
b: []byte(`{
"data": {
Expand All @@ -259,6 +266,7 @@ func Test_getCountFromSeleniumResponse(t *testing.T) {
browserName: "MicrosoftEdge",
sessionBrowserName: "msedge",
browserVersion: "latest",
platformName: "linux",
},
want: 3,
wantErr: false,
Expand Down Expand Up @@ -287,6 +295,7 @@ func Test_getCountFromSeleniumResponse(t *testing.T) {
browserName: "chrome",
sessionBrowserName: "chrome",
browserVersion: "latest",
platformName: "linux",
},
want: 2,
wantErr: false,
Expand Down Expand Up @@ -315,14 +324,95 @@ func Test_getCountFromSeleniumResponse(t *testing.T) {
browserName: "chrome",
sessionBrowserName: "chrome",
browserVersion: "latest",
platformName: "linux",
},
want: 1,
wantErr: false,
},
{
name: "session request with matching browsername and no specific platformName should return count as 2",
args: args{
b: []byte(`{
"data": {
"grid":{
"maxSession": 1,
"nodeCount": 1
},
"sessionsInfo": {
"sessionQueueRequests": ["{\n \"browserName\": \"chrome\"\n}","{\n \"browserName\": \"chrome\",\n \"platformName\": \"Windows 11\"\n}"],
"sessions": []
}
}
}`),
browserName: "chrome",
sessionBrowserName: "chrome",
browserVersion: "latest",
platformName: "Windows 11",
},
want: 2,
wantErr: false,
},
{
name: "sessions requests with matching browsername and platformName should return count as 1",
args: args{
b: []byte(`{
"data": {
"grid":{
"maxSession": 1,
"nodeCount": 1
},
"sessionsInfo": {
"sessionQueueRequests": ["{\n \"browserName\": \"chrome\",\n \"platformName\": \"linux\"\n}","{\n \"browserName\": \"chrome\",\n \"platformName\": \"Windows 11\"\n}"],
"sessions": []
}
}
}`),
browserName: "chrome",
sessionBrowserName: "chrome",
browserVersion: "latest",
platformName: "Windows 11",
},
want: 1,
wantErr: false,
},
{
name: "sessions requests and active sessions with matching browsername and platformName should return count as 2",
args: args{
b: []byte(`{
"data": {
"grid":{
"maxSession": 1,
"nodeCount": 1
},
"sessionsInfo": {
"sessionQueueRequests": ["{\n \"browserName\": \"chrome\",\n \"platformName\": \"linux\"\n}","{\n \"browserName\": \"chrome\",\n \"platformName\": \"Windows 11\"\n}"],
"sessions": [
{
"id": "0f9c5a941aa4d755a54b84be1f6535b1",
"capabilities": "{\n \"acceptInsecureCerts\": false,\n \"browserName\": \"chrome\",\n \"browserVersion\": \"91.0.4472.114\",\n \"chrome\": {\n \"chromedriverVersion\": \"91.0.4472.101 (af52a90bf87030dd1523486a1cd3ae25c5d76c9b-refs\\u002fbranch-heads\\u002f4472@{#1462})\",\n \"userDataDir\": \"\\u002ftmp\\u002f.com.google.Chrome.DMqx9m\"\n },\n \"goog:chromeOptions\": {\n \"debuggerAddress\": \"localhost:35839\"\n },\n \"networkConnectionEnabled\": false,\n \"pageLoadStrategy\": \"normal\",\n \"platformName\": \"Windows 11\",\n \"proxy\": {\n },\n \"se:cdp\": \"http:\\u002f\\u002flocalhost:35839\",\n \"se:cdpVersion\": \"91.0.4472.114\",\n \"se:vncEnabled\": true,\n \"se:vncLocalAddress\": \"ws:\\u002f\\u002flocalhost:7900\\u002fwebsockify\",\n \"setWindowRect\": true,\n \"strictFileInteractability\": false,\n \"timeouts\": {\n \"implicit\": 0,\n \"pageLoad\": 300000,\n \"script\": 30000\n },\n \"unhandledPromptBehavior\": \"dismiss and notify\",\n \"webauthn:extension:largeBlob\": true,\n \"webauthn:virtualAuthenticators\": true\n}",
"nodeId": "d44dcbc5-0b2c-4d5e-abf4-6f6aa5e0983c"
},
{
"id": "0f9c5a941aa4d755a54b84be1f6535b1",
"capabilities": "{\n \"acceptInsecureCerts\": false,\n \"browserName\": \"chrome\",\n \"browserVersion\": \"91.0.4472.114\",\n \"chrome\": {\n \"chromedriverVersion\": \"91.0.4472.101 (af52a90bf87030dd1523486a1cd3ae25c5d76c9b-refs\\u002fbranch-heads\\u002f4472@{#1462})\",\n \"userDataDir\": \"\\u002ftmp\\u002f.com.google.Chrome.DMqx9m\"\n },\n \"goog:chromeOptions\": {\n \"debuggerAddress\": \"localhost:35839\"\n },\n \"networkConnectionEnabled\": false,\n \"pageLoadStrategy\": \"normal\",\n \"platformName\": \"linux\",\n \"proxy\": {\n },\n \"se:cdp\": \"http:\\u002f\\u002flocalhost:35839\",\n \"se:cdpVersion\": \"91.0.4472.114\",\n \"se:vncEnabled\": true,\n \"se:vncLocalAddress\": \"ws:\\u002f\\u002flocalhost:7900\\u002fwebsockify\",\n \"setWindowRect\": true,\n \"strictFileInteractability\": false,\n \"timeouts\": {\n \"implicit\": 0,\n \"pageLoad\": 300000,\n \"script\": 30000\n },\n \"unhandledPromptBehavior\": \"dismiss and notify\",\n \"webauthn:extension:largeBlob\": true,\n \"webauthn:virtualAuthenticators\": true\n}",
"nodeId": "d44dcbc5-0b2c-4d5e-abf4-6f6aa5e0983c"
}
]
}
}
}`),
browserName: "chrome",
sessionBrowserName: "chrome",
browserVersion: "latest",
platformName: "Windows 11",
},
want: 2,
wantErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := getCountFromSeleniumResponse(tt.args.b, tt.args.browserName, tt.args.browserVersion, tt.args.sessionBrowserName, logr.Discard())
got, err := getCountFromSeleniumResponse(tt.args.b, tt.args.browserName, tt.args.browserVersion, tt.args.sessionBrowserName, tt.args.platformName, logr.Discard())
if (err != nil) != tt.wantErr {
t.Errorf("getCountFromSeleniumResponse() error = %v, wantErr %v", err, tt.wantErr)
return
Expand Down Expand Up @@ -381,6 +471,7 @@ func Test_parseSeleniumGridScalerMetadata(t *testing.T) {
sessionBrowserName: "chrome",
targetValue: 1,
browserVersion: "latest",
platformName: "linux",
},
},
{
Expand All @@ -401,6 +492,7 @@ func Test_parseSeleniumGridScalerMetadata(t *testing.T) {
sessionBrowserName: "msedge",
targetValue: 1,
browserVersion: "latest",
platformName: "linux",
},
},
{
Expand All @@ -423,6 +515,7 @@ func Test_parseSeleniumGridScalerMetadata(t *testing.T) {
sessionBrowserName: "msedge",
targetValue: 1,
browserVersion: "latest",
platformName: "linux",
},
},
{
Expand All @@ -445,6 +538,7 @@ func Test_parseSeleniumGridScalerMetadata(t *testing.T) {
targetValue: 1,
browserVersion: "91.0",
unsafeSsl: false,
platformName: "linux",
},
},
{
Expand All @@ -469,6 +563,7 @@ func Test_parseSeleniumGridScalerMetadata(t *testing.T) {
activationThreshold: 10,
browserVersion: "91.0",
unsafeSsl: true,
platformName: "linux",
},
},
{
Expand All @@ -486,6 +581,57 @@ func Test_parseSeleniumGridScalerMetadata(t *testing.T) {
},
wantErr: true,
},
{
name: "valid url, browsername, unsafeSsl and activationThreshold with default platformName should return metadata",
args: args{
config: &ScalerConfig{
TriggerMetadata: map[string]string{
"url": "http://selenium-hub:4444/graphql",
"browserName": "chrome",
"browserVersion": "91.0",
"unsafeSsl": "true",
"activationThreshold": "10",
},
},
},
wantErr: false,
want: &seleniumGridScalerMetadata{
url: "http://selenium-hub:4444/graphql",
browserName: "chrome",
sessionBrowserName: "chrome",
targetValue: 1,
activationThreshold: 10,
browserVersion: "91.0",
unsafeSsl: true,
platformName: "linux",
},
},
{
name: "valid url, browsername, unsafeSsl, activationThreshold and platformName should return metadata",
args: args{
config: &ScalerConfig{
TriggerMetadata: map[string]string{
"url": "http://selenium-hub:4444/graphql",
"browserName": "chrome",
"browserVersion": "91.0",
"unsafeSsl": "true",
"activationThreshold": "10",
"platformName": "Windows 11",
},
},
},
wantErr: false,
want: &seleniumGridScalerMetadata{
url: "http://selenium-hub:4444/graphql",
browserName: "chrome",
sessionBrowserName: "chrome",
targetValue: 1,
activationThreshold: 10,
browserVersion: "91.0",
unsafeSsl: true,
platformName: "Windows 11",
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand Down