Rakefile

# -*- mode: ruby -*-

$LOAD_PATH.unshift File.expand_path(".")

require 'rake'
require 'rake_tasks/files'
require 'net/telnet'
require 'stringio'
require 'fileutils'

include Rake::DSL

Rake.application.instance_variable_set "@name", "go"
orig_verbose = verbose
verbose(false)

# The CrazyFun build grammar. There's no magic here, just ruby
require 'rake_tasks/crazy_fun/main'
require 'rake_tasks/selenium_rake/detonating_handler'
require 'rake_tasks/selenium_rake/crazy_fun'

require 'rake_tasks/crazy_fun/mappings/export'
require 'rake_tasks/crazy_fun/mappings/folder'
require 'rake_tasks/crazy_fun/mappings/javascript'
require 'rake_tasks/crazy_fun/mappings/rake'
require 'rake_tasks/crazy_fun/mappings/rename'
require 'rake_tasks/crazy_fun/mappings/ruby'

# Location of all new methods
require 'rake_tasks/selenium_rake/c_tasks'
require 'rake_tasks/selenium_rake/checks'
require 'rake_tasks/selenium_rake/ie_code_generator'
require 'rake_tasks/selenium_rake/java_formatter'
require 'rake_tasks/selenium_rake/cpp_formatter'
require 'rake_tasks/selenium_rake/type_definitions_generator'

# Our modifications to the Rake library
require 'rake_tasks/rake/task'

$DEBUG = orig_verbose != Rake::FileUtilsExt::DEFAULT ? true : false
$DEBUG = true if ENV['debug'] == 'true'

verbose($DEBUG)

def release_version
  "4.0"
end

def google_storage_version
  "4.0-alpha"
end

def version
  "#{release_version}.0-alpha-3"
end

# The build system used by webdriver is layered on top of rake, and we call it
# "crazy fun" for no readily apparent reason.

# First off, create a new CrazyFun object.
crazy_fun = SeleniumRake::CrazyFun.new

# Secondly, we add the handlers, which are responsible for turning a build
# rule into a (series of) rake tasks. For example if we're looking at a file
# in subdirectory "subdir" contains the line:
#
# java_library(:name => "example", :srcs => ["foo.java"])
#
# we would generate a rake target of "//subdir:example" which would generate
# a Java JAR at "build/subdir/example.jar".
#
# If crazy fun doesn't know how to handle a particular output type ("java_library"
# in the example above) then it will throw an exception, stopping the build
RakeMappings.new.add_all(crazy_fun)
RubyMappings.new.add_all(crazy_fun)

# Finally, find every file named "build.desc" in the project, and generate
# rake tasks from them. These tasks are normal rake tasks, and can be invoked
# from rake.
crazy_fun.create_tasks(Dir["common/**/build.desc"])
crazy_fun.create_tasks(Dir["rb/**/build.desc"])

# If it looks like a bazel target, build it with bazel
rule /\/\/.*/ do |task|
  task.out = Bazel::execute("build", ["--workspace_status_command", "scripts/build-info.py"], task.name)
end

# Spoof tasks to get CI working with bazel
task '//java/client/test/org/openqa/selenium/environment/webserver:webserver:uber' => [
  '//java/client/test/org/openqa/selenium/environment:webserver'
]

# Java targets required for release. These should all be java_export targets.
# Generated from: bazel query 'kind(.*_publish, set(//java/... //third_party/...))'
JAVA_RELEASE_TARGETS = %w(
  //java/server/src/org/openqa/selenium/grid:grid-publish
  //java/server/src/com/thoughtworks/selenium/webdriven:webdriven-publish
  //java/client/src/org/openqa/selenium/support:support-publish
  //java/client/src/org/openqa/selenium/safari:safari-publish
  //java/client/src/org/openqa/selenium/remote/http:http-publish
  //java/client/src/org/openqa/selenium/remote:remote-publish
  //java/client/src/org/openqa/selenium/opera:opera-publish
  //java/client/src/org/openqa/selenium/lift:lift-publish
  //java/client/src/org/openqa/selenium/json:json-publish
  //java/client/src/org/openqa/selenium/ie:ie-publish
  //java/client/src/org/openqa/selenium/firefox/xpi:xpi-publish
  //java/client/src/org/openqa/selenium/firefox:firefox-publish
  //java/client/src/org/openqa/selenium/edge/edgehtml:edgehtml-publish
  //java/client/src/org/openqa/selenium/edge:edgeium-publish
  //java/client/src/org/openqa/selenium/devtools:devtools-publish
  //java/client/src/org/openqa/selenium/chromium:chromium-publish
  //java/client/src/org/openqa/selenium/chrome:chrome-publish
  //java/client/src/org/openqa/selenium:core-publish
  //java/client/src/org/openqa/selenium:client-combined-publish
)

