Merge branch 'trunk' into rb_add_argument_for_websocket_port

Author: aguspe

.github/workflows/pre-release.yml

@@ -97,17 +97,19 @@ jobs:
             **Warning: Manually update the changelogs before merging**
 
             This PR:
-              * Updates Rust version for Selenium Manager release
               * Updates Pinned browser version to coincide with new CDP release
               * Adds support for new CDP version and removes old CDP version
               * Selenium Manager references the new Selenium Manager release
               * Updates Maven Dependencies
               * Adds new authors to authors file
               * Updates all versions for all bindings
               * Generates *rough* change logs for each bindings (please tidy them up before merging this)
+                  * Not all commits need to be in the change log — users do not need to see anything about building or testing Selenium
+                  * Remove references to updating versions including nightly
+                  * The code now outputs the complete body of the commit message; make sure the changelog message is complete and correct
 
-            - Auto-generated by [create-pull-request][1]
+            - This PR was auto-generated by workflow run: [release-preparation][1]
 
-            [1]: https://github.com/peter-evans/create-pull-request
+            [1]: https://github.com/SeleniumHQ/selenium/actions/runs/${{ github.run_id }}
           labels: C-build
           draft: true

README.md

@@ -201,7 +201,7 @@ for Maven to use locally by deploying to your local maven repository (`~/.m2/rep
 
 #### Updating Dependencies
 
-Dependencies are defined in the file [maven_deps.bzl](https://github.com/SeleniumHQ/selenium/blob/trunk/java/maven_deps.bzl).
+Dependencies are defined in the file [MODULE.bazel](https://github.com/SeleniumHQ/selenium/blob/trunk/MODULE.bazel).
 To automatically update and pin new dependencies, run:
 
 ```shell

Rakefile

@@ -129,7 +129,7 @@ def verify_java_release_targets
   current_targets = []
 
   Bazel.execute('query', [], query) do |output|
-    current_targets = output.lines.map(&:strip).reject(&:empty?)
+    current_targets = output.lines.map(&:strip).reject(&:empty?).select { |line| line.start_with?('//') }
   end
 
   missing_targets = current_targets - JAVA_RELEASE_TARGETS
@@ -1110,34 +1110,38 @@ namespace :all do
     commit!('Update selenium manager version', ['common/selenium_manager.bzl'])
 
     Rake::Task['java:update'].invoke
-    commit!('Update Maven Dependencies', ['java/maven_deps.bzl', 'java/maven_install.json'])
+    commit!('Update Maven Dependencies', ['MODULE.bazel', 'java/maven_install.json'])
 
     Rake::Task['authors'].invoke
     commit!('Update authors file', ['AUTHORS'])
 
     # Note that this does not include Rust version changes that are handled in separate rake:version task
     # TODO: These files are all defined in other tasks; remove duplication
     Rake::Task['all:version'].invoke(version)
-    commit!("FIX CHANGELOGS BEFORE MERGING!\n\nUpdate versions and change logs to release Selenium #{java_version}",
-            ['dotnet/CHANGELOG',
-             'dotnet/selenium-dotnet-version.bzl',
-             'java/CHANGELOG',
+    commit!("Update Version in all bindings to #{java_version}",
+            ['dotnet/selenium-dotnet-version.bzl',
              'java/version.bzl',
-             'javascript/node/selenium-webdriver/CHANGES.md',
+             'javascript/node/selenium-webdriver/BUILD.bazel',
              'javascript/node/selenium-webdriver/package.json',
              'py/docs/source/conf.py',
+             'py/pyproject.toml',
              'py/selenium/__init__.py',
              'py/selenium/webdriver/__init__.py',
              'py/BUILD.bazel',
-             'py/CHANGES',
              'rb/lib/selenium/webdriver/version.rb',
-             'rb/CHANGES',
              'rb/Gemfile.lock',
-             'rust/CHANGELOG.md',
              'rust/BUILD.bazel',
              'rust/Cargo.Bazel.lock',
              'rust/Cargo.toml',
              'rust/Cargo.lock'])
+
+    commit!("FIX CHANGELOGS BEFORE MERGING! #{java_version}",
+            ['dotnet/CHANGELOG',
+             'java/CHANGELOG',
+             'javascript/node/selenium-webdriver/CHANGES.md',
+             'py/CHANGES',
+             'rb/CHANGES',
+             'rust/CHANGELOG.md'])
   end
 
   desc 'Update all versions'
@@ -1214,16 +1218,25 @@ end
 
 def update_changelog(version, language, path, changelog, header)
   tag = previous_tag(version, language)
-  log = if language == 'javascript'
-          `git --no-pager log #{tag}...HEAD --pretty=format:"- %s" --reverse #{path}`
-        else
-          `git --no-pager log #{tag}...HEAD --pretty=format:"* %s" --reverse #{path}`
-        end
-  commits = log.split('>>>').map { |entry|
-    lines = entry.split("\n")
-    lines.reject! { |line| line.match?(/^(----|Co-authored|Signed-off)/) || line.empty? }
-    lines.join("\n")
-  }.join("\n>>>")
+  bullet = language == 'javascript' ? '- ' : '* '
+  commit_delimiter = '===DELIM==='
+  tags_to_remove = /\[(dotnet|rb|py|java|js|rust)\]:?\s?/
+
+  command = "git --no-pager log #{tag}...HEAD --pretty=format:\"%s%n%b#{commit_delimiter}\" --reverse #{path}"
+  puts "Executing git command: #{command}"
+
+  log = `#{command}`
+
+  commits = log.split(commit_delimiter).map { |commit|
+    lines = commit.gsub(tags_to_remove, '').strip.lines.map(&:chomp)
+    subject = "#{bullet}#{lines[0]}"
+
+    body = lines[1..]
+           .reject { |line| line.match?(/^(----|Co-authored|Signed-off)/) || line.empty? }
+           .map { |line| "    > #{line}" }
+           .join("\n")
+    body.empty? ? subject : "#{subject}\n#{body}"
+  }.join("\n")
 
   File.open(changelog, 'r+') do |file|
     new_content = "#{header}\n#{commits}\n\n#{file.read}"

java/src/org/openqa/selenium/bidi/module/BUILD.bazel

@@ -22,6 +22,7 @@ java_library(
         "//java/src/org/openqa/selenium/bidi/browsingcontext",
         "//java/src/org/openqa/selenium/bidi/log",
         "//java/src/org/openqa/selenium/bidi/network",
+        "//java/src/org/openqa/selenium/bidi/permissions",
         "//java/src/org/openqa/selenium/bidi/script",
         "//java/src/org/openqa/selenium/bidi/storage",
         "//java/src/org/openqa/selenium/json",

java/src/org/openqa/selenium/bidi/module/Permission.java

@@ -0,0 +1,70 @@
+// 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.bidi.module;
+
+import java.util.HashMap;
+import java.util.Map;
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.bidi.BiDi;
+import org.openqa.selenium.bidi.Command;
+import org.openqa.selenium.bidi.HasBiDi;
+import org.openqa.selenium.bidi.permissions.PermissionState;
+import org.openqa.selenium.internal.Require;
+
+public class Permission {
+
+  private final BiDi bidi;
+
+  public Permission(WebDriver driver) {
+    Require.nonNull("WebDriver", driver);
+
+    if (!(driver instanceof HasBiDi)) {
+      throw new IllegalArgumentException("WebDriver instance must support BiDi protocol");
+    }
+
+    this.bidi = ((HasBiDi) driver).getBiDi();
+  }
+
+  public void setPermission(
+      Map<String, String> permissionDescriptor, PermissionState state, String origin) {
+    this.setPermission(permissionDescriptor, state, origin, null);
+  }
+
+  public void setPermission(
+      Map<String, String> permissionDescriptor,
+      PermissionState state,
+      String origin,
+      String userContext) {
+    Require.nonNull("Permission descriptor", permissionDescriptor);
+    Require.nonNull("Permission state", state);
+    Require.nonNull("Origin", origin);
+
+    Map<String, Object> params =
+        new HashMap<>(
+            Map.of(
+                "descriptor", permissionDescriptor,
+                "state", state.toString(),
+                "origin", origin));
+
+    if (userContext != null) {
+      params.put("userContext", userContext);
+    }
+
+    this.bidi.send(new Command<>("permissions.setPermission", params));
+  }
+}

java/src/org/openqa/selenium/bidi/permissions/BUILD.bazel

@@ -0,0 +1,17 @@
+load("//java:defs.bzl", "java_library")
+
+java_library(
+    name = "permissions",
+    srcs = glob(
+        [
+            "*.java",
+        ],
+    ),
+    visibility = [
+        "//java/src/org/openqa/selenium/bidi:__subpackages__",
+        "//java/src/org/openqa/selenium/firefox:__subpackages__",
+        "//java/src/org/openqa/selenium/remote:__pkg__",
+        "//java/test/org/openqa/selenium/bidi:__subpackages__",
+        "//java/test/org/openqa/selenium/grid:__subpackages__",
+    ],
+)

java/src/org/openqa/selenium/bidi/permissions/PermissionState.java

@@ -0,0 +1,46 @@
+// 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.bidi.permissions;
+
+public enum PermissionState {
+  GRANTED("granted"),
+  DENIED("denied"),
+  PROMPT("prompt");
+
+  private final String state;
+
+  PermissionState(String state) {
+    this.state = state;
+  }
+
+  @Override
+  public String toString() {
+    return state;
+  }
+
+  public static PermissionState findByName(String name) {
+    PermissionState result = null;
+    for (PermissionState state : values()) {
+      if (state.toString().equalsIgnoreCase(name)) {
+        result = state;
+        break;
+      }
+    }
+    return result;
+  }
+}

java/src/org/openqa/selenium/remote/BUILD.bazel

@@ -31,6 +31,7 @@ java_export(
         "//java/src/org/openqa/selenium/bidi/log",
         "//java/src/org/openqa/selenium/bidi/module",
         "//java/src/org/openqa/selenium/bidi/network",
+        "//java/src/org/openqa/selenium/bidi/permissions",
         "//java/src/org/openqa/selenium/bidi/script",
         "//java/src/org/openqa/selenium/bidi/storage",
         "//java/src/org/openqa/selenium/devtools",

java/test/org/openqa/selenium/bidi/input/BUILD.bazel

@@ -22,6 +22,7 @@ java_selenium_test_suite(
         "//java/src/org/openqa/selenium/bidi/log",
         "//java/src/org/openqa/selenium/bidi/module",
         "//java/src/org/openqa/selenium/bidi/network",
+        "//java/src/org/openqa/selenium/bidi/permissions",
         "//java/src/org/openqa/selenium/bidi/script",
         "//java/src/org/openqa/selenium/chrome",
         "//java/src/org/openqa/selenium/firefox",

java/test/org/openqa/selenium/bidi/permissions/BUILD.bazel

@@ -0,0 +1,39 @@
+load("@rules_jvm_external//:defs.bzl", "artifact")
+load("//java:defs.bzl", "JUNIT5_DEPS", "java_selenium_test_suite")
+
+java_selenium_test_suite(
+    name = "large-tests",
+    size = "large",
+    srcs = glob(["*Test.java"]),
+    browsers = [
+        "firefox",
+    ],
+    data = [
+        "//third_party/chrome_ext:backspace.crx",
+    ],
+    tags = [
+        "selenium-remote",
+    ],
+    deps = [
+        "//java/src/org/openqa/selenium/bidi",
+        "//java/src/org/openqa/selenium/bidi/browsingcontext",
+        "//java/src/org/openqa/selenium/bidi/log",
+        "//java/src/org/openqa/selenium/bidi/module",
+        "//java/src/org/openqa/selenium/bidi/network",
+        "//java/src/org/openqa/selenium/bidi/script",
+        "//java/src/org/openqa/selenium/chrome",
+        "//java/src/org/openqa/selenium/firefox",
+        "//java/src/org/openqa/selenium/json",
+        "//java/src/org/openqa/selenium/remote",
+        "//java/src/org/openqa/selenium/support",
+        "//java/test/org/openqa/selenium:helpers",
+        "//java/test/org/openqa/selenium/build",
+        "//java/test/org/openqa/selenium/environment",
+        "//java/test/org/openqa/selenium/testing:annotations",
+        "//java/test/org/openqa/selenium/testing:test-base",
+        "//java/test/org/openqa/selenium/testing/drivers",
+        artifact("org.junit.jupiter:junit-jupiter-api"),
+        artifact("org.assertj:assertj-core"),
+        artifact("org.mockito:mockito-core"),
+    ] + JUNIT5_DEPS,
+)