git-pr-release 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f42f2fbcbe9b84d8350c7000d2b0ca020cb6dd1cea5e1052589d496c6a508ed8
-  data.tar.gz: 3870591b45c379d9d313eb3dd5b753b299e1b794700b84b0ba5be37ba99e45d9
+  metadata.gz: 9a844daa490c47830e91fa7246c0b156c125c88015267325270a38591714efd3
+  data.tar.gz: c186c70a276036feb41445a96c1902f75978e22a41733ecc48e82debd8b57c18
 SHA512:
-  metadata.gz: c12cef27a2b08b16578c136bcd64b65c3f432df57f812decd735e38af71256d7034fcd0846345221e7edd0a336b3b06dd31b7427b74526294aa59ab24848f092
-  data.tar.gz: 1d47e89c6b8cb2186708c9925f02c0fddae0c101076a62861ccdccce85140e32bc38524b831380fb47d851d65634581e05d754648293e4f549e9f81a3cfabffb
+  metadata.gz: c3b8706c8becc5547e7e7ad628aec694a94e912958f3acb717c9228d62e84132cc4382c5a0e90e4984cb1074fc64ac33495605a48b1f3b227efb048678ccd9f7
+  data.tar.gz: 330ddac17a6514d06a9ddf522f50be4f267f5fce53a32fb0f20e7cfadfa30eb64dad647386e265c3541d5c8118795c207aad1337c950ae62e8678031b5b4a7c2

data/.gitignore

@@ -1,3 +1,4 @@
 /.bundle/
 *.gem
 Gemfile.lock
+/.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/bin/git-pr-release

@@ -153,7 +153,16 @@ def merge_pr_body(old_body, new_body)
   # Try to take over checklist statuses
   pr_body_lines = []
 
-  Diff::LCS.traverse_balanced(old_body.split(/\r?\n/), new_body.split(/\r?\n/)) do |event|
+  check_status = {}
+  old_body.split(/\r?\n/).each { |line|
+    line.match(/^- \[(?<check_value>[ x])\] #(?<issue_number>\d+)/) { |m|
+      say "Found pull-request checkbox \##{m[:issue_number]} is #{m[:check_value]}.", :trace
+      check_status[m[:issue_number]] = m[:check_value]
+    }
+  }
+  old_body_unchecked = old_body.gsub /^- \[[ x]\] \#(\d+)/, '- [ ] #\1'
+
+  Diff::LCS.traverse_balanced(old_body_unchecked.split(/\r?\n/), new_body.split(/\r?\n/)) do |event|
     say "diff: #{event.inspect}", :trace
     action, old, new = *event
     old_nr, old_line = *old
@@ -167,7 +176,7 @@ def merge_pr_body(old_body, new_body)
       say "Use old line: #{old_line}", :trace
       pr_body_lines << old_line
     when '!'
-      if [ old_line, new_line ].all? { |line| /^- \[[ x]\]/ === line }
+      if [ old_line, new_line ].all? { |line| /^- \[ \]/ === line }
         say "Found checklist diff; use old one: #{old_line}", :trace
         pr_body_lines << old_line
       else
@@ -183,7 +192,13 @@ def merge_pr_body(old_body, new_body)
     end
   end
 
-  pr_body_lines.join("\n")
+  merged_body = pr_body_lines.join("\n")
+  check_status.each { |issue_number, check_value|
+    say "Update pull-request checkbox \##{issue_number} to #{check_value}.", :trace
+    merged_body.gsub! /^- \[ \] \##{issue_number}/, "- [#{check_value}] \##{issue_number}"
+  }
+
+  merged_body
 end
 
 def obtain_token!
@@ -246,148 +261,152 @@ def pull_request_files(client, pull_request)
   return client.pull_request_files repository, pull_request.number
 end
 
-host, repository, scheme = host_and_repository_and_scheme
+def main
+  host, repository, scheme = host_and_repository_and_scheme
 
-if host
-  # GitHub:Enterprise
-  OpenSSL::SSL.const_set :VERIFY_PEER, OpenSSL::SSL::VERIFY_NONE # XXX
+  if host
+    # GitHub:Enterprise
+    OpenSSL::SSL.const_set :VERIFY_PEER, OpenSSL::SSL::VERIFY_NONE # XXX
 
