[grid] Support Grid custom capability mutators #13672
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| // Licensed to the Software Freedom Conservancy (SFC) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The SFC licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| package org.openqa.selenium.grid.node.config; | ||
|
|
||
| import com.google.common.annotations.VisibleForTesting; | ||
| import org.openqa.selenium.Capabilities; | ||
|
|
||
| import java.util.Comparator; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.ServiceLoader; | ||
| import java.util.concurrent.CopyOnWriteArrayList; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.StreamSupport; | ||
|
|
||
| public class CapabilitiesMutatorService { | ||
| Capabilities stereotype; | ||
| private final List<CapabilityMutator> customMutators = new CopyOnWriteArrayList<>(); | ||
|
|
||
| private static final Comparator<CapabilityMutator> MUTATOR_COMPARATOR = | ||
| Comparator.comparingInt(CapabilityMutator::getOrder).reversed(); | ||
|
|
||
| public CapabilitiesMutatorService(Capabilities stereotype) { | ||
| this.stereotype = stereotype; | ||
|
|
||
| loadAllCustomMutators(); | ||
| } | ||
|
|
||
| public Capabilities getMutatedCapabilities(Capabilities desiredCapabilities) { | ||
| Objects.requireNonNull(desiredCapabilities, "desiredCapabilities must not be null"); | ||
|
There was a problem hiding this comment. Selenium is using |
||
|
|
||
| // Always apply this default capability mutator before applying any other mutator | ||
| SessionCapabilitiesMutator defaultMutator = new SessionCapabilitiesMutator(stereotype); | ||
|
There was a problem hiding this comment. The defaultMutator seems to be based off of |
||
| Capabilities newCapability = defaultMutator.apply(desiredCapabilities); | ||
|
|
||
| for (CapabilityMutator customMutator : customMutators) { | ||
| newCapability = customMutator.apply(newCapability); | ||
| } | ||
|
|
||
| return newCapability; | ||
| } | ||
|
|
||
| private void loadAllCustomMutators() { | ||
| ServiceLoader<CapabilityMutator> loader = ServiceLoader.load(CapabilityMutator.class); | ||
|
|
||
| List<CapabilityMutator> allMutators = StreamSupport.stream(loader.spliterator(), false) | ||
|
There was a problem hiding this comment. It would be good if you could create a common method that internally takes care of building a stream, sorting the collection and returning back the list. This common method should be called via the |
||
| .sorted(MUTATOR_COMPARATOR) | ||
| .collect(Collectors.toList()); | ||
|
|
||
| customMutators.addAll(allMutators); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| void setCustomMutators(List<CapabilityMutator> mutators) { | ||
| customMutators.clear(); | ||
| customMutators.addAll(mutators); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| List<CapabilityMutator> getCustomMutators() { | ||
| return customMutators; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| // Licensed to the Software Freedom Conservancy (SFC) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The SFC licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| package org.openqa.selenium.grid.node.config; | ||
|
|
||
| import org.openqa.selenium.Capabilities; | ||
|
|
||
| import java.util.function.Function; | ||
|
|
||
| public interface CapabilityMutator extends Function<Capabilities, Capabilities> { | ||
|
|
||
| default int getOrder() { | ||
| return 100; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| // Licensed to the Software Freedom Conservancy (SFC) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The SFC licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| package org.openqa.selenium.grid.node.config; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.openqa.selenium.Capabilities; | ||
| import org.openqa.selenium.ImmutableCapabilities; | ||
| import org.openqa.selenium.PersistentCapabilities; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.assertj.core.api.InstanceOfAssertFactories.LIST; | ||
| import static org.assertj.core.api.InstanceOfAssertFactories.MAP; | ||
|
|
||
| public class CapabilitiesMutatorServiceTest { | ||
|
|
||
| @Test | ||
| void applyDefaultCapabilityMutator() { | ||
| CapabilitiesMutatorService mutatorService = new CapabilitiesMutatorService(getStereotype()); | ||
| Map<String, Object> newCapabilities = mutatorService.getMutatedCapabilities(getRequirdCapabilities()).asMap(); | ||
|
|
||
| assertThat(mutatorService.getCustomMutators().size()).isEqualTo(0); | ||
|
|
||
| assertThat(newCapabilities.get("browserName")).isEqualTo("chrome"); | ||
|
|
||
| assertThat(newCapabilities) | ||
| .extractingByKey("goog:chromeOptions") | ||
| .asInstanceOf(MAP) | ||
| .extractingByKey("args") | ||
| .asInstanceOf(LIST) | ||
| .contains("incognito", "window-size=500,500"); | ||
| } | ||
|
|
||
| @Test | ||
| void applyCustomCapabilityMutator() { | ||
| CapabilitiesMutatorService mutatorService = new CapabilitiesMutatorService(getStereotype()); | ||
| mutatorService.setCustomMutators(List.of(getTestMutatorA())); | ||
|
|
||
| Capabilities newCapabilities = mutatorService.getMutatedCapabilities(getRequirdCapabilities()); | ||
|
|
||
| assertThat(mutatorService.getCustomMutators().size()).isEqualTo(1); | ||
|
|
||
| assertThat(newCapabilities.getCapability("browserName")).isEqualTo("chrome"); | ||
| assertThat(newCapabilities.getCapability("key")).isEqualTo("foo"); | ||
| } | ||
|
|
||
| @Test | ||
| void applyCustomCapabilityMutator_with_order() { | ||
| CapabilitiesMutatorService mutatorService = new CapabilitiesMutatorService(getStereotype()); | ||
| mutatorService.setCustomMutators(List.of(getTestHighOrderMutator(), getTestMutatorA())); | ||
|
|
||
| Capabilities newCapabilities = mutatorService.getMutatedCapabilities(getRequirdCapabilities()); | ||
|
|
||
| assertThat(mutatorService.getCustomMutators().size()).isEqualTo(2); | ||
|
|
||
| assertThat(newCapabilities.getCapability("browserName")).isEqualTo("chrome"); | ||
| assertThat(newCapabilities.getCapability("key")).isEqualTo("foo"); | ||
| assertThat(newCapabilities.getCapability("someKey")).isEqualTo("someValue"); | ||
| } | ||
|
|
||
| private Capabilities getStereotype() { | ||
| return new ImmutableCapabilities("browserName", "chrome"); | ||
| } | ||
|
|
||
| private Capabilities getRequirdCapabilities() { | ||
| Map<String, Object> chromeOptions = new HashMap<>(); | ||
| chromeOptions.put("args", Arrays.asList("incognito", "window-size=500,500")); | ||
|
|
||
| return new ImmutableCapabilities( | ||
| "browserName", "chrome", | ||
| "goog:chromeOptions", chromeOptions); | ||
| } | ||
|
|
||
| private CapabilityMutator getTestMutatorA() { | ||
| return capabilities -> new PersistentCapabilities(capabilities).setCapability("key", "foo"); | ||
| } | ||
|
|
||
| private CapabilityMutator getTestHighOrderMutator() { | ||
| return new CapabilityMutator() { | ||
| @Override | ||
| public Capabilities apply(Capabilities capabilities) { | ||
| return new PersistentCapabilities(capabilities) | ||
| .setCapability("key", "bar") | ||
| .setCapability("someKey", "someValue"); | ||
| } | ||
|
|
||
| @Override | ||
| public int getOrder() { | ||
| return 10; | ||
| } | ||
| }; | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the
customMutatorsis expected to be populated as soon as the object gets created. After that Its only going to be iterated upon. So do we still need aCopyOnWriteArrayList? Can we not just useArrayListinstead ?