mirror of
https://github.com/discourse/discourse.git
synced 2024-12-02 09:33:39 +08:00
e0ef88abca
Why this change? As the number of themes which the Discourse team supports officially grows, we want to ensure that changes made to Discourse core do not break the plugins. As such, we are adding a step to our Github actions test job to run the QUnit tests for all official themes. What does this change do? This change adds a new job to our tests Github actions workflow to run the QUnit tests for all official plugins. This is achieved with the following changes: 1. Update `testem.js` to rely on the `THEME_TEST_PAGES` env variable to set the `test_page` option when running theme QUnit tests with testem. The `test_page` option [allows an array to be specified](https://github.com/testem/testem#multiple-test-pages) such that tests for multiple pages can be run at the same time. We are relying on a ENV variable because the `testem` CLI does not support passing a list of pages to the `--test_page` option. 2. Support a `/testem-theme-qunit/:testem_id/theme-qunit` Rails route in the development environment. This is done because testem prefixes the path with a unique ID to the configured `test_page` URL. This is problematic for us because we proxy all testem requests to the Rails server and testem's proxy configuration option does not allow us to easily rewrite the URL to remove the prefix. Therefore, we configure a proxy in testem to prefix `theme-qunit` requests with `/testem-theme-qunit` which can then be easily identified by the Rails server and routed accordingly. 3. Update `qunit:test` to support a `THEME_IDS` environment variable which will allow it to run QUnit tests for multiple themes at the same time. 4. Support `bin/rake themes:qunit[ids,"<theme_id>|<theme_id>"]` to run the QUnit tests for multiple themes at the same time. 5. Adds a `themes:qunit_all_official` Rake task which runs the QUnit tests for all the official themes.
149 lines
4.0 KiB
Ruby
149 lines
4.0 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
desc "Runs the qunit test suite"
|
|
task "qunit:test", %i[timeout qunit_path filter] do |_, args|
|
|
require "socket"
|
|
require "chrome_installed_checker"
|
|
|
|
begin
|
|
ChromeInstalledChecker.run
|
|
rescue ChromeInstalledChecker::ChromeError => err
|
|
abort err.message
|
|
end
|
|
|
|
unless system("command -v yarn >/dev/null;")
|
|
abort "Yarn is not installed. Download from https://yarnpkg.com/lang/en/docs/install/"
|
|
end
|
|
|
|
report_requests = ENV["REPORT_REQUESTS"] == "1"
|
|
|
|
system("yarn install")
|
|
|
|
# ensure we have this port available
|
|
def port_available?(port)
|
|
server = TCPServer.open port
|
|
server.close
|
|
true
|
|
rescue Errno::EADDRINUSE
|
|
false
|
|
end
|
|
|
|
if ENV["QUNIT_EMBER_CLI"] == "0"
|
|
puts "The 'legacy' ember environment is discontinued - running tests with ember-cli assets..."
|
|
end
|
|
|
|
port = ENV["TEST_SERVER_PORT"] || 60_099
|
|
port += 1 while !port_available? port
|
|
|
|
unicorn_port = 60_098
|
|
unicorn_port += 1 while unicorn_port == port || !port_available?(unicorn_port)
|
|
|
|
env = {
|
|
"RAILS_ENV" => ENV["QUNIT_RAILS_ENV"] || "test",
|
|
"SKIP_ENFORCE_HOSTNAME" => "1",
|
|
"UNICORN_PID_PATH" => "#{Rails.root}/tmp/pids/unicorn_test_#{unicorn_port}.pid", # So this can run alongside development
|
|
"UNICORN_PORT" => unicorn_port.to_s,
|
|
"UNICORN_SIDEKIQS" => "0",
|
|
"DISCOURSE_SKIP_CSS_WATCHER" => "1",
|
|
"UNICORN_LISTENER" => "127.0.0.1:#{unicorn_port}",
|
|
"LOGSTASH_UNICORN_URI" => nil,
|
|
"UNICORN_WORKERS" => "1",
|
|
"UNICORN_TIMEOUT" => "90",
|
|
}
|
|
|
|
pid = Process.spawn(env, "#{Rails.root}/bin/unicorn", pgroup: true)
|
|
|
|
begin
|
|
success = true
|
|
test_path = "#{Rails.root}/test"
|
|
qunit_path = args[:qunit_path]
|
|
filter = args[:filter]
|
|
|
|
options = { seed: (ENV["QUNIT_SEED"] || Random.new.seed), hidepassed: 1 }
|
|
|
|
%w[
|
|
module
|
|
filter
|
|
qunit_skip_core
|
|
qunit_single_plugin
|
|
theme_name
|
|
theme_url
|
|
theme_id
|
|
target
|
|
].each { |arg| options[arg] = ENV[arg.upcase] if ENV[arg.upcase].present? }
|
|
|
|
options["report_requests"] = "1" if report_requests
|
|
|
|
query = options.to_query
|
|
|
|
@now = Time.now
|
|
def elapsed
|
|
Time.now - @now
|
|
end
|
|
|
|
# wait for server to accept connections
|
|
require "net/http"
|
|
uri = URI("http://localhost:#{unicorn_port}/srv/status")
|
|
puts "Warming up Rails server"
|
|
|
|
begin
|
|
Net::HTTP.get(uri)
|
|
rescue Errno::ECONNREFUSED,
|
|
Errno::EADDRNOTAVAIL,
|
|
Net::ReadTimeout,
|
|
Net::HTTPBadResponse,
|
|
EOFError
|
|
sleep 1
|
|
retry if elapsed() <= 60
|
|
puts "Timed out. Can not connect to forked server!"
|
|
exit 1
|
|
end
|
|
puts "Rails server is warmed up"
|
|
|
|
env = { "UNICORN_PORT" => unicorn_port.to_s }
|
|
cmd = []
|
|
|
|
parallel = ENV["QUNIT_PARALLEL"]
|
|
|
|
if qunit_path
|
|
# Bypass `ember test` - it only works properly for the `/tests` path.
|
|
# We have to trigger a `build` manually so that JS is available for rails to serve.
|
|
system("yarn", "ember", "build", chdir: "#{Rails.root}/app/assets/javascripts/discourse")
|
|
|
|
env["THEME_TEST_PAGES"] = if ENV["THEME_IDS"]
|
|
ENV["THEME_IDS"]
|
|
.split("|")
|
|
.map { |theme_id| "#{qunit_path}?#{query}&testem=1&id=#{theme_id}" }
|
|
.join(",")
|
|
else
|
|
"#{qunit_path}?#{query}&testem=1"
|
|
end
|
|
|
|
cmd += %w[yarn testem ci -f testem.js]
|
|
cmd += ["--parallel", parallel] if parallel
|
|
else
|
|
cmd += ["yarn", "ember", "exam", "--query", query]
|
|
cmd += ["--load-balance", "--parallel", parallel] if parallel
|
|
cmd += ["--filter", filter] if filter
|
|
cmd << "--write-execution-file" if ENV["QUNIT_WRITE_EXECUTION_FILE"]
|
|
end
|
|
|
|
# Print out all env for debugging purposes
|
|
p env
|
|
system(env, *cmd, chdir: "#{Rails.root}/app/assets/javascripts/discourse")
|
|
|
|
success &&= $?.success?
|
|
ensure
|
|
# was having issues with HUP
|
|
Process.kill "-KILL", pid
|
|
FileUtils.rm("#{Rails.root}/tmp/pids/unicorn_test_#{unicorn_port}.pid")
|
|
end
|
|
|
|
if success
|
|
puts "\nTests Passed"
|
|
else
|
|
puts "\nTests Failed"
|
|
exit(1)
|
|
end
|
|
end
|