discourse/lib/tasks/qunit.rake
Osama Sayegh a53d8d3e61
FEATURE: Introduce theme/component QUnit tests (#12517)
This commit allows themes and theme components to have QUnit tests. To add tests to your theme/component, create a top-level directory in your theme and name it `test`, and Discourse will save all the files in that directory (and its sub-directories) as "tests files" in the database. While tests files/directories are not required to be organized in a specific way, we recommend that you follow Discourse core's tests [structure](https://github.com/discourse/discourse/tree/master/app/assets/javascripts/discourse/tests).

Writing theme tests should be identical to writing plugins or core tests; all the `import` statements and APIs that you see in core (or plugins) to define/setup tests should just work in themes.

You do need a working Discourse install to run theme tests, and you have 2 ways to run theme tests:

* In the browser at the `/qunit` route. `/qunit` will run tests of all active themes/components as well as core and plugins. The `/qunit` now accepts a `theme_name` or `theme_url` params that you can use to run tests of a specific theme/component like so: `/qunit?theme_name=<your_theme_name>`.

* In the command line using the `themes:qunit` rake task. This take is meant to run tests of a single theme/component so you need to provide it with a theme name or URL like so: `bundle exec rake themes:qunit[name=<theme_name>]` or `bundle exec rake themes:qunit[url=<theme_url>]`.

There are some refactors to internal code that's responsible for processing themes/components in Discourse, most notably:

* `<script type="text/discourse-plugin">` tags are automatically converted to modules.

* The `theme-settings` service is removed in favor of a simple `lib` file responsible for managing theme settings. This was done to allow us to register/lookup theme settings very early in our Ember app lifecycle and because there was no reason for it to be an Ember service.

These refactors should 100% backward compatible and invisible to theme developers.
2021-04-07 10:39:57 +03:00

123 lines
3.1 KiB
Ruby

# frozen_string_literal: true
desc "Runs the qunit test suite"
task "qunit:test", [:timeout, :qunit_path] do |_, args|
require "socket"
require 'rbconfig'
if RbConfig::CONFIG['host_os'][/darwin|mac os/]
google_chrome_cli = "/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome"
else
google_chrome_cli = "google-chrome"
end
unless system("command -v \"#{google_chrome_cli}\" >/dev/null")
abort "Chrome is not installed. Download from https://www.google.com/chrome/browser/desktop/index.html"
end
if Gem::Version.new(`\"#{google_chrome_cli}\" --version`.match(/[\d\.]+/)[0]) < Gem::Version.new("59")
abort "Chrome 59 or higher is required to run tests in headless mode."
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
port = ENV['TEST_SERVER_PORT'] || 60099
while !port_available? port
port += 1
end
pid = Process.spawn(
{
"RAILS_ENV" => "test",
"SKIP_ENFORCE_HOSTNAME" => "1",
"UNICORN_PID_PATH" => "#{Rails.root}/tmp/pids/unicorn_test_#{port}.pid", # So this can run alongside development
"UNICORN_PORT" => port.to_s,
"UNICORN_SIDEKIQS" => "0"
},
"#{Rails.root}/bin/unicorn -c config/unicorn.conf.rb"
)
begin
success = true
test_path = "#{Rails.root}/test"
qunit_path = args[:qunit_path] || "/qunit"
cmd = "node #{test_path}/run-qunit.js http://localhost:#{port}#{qunit_path}"
options = { seed: (ENV["QUNIT_SEED"] || Random.new.seed), hidepassed: 1 }
%w{module filter qunit_skip_core qunit_single_plugin theme_name theme_url}.each do |arg|
options[arg] = ENV[arg.upcase] if ENV[arg.upcase].present?
end
if report_requests
options['report_requests'] = '1'
end
cmd += "?#{options.to_query.gsub('+', '%20').gsub("&", '\\\&')}"
if args[:timeout].present?
cmd += " #{args[:timeout]}"
end
@now = Time.now
def elapsed
Time.now - @now
end
# wait for server to accept connections
require 'net/http'
uri = URI("http://localhost:#{port}/assets/test_helper.js")
puts "Warming up Rails server"
begin
Net::HTTP.get(uri)
rescue Errno::ECONNREFUSED, Errno::EADDRNOTAVAIL, Net::ReadTimeout, EOFError
sleep 1
retry unless elapsed() > 60
puts "Timed out. Can not connect to forked server!"
exit 1
end
puts "Rails server is warmed up"
sh(cmd)
# A bit of a hack until we can figure this out on Travis
tries = 0
while tries < 3 && $?.exitstatus == 124
tries += 1
puts "\nTimed Out. Trying again...\n"
sh(cmd)
end
success &&= $?.success?
ensure
# was having issues with HUP
Process.kill "KILL", pid
FileUtils.rm("#{Rails.root}/tmp/pids/unicorn_test_#{port}.pid")
end
if success
puts "\nTests Passed"
else
puts "\nTests Failed"
exit(1)
end
end