# Notice that because we're using rake, anything you can do in a normal rake
# build can also be done here. For example, here we set the default task
task :default => [:test]

task :all => [
  :"selenium-java",
  "//java/client/test/org/openqa/selenium/environment:webserver"
]
task :all_zip => [:'prep-release-zip']
task :tests => [
  "//java/client/test/org/openqa/selenium/htmlunit:htmlunit",
  "//java/client/test/org/openqa/selenium/firefox:test-synthesized",
  "//java/client/test/org/openqa/selenium/ie:ie",
  "//java/client/test/org/openqa/selenium/chrome:chrome",
  "//java/client/test/org/openqa/selenium/edge:edge",
  "//java/client/test/org/openqa/selenium/opera:opera",
  "//java/client/test/org/openqa/selenium/support:small-tests",
  "//java/client/test/org/openqa/selenium/support:large-tests",
  "//java/client/test/org/openqa/selenium/remote:small-tests",
  "//java/server/test/org/openqa/selenium/remote/server/log:test",
  "//java/server/test/org/openqa/selenium/remote/server:small-tests",
]
task :chrome => [ "//java/client/src/org/openqa/selenium/chrome" ]
task :grid => [ :'selenium-server-standalone' ]
task :ie => [ "//java/client/src/org/openqa/selenium/ie" ]
task :firefox => [ "//java/client/src/org/openqa/selenium/firefox" ]
task :'debug-server' => "//java/client/test/org/openqa/selenium/environment:webserver:run"
task :remote => [:remote_server, :remote_client]
task :remote_client => ["//java/client/src/org/openqa/selenium/remote"]
task :remote_server => ["//java/server/src/org/openqa/selenium/remote/server"]
task :safari => [ "//java/client/src/org/openqa/selenium/safari" ]
task :selenium => [ "//java/client/src/org/openqa/selenium:core" ]
task :support => [
  "//java/client/src/org/openqa/selenium/lift",
  "//java/client/src/org/openqa/selenium/support",
]

desc 'Build the standalone server'
task 'selenium-server-standalone' => '//java/server/src/org/openqa/selenium/grid:selenium_server_deploy.jar'

task :test_javascript => [
  'calcdeps',
  '//javascript/atoms:atoms-chrome:run',
  '//javascript/webdriver:webdriver-chrome:run',
  '//javascript/selenium-atoms:selenium-atoms-chrome:run',
  '//javascript/selenium-core:selenium-core-chrome:run']
task :test_chrome => [ "//java/client/test/org/openqa/selenium/chrome:chrome:run" ]
task :test_edge => [ "//java/client/test/org/openqa/selenium/edge:edge:run" ]
task :test_chrome_atoms => [
  '//javascript/atoms:test_chrome:run',
  '//javascript/chrome-driver:test:run',
  '//javascript/webdriver:test_chrome:run']
task :test_htmlunit => [
  "//java/client/test/org/openqa/selenium/htmlunit:htmlunit:run"
]
task :test_grid => [
  "//java/server/test/org/openqa/grid/common:common:run",
  "//java/server/test/org/openqa/grid:grid:run",
  "//java/server/test/org/openqa/grid/e2e:e2e:run",
  "//java/client/test/org/openqa/selenium/remote:remote-driver-grid-tests:run",
]
task :test_ie => [
  "//cpp/iedriverserver:win32",
  "//cpp/iedriverserver:x64",
  "//java/client/test/org/openqa/selenium/ie:ie:run"
]
task :test_jobbie => [ :test_ie ]
task :test_firefox => [ "//java/client/test/org/openqa/selenium/firefox:marionette:run" ]
task :test_opera => [ "//java/client/test/org/openqa/selenium/opera:opera:run" ]
task :test_remote_server => [
   '//java/server/test/org/openqa/selenium/remote/server:small-tests:run',
   '//java/server/test/org/openqa/selenium/remote/server/log:test:run',
]
task :test_remote => [
  '//java/client/test/org/openqa/selenium/json:small-tests:run',
  '//java/client/test/org/openqa/selenium/remote:common-tests:run',
  '//java/client/test/org/openqa/selenium/remote:client-tests:run',
  '//java/client/test/org/openqa/selenium/remote:remote-driver-tests:run',
  :test_remote_server
]
task :test_safari => [ "//java/client/test/org/openqa/selenium/safari:safari:run" ]
task :test_support => [
  "//java/client/test/org/openqa/selenium/lift:lift:run",
  "//java/client/test/org/openqa/selenium/support:small-tests:run",
  "//java/client/test/org/openqa/selenium/support:large-tests:run"
]

