github_changelog_generator 1.16.3 → 1.17.0

data/spec/unit/generator/generator_spec.rb

@@ -44,4 +44,155 @@ RSpec.describe GitHubChangelogGenerator::Generator do
       end
     end
   end
+
+  describe "#add_first_occurring_tag_to_prs" do
+    def sha(num)
+      base = num.to_s
+      pad_length = 40 - base.length
+      "#{'a' * pad_length}#{base}"
+    end
+
+    let(:release_branch_name) { "release" }
+    let(:generator) { described_class.new({ release_branch: release_branch_name }) }
+    let(:fake_fetcher) do
+      instance_double(GitHubChangelogGenerator::OctoFetcher,
+                      fetch_tag_shas: nil,
+                      fetch_comments_async: nil)
+    end
+
+    before do
+      allow(fake_fetcher)
+        .to receive(:commits_in_branch).with(release_branch_name)
+                                       .and_return([sha(1), sha(2), sha(3), sha(4)])
+      allow(GitHubChangelogGenerator::OctoFetcher).to receive(:new).and_return(fake_fetcher)
+    end
+
+    it "associates prs to the oldest tag containing the merge commit" do
+      prs = [{ "number" => "23", "events" => [{ "event" => "merged", "commit_id" => sha(2) }] }]
+      tags = [
+        { "name" => "newer2.0", "shas_in_tag" => [sha(1), sha(2), sha(3)] },
+        { "name" => "older1.0", "shas_in_tag" => [sha(1), sha(2)] }
+      ]
+
+      prs_left = generator.send(:add_first_occurring_tag_to_prs, tags, prs)
+
+      aggregate_failures do
+        expect(prs_left).to be_empty
+        expect(prs.first["first_occurring_tag"]).to eq "older1.0"
+
+        expect(fake_fetcher).to have_received(:fetch_tag_shas)
+        expect(fake_fetcher).not_to have_received(:fetch_comments_async)
+      end
+    end
+
+    it "detects prs merged in the release branch" do
+      prs = [{ "number" => "23", "events" => [{ "event" => "merged", "commit_id" => sha(4) }] }]
+      tags = [{ "name" => "v1.0", "shas_in_tag" => [sha(1), sha(2)] }]
+
+      prs_left = generator.send(:add_first_occurring_tag_to_prs, tags, prs)
+
+      aggregate_failures do
+        expect(prs_left).to be_empty
+        expect(prs.first["first_occurring_tag"]).to be_nil
+
+        expect(fake_fetcher).to have_received(:fetch_tag_shas)
+        expect(fake_fetcher).not_to have_received(:fetch_comments_async)
+      end
+    end
+
+    it "detects closed prs marked as rebased in a tag" do
+      prs = [{ "number" => "23", "comments" => [{ "body" => "rebased commit: #{sha(2)}" }] }]
+      tags = [{ "name" => "v1.0", "shas_in_tag" => [sha(1), sha(2)] }]
+
+      prs_left = generator.send(:add_first_occurring_tag_to_prs, tags, prs)
+
+      aggregate_failures do
+        expect(prs_left).to be_empty
+        expect(prs.first["first_occurring_tag"]).to eq "v1.0"
+
+        expect(fake_fetcher).to have_received(:fetch_tag_shas)
+        expect(fake_fetcher).to have_received(:fetch_comments_async)
+      end
+    end
+
+    it "detects closed prs marked as rebased in the release branch" do
+      prs = [{ "number" => "23", "comments" => [{ "body" => "rebased commit: #{sha(4)}" }] }]
+      tags = [{ "name" => "v1.0", "shas_in_tag" => [sha(1), sha(2)] }]
+
+      prs_left = generator.send(:add_first_occurring_tag_to_prs, tags, prs)
+
+      aggregate_failures do
+        expect(prs_left).to be_empty
+        expect(prs.first["first_occurring_tag"]).to be_nil
+
+        expect(fake_fetcher).to have_received(:fetch_tag_shas)
+        expect(fake_fetcher).to have_received(:fetch_comments_async)
+      end
+    end
+
+    it "leaves prs merged in another branch" do
+      prs = [{ "number" => "23", "events" => [{ "event" => "merged", "commit_id" => sha(5) }] }]
+      tags = [{ "name" => "v1.0", "shas_in_tag" => [sha(1), sha(2)] }]
+
+      prs_left = generator.send(:add_first_occurring_tag_to_prs, tags, prs)
+
+      aggregate_failures do
+        expect(prs_left).to eq prs
+        expect(prs.first["first_occurring_tag"]).to be_nil
+
+        expect(fake_fetcher).to have_received(:fetch_tag_shas)
+        expect(fake_fetcher).to have_received(:fetch_comments_async)
+      end
+    end
+
+    it "detects prs merged elsewhere and marked as rebased in a tag" do
+      prs = [{ "number" => "23",
+               "events" => [{ "event" => "merged", "commit_id" => sha(5) }],
+               "comments" => [{ "body" => "rebased commit: #{sha(2)}" }] }]
+      tags = [{ "name" => "v1.0", "shas_in_tag" => [sha(1), sha(2)] }]
+
+      prs_left = generator.send(:add_first_occurring_tag_to_prs, tags, prs)
+
+      aggregate_failures do
+        expect(prs_left).to be_empty
+        expect(prs.first["first_occurring_tag"]).to eq "v1.0"
+
+        expect(fake_fetcher).to have_received(:fetch_tag_shas)
+        expect(fake_fetcher).to have_received(:fetch_comments_async)
+      end
+    end
+
+    it "detects prs merged elsewhere and marked as rebased in the release branch" do
+      prs = [{ "number" => "23",
+               "events" => [{ "event" => "merged", "commit_id" => sha(5) }],
+               "comments" => [{ "body" => "rebased commit: #{sha(4)}" }] }]
+      tags = [{ "name" => "v1.0", "shas_in_tag" => [sha(1), sha(2)] }]
+
+      prs_left = generator.send(:add_first_occurring_tag_to_prs, tags, prs)
+
+      aggregate_failures do
+        expect(prs_left).to be_empty
+        expect(prs.first["first_occurring_tag"]).to be_nil
+
+        expect(fake_fetcher).to have_received(:fetch_tag_shas)
+        expect(fake_fetcher).to have_received(:fetch_comments_async)
+      end
+    end
+
+    it "raises an error for closed prs marked as rebased to an unknown commit" do
+      prs = [{ "number" => "23", "comments" => [{ "body" => "rebased commit: #{sha(5)}" }] }]
+      tags = [{ "name" => "v1.0", "shas_in_tag" => [sha(1), sha(2)] }]
+
+      expect { generator.send(:add_first_occurring_tag_to_prs, tags, prs) }
+        .to raise_error StandardError, "PR 23 has a rebased SHA comment but that SHA was not found in the release branch or any tags"
+    end
+
+    it "raises an error for prs without merge event or rebase comment" do
+      prs = [{ "number" => "23" }]
+      tags = [{ "name" => "v1.0", "shas_in_tag" => [sha(1), sha(2)] }]
+
+      expect { generator.send(:add_first_occurring_tag_to_prs, tags, prs) }
+        .to raise_error StandardError, "No merge sha found for PR 23 via the GitHub API"
+    end
+  end
 end