-  Octokit.configure do |c|
-    c.api_endpoint = "#{scheme}://#{host}/api/v3"
-    c.web_endpoint = "#{scheme}://#{host}/"
+    Octokit.configure do |c|
+      c.api_endpoint = "#{scheme}://#{host}/api/v3"
+      c.web_endpoint = "#{scheme}://#{host}/"
+    end
   end
-end
 
-OptionParser.new do |opts|
-  opts.on('-n', '--dry-run', 'Do not create/update a PR. Just prints out') do |v|
-    @dry_run = v
-  end
-  opts.on('--json', 'Show data of target PRs in JSON format') do |v|
-    @json = v
-  end
-  opts.on('--no-fetch', 'Do not fetch from remote repo before determining target PRs (CI friendly)') do |v|
-    @no_fetch = v
-  end
-end.parse!
+  OptionParser.new do |opts|
+    opts.on('-n', '--dry-run', 'Do not create/update a PR. Just prints out') do |v|
+      @dry_run = v
+    end
+    opts.on('--json', 'Show data of target PRs in JSON format') do |v|
+      @json = v
+    end
+    opts.on('--no-fetch', 'Do not fetch from remote repo before determining target PRs (CI friendly)') do |v|
+      @no_fetch = v
+    end
+  end.parse!
 
-### Set up configuration
+  ### Set up configuration
 
-production_branch = ENV.fetch('GIT_PR_RELEASE_BRANCH_PRODUCTION') { git_config('branch.production') } || 'master'
-staging_branch    = ENV.fetch('GIT_PR_RELEASE_BRANCH_STAGING') { git_config('branch.staging') }       || 'staging'
+  production_branch = ENV.fetch('GIT_PR_RELEASE_BRANCH_PRODUCTION') { git_config('branch.production') } || 'master'
+  staging_branch    = ENV.fetch('GIT_PR_RELEASE_BRANCH_STAGING') { git_config('branch.staging') }       || 'staging'
 
-say "Repository:        #{repository}", :debug
-say "Production branch: #{production_branch}", :debug
-say "Staging branch:    #{staging_branch}", :debug
+  say "Repository:        #{repository}", :debug
+  say "Production branch: #{production_branch}", :debug
+  say "Staging branch:    #{staging_branch}", :debug
 
-client = Octokit::Client.new :access_token => obtain_token!
+  client = Octokit::Client.new :access_token => obtain_token!
 
-git :remote, 'update', 'origin' unless @no_fetch
+  git :remote, 'update', 'origin' unless @no_fetch
 
-### Fetch merged PRs
+  ### Fetch merged PRs
 
-merged_feature_head_sha1s = git(
-  :log, '--merges', '--pretty=format:%P', "origin/#{production_branch}..origin/#{staging_branch}"
-).map do |line|
-  main_sha1, feature_sha1 = line.chomp.split /\s+/
-  feature_sha1
-end
+  merged_feature_head_sha1s = git(
+    :log, '--merges', '--pretty=format:%P', "origin/#{production_branch}..origin/#{staging_branch}"
+  ).map do |line|
+    main_sha1, feature_sha1 = line.chomp.split /\s+/
+    feature_sha1
+  end
 
-merged_pull_request_numbers = git('ls-remote', 'origin', 'refs/pull/*/head').map do |line|
-  sha1, ref = line.chomp.split /\s+/
+  merged_pull_request_numbers = git('ls-remote', 'origin', 'refs/pull/*/head').map do |line|
+    sha1, ref = line.chomp.split /\s+/
 
-  if merged_feature_head_sha1s.include? sha1
-    if %r<^refs/pull/(\d+)/head$>.match ref
-      pr_number = $1.to_i
+    if merged_feature_head_sha1s.include? sha1
+      if %r<^refs/pull/(\d+)/head$>.match ref
+        pr_number = $1.to_i
 
-      if git('merge-base', sha1, "origin/#{production_branch}").first.chomp == sha1
-        say "##{pr_number} (#{sha1}) is already merged into #{production_branch}", :debug
+        if git('merge-base', sha1, "origin/#{production_branch}").first.chomp == sha1
+          say "##{pr_number} (#{sha1}) is already merged into #{production_branch}", :debug
+        else
+          pr_number
+        end
       else
