github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-05-31 11:47:15 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

DEV: Add support for uploading a theme from a directory in system tests (#23402)

Browse Source 
Why this change?

Currently, we do not have an easy way to test themes and theme components
using Rails system tests. While we support QUnit acceptance tests for
themes and theme components, QUnit acceptance tests stubs out the server
and setting up the fixtures for server responses is difficult and can lead to a
frustrating experience. System tests on the other hand allow authors to
set up the test fixtures using our fabricator system which is much
easier to use.

What does this change do?

In order for us to allow authors to run system tests with their themes
installed, we are adding a `upload_theme` helper that is made available
when writing system tests. The `upload_theme` helper requires a single
`directory` parameter where `directory` is the directory of the theme
locally and returns a `Theme` record.
This commit is contained in:
Alan Guo Xiang Tan
2023-09-12 07:38:47 +08:00
committed by GitHub
parent 98f3976168
commit d2e4b32c87
15 changed files with 126 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
app/models/remote_theme.rb
View File

@ -51,16 +51,34 @@ class RemoteTheme < ActiveRecord::Base
def self.update_zipped_theme(
filename,
original_filename,
match_theme: false,
user: Discourse.system_user,
theme_id: nil,
update_components: nil
)
importer = ThemeStore::ZipImporter.new(filename, original_filename)
update_theme(
ThemeStore::ZipImporter.new(filename, original_filename),
user:,
theme_id:,
update_components:,
)
end
# This is only used in the tests environment and is currently not supported for other environments
if Rails.env.test?
def self.import_theme_from_directory(directory)
update_theme(ThemeStore::DirectoryImporter.new(directory))
end
end
def self.update_theme(
importer,
user: Discourse.system_user,
theme_id: nil,
update_components: nil
)
importer.import!
theme_info = RemoteTheme.extract_theme_info(importer)
theme = Theme.find_by(name: theme_info["name"]) if match_theme # Old theme CLI method, remove Jan 2020
theme = Theme.find_by(id: theme_id) if theme_id # New theme CLI method
existing = true
@ -107,6 +125,7 @@ class RemoteTheme < ActiveRecord::Base
Rails.logger.warn("Failed cleanup remote path #{e}")
end
end
private_class_method :update_theme
def self.import_theme(url, user = Discourse.system_user, private_key: nil, branch: nil)
importer = ThemeStore::GitImporter.new(url.strip, private_key: private_key, branch: branch)
@ -232,6 +251,7 @@ class RemoteTheme < ActiveRecord::Base
METADATA_PROPERTIES.each do |property|
self.public_send(:"#{property}=", theme_info[property.to_s])
end
if !self.valid?
raise ImportError,
I18n.t(
@ -246,6 +266,7 @@ class RemoteTheme < ActiveRecord::Base
theme_info.dig("modifiers", modifier_name.to_s),
)
end
if !theme.theme_modifier_set.valid?
raise ImportError,
I18n.t(