mirror of
https://github.com/discourse/discourse.git
synced 2024-11-25 22:33:37 +08:00
ea5c3a3bdc
In AdminDashboardData we have a bunch of problem checks implemented as methods on that class. This PR absolves it of the responsibility by promoting each of those checks to a first class ProblemCheck. This way each of them can have their own priority and arbitrary functionality can be isolated in its own class. Think "extract class" refactoring over and over. Since they were all moved we can also get rid of the @@problem_syms class variable which was basically the old version of the registry now replaced by ProblemCheck.realtime. In addition AdminDashboardData::Problem value object has been entirely replaced with the new ProblemCheck::Problem (with compatible API). Lastly, I added some RSpec matchers to simplify testing of problem checks and provide helpful error messages when assertions fail.
84 lines
3.1 KiB
Ruby
84 lines
3.1 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
RSpec.describe ProblemCheck::S3UploadConfig do
|
|
subject(:check) { described_class.new }
|
|
|
|
describe ".call" do
|
|
before do
|
|
GlobalSetting.stubs(use_s3?: globally_enabled)
|
|
SiteSetting.stubs(enable_s3_uploads?: locally_enabled)
|
|
end
|
|
|
|
context "when S3 uploads are globally enabled" do
|
|
let(:globally_enabled) { true }
|
|
let(:locally_enabled) { false }
|
|
|
|
it "relies on the check in GlobalSettings#use_s3?" do
|
|
expect(check).to be_chill_about_it
|
|
end
|
|
end
|
|
|
|
context "when S3 uploads are disabled" do
|
|
let(:globally_enabled) { false }
|
|
let(:locally_enabled) { false }
|
|
|
|
it { expect(check).to be_chill_about_it }
|
|
end
|
|
|
|
context "when S3 uploads are locally enabled" do
|
|
let(:globally_enabled) { false }
|
|
let(:locally_enabled) { true }
|
|
|
|
before { SiteSetting.stubs(s3_use_iam_profile: use_iam_profile) }
|
|
|
|
context "when configured to use IAM profile" do
|
|
let(:use_iam_profile) { true }
|
|
|
|
it { expect(check).to be_chill_about_it }
|
|
end
|
|
|
|
context "when not configured to use IAM profile" do
|
|
let(:use_iam_profile) { false }
|
|
|
|
before do
|
|
SiteSetting.stubs(s3_access_key_id: access_key)
|
|
SiteSetting.stubs(s3_secret_access_key: secret_access_key)
|
|
SiteSetting.stubs(s3_upload_bucket: bucket_name)
|
|
end
|
|
|
|
context "when credentials are present" do
|
|
let(:access_key) { "foo" }
|
|
let(:secret_access_key) { "bar" }
|
|
let(:bucket_name) { "baz" }
|
|
|
|
it { expect(check).to be_chill_about_it }
|
|
end
|
|
|
|
context "when credentials are missing" do
|
|
let(:access_key) { "foo" }
|
|
let(:secret_access_key) { nil }
|
|
let(:bucket_name) { "baz" }
|
|
|
|
it do
|
|
expect(check).to have_a_problem.with_priority("low").with_message(
|
|
'The server is configured to upload files to S3, but at least one the following setting is not set: s3_access_key_id, s3_secret_access_key, s3_use_iam_profile, or s3_upload_bucket. Go to <a href="/admin/site_settings">the Site Settings</a> and update the settings. <a href="https://meta.discourse.org/t/how-to-set-up-image-uploads-to-s3/7229" target="_blank">See "How to set up image uploads to S3?" to learn more</a>.',
|
|
)
|
|
end
|
|
end
|
|
|
|
context "when bucket name is missing" do
|
|
let(:access_key) { "foo" }
|
|
let(:secret_access_key) { "bar" }
|
|
let(:bucket_name) { nil }
|
|
|
|
it do
|
|
expect(check).to have_a_problem.with_priority("low").with_message(
|
|
'The server is configured to upload files to S3, but at least one the following setting is not set: s3_access_key_id, s3_secret_access_key, s3_use_iam_profile, or s3_upload_bucket. Go to <a href="/admin/site_settings">the Site Settings</a> and update the settings. <a href="https://meta.discourse.org/t/how-to-set-up-image-uploads-to-s3/7229" target="_blank">See "How to set up image uploads to S3?" to learn more</a>.',
|
|
)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|