-        pr_number
+        say "Bad pull request head ref format: #{ref}", :warn
+        nil
       end
-    else
-      say "Bad pull request head ref format: #{ref}", :warn
-      nil
     end
-  end
-end.compact
+  end.compact
 
-if merged_pull_request_numbers.empty?
-  say 'No pull requests to be released', :error
-  exit 1
-end
+  if merged_pull_request_numbers.empty?
+    say 'No pull requests to be released', :error
+    exit 1
+  end
 
-merged_prs = merged_pull_request_numbers.map do |nr|
-  pr = client.pull_request repository, nr
-  say "To be released: ##{pr.number} #{pr.title}", :notice
-  pr
-end
+  merged_prs = merged_pull_request_numbers.map do |nr|
+    pr = client.pull_request repository, nr
+    say "To be released: ##{pr.number} #{pr.title}", :notice
+    pr
+  end
 
-### Create a release PR
+  ### Create a release PR
 
-say 'Searching for existing release pull requests...', :info
-found_release_pr = client.pull_requests(repository).find do |pr|
-  pr.head.ref == staging_branch && pr.base.ref == production_branch
-end
-create_mode = found_release_pr.nil?
+  say 'Searching for existing release pull requests...', :info
+  found_release_pr = client.pull_requests(repository).find do |pr|
+    pr.head.ref == staging_branch && pr.base.ref == production_branch
+  end
+  create_mode = found_release_pr.nil?
 
-# Fetch changed files of a release PR
-changed_files = pull_request_files(client, found_release_pr)
+  # Fetch changed files of a release PR
+  changed_files = pull_request_files(client, found_release_pr)
 
-if @dry_run
-  pr_title, new_body = build_pr_title_and_body found_release_pr, merged_prs, changed_files
-  pr_body = create_mode ? new_body : merge_pr_body(found_release_pr.body, new_body)
+  if @dry_run
+    pr_title, new_body = build_pr_title_and_body found_release_pr, merged_prs, changed_files
+    pr_body = create_mode ? new_body : merge_pr_body(found_release_pr.body, new_body)
 
-  say 'Dry-run. Not updating PR', :info
-  say pr_title, :notice
-  say pr_body, :notice
-  dump_result_as_json( found_release_pr, merged_prs, changed_files ) if @json
-  exit 0
-end
+    say 'Dry-run. Not updating PR', :info
+    say pr_title, :notice
+    say pr_body, :notice
+    dump_result_as_json( found_release_pr, merged_prs, changed_files ) if @json
+    exit 0
+  end
 
-pr_title, pr_body = nil, nil
-release_pr = nil
+  pr_title, pr_body = nil, nil
+  release_pr = nil
 
-if create_mode
-  created_pr = client.create_pull_request(
-    repository, production_branch, staging_branch, 'Preparing release pull request...', ''
-  )
-  unless created_pr
-    say 'Failed to create a new pull request', :error
-    exit 2
+  if create_mode
+    created_pr = client.create_pull_request(
+      repository, production_branch, staging_branch, 'Preparing release pull request...', ''
+    )
+    unless created_pr
+      say 'Failed to create a new pull request', :error
+      exit 2
+    end
+    changed_files = pull_request_files(client, created_pr) # Refetch changed files from created_pr
+    pr_title, pr_body = build_pr_title_and_body created_pr, merged_prs, changed_files
+    release_pr = created_pr
+  else
+    pr_title, new_body = build_pr_title_and_body found_release_pr, merged_prs, changed_files
+    pr_body = merge_pr_body(found_release_pr.body, new_body)
+    release_pr = found_release_pr
   end
-  changed_files = pull_request_files(client, created_pr) # Refetch changed files from created_pr
-  pr_title, pr_body = build_pr_title_and_body created_pr, merged_prs, changed_files
-  release_pr = created_pr
-else
-  pr_title, new_body = build_pr_title_and_body found_release_pr, merged_prs, changed_files
-  pr_body = merge_pr_body(found_release_pr.body, new_body)
-  release_pr = found_release_pr
-end
 
-say 'Pull request body:', :debug
-say pr_body, :debug
+  say 'Pull request body:', :debug
+  say pr_body, :debug
 
