debian-mirror-gitlab/spec/controllers/help_controller_spec.rb

307 lines
8.3 KiB
Ruby
Raw Normal View History

2019-07-31 22:56:46 +05:30
# frozen_string_literal: true
2015-04-26 12:48:37 +05:30
require 'spec_helper'
2020-06-23 00:09:42 +05:30
RSpec.describe HelpController do
2021-01-03 14:25:43 +05:30
include StubVersion
2022-07-23 23:45:48 +05:30
include DocUrlHelper
2021-01-03 14:25:43 +05:30
2015-04-26 12:48:37 +05:30
let(:user) { create(:user) }
2021-03-11 19:13:27 +05:30
shared_examples 'documentation pages local render' do
it 'renders HTML' do
aggregate_failures do
2022-07-23 23:45:48 +05:30
is_expected.to render_template('help/show')
2021-03-11 19:13:27 +05:30
expect(response.media_type).to eq 'text/html'
end
end
end
shared_examples 'documentation pages redirect' do |documentation_base_url|
2022-07-23 23:45:48 +05:30
let(:gitlab_version) { version }
2021-03-11 19:13:27 +05:30
before do
stub_version(gitlab_version, 'ignored_revision_value')
end
it 'redirects user to custom documentation url with a specified version' do
2022-07-23 23:45:48 +05:30
is_expected.to redirect_to(doc_url(documentation_base_url))
2021-03-11 19:13:27 +05:30
end
context 'when it is a pre-release' do
let(:gitlab_version) { '13.4.0-pre' }
it 'redirects user to custom documentation url without a version' do
2022-07-23 23:45:48 +05:30
is_expected.to redirect_to(doc_url_without_version(documentation_base_url))
2021-03-11 19:13:27 +05:30
end
end
end
2015-04-26 12:48:37 +05:30
before do
sign_in(user)
end
2017-08-17 22:00:37 +05:30
describe 'GET #index' do
context 'with absolute url' do
it 'keeps the URL absolute' do
2022-07-23 23:45:48 +05:30
stub_doc_file_read(content: "[API](/api/README.md)")
2017-08-17 22:00:37 +05:30
get :index
expect(assigns[:help_index]).to eq '[API](/api/README.md)'
end
end
context 'with relative url' do
it 'prefixes it with /help/' do
2022-07-23 23:45:48 +05:30
stub_doc_file_read(content: "[API](api/README.md)")
2017-08-17 22:00:37 +05:30
get :index
expect(assigns[:help_index]).to eq '[API](/help/api/README.md)'
end
end
context 'when url is an external link' do
it 'does not change it' do
2022-07-23 23:45:48 +05:30
stub_doc_file_read(content: "[external](https://some.external.link)")
2017-08-17 22:00:37 +05:30
get :index
expect(assigns[:help_index]).to eq '[external](https://some.external.link)'
end
end
2019-07-07 11:18:12 +05:30
context 'when relative url with external on same line' do
it 'prefix it with /help/' do
2022-07-23 23:45:48 +05:30
stub_doc_file_read(content: "[API](api/README.md) [external](https://some.external.link)")
2019-07-07 11:18:12 +05:30
get :index
expect(assigns[:help_index]).to eq '[API](/help/api/README.md) [external](https://some.external.link)'
end
end
context 'when relative url with http:// in query' do
it 'prefix it with /help/' do
2022-07-23 23:45:48 +05:30
stub_doc_file_read(content: "[API](api/README.md?go=https://example.com/)")
2019-07-07 11:18:12 +05:30
get :index
expect(assigns[:help_index]).to eq '[API](/help/api/README.md?go=https://example.com/)'
end
end
context 'when mailto URL' do
it 'do not change it' do
2022-07-23 23:45:48 +05:30
stub_doc_file_read(content: "[report bug](mailto:bugs@example.com)")
2019-07-07 11:18:12 +05:30
get :index
expect(assigns[:help_index]).to eq '[report bug](mailto:bugs@example.com)'
end
end
context 'when protocol-relative link' do
it 'do not change it' do
2022-07-23 23:45:48 +05:30
stub_doc_file_read(content: "[protocol-relative](//example.com)")
2019-07-07 11:18:12 +05:30
get :index
expect(assigns[:help_index]).to eq '[protocol-relative](//example.com)'
end
end
2020-04-22 19:07:51 +05:30
context 'restricted visibility set to public' do
before do
sign_out(user)
stub_application_setting(restricted_visibility_levels: [Gitlab::VisibilityLevel::PUBLIC])
end
it 'redirects to sign_in path' do
get :index
expect(response).to redirect_to(new_user_session_path)
end
end
2021-04-17 20:07:23 +05:30
context 'when two factor is required' do
before do
stub_two_factor_required
end
it 'does not redirect to two factor auth' do
get :index
expect(response).not_to redirect_to(profile_two_factor_auth_path)
end
end
2017-08-17 22:00:37 +05:30
end
2022-10-11 01:57:18 +05:30
describe 'GET #drawers' do
subject { get :drawers, params: { markdown_file: path } }
context 'when requested file exists' do
let(:path) { 'user/ssh' }
let(:file_name) { "#{path}.md" }
before do
subject
end
it 'assigns variables', :aggregate_failures do
expect(assigns[:path]).not_to be_empty
expect(assigns[:clean_path]).not_to be_empty
end
it 'renders HTML', :aggregate_failures do
is_expected.to render_template('help/drawers')
expect(response.media_type).to eq 'text/html'
end
end
context 'when requested file is missing' do
let(:path) { 'foo/bar' }
it 'renders not found' do
subject
expect(response).to be_not_found
end
end
end
2015-04-26 12:48:37 +05:30
describe 'GET #show' do
context 'for Markdown formats' do
2021-03-11 19:13:27 +05:30
subject { get :show, params: { path: path }, format: :md }
2022-06-21 17:19:12 +05:30
let(:path) { 'user/ssh' }
2021-03-11 19:13:27 +05:30
2015-04-26 12:48:37 +05:30
context 'when requested file exists' do
before do
2022-07-23 23:45:48 +05:30
stub_doc_file_read(file_name: 'user/ssh.md', content: fixture_file('blockquote_fence_after.md'))
2021-02-22 17:27:13 +05:30
2021-03-11 19:13:27 +05:30
subject
2015-04-26 12:48:37 +05:30
end
it 'assigns to @markdown' do
expect(assigns[:markdown]).not_to be_empty
end
2021-03-11 19:13:27 +05:30
it_behaves_like 'documentation pages local render'
2021-04-17 20:07:23 +05:30
context 'when two factor is required' do
before do
stub_two_factor_required
end
it 'does not redirect to two factor auth' do
expect(response).not_to redirect_to(profile_two_factor_auth_path)
end
end
2021-01-03 14:25:43 +05:30
end
2021-03-11 19:13:27 +05:30
context 'when a custom help_page_documentation_url is set in database' do
2021-01-03 14:25:43 +05:30
before do
2021-03-11 19:13:27 +05:30
stub_application_setting(help_page_documentation_base_url: 'https://in-db.gitlab.com')
2021-01-03 14:25:43 +05:30
end
2021-03-11 19:13:27 +05:30
it_behaves_like 'documentation pages redirect', 'https://in-db.gitlab.com'
end
2021-01-03 14:25:43 +05:30
2021-03-11 19:13:27 +05:30
context 'when a custom help_page_documentation_url is set in configuration file' do
let(:host) { 'https://in-yaml.gitlab.com' }
let(:docs_enabled) { true }
2021-01-03 14:25:43 +05:30
2021-03-11 19:13:27 +05:30
before do
allow(Settings).to receive(:gitlab_docs) { double(enabled: docs_enabled, host: host) }
2021-01-03 14:25:43 +05:30
end
2021-03-11 19:13:27 +05:30
it_behaves_like 'documentation pages redirect', 'https://in-yaml.gitlab.com'
context 'when gitlab_docs is disabled' do
let(:docs_enabled) { false }
2021-01-03 14:25:43 +05:30
2021-03-11 19:13:27 +05:30
it_behaves_like 'documentation pages local render'
2021-01-03 14:25:43 +05:30
end
2021-03-11 19:13:27 +05:30
context 'when host is missing' do
let(:host) { nil }
2021-01-03 14:25:43 +05:30
2021-03-11 19:13:27 +05:30
it_behaves_like 'documentation pages local render'
end
end
context 'when help_page_documentation_url is set in both db and configuration file' do
before do
stub_application_setting(help_page_documentation_base_url: 'https://in-db.gitlab.com')
allow(Settings).to receive(:gitlab_docs) { double(enabled: true, host: 'https://in-yaml.gitlab.com') }
2021-01-03 14:25:43 +05:30
end
2021-03-11 19:13:27 +05:30
it_behaves_like 'documentation pages redirect', 'https://in-yaml.gitlab.com'
end
context 'when help_page_documentation_url has a trailing slash' do
before do
allow(Settings).to receive(:gitlab_docs) { double(enabled: true, host: 'https://in-yaml.gitlab.com/') }
2015-04-26 12:48:37 +05:30
end
2021-03-11 19:13:27 +05:30
it_behaves_like 'documentation pages redirect', 'https://in-yaml.gitlab.com'
2015-04-26 12:48:37 +05:30
end
context 'when requested file is missing' do
it 'renders not found' do
2019-02-15 15:39:39 +05:30
get :show, params: { path: 'foo/bar' }, format: :md
2015-04-26 12:48:37 +05:30
expect(response).to be_not_found
end
end
end
context 'for image formats' do
context 'when requested file exists' do
it 'renders the raw file' do
2015-09-11 14:41:01 +05:30
get :show,
2019-02-15 15:39:39 +05:30
params: {
2020-03-13 15:44:24 +05:30
path: 'user/img/markdown_logo'
2019-02-15 15:39:39 +05:30
},
2015-09-11 14:41:01 +05:30
format: :png
2021-01-03 14:25:43 +05:30
aggregate_failures do
expect(response).to be_successful
expect(response.media_type).to eq 'image/png'
expect(response.headers['Content-Disposition']).to match(/^inline;/)
end
2015-04-26 12:48:37 +05:30
end
end
context 'when requested file is missing' do
it 'renders not found' do
2015-09-11 14:41:01 +05:30
get :show,
2019-02-15 15:39:39 +05:30
params: {
path: 'foo/bar'
},
2015-09-11 14:41:01 +05:30
format: :png
2015-04-26 12:48:37 +05:30
expect(response).to be_not_found
end
end
end
context 'for other formats' do
it 'always renders not found' do
2015-09-11 14:41:01 +05:30
get :show,
2019-02-15 15:39:39 +05:30
params: {
2022-06-21 17:19:12 +05:30
path: 'user/ssh'
2019-02-15 15:39:39 +05:30
},
2015-09-11 14:41:01 +05:30
format: :foo
2015-04-26 12:48:37 +05:30
expect(response).to be_not_found
end
end
end
2016-08-24 12:49:21 +05:30
2021-04-17 20:07:23 +05:30
def stub_two_factor_required
allow(controller).to receive(:two_factor_authentication_required?).and_return(true)
allow(controller).to receive(:current_user_requires_two_factor?).and_return(true)
end
2015-04-26 12:48:37 +05:30
end