data/spec/unit/generator/generator_tags_spec.rb

@@ -49,7 +49,7 @@ describe GitHubChangelogGenerator::Generator do
     let(:generator) { described_class.new(default_options.merge(options)) }
 
     before do
-      allow_any_instance_of(GitHubChangelogGenerator::OctoFetcher).to receive(:get_all_tags).and_return(all_tags)
+      allow_any_instance_of(GitHubChangelogGenerator::OctoFetcher).to receive(:fetch_all_tags).and_return(all_tags)
       allow(generator).to receive(:fetch_tags_dates).with(all_tags)
       allow(generator).to receive(:sort_tags_by_date).with(all_tags).and_return(sorted_tags)
       generator.fetch_and_filter_tags

data/spec/unit/generator/section_spec.rb

@@ -30,5 +30,14 @@ module GitHubChangelogGenerator
         end
       end
     end
+
+    describe "#normalize_body" do
+      context "it should remove CR" do
+        let(:body) { "Some content from GitHub\r\n\r\nUser is describing something" }
+        it "returns a cleaned body" do
+          expect(section.send(:normalize_body, body)).to eq "Some content from GitHub\n\nUser is describing something"
+        end
+      end
+    end
   end
 end

data/spec/unit/octo_fetcher_spec.rb

@@ -29,9 +29,6 @@ describe GitHubChangelogGenerator::OctoFetcher do
 
     context "when raises Octokit::Forbidden" do
       it "sleeps and retries and then aborts" do