-updated_pull_request = client.update_pull_request(
-  repository, release_pr.number, :title => pr_title, :body => pr_body
-)
+  updated_pull_request = client.update_pull_request(
+    repository, release_pr.number, :title => pr_title, :body => pr_body
+  )
 
-unless updated_pull_request
-  say 'Failed to update a pull request', :error
-  exit 3
-end
+  unless updated_pull_request
+    say 'Failed to update a pull request', :error
+    exit 3
+  end
 
-labels = ENV.fetch('GIT_PR_RELEASE_LABELS') { git_config('labels') }
-if not labels.nil? and not labels.empty?
-  labels = labels.split(/\s*,\s*/)
-  labeled_pull_request = client.add_labels_to_an_issue(
-    repository, release_pr.number, labels
-  )
+  labels = ENV.fetch('GIT_PR_RELEASE_LABELS') { git_config('labels') }
+  if not labels.nil? and not labels.empty?
+    labels = labels.split(/\s*,\s*/)
+    labeled_pull_request = client.add_labels_to_an_issue(
+      repository, release_pr.number, labels
+    )
 
-  unless labeled_pull_request
-    say 'Failed to add labels to a pull request', :error
-    exit 4
+    unless labeled_pull_request
+      say 'Failed to add labels to a pull request', :error
+      exit 4
+    end
   end
+
+  say "#{create_mode ? 'Created' : 'Updated'} pull request: #{updated_pull_request.rels[:html].href}", :notice
+  dump_result_as_json( release_pr, merged_prs, changed_files ) if @json
 end
 
-say "#{create_mode ? 'Created' : 'Updated'} pull request: #{updated_pull_request.rels[:html].href}", :notice
-dump_result_as_json( release_pr, merged_prs, changed_files ) if @json
+main if $0 == __FILE__

data/git-pr-release.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "git-pr-release"
-  spec.version       = '0.6.0'
+  spec.version       = '0.7.0'
   spec.authors       = ["motemen"]
   spec.email         = ["motemen@gmail.com"]
   spec.summary       = 'Creates a release pull request'
@@ -21,5 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'colorize'
   spec.add_dependency 'diff-lcs'
 
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'timecop'
+
   spec.license = 'MIT'
 end

data/spec/bin_spec.rb