# TODO(simon): test-core should go first, but it's changing the least for now.
task :test_selenium => [ :'test-rc']
task :'test-rc' => ['//java/client/test/com/thoughtworks/selenium:firefox-rc-test:run']
task :'test-rc' => ['//java/client/test/com/thoughtworks/selenium:ie-rc-test:run'] if SeleniumRake::Checks.windows?

task :test_java_webdriver => [
  :test_htmlunit,
  :test_firefox,
  :test_remote_server,
]

task :test_java_webdriver => [:test_ie] if SeleniumRake::Checks.windows?
task :test_java_webdriver => [:test_chrome] if SeleniumRake::Checks.present?("chromedriver")
task :test_java_webdriver => [:test_edge] if SeleniumRake::Checks.present?("msedgedriver")
task :test_java_webdriver => [:test_opera] if SeleniumRake::Checks.opera?

task :test_java => [
  "//java/client/test/org/openqa/selenium/atoms:test:run",
  :test_java_small_tests,
  :test_support,
  :test_java_webdriver,
  :test_selenium,
  "test_grid",
]

task :test_java_small_tests => [
  "//java/client/test/org/openqa/selenium:small-tests:run",
  "//java/client/test/org/openqa/selenium/json:small-tests:run",
  "//java/client/test/org/openqa/selenium/support:small-tests:run",
  "//java/client/test/org/openqa/selenium/remote:common-tests:run",
  "//java/client/test/org/openqa/selenium/remote:client-tests:run",
  "//java/server/test/org/openqa/grid/selenium/node:node:run",
  "//java/server/test/org/openqa/grid/selenium/proxy:proxy:run",
  "//java/server/test/org/openqa/selenium/remote/server:small-tests:run",
  "//java/server/test/org/openqa/selenium/remote/server/log:test:run",
]

task :test_rb => ["//rb:unit-test", :test_rb_local, :test_rb_remote]

task :test_rb_local => [
  "//rb:chrome-test",
  "//rb:firefox-test",
  ("//rb:safari-preview-test" if SeleniumRake::Checks.mac?),
  ("//rb:safari-test" if SeleniumRake::Checks.mac?),
  ("//rb:ie-test" if SeleniumRake::Checks.windows?),
  ("//rb:edge-test" if SeleniumRake::Checks.windows?)
].compact

task :test_rb_remote => [
  "//rb:remote-chrome-test",
  "//rb:remote-firefox-test",
  ("//rb:remote-safari-test" if SeleniumRake::Checks.mac?),
  ("//rb:remote-ie-test" if SeleniumRake::Checks.windows?),
  ("//rb:remote-edge-test" if SeleniumRake::Checks.windows?)
].compact

task :test_py => [ :py_prep_for_install_release, "py:marionette_test" ]
task :test => [ :test_javascript, :test_java, :test_rb ]
task :test => [ :test_py ] if SeleniumRake::Checks.python?
task :build => [:all, :firefox, :remote, :selenium, :tests]

desc 'Clean build artifacts.'
task :clean do
  rm_rf 'build/'
  rm_rf 'java/client/build/'
  rm_rf 'dist/'
end

# Create a new IEGenerator instance
ie_generator = SeleniumRake::IEGenerator.new

# Generate a C++ Header file for mapping between magic numbers and #defines
# in the C++ code.
ie_generator.ie_generate_type_mapping(
  :name => "ie_result_type_cpp",
  :src => "cpp/iedriver/result_types.txt",
  :type => "cpp",
  :out => "cpp/iedriver/IEReturnTypes.h"
)