-        retry_limit = GitHubChangelogGenerator::OctoFetcher::MAX_FORBIDDEN_RETRIES - 1
-        allow(fetcher).to receive(:sleep_base_interval).exactly(retry_limit).times.and_return(0)
-
         expect(fetcher).to receive(:sys_abort).with("Exceeded retry limit")
         fetcher.send(:check_github_response) { raise(Octokit::Forbidden) }
       end
@@ -75,12 +72,12 @@ describe GitHubChangelogGenerator::OctoFetcher do
     end
   end
 
-  describe "#get_all_tags" do
+  describe "#fetch_all_tags" do
     context "when github_fetch_tags returns tags" do
       it "returns tags" do
         mock_tags = ["tag"]
         allow(fetcher).to receive(:github_fetch_tags).and_return(mock_tags)
-        expect(fetcher.get_all_tags).to eq(mock_tags)
+        expect(fetcher.fetch_all_tags).to eq(mock_tags)
       end
     end
   end
@@ -550,21 +547,21 @@ describe GitHubChangelogGenerator::OctoFetcher do
         expectations = [
           %w[sha decfe840d1a1b86e0c28700de5362d3365a29555],
           ["url",
-           "https://api.github.com/repos/skywinder/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555"],
+           "https://api.github.com/repos/github-changelog-generator/changelog_test/commits/decfe840d1a1b86e0c28700de5362d3365a29555"],
           # OLD API: "https://api.github.com/repos/skywinder/changelog_test/git/commits/decfe840d1a1b86e0c28700de5362d3365a29555"],
           ["html_url",
-           "https://github.com/skywinder/changelog_test/commit/decfe840d1a1b86e0c28700de5362d3365a29555"],
+           "https://github.com/github-changelog-generator/changelog_test/commit/decfe840d1a1b86e0c28700de5362d3365a29555"],
           ["author",
-           { "login" => "skywinder", "id" => 3_356_474, "avatar_url" => "https://avatars2.githubusercontent.com/u/3356474?v=4", "gravatar_id" => "", "url" => "https://api.github.com/users/skywinder", "html_url" => "https://github.com/skywinder", "followers_url" => "https://api.github.com/users/skywinder/followers", "following_url" => "https://api.github.com/users/skywinder/following{/other_user}", "gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}", "starred_url" => "https://api.github.com/users/skywinder/starred{/owner}{/repo}", "subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions", "organizations_url" => "https://api.github.com/users/skywinder/orgs", "repos_url" => "https://api.github.com/users/skywinder/repos", "events_url" => "https://api.github.com/users/skywinder/events{/privacy}", "received_events_url" => "https://api.github.com/users/skywinder/received_events", "type" => "User", "site_admin" => false }],
+           { "login" => "skywinder", "node_id" => "MDQ6VXNlcjMzNTY0NzQ=", "id" => 3_356_474, "avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=4", "gravatar_id" => "", "url" => "https://api.github.com/users/skywinder", "html_url" => "https://github.com/skywinder", "followers_url" => "https://api.github.com/users/skywinder/followers", "following_url" => "https://api.github.com/users/skywinder/following{/other_user}", "gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}", "starred_url" => "https://api.github.com/users/skywinder/starred{/owner}{/repo}", "subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions", "organizations_url" => "https://api.github.com/users/skywinder/orgs", "repos_url" => "https://api.github.com/users/skywinder/repos", "events_url" => "https://api.github.com/users/skywinder/events{/privacy}", "received_events_url" => "https://api.github.com/users/skywinder/received_events", "type" => "User", "site_admin" => false }],
           ["committer",
-           { "login" => "skywinder", "id" => 3_356_474, "avatar_url" => "https://avatars2.githubusercontent.com/u/3356474?v=4", "gravatar_id" => "", "url" => "https://api.github.com/users/skywinder", "html_url" => "https://github.com/skywinder", "followers_url" => "https://api.github.com/users/skywinder/followers", "following_url" => "https://api.github.com/users/skywinder/following{/other_user}", "gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}", "starred_url" => "https://api.github.com/users/skywinder/starred{/owner}{/repo}", "subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions", "organizations_url" => "https://api.github.com/users/skywinder/orgs", "repos_url" => "https://api.github.com/users/skywinder/repos", "events_url" => "https://api.github.com/users/skywinder/events{/privacy}", "received_events_url" => "https://api.github.com/users/skywinder/received_events", "type" => "User", "site_admin" => false }],
+           { "login" => "skywinder", "node_id" => "MDQ6VXNlcjMzNTY0NzQ=", "id" => 3_356_474, "avatar_url" => "https://avatars.githubusercontent.com/u/3356474?v=4", "gravatar_id" => "", "url" => "https://api.github.com/users/skywinder", "html_url" => "https://github.com/skywinder", "followers_url" => "https://api.github.com/users/skywinder/followers", "following_url" => "https://api.github.com/users/skywinder/following{/other_user}", "gists_url" => "https://api.github.com/users/skywinder/gists{/gist_id}", "starred_url" => "https://api.github.com/users/skywinder/starred{/owner}{/repo}", "subscriptions_url" => "https://api.github.com/users/skywinder/subscriptions", "organizations_url" => "https://api.github.com/users/skywinder/orgs", "repos_url" => "https://api.github.com/users/skywinder/repos", "events_url" => "https://api.github.com/users/skywinder/events{/privacy}", "received_events_url" => "https://api.github.com/users/skywinder/received_events", "type" => "User", "site_admin" => false }],
           ["parents",
            [{ "sha" => "7ec095e5e3caceacedabf44d0b9b10da17c92e51",
               "url" =>
-               "https://api.github.com/repos/skywinder/changelog_test/commits/7ec095e5e3caceacedabf44d0b9b10da17c92e51",
+               "https://api.github.com/repos/github-changelog-generator/changelog_test/commits/7ec095e5e3caceacedabf44d0b9b10da17c92e51",
               # OLD API: "https://api.github.com/repos/skywinder/changelog_test/git/commits/7ec095e5e3caceacedabf44d0b9b10da17c92e51",
               "html_url" =>
-               "https://github.com/skywinder/changelog_test/commit/7ec095e5e3caceacedabf44d0b9b10da17c92e51" }]]
+               "https://github.com/github-changelog-generator/changelog_test/commit/7ec095e5e3caceacedabf44d0b9b10da17c92e51" }]]
         ]
 
         expectations.each do |property, value|

