diff options
Diffstat (limited to 'spec/scripts/lib/glfm')
3 files changed, 177 insertions, 129 deletions
diff --git a/spec/scripts/lib/glfm/update_example_snapshots_spec.rb b/spec/scripts/lib/glfm/update_example_snapshots_spec.rb index c97226c1a2d..58e016b6d68 100644 --- a/spec/scripts/lib/glfm/update_example_snapshots_spec.rb +++ b/spec/scripts/lib/glfm/update_example_snapshots_spec.rb @@ -32,8 +32,8 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do subject { described_class.new } # GLFM input files - let(:glfm_spec_txt_path) { described_class::GLFM_SPEC_TXT_PATH } - let(:glfm_spec_txt_local_io) { StringIO.new(glfm_spec_txt_contents) } + let(:es_snapshot_spec_md_path) { described_class::ES_SNAPSHOT_SPEC_MD_PATH } + let(:es_snapshot_spec_md_local_io) { StringIO.new(es_snapshot_spec_md_contents) } let(:glfm_example_status_yml_path) { described_class::GLFM_EXAMPLE_STATUS_YML_PATH } let(:glfm_example_metadata_yml_path) { described_class::GLFM_EXAMPLE_METADATA_YML_PATH } let(:glfm_example_normalizations_yml_path) { described_class::GLFM_EXAMPLE_NORMALIZATIONS_YML_PATH } @@ -53,16 +53,11 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do # Internal tempfiles let(:static_html_tempfile_path) { Tempfile.new.path } - let(:glfm_spec_txt_contents) do + let(:es_snapshot_spec_md_contents) do <<~MARKDOWN --- title: GitLab Flavored Markdown Spec ... - - # Introduction - - GLFM intro text... - # Inlines ## Strong @@ -96,7 +91,7 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do ### Another H3 This is a second consecutive third-level heading. It exists to drive full code coverage - for this scenario, although it doesn't (yet) exist in the actual spec.txt. + for this scenario, although it doesn't (yet) exist in the actual snapshot_spec.md. ## An H2 with all disabled examples @@ -243,12 +238,6 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do . <p><a href="project-wikis-test-file">project-wikis-test-file</a></p> ```````````````````````````````` - - <!-- END TESTS --> - - # Appendix - - Appendix text. MARKDOWN end @@ -305,11 +294,11 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do --- 01_00_00__obsolete_entry_to_be_deleted__001: canonical: | - This entry is no longer exists in the spec.txt, so it will be deleted. + This entry is no longer exists in the snapshot_spec.md, so it will be deleted. static: |- - This entry is no longer exists in the spec.txt, so it will be deleted. + This entry is no longer exists in the snapshot_spec.md, so it will be deleted. wysiwyg: |- - This entry is no longer exists in the spec.txt, so it will be deleted. + This entry is no longer exists in the snapshot_spec.md, so it will be deleted. 02_01_00__inlines__strong__001: canonical: | This entry is existing, but not skipped, so it will be overwritten. @@ -332,7 +321,7 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do --- 01_00_00__obsolete_entry_to_be_deleted__001: |- { - "obsolete": "This entry is no longer exists in the spec.txt, and is not skipped, so it will be deleted." + "obsolete": "This entry is no longer exists in the snapshot_spec.md, and is not skipped, so it will be deleted." } 02_01_00__inlines__strong__001: |- { @@ -370,7 +359,7 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do # actual network and filesystem I/O during the spec run. # input files - allow(File).to receive(:open).with(glfm_spec_txt_path) { glfm_spec_txt_local_io } + allow(File).to receive(:open).with(es_snapshot_spec_md_path) { es_snapshot_spec_md_local_io } allow(File).to receive(:open).with(glfm_example_status_yml_path) do StringIO.new(glfm_example_status_yml_contents) end @@ -454,43 +443,43 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do <<~YAML --- 02_01_00__inlines__strong__001: - spec_txt_example_position: 1 + spec_example_position: 1 source_specification: commonmark 02_01_00__inlines__strong__002: - spec_txt_example_position: 2 + spec_example_position: 2 source_specification: github 02_03_00__inlines__strikethrough_extension__001: - spec_txt_example_position: 4 + spec_example_position: 4 source_specification: github 03_01_00__first_gitlab_specific_section_with_examples__strong_but_with_two_asterisks__001: - spec_txt_example_position: 5 + spec_example_position: 5 source_specification: gitlab 03_02_01__first_gitlab_specific_section_with_examples__h2_which_contains_an_h3__example_in_an_h3__001: - spec_txt_example_position: 6 + spec_example_position: 6 source_specification: gitlab 04_01_00__second_gitlab_specific_section_with_examples__strong_but_with_html__001: - spec_txt_example_position: 7 + spec_example_position: 7 source_specification: gitlab 05_01_00__third_gitlab_specific_section_with_skipped_examples__strong_but_skipped__001: - spec_txt_example_position: 8 + spec_example_position: 8 source_specification: gitlab 05_02_00__third_gitlab_specific_section_with_skipped_examples__strong_but_manually_modified_and_skipped__001: - spec_txt_example_position: 9 + spec_example_position: 9 source_specification: gitlab 06_01_00__api_request_overrides__group_upload_link__001: - spec_txt_example_position: 10 + spec_example_position: 10 source_specification: gitlab 06_02_00__api_request_overrides__project_repo_link__001: - spec_txt_example_position: 11 + spec_example_position: 11 source_specification: gitlab 06_03_00__api_request_overrides__project_snippet_ref__001: - spec_txt_example_position: 12 + spec_example_position: 12 source_specification: gitlab 06_04_00__api_request_overrides__personal_snippet_ref__001: - spec_txt_example_position: 13 + spec_example_position: 13 source_specification: gitlab 06_05_00__api_request_overrides__project_wiki_link__001: - spec_txt_example_position: 14 + spec_example_position: 14 source_specification: gitlab YAML end @@ -696,7 +685,7 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do canonical: | <p><a href="projects-test-file">projects-test-file</a></p> static: |- - <p data-sourcepos="1:1-1:40" dir="auto"><a href="/glfm_group/glfm_project/-/blob/master/projects-test-file">projects-test-file</a></p> + <p data-sourcepos="1:1-1:40" dir="auto"><a href="/glfm_group/glfm_project/-/blob/master/projects-test-file" class="gfm">projects-test-file</a></p> wysiwyg: |- <p><a target="_blank" rel="noopener noreferrer nofollow" href="projects-test-file">projects-test-file</a></p> 06_03_00__api_request_overrides__project_snippet_ref__001: diff --git a/spec/scripts/lib/glfm/update_specification_spec.rb b/spec/scripts/lib/glfm/update_specification_spec.rb index 852b2b580e6..ccf1a8fd26a 100644 --- a/spec/scripts/lib/glfm/update_specification_spec.rb +++ b/spec/scripts/lib/glfm/update_specification_spec.rb @@ -37,18 +37,44 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do let(:ghfm_spec_md_path) { described_class::GHFM_SPEC_MD_PATH } let(:ghfm_spec_txt_local_io) { StringIO.new(ghfm_spec_txt_contents) } - let(:glfm_intro_md_path) { described_class::GLFM_INTRO_MD_PATH } - let(:glfm_intro_md_io) { StringIO.new(glfm_intro_md_contents) } - let(:glfm_official_specification_examples_md_path) { described_class::GLFM_OFFICIAL_SPECIFICATION_EXAMPLES_MD_PATH } - let(:glfm_official_specification_examples_md_io) { StringIO.new(glfm_official_specification_examples_md_contents) } - let(:glfm_internal_extension_examples_md_path) { described_class::GLFM_INTERNAL_EXTENSION_EXAMPLES_MD_PATH } - let(:glfm_internal_extension_examples_md_io) { StringIO.new(glfm_internal_extension_examples_md_contents) } + let(:glfm_official_specification_md_path) { described_class::GLFM_OFFICIAL_SPECIFICATION_MD_PATH } + let(:glfm_official_specification_md_io) { StringIO.new(glfm_official_specification_md_contents) } + let(:glfm_internal_extensions_md_path) { described_class::GLFM_INTERNAL_EXTENSIONS_MD_PATH } + let(:glfm_internal_extensions_md_io) { StringIO.new(glfm_internal_extensions_md_contents) } let(:glfm_spec_txt_path) { described_class::GLFM_SPEC_TXT_PATH } let(:glfm_spec_txt_io) { StringIO.new } let(:glfm_spec_html_path) { described_class::GLFM_SPEC_HTML_PATH } let(:glfm_spec_html_io) { StringIO.new } + let(:es_snapshot_spec_md_path) { described_class::ES_SNAPSHOT_SPEC_MD_PATH } + let(:es_snapshot_spec_md_io) { StringIO.new } + let(:es_snapshot_spec_html_path) { described_class::ES_SNAPSHOT_SPEC_HTML_PATH } + let(:es_snapshot_spec_html_io) { StringIO.new } let(:markdown_tempfile_io) { StringIO.new } + let(:ghfm_spec_txt_examples) do + <<~MARKDOWN + # Section with Examples + + ## Emphasis and Strong + + ```````````````````````````````` example + _EMPHASIS LINE 1_ + _EMPHASIS LINE 2_ + . + <p><em>EMPHASIS LINE 1</em> + <em>EMPHASIS LINE 2</em></p> + ```````````````````````````````` + + ```````````````````````````````` example + __STRONG!__ + . + <p><strong>STRONG!</strong></p> + ```````````````````````````````` + + End of last GitHub examples section. + MARKDOWN + end + let(:ghfm_spec_txt_contents) do <<~MARKDOWN --- @@ -60,22 +86,9 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do # Introduction - ## What is GitHub Flavored Markdown? - - It's like GLFM, but with an H. - - # Section with Examples - - ## Strong - - ```````````````````````````````` example - __bold__ - . - <p><strong>bold</strong></p> - ```````````````````````````````` - - End of last GitHub examples section. + GHFM Intro. + #{ghfm_spec_txt_examples} <!-- END TESTS --> # Appendix @@ -84,26 +97,28 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do MARKDOWN end - let(:glfm_intro_md_contents) do - # language=Markdown + let(:glfm_official_specification_md_examples) do <<~MARKDOWN - # Introduction - - ## What is GitLab Flavored Markdown? + # Official Specification Section with Examples - Intro text about GitLab Flavored Markdown. + Some examples. MARKDOWN end - let(:glfm_official_specification_examples_md_contents) do + let(:glfm_official_specification_md_contents) do <<~MARKDOWN - # Official Specification Section with Examples + # GLFM Introduction - Some examples. + GLFM intro text. + + <!-- BEGIN TESTS --> + #{glfm_official_specification_md_examples} + <!-- END TESTS --> + # Non-example official content MARKDOWN end - let(:glfm_internal_extension_examples_md_contents) do + let(:glfm_internal_extensions_md_examples) do <<~MARKDOWN # Internal Extension Section with Examples @@ -111,10 +126,19 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do MARKDOWN end + let(:glfm_internal_extensions_md_contents) do + <<~MARKDOWN + # Non-example internal content + <!-- BEGIN TESTS --> + #{glfm_internal_extensions_md_examples} + <!-- END TESTS --> + # More non-example internal content + MARKDOWN + end + before do # Mock default ENV var values - allow(ENV).to receive(:[]).with('UPDATE_GHFM_SPEC_MD').and_return(nil) - allow(ENV).to receive(:[]).and_call_original + stub_env('UPDATE_GHFM_SPEC_MD') # We mock out the URI and local file IO objects with real StringIO, instead of just mock # objects. This gives better and more realistic coverage, while still avoiding @@ -124,17 +148,18 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do allow(URI).to receive(:parse).with(ghfm_spec_txt_uri).and_return(ghfm_spec_txt_uri_parsed) allow(ghfm_spec_txt_uri_parsed).to receive(:open).and_return(ghfm_spec_txt_uri_io) allow(File).to receive(:open).with(ghfm_spec_md_path) { ghfm_spec_txt_local_io } - allow(File).to receive(:open).with(glfm_intro_md_path) { glfm_intro_md_io } - allow(File).to receive(:open).with(glfm_official_specification_examples_md_path) do - glfm_official_specification_examples_md_io + allow(File).to receive(:open).with(glfm_official_specification_md_path) do + glfm_official_specification_md_io end - allow(File).to receive(:open).with(glfm_internal_extension_examples_md_path) do - glfm_internal_extension_examples_md_io + allow(File).to receive(:open).with(glfm_internal_extensions_md_path) do + glfm_internal_extensions_md_io end # output files allow(File).to receive(:open).with(glfm_spec_txt_path, 'w') { glfm_spec_txt_io } allow(File).to receive(:open).with(glfm_spec_html_path, 'w') { glfm_spec_html_io } + allow(File).to receive(:open).with(es_snapshot_spec_md_path, 'w') { es_snapshot_spec_md_io } + allow(File).to receive(:open).with(es_snapshot_spec_html_path, 'w') { es_snapshot_spec_html_io } # Allow normal opening of Tempfile files created during script execution. tempfile_basenames = [ @@ -166,7 +191,7 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do let(:ghfm_spec_txt_local_io) { StringIO.new } before do - allow(ENV).to receive(:[]).with('UPDATE_GHFM_SPEC_MD').and_return('true') + stub_env('UPDATE_GHFM_SPEC_MD', 'true') allow(File).to receive(:open).with(ghfm_spec_md_path, 'w') { ghfm_spec_txt_local_io } end @@ -217,90 +242,121 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do end end - describe 'writing GLFM spec.txt' do - let(:glfm_contents) { reread_io(glfm_spec_txt_io) } + describe 'writing output_spec/spec.txt' do + let(:glfm_spec_txt_contents) { reread_io(glfm_spec_txt_io) } before do subject.process(skip_spec_html_generation: true) end - it 'replaces the header text with the GitLab version' do - expect(glfm_contents).not_to match(/GitHub Flavored Markdown Spec/m) - expect(glfm_contents).not_to match(/^version: \d\.\d/m) - expect(glfm_contents).not_to match(/^date: /m) - expect(glfm_contents).not_to match(/^license: /m) - expect(glfm_contents).to match(/#{Regexp.escape(described_class::GLFM_SPEC_TXT_HEADER)}\n/mo) + it 'includes only the header and official examples' do + expected = described_class::GLFM_SPEC_TXT_HEADER + glfm_official_specification_md_contents + expect(glfm_spec_txt_contents).to eq(expected) end + end - it 'replaces the intro section with the GitLab version' do - expect(glfm_contents).not_to match(/What is GitHub Flavored Markdown/m) - expect(glfm_contents).to match(/#{Regexp.escape(glfm_intro_md_contents)}/m) - end - - it 'inserts the GitLab official spec and internal extension examples sections before the appendix section' do - expected = <<~MARKDOWN - End of last GitHub examples section. - - # Official Specification Section with Examples - - Some examples. + describe 'writing output_example_snapshots/snapshot_spec.md' do + let(:es_snapshot_spec_md_contents) { reread_io(es_snapshot_spec_md_io) } - # Internal Extension Section with Examples + before do + subject.process(skip_spec_html_generation: true) + end - Some examples. + it 'replaces the header text with the GitLab version' do + expect(es_snapshot_spec_md_contents).not_to match(/GitHub Flavored Markdown Spec/m) + expect(es_snapshot_spec_md_contents).not_to match(/^version: \d\.\d/m) + expect(es_snapshot_spec_md_contents).not_to match(/^date: /m) - <!-- END TESTS --> + expect(es_snapshot_spec_md_contents).to match(/#{Regexp.escape(described_class::GLFM_SPEC_TXT_HEADER)}/mo) + end - # Appendix - MARKDOWN - expect(glfm_contents).to match(/#{Regexp.escape(expected)}/m) + it 'includes header and all examples', :unlimited_max_formatted_output_length do + # rubocop:disable Style/StringConcatenation (string contatenation is more readable) + expected = described_class::GLFM_SPEC_TXT_HEADER + + ghfm_spec_txt_examples + + "\n" + + glfm_official_specification_md_examples + + "\n\n" + # NOTE: We want a blank line between the official and internal examples + glfm_internal_extensions_md_examples + + "\n" + # rubocop:enable Style/StringConcatenation + expect(es_snapshot_spec_md_contents).to eq(expected) end end - describe 'writing GLFM spec.html' do - let(:glfm_contents) { reread_io(glfm_spec_html_io) } + # rubocop:disable RSpec/MultipleMemoizedHelpers + describe 'writing output html files' do + let(:spec_html_contents) { reread_io(glfm_spec_html_io) } + let(:snapshot_spec_html_contents) { reread_io(es_snapshot_spec_html_io) } before do subject.process end - it 'renders HTML from spec.txt', :unlimited_max_formatted_output_length do - expected = <<~HTML + it 'renders expected HTML', :unlimited_max_formatted_output_length do + # NOTE: We do assertions for both output HTML files in this same `it` example block, + # because calling a full `subject.process` without `skip_spec_html_generation: true` + # is very slow, and want to avoid doing it twice. + + expected_spec_html = <<~RENDERED_HTML + <div class="gl-relative markdown-code-block js-markdown-code"> + <pre data-sourcepos="1:1-4:3" lang="yaml" class="code highlight js-syntax-highlight language-yaml" data-lang-params="frontmatter" v-pre="true"><code><span id="LC1" class="line" lang="yaml"><span class="na">title</span><span class="pi">:</span> <span class="s">GitLab Flavored Markdown (GLFM) Spec</span></span> + <span id="LC2" class="line" lang="yaml"><span class="na">version</span><span class="pi">:</span> <span class="s">alpha</span></span></code></pre> + <copy-code></copy-code> + </div> + <h1 data-sourcepos="5:1-5:19" dir="auto"> + <a id="user-content-glfm-introduction" class="anchor" href="#glfm-introduction" aria-hidden="true"></a>GLFM Introduction</h1> + <p data-sourcepos="7:1-7:16" dir="auto">GLFM intro text.</p> + + <h1 data-sourcepos="10:1-10:46" dir="auto"> + <a id="user-content-official-specification-section-with-examples" class="anchor" href="#official-specification-section-with-examples" aria-hidden="true"></a>Official Specification Section with Examples</h1> + <p data-sourcepos="12:1-12:14" dir="auto">Some examples.</p> + + <h1 data-sourcepos="15:1-15:30" dir="auto"> + <a id="user-content-non-example-official-content" class="anchor" href="#non-example-official-content" aria-hidden="true"></a>Non-example official content</h1> + RENDERED_HTML + expect(spec_html_contents).to be == expected_spec_html + + expected_snapshot_spec_html = <<~RENDERED_HTML <div class="gl-relative markdown-code-block js-markdown-code"> - <pre data-sourcepos="1:1-4:3" class="code highlight js-syntax-highlight language-yaml" lang="yaml" data-lang-params="frontmatter" v-pre="true"><code><span id="LC1" class="line" lang="yaml"><span class="na">title</span><span class="pi">:</span> <span class="s">GitLab Flavored Markdown (GLFM) Spec</span></span> + <pre data-sourcepos="1:1-4:3" lang="yaml" class="code highlight js-syntax-highlight language-yaml" data-lang-params="frontmatter" v-pre="true"><code><span id="LC1" class="line" lang="yaml"><span class="na">title</span><span class="pi">:</span> <span class="s">GitLab Flavored Markdown (GLFM) Spec</span></span> <span id="LC2" class="line" lang="yaml"><span class="na">version</span><span class="pi">:</span> <span class="s">alpha</span></span></code></pre> <copy-code></copy-code> </div> - <h1 data-sourcepos="6:1-6:14" dir="auto"> - <a id="user-content-introduction" class="anchor" href="#introduction" aria-hidden="true"></a>Introduction</h1> - <h2 data-sourcepos="8:1-8:36" dir="auto"> - <a id="user-content-what-is-gitlab-flavored-markdown" class="anchor" href="#what-is-gitlab-flavored-markdown" aria-hidden="true"></a>What is GitLab Flavored Markdown?</h2> - <p data-sourcepos="10:1-10:42" dir="auto">Intro text about GitLab Flavored Markdown.</p> - <h1 data-sourcepos="12:1-12:23" dir="auto"> + <h1 data-sourcepos="5:1-5:23" dir="auto"> <a id="user-content-section-with-examples" class="anchor" href="#section-with-examples" aria-hidden="true"></a>Section with Examples</h1> - <h2 data-sourcepos="14:1-14:9" dir="auto"> - <a id="user-content-strong" class="anchor" href="#strong" aria-hidden="true"></a>Strong</h2> + <h2 data-sourcepos="7:1-7:22" dir="auto"> + <a id="user-content-emphasis-and-strong" class="anchor" href="#emphasis-and-strong" aria-hidden="true"></a>Emphasis and Strong</h2> <div class="gl-relative markdown-code-block js-markdown-code"> - <pre data-sourcepos="16:1-20:32" class="code highlight js-syntax-highlight language-plaintext" lang="plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">__bold__</span> - <span id="LC2" class="line" lang="plaintext">.</span> - <span id="LC3" class="line" lang="plaintext"><p><strong>bold</strong></p></span></code></pre> + <pre data-sourcepos="9:1-12:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">_EMPHASIS LINE 1_</span> + <span id="LC2" class="line" lang="plaintext">_EMPHASIS LINE 2_</span></code></pre> <copy-code></copy-code> </div> - <p data-sourcepos="22:1-22:36" dir="auto">End of last GitHub examples section.</p> - <h1 data-sourcepos="24:1-24:46" dir="auto"> + <div class="gl-relative markdown-code-block js-markdown-code"> + <pre data-sourcepos="14:1-17:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><p><em>EMPHASIS LINE 1</em></span> + <span id="LC2" class="line" lang="plaintext"><em>EMPHASIS LINE 2</em></p></span></code></pre> + <copy-code></copy-code> + </div> + <div class="gl-relative markdown-code-block js-markdown-code"> + <pre data-sourcepos="19:1-21:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">__STRONG!__</span></code></pre> + <copy-code></copy-code> + </div> + <div class="gl-relative markdown-code-block js-markdown-code"> + <pre data-sourcepos="23:1-25:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><p><strong>STRONG!</strong></p></span></code></pre> + <copy-code></copy-code> + </div> + <p data-sourcepos="27:1-27:36" dir="auto">End of last GitHub examples section.</p> + <h1 data-sourcepos="29:1-29:46" dir="auto"> <a id="user-content-official-specification-section-with-examples" class="anchor" href="#official-specification-section-with-examples" aria-hidden="true"></a>Official Specification Section with Examples</h1> - <p data-sourcepos="26:1-26:14" dir="auto">Some examples.</p> - <h1 data-sourcepos="28:1-28:42" dir="auto"> + <p data-sourcepos="31:1-31:14" dir="auto">Some examples.</p> + <h1 data-sourcepos="34:1-34:42" dir="auto"> <a id="user-content-internal-extension-section-with-examples" class="anchor" href="#internal-extension-section-with-examples" aria-hidden="true"></a>Internal Extension Section with Examples</h1> - <p data-sourcepos="30:1-30:14" dir="auto">Some examples.</p> - - <h1 data-sourcepos="34:1-34:10" dir="auto"> - <a id="user-content-appendix" class="anchor" href="#appendix" aria-hidden="true"></a>Appendix</h1> - <p data-sourcepos="36:1-36:14" dir="auto">Appendix text.</p> - HTML - expect(glfm_contents).to be == expected + <p data-sourcepos="36:1-36:14" dir="auto">Some examples.</p> + RENDERED_HTML + expect(snapshot_spec_html_contents).to be == expected_snapshot_spec_html end end + # rubocop:enable RSpec/MultipleMemoizedHelpers def reread_io(io) # Reset the io StringIO to the beginning position of the buffer diff --git a/spec/scripts/lib/glfm/verify_all_generated_files_are_up_to_date_spec.rb b/spec/scripts/lib/glfm/verify_all_generated_files_are_up_to_date_spec.rb index fca037c9ff3..c678565fe90 100644 --- a/spec/scripts/lib/glfm/verify_all_generated_files_are_up_to_date_spec.rb +++ b/spec/scripts/lib/glfm/verify_all_generated_files_are_up_to_date_spec.rb @@ -9,8 +9,8 @@ require_relative '../../../../scripts/lib/glfm/verify_all_generated_files_are_up RSpec.describe Glfm::VerifyAllGeneratedFilesAreUpToDate, '#process' do subject { described_class.new } - let(:output_path) { described_class::GLFM_SPEC_OUTPUT_PATH } - let(:snapshots_path) { described_class::EXAMPLE_SNAPSHOTS_PATH } + let(:output_path) { described_class::GLFM_OUTPUT_SPEC_PATH } + let(:snapshots_path) { described_class::ES_OUTPUT_EXAMPLE_SNAPSHOTS_PATH } let(:verify_cmd) { "git status --porcelain #{output_path} #{snapshots_path}" } before do @@ -52,10 +52,13 @@ RSpec.describe Glfm::VerifyAllGeneratedFilesAreUpToDate, '#process' do before do # Simulate a clean repo, then simulate changes to generated files allow(subject).to receive(:run_external_cmd).twice.with(verify_cmd).and_return('', "M #{snapshots_path}") + allow(subject).to receive(:run_external_cmd).with('git diff') + allow(subject).to receive(:warn).and_call_original end it 'raises an error', :unlimited_max_formatted_output_length do - expect { subject.process }.to raise_error(/following files were modified.*#{snapshots_path}/m) + expect(subject).to receive(:warn).with(/following files were modified.*#{snapshots_path}/m) + expect { subject.process }.to raise_error(/The generated files are not up to date/) end end end |