task :javadocs => [:common, :firefox, :ie, :remote, :support, :chrome, :selenium] do
  rm_rf "build/javadoc"
  mkdir_p "build/javadoc"
   sourcepath = ""
   classpath = '.'
   Dir["third_party/java/*/*.jar"].each do |jar|
     classpath << ":" + jar unless jar.to_s =~ /.*-src.*\.jar/
   end
   [File.join(%w(java client src))].each do |m|
     sourcepath += File::PATH_SEPARATOR + m
   end
   [File.join(%w(java server src))].each do |m|
     sourcepath += File::PATH_SEPARATOR + m
   end

   p sourcepath
   cmd = "javadoc -notimestamp -d build/javadoc -sourcepath #{sourcepath} -classpath #{classpath} -subpackages org.openqa.selenium -subpackages com.thoughtworks "
   cmd << " -exclude org.openqa.selenium.internal.selenesedriver:org.openqa.selenium.internal.seleniumemulation:org.openqa.selenium.remote.internal"

   if SeleniumRake::Checks.windows?
     cmd = cmd.gsub(/\//, "\\").gsub(/:/, ";")
   end
   sh cmd

   File.open("build/javadoc/stylesheet.css", "a") { |file| file.write(<<EOF

/* Custom selenium-specific styling */
.blink {
  animation: 2s cubic-bezier(0.5, 0, 0.85, 0.85) infinite blink;
}

@keyframes blink {
  50% {
    opacity: 0;
  }
}

EOF
)
   }
end

task :py_prep_for_install_release => [
  :chrome,
  "py:prep"
]

task :py_docs => "py:docs"
task :py_install =>  "py:install"

task :py_release => :py_prep_for_install_release do
  sh "python setup.py sdist bdist_wheel upload"
end

file "cpp/iedriver/sizzle.h" => [ "//third_party/js/sizzle:sizzle:header" ] do
  cp "build/third_party/js/sizzle/sizzle.h", "cpp/iedriver/sizzle.h"
end

task :sizzle_header => [ "cpp/iedriver/sizzle.h" ]

task :ios_driver => [
  "//javascript/atoms/fragments:get_visible_text:ios",
  "//javascript/atoms/fragments:click:ios",
  "//javascript/atoms/fragments:back:ios",
  "//javascript/atoms/fragments:forward:ios",
  "//javascript/atoms/fragments:submit:ios",
  "//javascript/atoms/fragments:xpath:ios",
  "//javascript/atoms/fragments:xpaths:ios",
  "//javascript/atoms/fragments:type:ios",
  "//javascript/atoms/fragments:get_attribute:ios",
  "//javascript/atoms/fragments:clear:ios",
  "//javascript/atoms/fragments:is_selected:ios",
  "//javascript/atoms/fragments:is_enabled:ios",
  "//javascript/atoms/fragments:is_shown:ios",
  "//javascript/atoms/fragments:stringify:ios",
  "//javascript/atoms/fragments:link_text:ios",
  "//javascript/atoms/fragments:link_texts:ios",
  "//javascript/atoms/fragments:partial_link_text:ios",
  "//javascript/atoms/fragments:partial_link_texts:ios",
  "//javascript/atoms/fragments:get_interactable_size:ios",
  "//javascript/atoms/fragments:scroll_into_view:ios",
  "//javascript/atoms/fragments:get_effective_style:ios",
  "//javascript/atoms/fragments:get_element_size:ios",
  "//javascript/webdriver/atoms/fragments:get_location_in_view:ios"
]

task :'prep-release-zip' => [
  '//java/client/src/org/openqa/selenium:client-zip',
  '//java/server/src/org/openqa/selenium/grid:server-zip',
  '//java/server/src/org/openqa/selenium/grid:selenium_server_deploy.jar',
  '//java/server/src/org/openqa/selenium/server/htmlrunner:selenium-runner_deploy.jar'] do

  ["build/dist/selenium-server-#{version}.zip", "build/dist/selenium-java-#{version}.zip",
   "build/dist/selenium-server-#{version}.jar", "build/dist/selenium-html-runner-#{version}.jar"].each do |f|
    rm_f(f) if File.exists?(f)
  end

  mkdir_p "build/dist"
  File.delete()
  cp Rake::Task['//java/server/src/org/openqa/selenium/grid:server-zip'].out, "build/dist/selenium-server-#{version}.zip", preserve: false
  chmod 0666, "build/dist/selenium-server-#{version}.zip"
  cp Rake::Task['//java/client/src/org/openqa/selenium:client-zip'].out, "build/dist/selenium-java-#{version}.zip", preserve: false
  chmod 0666, "build/dist/selenium-java-#{version}.zip"
  cp Rake::Task['//java/server/src/org/openqa/selenium/grid:selenium_server_deploy.jar'].out, "build/dist/selenium-server-#{version}.jar", preserve: false
  chmod 0666, "build/dist/selenium-server-#{version}.jar"
  cp Rake::Task['//java/server/src/org/openqa/selenium/server/htmlrunner:selenium-runner_deploy.jar'].out, "build/dist/selenium-html-runner-#{version}.jar", preserve: false
  chmod 0666, "build/dist/selenium-html-runner-#{version}.jar"
end

task :'release-java' => [:'publish-maven', :'push-release']

def read_user_pass_from_m2_settings
    settings = File.read(ENV['HOME'] + "/.m2/settings.xml")
    found_section = false
    user = nil
    pass = nil
    settings.each_line do |line|
        if !found_section
            found_section = line.include? "<id>sonatype-nexus-staging</id>"
        else
            if user == nil and line.include? "<username>"
              user = line.split("<username>")[1].split("</")[0]
            elsif pass == nil and line.include? "<password>"
              pass = line.split("<password>")[1].split("</")[0]
            end
        end
    end

    return [user, pass]
end

task :'publish-maven' => JAVA_RELEASE_TARGETS + %w(//java/server/src/org/openqa/selenium/server/htmlrunner:selenium-runner_deploy.jar) do
  puts "\n Enter Passphrase:"
  passphrase = STDIN.gets.chomp

  creds = read_user_pass_from_m2_settings()
  JAVA_RELEASE_TARGETS.each do |p|
    Bazel::execute('run', ["--workspace_status_command=\"#{py_exe} scripts/build-info.py\"", '--stamp', '--define', 'maven_repo=https://oss.sonatype.org/service/local/staging/deploy/maven2', '--define', "maven_user=#{creds[0]}", '--define', "maven_password=#{creds[1]}", '--define', "gpg_password=#{passphrase}"], p)
  end
end

task :'maven-install' do
  JAVA_RELEASE_TARGETS.each do |p|
    Bazel::execute('run', ["--workspace_status_command=\"#{py_exe} scripts/build-info.py\"", '--stamp', '--define', "maven_repo=file://#{ENV['HOME']}/.m2/repository"], p)
  end
end

task :'push-release' => [:'prep-release-zip'] do
  py = "java -jar third_party/py/jython.jar"
  py = "python" if SeleniumRake::Checks.python?

  sh "#{py} third_party/py/googlestorage/publish_release.py --project_id google.com:webdriver --bucket selenium-release --acl public-read --publish_version #{google_storage_version} --publish build/dist/selenium-server-#{version}.jar --publish build/dist/selenium-java-#{version}.zip --publish build/dist/selenium-server-#{version}.jar --publish build/dist/selenium-html-runner-#{version}.jar"
end

desc 'Build the selenium client jars'
task 'selenium-java' => '//java/client/src/org/openqa/selenium:client-combined'

namespace :safari do
  desc "Build the SafariDriver java client"
  task :build => [
    "//java/client/src/org/openqa/selenium/safari"
  ]
end

task :authors do
  puts "Generating AUTHORS file"
  sh "(git log --use-mailmap --format='%aN <%aE>' ; cat .OLD_AUTHORS) | sort -uf > AUTHORS"
end

namespace :ci do
  task :upload_to_sauce do
    upload_path = ENV['UPLOAD_PATH']
    username = ENV['SAUCE_USERNAME']
    apikey = ENV['SAUCE_APIKEY']
    upload_filename = Pathname.new(upload_path).basename
    upload_url = "http://saucelabs.com/rest/v1/storage/#{username}/#{upload_filename}"
    body = nil

    File.open(find_file(upload_path), 'r') do |infile|
      body = infile.read
    end

    6.times do
      uri = URI.parse(upload_url)
      request = Net::HTTP::Post.new(uri.request_uri)
      request.basic_auth(username, apikey)
      request['Content-Type'] = 'application/octet-stream'
      request.body = body
      http = net_http.new(uri.host, uri.port)
      http.read_timeout = 60 * 5 # 5 min
      begin
        response = http.request(request)
      rescue StandardError => e
        puts "issue uploading file: #{e}"
        next
      end
      metadata = JSON.parse(response.body)
      local_digest = Digest::MD5.hexdigest(body)
      if metadata['md5'] == local_digest
        puts "file successfully uploaded: #{metadata['filename']}"
      else
        puts "issues uploading file: #{response.code} - #{response.body}"
      end
      break
    end
    raise 'failed to upload to saucelabs after numerous retries'
  end
end

# Required for above ci:upload_to_sauce rake only
require 'uri'
require 'net/http'
require 'digest/md5'
require 'json'
require 'pathname'

def net_http
  http_proxy = ENV['http_proxy'] || ENV['HTTP_PROXY']
  if http_proxy
    http_proxy = "http://#{http_proxy}" unless http_proxy.start_with?('http://')
    proxy_uri = URI.parse(http_proxy)

    Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port)
  else
    Net::HTTP
  end
end

at_exit do
  if File.exist?(".git") && !SeleniumRake::Checks.windows?
    system "sh", ".git-fixfiles"
  end
end