data/spec/unit/{parse_file_spec.rb → parser_file_spec.rb}

@@ -3,15 +3,18 @@
 describe GitHubChangelogGenerator::ParserFile do
   describe ".github_changelog_generator" do
     let(:options) { {} }
+    let(:parser) { described_class.new(options, StringIO.new(file)) }
 
     context "when the well-known default file does not exist" do
-      let(:parser) { GitHubChangelogGenerator::ParserFile.new(options) }
+      let(:parser) { described_class.new(options) }
+
       subject { parser.parse! }
+
       it { is_expected.to be_nil }
     end
 
     context "when file is empty" do
-      let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, StringIO.new("")) }
+      let(:file) { "" }
 
       it "does not change the options" do
         expect { parser.parse! }.to_not(change { options })
@@ -19,19 +22,26 @@ describe GitHubChangelogGenerator::ParserFile do
     end
 
     context "when file is incorrect" do
-      let(:options_before_change) { options.dup }
-      let(:file) { StringIO.new("unreleased_label=staging\nunreleased: false") }
-      let(:parser) do
-        GitHubChangelogGenerator::ParserFile.new(options, file)
+      let(:file) do
+        <<~FILE.strip
+          unreleased_label=staging
+          unreleased: false
+        FILE
       end
+
       it { expect { parser.parse! }.to raise_error(/line #2/) }
     end
 
     context "allows empty lines and comments with semi-colon or pound sign" do
-      let(:file) { StringIO.new("\n   \n# Comment on first line\nunreleased_label=staging\n; Comment on third line\nunreleased=false") }
-      let(:parser) do
-        GitHubChangelogGenerator::ParserFile.new(options, file)
+      let(:file) do
+        "\n   \n#{<<~REMAINING.strip}"
+          # Comment on first line
+          unreleased_label=staging
+          ; Comment on third line
+          unreleased=false
+        REMAINING
       end
+
       it { expect { parser.parse! }.not_to raise_error }
     end
 
@@ -39,22 +49,32 @@ describe GitHubChangelogGenerator::ParserFile do
       let(:default_options) { GitHubChangelogGenerator::Parser.default_options.merge(verbose: false) }
       let(:options) { {}.merge(default_options) }
       let(:options_before_change) { options.dup }
-      let(:file) { StringIO.new("unreleased_label=staging\nunreleased=false\nheader==== Changelog ===") }
-      let(:parser) { GitHubChangelogGenerator::ParserFile.new(options, file) }
+      let(:file) do
+        <<~FILE.strip
+          unreleased_label=staging
+          unreleased=false
+          header==== Changelog ===
+          max_issues=123
+          simple-list=true
+        FILE
+      end
 
       it "changes the options" do
         expect { parser.parse! }.to change { options }
           .from(options_before_change)
           .to(options_before_change.merge(unreleased_label: "staging",
                                           unreleased: false,
-                                          header: "=== Changelog ==="))
+                                          header: "=== Changelog ===",
+                                          max_issues: 123,
+                                          simple_list: true))
       end
 
       context "turns exclude-labels into an Array", bug: "#327" do
         let(:file) do