@@ -0,0 +1,136 @@
+load File.expand_path("../bin/git-pr-release", __dir__)
+
+RSpec.describe "git-pr-release" do
+  before do
+    Timecop.freeze(Time.parse("2019-02-20 22:58:35"))
+
+    @stubs = Faraday::Adapter::Test::Stubs.new
+    @agent = Sawyer::Agent.new "http://foo.com/a/" do |conn|
+      conn.builder.handlers.delete(Faraday::Adapter::NetHttp)
+      conn.adapter :test, @stubs
+    end
+    @release_pr = Sawyer::Resource.new(@agent, YAML.load_file(file_fixture("pr_1.yml")))
+    @merged_prs = [
+      Sawyer::Resource.new(@agent, YAML.load_file(file_fixture("pr_3.yml"))),
+      Sawyer::Resource.new(@agent, YAML.load_file(file_fixture("pr_6.yml"))),
+    ]
+    @changed_files = [
+      Sawyer::Resource.new(@agent, YAML.load_file(file_fixture("pr_1_files.yml"))),
+    ]
+  end
+
+  describe "#build_pr_title_and_body" do
+    context "without any options" do
+      it {
+        pr_title, new_body = build_pr_title_and_body(@release_pr, @merged_prs, @changed_files)
+        expect(pr_title).to eq "Release 2019-02-20 22:58:35 +0900"
+        expect(new_body).to eq <<~MARKDOWN
+          - [ ] #3 Provides a creating release pull-request object for template @hakobe
+          - [ ] #6 Support two factor auth @ninjinkun
+        MARKDOWN
+      }
+    end
+
+    context "with ENV" do
+      before {
+        ENV["GIT_PR_RELEASE_TEMPLATE"] = "spec/fixtures/file/template_1.erb"
+      }
+
+      after {
+        ENV["GIT_PR_RELEASE_TEMPLATE"] = nil
+      }
+
+      it {
+        pr_title, new_body = build_pr_title_and_body(@release_pr, @merged_prs, @changed_files)
+        expect(pr_title).to eq "a"
+        expect(new_body).to eq <<~MARKDOWN
+          b
+        MARKDOWN
+      }
+    end
+
+    context "with git_config template" do
+      before {
+        expect(self).to receive(:git_config).with("template") { "spec/fixtures/file/template_2.erb" }
+      }
+
+      it {
+        pr_title, new_body = build_pr_title_and_body(@release_pr, @merged_prs, @changed_files)
+        expect(pr_title).to eq "c"
+        expect(new_body).to eq <<~MARKDOWN
+          d
+        MARKDOWN
+      }
+    end
+  end
+
+  describe "#dump_result_as_json" do
+    it {
+      output = capture(:stdout) { dump_result_as_json(@release_pr, @merged_prs, @changed_files) }
+      parsed_output = JSON.parse(output)
+
+      expect(parsed_output.keys).to eq %w[release_pull_request merged_pull_requests changed_files]
+      expect(parsed_output["release_pull_request"]).to eq({ "data" => JSON.parse(@release_pr.to_hash.to_json) })
+      expect(parsed_output["merged_pull_requests"]).to eq @merged_prs.map {|e| JSON.parse(PullRequest.new(e).to_hash.to_json) }
+      expect(parsed_output["changed_files"]).to eq @changed_files.map {|e| JSON.parse(e.to_hash.to_json) }
+    }
+  end
+
+  describe "#merge_pr_body" do
+    context "new pr added" do
+      it {
+        actual = merge_pr_body(<<~OLD_BODY, <<~NEW_BODY)
+          - [x] #3 Provides a creating release pull-request object for template @hakobe
+          - [ ] #6 Support two factor auth @ninjinkun
+        OLD_BODY
+          - [ ] #3 Provides a creating release pull-request object for template @hakobe
+          - [ ] #4 use user who create PR if there is no assignee @hakobe
+          - [ ] #6 Support two factor auth @ninjinkun
+        NEW_BODY
+
+        expect(actual).to eq <<~MARKDOWN.chomp
+          - [x] #3 Provides a creating release pull-request object for template @hakobe
+          - [ ] #4 use user who create PR if there is no assignee @hakobe
+          - [ ] #6 Support two factor auth @ninjinkun
+        MARKDOWN
+      }
+    end
+    context "new pr added and keeping task status" do
+      it {
+        actual = merge_pr_body(<<~OLD_BODY, <<~NEW_BODY)
+          - [x] #4 use user who create PR if there is no assignee @hakobe
+          - [x] #6 Support two factor auth @ninjinkun
+        OLD_BODY
+          - [ ] #3 Provides a creating release pull-request object for template @hakobe
+          - [ ] #4 use user who create PR if there is no assignee @hakobe
+          - [ ] #6 Support two factor auth @ninjinkun
+        NEW_BODY
+
+        expect(actual).to eq <<~MARKDOWN.chomp
+          - [ ] #3 Provides a creating release pull-request object for template @hakobe
+          - [x] #4 use user who create PR if there is no assignee @hakobe
+          - [x] #6 Support two factor auth @ninjinkun
+        MARKDOWN
+      }
+    end
+  end
+
+  describe "#host_and_repository_and_scheme" do
+    it {
+      expect(self).to receive(:git).with(:config, "remote.origin.url") { ["https://github.com/motemen/git-pr-release\n"] }
+      expect(host_and_repository_and_scheme).to eq [nil, "motemen/git-pr-release", "https"]
+    }
+    it {
+      expect(self).to receive(:git).with(:config, "remote.origin.url") { ["ssh://git@github.com/motemen/git-pr-release.git\n"] }
+      expect(host_and_repository_and_scheme).to eq [nil, "motemen/git-pr-release", "https"]
+    }
+    it {
+      expect(self).to receive(:git).with(:config, "remote.origin.url") { ["http://ghe.example.com/motemen/git-pr-release\n"] }
+      expect(host_and_repository_and_scheme).to eq ["ghe.example.com", "motemen/git-pr-release", "http"]
+    }
+    it {
+      expect(self).to receive(:git).with(:config, "remote.origin.url") { ["ssh://git@ghe.example.com/motemen/git-pr-release.git\n"] }
+      expect(host_and_repository_and_scheme).to eq ["ghe.example.com", "motemen/git-pr-release", "https"]
+    }
+  end
+end