mirror of
https://github.com/discourse/discourse.git
synced 2024-12-02 07:23:40 +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.
57 lines
2.0 KiB
Ruby
57 lines
2.0 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
RSpec.describe ProblemCheck::GithubConfig do
|
|
subject(:check) { described_class.new }
|
|
|
|
describe ".call" do
|
|
before { SiteSetting.stubs(enable_github_logins: enabled) }
|
|
|
|
context "when GitHub authentication is disabled" do
|
|
let(:enabled) { false }
|
|
|
|
it { expect(check).to be_chill_about_it }
|
|
end
|
|
|
|
context "when GitHub authentication is enabled and configured" do
|
|
let(:enabled) { true }
|
|
|
|
before do
|
|
SiteSetting.stubs(github_client_id: "foo")
|
|
SiteSetting.stubs(github_client_secret: "bar")
|
|
end
|
|
|
|
it { expect(check).to be_chill_about_it }
|
|
end
|
|
|
|
context "when GitHub authentication is enabled but missing client ID" do
|
|
let(:enabled) { true }
|
|
|
|
before do
|
|
SiteSetting.stubs(github_client_id: nil)
|
|
SiteSetting.stubs(github_client_secret: "bar")
|
|
end
|
|
|
|
it do
|
|
expect(check).to have_a_problem.with_priority("low").with_message(
|
|
'The server is configured to allow signup and login with GitHub (enable_github_logins), but the client id and secret values are not set. Go to <a href="/admin/site_settings">the Site Settings</a> and update the settings. <a href="https://meta.discourse.org/t/configuring-github-login-for-discourse/13745" target="_blank">See this guide to learn more</a>.',
|
|
)
|
|
end
|
|
end
|
|
|
|
context "when GitHub authentication is enabled but missing client secret" do
|
|
let(:enabled) { true }
|
|
|
|
before do
|
|
SiteSetting.stubs(github_client_id: "foo")
|
|
SiteSetting.stubs(github_client_secret: nil)
|
|
end
|
|
|
|
it do
|
|
expect(check).to have_a_problem.with_priority("low").with_message(
|
|
'The server is configured to allow signup and login with GitHub (enable_github_logins), but the client id and secret values are not set. Go to <a href="/admin/site_settings">the Site Settings</a> and update the settings. <a href="https://meta.discourse.org/t/configuring-github-login-for-discourse/13745" target="_blank">See this guide to learn more</a>.',
|
|
)
|
|
end
|
|
end
|
|
end
|
|
end
|