diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-09-19 01:45:44 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-09-19 01:45:44 +0000 |
commit | 85dc423f7090da0a52c73eb66faf22ddb20efff9 (patch) | |
tree | 9160f299afd8c80c038f08e1545be119f5e3f1e1 /spec/lib/banzai | |
parent | 15c2c8c66dbe422588e5411eee7e68f1fa440bb8 (diff) | |
download | gitlab-ce-85dc423f7090da0a52c73eb66faf22ddb20efff9.tar.gz |
Add latest changes from gitlab-org/gitlab@13-4-stable-ee
Diffstat (limited to 'spec/lib/banzai')
8 files changed, 428 insertions, 58 deletions
diff --git a/spec/lib/banzai/filter/alert_reference_filter_spec.rb b/spec/lib/banzai/filter/alert_reference_filter_spec.rb new file mode 100644 index 00000000000..c57a8a7321c --- /dev/null +++ b/spec/lib/banzai/filter/alert_reference_filter_spec.rb @@ -0,0 +1,223 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Banzai::Filter::AlertReferenceFilter do + include FilterSpecHelper + + let_it_be(:project) { create(:project, :public) } + let_it_be(:alert) { create(:alert_management_alert, project: project) } + let_it_be(:reference) { alert.to_reference } + + it 'requires project context' do + expect { described_class.call('') }.to raise_error(ArgumentError, /:project/) + end + + %w(pre code a style).each do |elem| + it "ignores valid references contained inside '#{elem}' element" do + exp = act = "<#{elem}>Alert #{reference}</#{elem}>" + + expect(reference_filter(act).to_html).to eq exp + end + end + + context 'internal reference' do + it 'links to a valid reference' do + doc = reference_filter("See #{reference}") + + expect(doc.css('a').first.attr('href')).to eq alert.details_url + end + + it 'links with adjacent text' do + doc = reference_filter("Alert (#{reference}.)") + + expect(doc.to_html).to match(%r{\(<a.+>#{Regexp.escape(reference)}</a>\.\)}) + end + + it 'ignores invalid alert IDs' do + exp = act = "Alert #{invalidate_reference(reference)}" + + expect(reference_filter(act).to_html).to eq exp + end + + it 'includes a title attribute' do + doc = reference_filter("Alert #{reference}") + + expect(doc.css('a').first.attr('title')).to eq alert.title + end + + it 'escapes the title attribute' do + allow(alert).to receive(:title).and_return(%{"></a>whatever<a title="}) + doc = reference_filter("Alert #{reference}") + + expect(doc.text).to eq "Alert #{reference}" + end + + it 'includes default classes' do + doc = reference_filter("Alert #{reference}") + + expect(doc.css('a').first.attr('class')).to eq 'gfm gfm-alert has-tooltip' + end + + it 'includes a data-project attribute' do + doc = reference_filter("Alert #{reference}") + link = doc.css('a').first + + expect(link).to have_attribute('data-project') + expect(link.attr('data-project')).to eq project.id.to_s + end + + it 'includes a data-alert attribute' do + doc = reference_filter("See #{reference}") + link = doc.css('a').first + + expect(link).to have_attribute('data-alert') + expect(link.attr('data-alert')).to eq alert.id.to_s + end + + it 'supports an :only_path context' do + doc = reference_filter("Alert #{reference}", only_path: true) + link = doc.css('a').first.attr('href') + + expect(link).not_to match %r(https?://) + expect(link).to eq urls.details_project_alert_management_url(project, alert.iid, only_path: true) + end + end + + context 'cross-project / cross-namespace complete reference' do + let_it_be(:namespace) { create(:namespace) } + let_it_be(:project2) { create(:project, :public, namespace: namespace) } + let_it_be(:alert) { create(:alert_management_alert, project: project2) } + let_it_be(:reference) { "#{project2.full_path}^alert##{alert.iid}" } + + it 'links to a valid reference' do + doc = reference_filter("See #{reference}") + + expect(doc.css('a').first.attr('href')).to eq alert.details_url + end + + it 'link has valid text' do + doc = reference_filter("See (#{reference}.)") + + expect(doc.css('a').first.text).to eql(reference) + end + + it 'has valid text' do + doc = reference_filter("See (#{reference}.)") + + expect(doc.text).to eql("See (#{reference}.)") + end + + it 'ignores invalid alert IDs on the referenced project' do + exp = act = "See #{invalidate_reference(reference)}" + + expect(reference_filter(act).to_html).to eq exp + end + end + + context 'cross-project / same-namespace complete reference' do + let_it_be(:namespace) { create(:namespace) } + let_it_be(:project) { create(:project, :public, namespace: namespace) } + let_it_be(:project2) { create(:project, :public, namespace: namespace) } + let_it_be(:alert) { create(:alert_management_alert, project: project2) } + let_it_be(:reference) { "#{project2.full_path}^alert##{alert.iid}" } + + it 'links to a valid reference' do + doc = reference_filter("See #{reference}") + + expect(doc.css('a').first.attr('href')).to eq alert.details_url + end + + it 'link has valid text' do + doc = reference_filter("See (#{project2.path}^alert##{alert.iid}.)") + + expect(doc.css('a').first.text).to eql("#{project2.path}^alert##{alert.iid}") + end + + it 'has valid text' do + doc = reference_filter("See (#{project2.path}^alert##{alert.iid}.)") + + expect(doc.text).to eql("See (#{project2.path}^alert##{alert.iid}.)") + end + + it 'ignores invalid alert IDs on the referenced project' do + exp = act = "See #{invalidate_reference(reference)}" + + expect(reference_filter(act).to_html).to eq exp + end + end + + context 'cross-project shorthand reference' do + let_it_be(:namespace) { create(:namespace) } + let_it_be(:project) { create(:project, :public, namespace: namespace) } + let_it_be(:project2) { create(:project, :public, namespace: namespace) } + let_it_be(:alert) { create(:alert_management_alert, project: project2) } + let_it_be(:reference) { "#{project2.path}^alert##{alert.iid}" } + + it 'links to a valid reference' do + doc = reference_filter("See #{reference}") + + expect(doc.css('a').first.attr('href')).to eq alert.details_url + end + + it 'link has valid text' do + doc = reference_filter("See (#{project2.path}^alert##{alert.iid}.)") + + expect(doc.css('a').first.text).to eql("#{project2.path}^alert##{alert.iid}") + end + + it 'has valid text' do + doc = reference_filter("See (#{project2.path}^alert##{alert.iid}.)") + + expect(doc.text).to eql("See (#{project2.path}^alert##{alert.iid}.)") + end + + it 'ignores invalid alert IDs on the referenced project' do + exp = act = "See #{invalidate_reference(reference)}" + + expect(reference_filter(act).to_html).to eq exp + end + end + + context 'cross-project URL reference' do + let_it_be(:namespace) { create(:namespace, name: 'cross-reference') } + let_it_be(:project2) { create(:project, :public, namespace: namespace) } + let_it_be(:alert) { create(:alert_management_alert, project: project2) } + let_it_be(:reference) { alert.details_url } + + it 'links to a valid reference' do + doc = reference_filter("See #{reference}") + + expect(doc.css('a').first.attr('href')).to eq alert.details_url + end + + it 'links with adjacent text' do + doc = reference_filter("See (#{reference}.)") + + expect(doc.to_html).to match(%r{\(<a.+>#{Regexp.escape(alert.to_reference(project))}</a>\.\)}) + end + + it 'ignores invalid alert IDs on the referenced project' do + act = "See #{invalidate_reference(reference)}" + + expect(reference_filter(act).to_html).to match(%r{<a.+>#{Regexp.escape(invalidate_reference(reference))}</a>}) + end + end + + context 'group context' do + let_it_be(:group) { create(:group) } + + it 'links to a valid reference' do + reference = "#{project.full_path}^alert##{alert.iid}" + result = reference_filter("See #{reference}", { project: nil, group: group } ) + + expect(result.css('a').first.attr('href')).to eq(alert.details_url) + end + + it 'ignores internal references' do + exp = act = "See ^alert##{alert.iid}" + + expect(reference_filter(act, project: nil, group: group).to_html).to eq exp + end + end +end diff --git a/spec/lib/banzai/filter/external_issue_reference_filter_spec.rb b/spec/lib/banzai/filter/external_issue_reference_filter_spec.rb index 7d8fb183dbb..e7b6c910b8a 100644 --- a/spec/lib/banzai/filter/external_issue_reference_filter_spec.rb +++ b/spec/lib/banzai/filter/external_issue_reference_filter_spec.rb @@ -208,4 +208,47 @@ RSpec.describe Banzai::Filter::ExternalIssueReferenceFilter do end end end + + context "ewm project" do + let_it_be(:project) { create(:ewm_project) } + + before do + project.update!(issues_enabled: false) + end + + context "rtcwi keyword" do + let(:issue) { ExternalIssue.new("rtcwi 123", project) } + let(:reference) { issue.to_reference } + + it_behaves_like "external issue tracker" + end + + context "workitem keyword" do + let(:issue) { ExternalIssue.new("workitem 123", project) } + let(:reference) { issue.to_reference } + + it_behaves_like "external issue tracker" + end + + context "defect keyword" do + let(:issue) { ExternalIssue.new("defect 123", project) } + let(:reference) { issue.to_reference } + + it_behaves_like "external issue tracker" + end + + context "task keyword" do + let(:issue) { ExternalIssue.new("task 123", project) } + let(:reference) { issue.to_reference } + + it_behaves_like "external issue tracker" + end + + context "bug keyword" do + let(:issue) { ExternalIssue.new("bug 123", project) } + let(:reference) { issue.to_reference } + + it_behaves_like "external issue tracker" + end + end end diff --git a/spec/lib/banzai/filter/inline_metrics_filter_spec.rb b/spec/lib/banzai/filter/inline_metrics_filter_spec.rb index 9b0b95b9da2..cdebd886b16 100644 --- a/spec/lib/banzai/filter/inline_metrics_filter_spec.rb +++ b/spec/lib/banzai/filter/inline_metrics_filter_spec.rb @@ -5,25 +5,68 @@ require 'spec_helper' RSpec.describe Banzai::Filter::InlineMetricsFilter do include FilterSpecHelper - let(:params) { ['foo', 'bar', 12] } - let(:query_params) { {} } - - let(:trigger_url) { urls.metrics_namespace_project_environment_url(*params, query_params) } + let(:environment_id) { 12 } let(:dashboard_url) { urls.metrics_dashboard_namespace_project_environment_url(*params, **query_params, embedded: true) } - it_behaves_like 'a metrics embed filter' + let(:query_params) do + { + dashboard: 'config/prometheus/common_metrics.yml', + group: 'System metrics (Kubernetes)', + title: 'Core Usage (Pod Average)', + y_label: 'Cores per Pod' + } + end + + context 'with /-/environments/:environment_id/metrics URL' do + let(:params) { ['group', 'project', environment_id] } + let(:trigger_url) { urls.metrics_namespace_project_environment_url(*params, **query_params) } + + context 'with no query params' do + let(:query_params) { {} } + + it_behaves_like 'a metrics embed filter' + end + + context 'with query params' do + it_behaves_like 'a metrics embed filter' + end + end - context 'with query params specified' do - let(:query_params) do - { - dashboard: 'config/prometheus/common_metrics.yml', - group: 'System metrics (Kubernetes)', - title: 'Core Usage (Pod Average)', - y_label: 'Cores per Pod' - } + context 'with /-/metrics?environment=:environment_id URL' do + let(:params) { %w(group project) } + let(:trigger_url) { urls.namespace_project_metrics_dashboard_url(*params, **query_params) } + let(:dashboard_url) do + urls.metrics_dashboard_namespace_project_environment_url( + *params.append(environment_id), + **query_params.except(:environment), + embedded: true + ) end - it_behaves_like 'a metrics embed filter' + context 'with query params' do + it_behaves_like 'a metrics embed filter' do + before do + query_params.merge!(environment: environment_id) + end + end + end + + context 'with only environment in query params' do + let(:query_params) { { environment: environment_id } } + + it_behaves_like 'a metrics embed filter' + end + + context 'with no query params' do + let(:query_params) { {} } + + it 'ignores metrics URL without environment parameter' do + input = %(<a href="#{trigger_url}">example</a>) + filtered_input = filter(input).to_s + + expect(CGI.unescape_html(filtered_input)).to eq(input) + end + end end it 'leaves links to other dashboards unchanged' do diff --git a/spec/lib/banzai/filter/inline_metrics_redactor_filter_spec.rb b/spec/lib/banzai/filter/inline_metrics_redactor_filter_spec.rb index 5f66844f498..3c736b46131 100644 --- a/spec/lib/banzai/filter/inline_metrics_redactor_filter_spec.rb +++ b/spec/lib/banzai/filter/inline_metrics_redactor_filter_spec.rb @@ -22,6 +22,13 @@ RSpec.describe Banzai::Filter::InlineMetricsRedactorFilter do it_behaves_like 'redacts the embed placeholder' it_behaves_like 'retains the embed placeholder when applicable' + context 'with /-/metrics?environment=:environment_id URL' do + let(:url) { urls.project_metrics_dashboard_url(project, embedded: true, environment: 1) } + + it_behaves_like 'redacts the embed placeholder' + it_behaves_like 'retains the embed placeholder when applicable' + end + context 'for a grafana dashboard' do let(:url) { urls.project_grafana_api_metrics_dashboard_url(project, embedded: true) } @@ -33,7 +40,7 @@ RSpec.describe Banzai::Filter::InlineMetricsRedactorFilter do let_it_be(:cluster) { create(:cluster, :provided_by_gcp, :project, projects: [project]) } let(:params) { [project.namespace.path, project.path, cluster.id] } let(:query_params) { { group: 'Cluster Health', title: 'CPU Usage', y_label: 'CPU (cores)' } } - let(:url) { urls.metrics_dashboard_namespace_project_cluster_url(*params, **query_params) } + let(:url) { urls.metrics_dashboard_namespace_project_cluster_url(*params, **query_params, format: :json) } context 'with user who can read cluster' do it_behaves_like 'redacts the embed placeholder' diff --git a/spec/lib/banzai/filter/issue_reference_filter_spec.rb b/spec/lib/banzai/filter/issue_reference_filter_spec.rb index 0ad058675fe..447802d18a7 100644 --- a/spec/lib/banzai/filter/issue_reference_filter_spec.rb +++ b/spec/lib/banzai/filter/issue_reference_filter_spec.rb @@ -40,10 +40,10 @@ RSpec.describe Banzai::Filter::IssueReferenceFilter do end context 'internal reference' do - it_behaves_like 'a reference containing an element node' - let(:reference) { "##{issue.iid}" } + it_behaves_like 'a reference containing an element node' + it 'links to a valid reference' do doc = reference_filter("Fixed #{reference}") @@ -134,11 +134,11 @@ RSpec.describe Banzai::Filter::IssueReferenceFilter do end context 'cross-project / cross-namespace complete reference' do - it_behaves_like 'a reference containing an element node' - - let(:project2) { create(:project, :public) } - let(:issue) { create(:issue, project: project2) } let(:reference) { "#{project2.full_path}##{issue.iid}" } + let(:issue) { create(:issue, project: project2) } + let(:project2) { create(:project, :public) } + + it_behaves_like 'a reference containing an element node' it 'ignores valid references when cross-reference project uses external tracker' do expect_any_instance_of(described_class).to receive(:find_object) @@ -182,13 +182,13 @@ RSpec.describe Banzai::Filter::IssueReferenceFilter do end context 'cross-project / same-namespace complete reference' do - it_behaves_like 'a reference containing an element node' - - let(:namespace) { create(:namespace) } - let(:project) { create(:project, :public, namespace: namespace) } - let(:project2) { create(:project, :public, namespace: namespace) } - let(:issue) { create(:issue, project: project2) } let(:reference) { "#{project2.full_path}##{issue.iid}" } + let(:issue) { create(:issue, project: project2) } + let(:project2) { create(:project, :public, namespace: namespace) } + let(:project) { create(:project, :public, namespace: namespace) } + let(:namespace) { create(:namespace) } + + it_behaves_like 'a reference containing an element node' it 'ignores valid references when cross-reference project uses external tracker' do expect_any_instance_of(described_class).to receive(:find_object) @@ -232,13 +232,13 @@ RSpec.describe Banzai::Filter::IssueReferenceFilter do end context 'cross-project shorthand reference' do - it_behaves_like 'a reference containing an element node' - - let(:namespace) { create(:namespace) } - let(:project) { create(:project, :public, namespace: namespace) } - let(:project2) { create(:project, :public, namespace: namespace) } - let(:issue) { create(:issue, project: project2) } let(:reference) { "#{project2.path}##{issue.iid}" } + let(:issue) { create(:issue, project: project2) } + let(:project2) { create(:project, :public, namespace: namespace) } + let(:project) { create(:project, :public, namespace: namespace) } + let(:namespace) { create(:namespace) } + + it_behaves_like 'a reference containing an element node' it 'ignores valid references when cross-reference project uses external tracker' do expect_any_instance_of(described_class).to receive(:find_object) @@ -282,12 +282,12 @@ RSpec.describe Banzai::Filter::IssueReferenceFilter do end context 'cross-project URL reference' do - it_behaves_like 'a reference containing an element node' - - let(:namespace) { create(:namespace, name: 'cross-reference') } - let(:project2) { create(:project, :public, namespace: namespace) } - let(:issue) { create(:issue, project: project2) } let(:reference) { issue_url + "#note_123" } + let(:issue) { create(:issue, project: project2) } + let(:project2) { create(:project, :public, namespace: namespace) } + let(:namespace) { create(:namespace, name: 'cross-reference') } + + it_behaves_like 'a reference containing an element node' it 'links to a valid reference' do doc = reference_filter("See #{reference}") @@ -310,13 +310,13 @@ RSpec.describe Banzai::Filter::IssueReferenceFilter do end context 'cross-project reference in link href' do - it_behaves_like 'a reference containing an element node' - - let(:namespace) { create(:namespace, name: 'cross-reference') } - let(:project2) { create(:project, :public, namespace: namespace) } - let(:issue) { create(:issue, project: project2) } - let(:reference) { issue.to_reference(project) } let(:reference_link) { %{<a href="#{reference}">Reference</a>} } + let(:reference) { issue.to_reference(project) } + let(:issue) { create(:issue, project: project2) } + let(:project2) { create(:project, :public, namespace: namespace) } + let(:namespace) { create(:namespace, name: 'cross-reference') } + + it_behaves_like 'a reference containing an element node' it 'links to a valid reference' do doc = reference_filter("See #{reference_link}") @@ -339,13 +339,13 @@ RSpec.describe Banzai::Filter::IssueReferenceFilter do end context 'cross-project URL in link href' do - it_behaves_like 'a reference containing an element node' - - let(:namespace) { create(:namespace, name: 'cross-reference') } - let(:project2) { create(:project, :public, namespace: namespace) } - let(:issue) { create(:issue, project: project2) } - let(:reference) { "#{issue_url + "#note_123"}" } let(:reference_link) { %{<a href="#{reference}">Reference</a>} } + let(:reference) { "#{issue_url + "#note_123"}" } + let(:issue) { create(:issue, project: project2) } + let(:project2) { create(:project, :public, namespace: namespace) } + let(:namespace) { create(:namespace, name: 'cross-reference') } + + it_behaves_like 'a reference containing an element node' it 'links to a valid reference' do doc = reference_filter("See #{reference_link}") diff --git a/spec/lib/banzai/filter/table_of_contents_filter_spec.rb b/spec/lib/banzai/filter/table_of_contents_filter_spec.rb index 2d17855707f..6e90f4457fa 100644 --- a/spec/lib/banzai/filter/table_of_contents_filter_spec.rb +++ b/spec/lib/banzai/filter/table_of_contents_filter_spec.rb @@ -65,6 +65,11 @@ RSpec.describe Banzai::Filter::TableOfContentsFilter do expect(doc.css('h1 a').first.attr('href')).to eq '#title-with-spaces' end + it 'removes a product suffix' do + doc = filter(header(1, "Title with spaces (ULTIMATE)")) + expect(doc.css('h1 a').first.attr('href')).to eq '#title-with-spaces' + end + it 'appends a unique number to duplicates' do doc = filter(header(1, 'One') + header(2, 'One')) diff --git a/spec/lib/banzai/filter/user_reference_filter_spec.rb b/spec/lib/banzai/filter/user_reference_filter_spec.rb index d8de3e5cc11..b8baccf6658 100644 --- a/spec/lib/banzai/filter/user_reference_filter_spec.rb +++ b/spec/lib/banzai/filter/user_reference_filter_spec.rb @@ -40,10 +40,10 @@ RSpec.describe Banzai::Filter::UserReferenceFilter do end context 'mentioning @all' do - it_behaves_like 'a reference containing an element node' - let(:reference) { User.reference_prefix + 'all' } + it_behaves_like 'a reference containing an element node' + before do project.add_developer(project.creator) end @@ -78,10 +78,10 @@ RSpec.describe Banzai::Filter::UserReferenceFilter do end context 'mentioning a group' do - it_behaves_like 'a reference containing an element node' - - let(:group) { create(:group) } let(:reference) { group.to_reference } + let(:group) { create(:group) } + + it_behaves_like 'a reference containing an element node' it 'links to the Group' do doc = reference_filter("Hey #{reference}") @@ -98,10 +98,10 @@ RSpec.describe Banzai::Filter::UserReferenceFilter do end context 'mentioning a nested group' do - it_behaves_like 'a reference containing an element node' - - let(:group) { create(:group, :nested) } let(:reference) { group.to_reference } + let(:group) { create(:group, :nested) } + + it_behaves_like 'a reference containing an element node' it 'links to the nested group' do doc = reference_filter("Hey #{reference}") diff --git a/spec/lib/banzai/reference_parser/alert_parser_spec.rb b/spec/lib/banzai/reference_parser/alert_parser_spec.rb new file mode 100644 index 00000000000..0a9499fe6e4 --- /dev/null +++ b/spec/lib/banzai/reference_parser/alert_parser_spec.rb @@ -0,0 +1,49 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Banzai::ReferenceParser::AlertParser do + include ReferenceParserHelpers + + let(:project) { create(:project, :public) } + let(:user) { create(:user) } + let(:alert) { create(:alert_management_alert, project: project) } + + subject { described_class.new(Banzai::RenderContext.new(project, user)) } + + let(:link) { empty_html_link } + + describe '#nodes_visible_to_user' do + context 'when the link has a data-issue attribute' do + before do + link['data-alert'] = alert.id.to_s + end + + it_behaves_like "referenced feature visibility", "issues", "merge_requests" do + before do + project.add_developer(user) if enable_user? + end + end + end + end + + describe '#referenced_by' do + describe 'when the link has a data-alert attribute' do + context 'using an existing alert ID' do + it 'returns an Array of alerts' do + link['data-alert'] = alert.id.to_s + + expect(subject.referenced_by([link])).to eq([alert]) + end + end + + context 'using a non-existing alert ID' do + it 'returns an empty Array' do + link['data-alert'] = '' + + expect(subject.referenced_by([link])).to eq([]) + end + end + end + end +end |