-          line1 = "exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90\n"
-          line2 = "header_label=# My changelog\n"
-          StringIO.new(line1 + line2)
+          <<~FILE
+            exclude-labels=73a91042-da6f-11e5-9335-1040f38d7f90,7adf83b4-da6f-11e5-ae18-1040f38d7f90
+            header_label=# My changelog
+          FILE
         end
 
         it "reads exclude_labels into an Array" do

data/spec/unit/reader_spec.rb

@@ -38,6 +38,15 @@ describe GitHubChangelogGenerator::Reader do
       it { is_expected.to include("url" => "https://github.com/github-changelog-generator/Github-Changelog-Generator/tree/1.3.10") }
       it { is_expected.to include("date" => "2015-03-18") }
     end
+    context "when given a named link" do
+      subject { @reader.parse_heading("## [1.3.10]") }
+      it { is_expected.to include("version" => "1.3.10") }
+    end
+    context "when given a named link with date" do
+      subject { @reader.parse_heading("## [1.3.10] (2015-03-18)") }
+      it { is_expected.to include("version" => "1.3.10") }
+      it { is_expected.to include("date" => "2015-03-18") }
+    end
     context "when no url and date is provided" do
       subject { @reader.parse_heading("## foobar") }
       it { is_expected.to include("version" => "foobar", "url" => nil, "date" => nil) }