Selenium用于测试Web自动化框架和生态系统
Selenium
自动化浏览器。就是这样！
Selenium 是一个涵盖各种工具和库的综合项目，用于实现 Web 浏览器自动化。Selenium 特别为 W3C WebDriver 规范 提供了基础架构，该规范是一个与平台和语言无关的编码接口，兼容所有主流 Web 浏览器。
该项目的实现离不开志愿者贡献者，他们慷慨地投入了数千小时的代码开发和维护。
本 README 适用于有意为该项目做出贡献的开发者。如果您希望开始使用 Selenium，请查看我们的 用户手册，获取详细的示例和说明；如果您遇到问题，可以通过多种方式 获取帮助。
安装
创建您自己的本地开发环境以贡献 Selenium 所需的条件如下。
所有平台
- Bazelisk，一个 Bazel 包装器，它会自动下载
.bazelversion文件中指定的 Bazel 版本，并将所有
命令行参数透明地传递给真正的 Bazel 二进制文件。 - Java JDK 17 或更高版本（例如，Java 17 Temurin)
- 将
JAVA_HOME环境变量设置为 Java 可执行文件的位置（JDK 而不是 JRE） - 要测试这一点，请尝试运行命令
javac。如果您只安装了 JRE，则此命令将不存在。
如果您看到命令行选项列表，则表示您正确引用了 JDK。
- 将
MacOS
- Xcode 包含命令行工具。使用
xcode-select --install安装最新版本。 - 适用于 Apple Silicon Mac 的 Rosetta。将
build --host_platform=//:rosetta添加到.bazelrc.local文件。我们正在努力
确保长期不需要执行此操作。
Windows
几年前，Jim Evans 发表了一篇很棒的文章，主题是为 Selenium .NET 语言绑定设置 Windows 开发环境；这篇文章虽然已经过时，但其中包含了更详细的描述和截图，可能会对一些人有所帮助。
替代开发环境
如果您想为项目做出贡献，但又不想搭建自己的本地开发环境，有两种替代方案可供选择。
使用 GitPod
GitPod 无需您自行创建本地开发环境，而是提供了一个现成的开发环境。
使用开发容器
您也可以构建一个开发容器，它本质上是一个 Docker 容器，适用于使用 .devcontainer 目录中的 devcontainer.json 文件构建和测试 Selenium。VS Code 或 IntelliJ IDEA 等支持 IDE 应该会指导您如何创建这样的容器。
使用 Docker 镜像
您还可以使用 dev image 目录中的 Dockerfile 构建一个适用于构建和测试 Selenium 的 Docker 镜像。
构建
Selenium 使用名为 Bazel 的通用构建工具进行构建，以便我们能够轻松管理依赖项下载、生成所需的二进制文件、构建和发布软件包以及执行测试；所有这些都以快速、高效的方式进行。有关更详细的讨论，请阅读 Simon Stewart关于构建 Selenium 的文章。
我们经常使用自定义的 Rake 包装器来包装 Bazel 命令。这些命令通过 ./go 命令运行。
常用的 Bazel 命令有：
bazel build— 评估依赖项、编译源文件并为指定目标生成输出文件。
它用于创建可执行二进制文件、库或其他工件。bazel run— 构建目标并执行。
它通常用于生成可执行二进制文件的目标。bazel test— 在上下文中构建并运行目标，并提供附加测试功能。bazel query— 识别指定路径的可用目标。
每个可构建的模块都定义在 BUILD.bazel 文件中。要执行模块，您需要以// 开头引用它，然后包含定义它的文件的相对路径，接着是 :，最后是目标的名称。
例如，构建网格的目标名为“executable-grid”，它
在“selenium/java/src/org/openqa/selenium/grid/BAZEL.build”文件中定义。
因此，要构建网格，您需要运行：bazel build //java/src/org/openqa/selenium/grid:executable-grid。
Bazel 文档提供了一个便捷指南，其中包含各种快捷方式以及构建多个目标的所有方法，Selenium 经常使用这些方法。
要为给定语言构建所有内容：
bazel build //<language>/...如果仅构建网格，可以使用别名（日志将显示输出 jar 所在的位置）：
bazel build grid为了更简单，可以使用此 ./go 命令构建每个绑定：
./go <language>:build开发
Java
IntelliJ
团队中的大多数人使用 IntelliJ 进行日常编辑。如果您正在使用 IntelliJ，我们强烈建议您安装 Bazel IJ插件，其文档位于其官方网站。
要将 Selenium 与 IntelliJ Bazel 插件配合使用，请将代码库导入为 Bazel 项目，然后从 scripts 目录中选择项目视图文件。Mac/Linux 系统使用 ij.bazelproject，Windows 系统使用 ij-win.bazelproject。
Linting
我们也使用 Google Java Format 进行 Linting，因此使用 Google Java Formatter 插件会很有用；要使其正常工作，需要几个步骤，因此请阅读其配置文档。还有一个可以运行的自动格式化脚本：./scripts/format.sh
本地安装
虽然 Selenium 不是使用 Maven 构建的，但您可以构建并安装 Selenium 组件
供 Maven 使用，方法是将其部署到本地 Maven 仓库 (~/.m2/repository)，使用以下命令：
./go java:install更新依赖项
依赖项在文件 MODULE.bazel 中定义。
要更新依赖项，请修改 MODULE.bazel 文件中的版本，然后运行：
RULES_JVM_EXTERNAL_REPIN=1 bazel run @maven//:pin要自动更新并固定新的依赖项，请运行：
./go java:updatePython
代码检查和格式化
我们遵循 PEP8 Python 代码风格指南（除了我们使用 120 个字符的行长）。我们使用 linting/formatting 工具 ruff 进行检查和强制执行。此外，还有一个可以运行的自动格式化脚本：./scripts/format.sh
本地安装
要在本地运行 Python 代码而不构建/安装包，您必须首先安装依赖项：
pip install -r py/requirements.txt然后，构建生成的文件并将其复制到本地源代码树中：
./go py:local_dev之后，您可以直接从源代码中的 py 目录导入 selenium 包。除了从源代码运行，您还可以在本地构建并安装 Selenium 包 (wheel)：
./go py:install这将尝试安装到全局 Python site-packages 目录中，该目录可能不可写。为避免这种情况，您应该在安装之前创建并激活一个虚拟环境。
Ruby
除了使用 irb，您还可以使用 bazel run //rb:console 命令创建一个加载了所有 gem 的交互式 REPL。如果您想调试代码，可以使用 debug gem 进行调试：
- 在您希望调试器启动的代码中添加
binding.break。 - 使用
ruby_debug配置运行测试：bazel test --config ruby_debug <test>。 - 调试器启动后，在单独的终端中运行以下命令连接到调试器：
bazel-selenium/external/bundle/bin/rdbg -A如果您想使用 RubyMine 进行开发，您可以使用 Bazel 工件进行配置：
- 打开
rb/作为主项目目录。 - 根据需要运行
bundle exec rake update来创建最新的工件。如果此命令无效，请从selenium（父目录）运行./go rb:update。 - 在 设置 / 语言和框架 / Ruby SDK 和 Gems 中，添加新的 解释器，指向
../bazel-selenium/external/rules_ruby_dist/dist/bin/ruby。 - 现在您应该能够运行和调试任何规范。它默认使用 Chrome，但您可以使用下面 Ruby 测试 部分中指定的环境变量进行更改。
Rust
要使 Carbo.Bazel.lock 与 Cargo.lock 保持同步，请运行：
CARGO_BAZEL_REPIN=true bazel sync --only=crates测试
Bazel 有许多专门用于测试的配置。
常用选项示例
以下是我们在测试 Selenium 代码时使用的参数示例：
--pin_browsers- 运行构建中定义的特定浏览器版本（版本会定期更新）--headless- 以无头模式运行浏览器（Chrome、Edge 和 Firefox 支持）--flaky_test_attempts 3- 最多重新运行 3 次失败的测试--local_test_jobs 1- 控制测试的并行度--cache_test_results=no,-t-- 禁用测试结果缓存并重新运行所有测试--test_output all- 打印测试的所有输出，而不仅仅是错误--test_output streamed- 逐个运行所有测试并立即打印其输出--test_env FOO=bar- 将额外的环境变量传递给测试进程--run_under="xvfb-run" -a"- 执行前插入的前缀
过滤
Selenium 测试可以按大小进行过滤：
- small — 通常是不打开浏览器的单元测试
- large — 通常是实际驱动浏览器的测试
- medium — 比简单的单元测试更复杂，但并非完全驱动浏览器的测试
可以使用 test_size_filters 参数进行过滤，如下所示：
bazel test //<language>/... --test_size_filters=small测试也可以按标签进行过滤，如下所示：
bazel test //<language>/... --test_tag_filters=this,-not-this如果有多个 --test_tag_filters，则只考虑最后一个，因此，如果还使用继承的配置，请谨慎使用。
Java
点击查看 Java 测试命令
运行单元测试：
bazel test //java/... --test_size_filters=small运行集成测试：
bazel test //java/... --test_size_filters=medium运行浏览器测试：
bazel test //java/... --test_size_filters=large --test_tag_filters=<browser>运行特定测试：
bazel test //java/test/org/openqa/selenium/chrome:ChromeDriverFunctionalTestJavaScript
点击查看 JavaScript 测试命令
要运行测试，请运行：
bazel test //javascript/selenium-webdriver:all您可以使用 --test_env 将浏览器名称设置为 SELENIUM_BROWSER。
bazel test //javascript/selenium-webdriver:all --test_env=SELENIUM_BROWSER=firefoxPython
点击查看 Python 测试命令
使用以下命令运行单元测试：
bazel test //py:unit使用特定浏览器运行常见测试：
bazel test //py:common-<browsername>使用特定浏览器运行常见测试（包括 BiDi 测试）：
bazel test //py:common-<browsername>-bidi使用特定浏览器运行测试：
bazel test //py:test-<browsername>运行所有 Python 测试：
bazel test //py:allRust
点击查看 Rust 测试命令
Rust 测试使用以下命令行运行：
bazel test //rust/...Linux
点击查看 Linux 测试要求
默认情况下，Bazel 会在您当前的 X-server 界面中运行这些测试。如果您愿意，
也可以在虚拟或嵌套的 X-server 中运行它们。
- 运行 X 服务器
Xvfb :99或Xnest :99 - 运行窗口管理器，例如
DISPLAY=:99 jwm - 运行您感兴趣的测试：
bazel test --test_env=DISPLAY=:99 //java/... --test_tag_filters=chrome在虚拟 X 服务器中运行测试的一种简单方法是使用 Bazel 的 --run_under 功能：
bazel test --run_under="xvfb-run -a" //java/...文档
API 文档可在此处找到：
更新特定语言的 API 文档：./go <language>:docs
更新所有文档：./go all:docs
发布
发布是构建和发布的结合，通常需要协调多个执行，以及额外的处理。正如构建 部分所述，我们使用 Rake 任务和 ./go 命令来完成这些操作。这些 ./go 命令包含 --stamp 参数，用于提供有关已构建资产的必要信息。
您可以使用以下命令构建和发布所有内容：
./go all:release要构建和发布特定语言的资源：
./go <language>:release如果您有权访问 Selenium EngFlow 代码库，您可以使用以下命令远程构建资产并将其下载到本地：
./go all:release['--config', 'release']