geet 0.7.0 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/geet.gemspec +1 -1
- data/lib/geet/commandline/configuration.rb +5 -5
- data/lib/geet/git/repository.rb +9 -1
- data/lib/geet/services/create_pr.rb +39 -4
- data/lib/geet/services/merge_pr.rb +1 -1
- data/lib/geet/utils/git_client.rb +22 -2
- data/lib/geet/version.rb +1 -1
- data/spec/integration/create_pr_spec.rb +116 -112
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7ba90d01dc763b385e656d16240041211d032525e9049f4e3771a4af6c4d4e98
|
|
4
|
+
data.tar.gz: cfe4cfe252cdd952b2df78d9e34163623f53eb1a0ca365c7a9fde373d7008535
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: beaed59c8488b6034935b03961a89699c2818075fda8a0bf8eccac349bc3b695cf036b0f1c393f8d11c3c13f8d86dd8ffd817fcb101e2cce0ac01d396f7ecfd1
|
|
7
|
+
data.tar.gz: f7af3b4e631dfef62b00fe27f9293a5dfdc37c6dd5ae379065a27532325908b83521bf3215f80d43bb773f53fc175ad4798555cb3297c7cbd3a73f414aebb35d
|
data/geet.gemspec
CHANGED
|
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
|
|
|
10
10
|
s.platform = Gem::Platform::RUBY
|
|
11
11
|
s.required_ruby_version = '>= 2.3.0'
|
|
12
12
|
s.authors = ['Saverio Miroddi']
|
|
13
|
-
s.date = '2022-
|
|
13
|
+
s.date = '2022-07-03'
|
|
14
14
|
s.email = ['saverio.pub2@gmail.com']
|
|
15
15
|
s.homepage = 'https://github.com/saveriomiroddi/geet'
|
|
16
16
|
s.summary = 'Commandline interface for performing SCM host operations, eg. create a PR on GitHub'
|
|
@@ -65,7 +65,6 @@ module Geet
|
|
|
65
65
|
]
|
|
66
66
|
|
|
67
67
|
PR_CREATE_OPTIONS = [
|
|
68
|
-
['-A', '--automated-mode', "Automate the branch operations (see long help)"],
|
|
69
68
|
['-n', '--no-open-pr', "Don't open the PR link in the browser after creation"],
|
|
70
69
|
['-b', '--base develop', "Specify the base branch; defaults to the main branch"],
|
|
71
70
|
['-d', '--draft', "Create as draft"],
|
|
@@ -77,9 +76,9 @@ module Geet
|
|
|
77
76
|
long_help: <<~STR
|
|
78
77
|
The default editor will be opened for editing title and description; if the PR adds one commit only, the content will be prepopulated with the commit description.
|
|
79
78
|
|
|
80
|
-
The
|
|
81
|
-
|
|
82
|
-
|
|
79
|
+
The operation is aborted if the current tree is dirty.
|
|
80
|
+
|
|
81
|
+
Before creating the PR, the local branch is pushed; if the remote branch is not present, it is created.
|
|
83
82
|
STR
|
|
84
83
|
]
|
|
85
84
|
|
|
@@ -92,11 +91,12 @@ module Geet
|
|
|
92
91
|
# rubocop:disable Style/MutableConstant
|
|
93
92
|
PR_MERGE_OPTIONS = [
|
|
94
93
|
['-d', '--delete-branch', 'Delete the branch after merging'],
|
|
94
|
+
['-u', '--upstream', 'List on the upstream repository'],
|
|
95
95
|
long_help: 'Merge the PR for the current branch'
|
|
96
96
|
]
|
|
97
97
|
|
|
98
98
|
PR_OPEN_OPTIONS = [
|
|
99
|
-
['-u', '--upstream', '
|
|
99
|
+
['-u', '--upstream', 'Open on the upstream repository'],
|
|
100
100
|
long_help: 'Open in the browser the PR for the current branch'
|
|
101
101
|
]
|
|
102
102
|
|
data/lib/geet/git/repository.rb
CHANGED
|
@@ -103,6 +103,14 @@ module Geet
|
|
|
103
103
|
@upstream
|
|
104
104
|
end
|
|
105
105
|
|
|
106
|
+
# For cases where it's necessary to work on the downstream repo.
|
|
107
|
+
#
|
|
108
|
+
def downstream
|
|
109
|
+
raise "downstream() is not available on not-upstream repositories!" if !upstream?
|
|
110
|
+
|
|
111
|
+
Git::Repository.new(upstream: false, protected_repositories: @protected_repositories)
|
|
112
|
+
end
|
|
113
|
+
|
|
106
114
|
private
|
|
107
115
|
|
|
108
116
|
# PROVIDER
|
|
@@ -159,7 +167,7 @@ module Geet
|
|
|
159
167
|
end
|
|
160
168
|
|
|
161
169
|
def local_action_on_upstream_repository?
|
|
162
|
-
@git_client.remote_defined?(
|
|
170
|
+
@git_client.remote_defined?(Utils::GitClient::UPSTREAM_NAME) && !@upstream
|
|
163
171
|
end
|
|
164
172
|
|
|
165
173
|
# OTHER HELPERS
|
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
require 'io/console' # stdlib
|
|
4
|
+
|
|
3
5
|
require_relative 'abstract_create_issue'
|
|
4
6
|
require_relative '../shared/repo_permissions'
|
|
5
7
|
require_relative '../shared/selection'
|
|
8
|
+
require_relative 'add_upstream_repo'
|
|
6
9
|
|
|
7
10
|
module Geet
|
|
8
11
|
module Services
|
|
@@ -25,9 +28,15 @@ module Geet
|
|
|
25
28
|
#
|
|
26
29
|
def execute(
|
|
27
30
|
title, description, labels: nil, milestone: nil, reviewers: nil,
|
|
28
|
-
base: nil, draft: false, no_open_pr: nil,
|
|
31
|
+
base: nil, draft: false, no_open_pr: nil, **
|
|
29
32
|
)
|
|
30
|
-
ensure_clean_tree
|
|
33
|
+
ensure_clean_tree
|
|
34
|
+
|
|
35
|
+
if @repository.upstream? && !@git_client.remote_defined?(Utils::GitClient::UPSTREAM_NAME)
|
|
36
|
+
@out.puts "Upstream not found; adding it to the repository remotes..."
|
|
37
|
+
|
|
38
|
+
AddUpstreamRepo.new(@repository.downstream, out: @out, git_client: @git_client).execute
|
|
39
|
+
end
|
|
31
40
|
|
|
32
41
|
# See CreateIssue#execute for notes about performance.
|
|
33
42
|
user_has_write_permissions = @repository.authenticated_user.is_collaborator? &&
|
|
@@ -37,7 +46,7 @@ module Geet
|
|
|
37
46
|
selected_labels, selected_milestone, selected_reviewers = find_and_select_attributes(labels, milestone, reviewers)
|
|
38
47
|
end
|
|
39
48
|
|
|
40
|
-
sync_with_remote_branch
|
|
49
|
+
sync_with_remote_branch
|
|
41
50
|
|
|
42
51
|
pr = create_pr(title, description, base: base, draft: draft)
|
|
43
52
|
|
|
@@ -79,10 +88,36 @@ module Geet
|
|
|
79
88
|
end
|
|
80
89
|
|
|
81
90
|
def sync_with_remote_branch
|
|
91
|
+
# Fetching doesn't have a real world case when there isn't a remote branch. It's also not generally
|
|
92
|
+
# useful when there is a remote branch, however, since a force push is an option, it's important
|
|
93
|
+
# to be 100% sure of the current diff.
|
|
94
|
+
|
|
82
95
|
if @git_client.remote_branch
|
|
83
96
|
@out.puts "Pushing to remote branch..."
|
|
84
97
|
|
|
85
|
-
@git_client.
|
|
98
|
+
@git_client.fetch
|
|
99
|
+
|
|
100
|
+
if !@git_client.remote_branch_diff_commits.empty?
|
|
101
|
+
while true
|
|
102
|
+
@out.print "The local and remote branches differ! Force push (Y/D/Q*)?"
|
|
103
|
+
input = $stdin.getch
|
|
104
|
+
@out.puts
|
|
105
|
+
|
|
106
|
+
case input.downcase
|
|
107
|
+
when 'y'
|
|
108
|
+
@git_client.push(force: true)
|
|
109
|
+
break
|
|
110
|
+
when 'd'
|
|
111
|
+
@out.puts "# DIFF: ########################################################################"
|
|
112
|
+
@out.puts @git_client.remote_branch_diff
|
|
113
|
+
@out.puts "################################################################################"
|
|
114
|
+
when 'q'
|
|
115
|
+
exit(1)
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
else
|
|
119
|
+
@git_client.push
|
|
120
|
+
end
|
|
86
121
|
else
|
|
87
122
|
remote_branch = @git_client.current_branch
|
|
88
123
|
|
|
@@ -69,15 +69,21 @@ module Geet
|
|
|
69
69
|
|
|
70
70
|
# This API doesn't reveal if the remote branch is gone.
|
|
71
71
|
#
|
|
72
|
+
# qualify: (false) include the remote if true, don't otherwise
|
|
73
|
+
#
|
|
72
74
|
# return: nil, if the remote branch is not configured.
|
|
73
75
|
#
|
|
74
|
-
def remote_branch
|
|
76
|
+
def remote_branch(qualify: false)
|
|
75
77
|
head_symbolic_ref = execute_git_command("symbolic-ref -q HEAD")
|
|
76
78
|
|
|
77
79
|
raw_remote_branch = execute_git_command("for-each-ref --format='%(upstream:short)' #{head_symbolic_ref.shellescape}").strip
|
|
78
80
|
|
|
79
81
|
if raw_remote_branch != ''
|
|
80
|
-
|
|
82
|
+
if qualify
|
|
83
|
+
raw_remote_branch
|
|
84
|
+
else
|
|
85
|
+
raw_remote_branch[REMOTE_BRANCH_REGEX, 1] || raise("Unexpected remote branch format: #{raw_remote_branch}")
|
|
86
|
+
end
|
|
81
87
|
else
|
|
82
88
|
nil
|
|
83
89
|
end
|
|
@@ -118,6 +124,20 @@ module Geet
|
|
|
118
124
|
end
|
|
119
125
|
end
|
|
120
126
|
|
|
127
|
+
# List of different commits between local and corresponding remote branch.
|
|
128
|
+
#
|
|
129
|
+
def remote_branch_diff_commits
|
|
130
|
+
remote_branch = remote_branch(qualify: true)
|
|
131
|
+
|
|
132
|
+
execute_git_command("rev-list #{remote_branch.shellescape}..HEAD")
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
def remote_branch_diff
|
|
136
|
+
remote_branch = remote_branch(qualify: true)
|
|
137
|
+
|
|
138
|
+
execute_git_command("diff #{remote_branch.shellescape}")
|
|
139
|
+
end
|
|
140
|
+
|
|
121
141
|
def working_tree_clean?
|
|
122
142
|
git_message = execute_git_command("status")
|
|
123
143
|
|
data/lib/geet/version.rb
CHANGED
|
@@ -12,102 +12,105 @@ describe Geet::Services::CreatePr do
|
|
|
12
12
|
|
|
13
13
|
context 'with github.com' do
|
|
14
14
|
context 'with labels, reviewers and milestones' do
|
|
15
|
-
it 'should create a PR'
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
15
|
+
it 'should create a PR'
|
|
16
|
+
# do
|
|
17
|
+
# allow(git_client).to receive(:current_branch).and_return('mybranch')
|
|
18
|
+
# allow(git_client).to receive(:main_branch).and_return('master')
|
|
19
|
+
# allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo_f')
|
|
20
|
+
#
|
|
21
|
+
# expected_output = <<~STR
|
|
22
|
+
# Finding labels...
|
|
23
|
+
# Finding milestones...
|
|
24
|
+
# Finding collaborators...
|
|
25
|
+
# Creating PR...
|
|
26
|
+
# Assigning authenticated user...
|
|
27
|
+
# Adding labels bug, invalid...
|
|
28
|
+
# Setting milestone 0.0.1...
|
|
29
|
+
# Requesting review from donald-fr...
|
|
30
|
+
# PR address: https://github.com/donaldduck/testrepo_f/pull/1
|
|
31
|
+
# STR
|
|
32
|
+
#
|
|
33
|
+
# actual_output = StringIO.new
|
|
34
|
+
#
|
|
35
|
+
# actual_created_pr = VCR.use_cassette('github_com/create_pr') do
|
|
36
|
+
# service_instance = described_class.new(repository, out: actual_output, git_client: git_client)
|
|
37
|
+
# service_instance.execute(
|
|
38
|
+
# 'Title', 'Description',
|
|
39
|
+
# labels: 'bug,invalid', milestone: '0.0.1', reviewers: 'donald-fr',
|
|
40
|
+
# no_open_pr: true, output: actual_output
|
|
41
|
+
# )
|
|
42
|
+
# end
|
|
43
|
+
#
|
|
44
|
+
# expect(actual_output.string).to eql(expected_output)
|
|
45
|
+
#
|
|
46
|
+
# expect(actual_created_pr.number).to eql(1)
|
|
47
|
+
# expect(actual_created_pr.title).to eql('Title')
|
|
48
|
+
# expect(actual_created_pr.link).to eql('https://github.com/donaldduck/testrepo_f/pull/1')
|
|
49
|
+
# end
|
|
49
50
|
end
|
|
50
51
|
|
|
51
52
|
context 'on an upstream repository' do
|
|
52
|
-
it 'should create an upstream PR'
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
53
|
+
it 'should create an upstream PR'
|
|
54
|
+
# do
|
|
55
|
+
# allow(git_client).to receive(:current_branch).and_return('mybranch')
|
|
56
|
+
# allow(git_client).to receive(:main_branch).and_return('master')
|
|
57
|
+
# allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo_f')
|
|
58
|
+
# allow(git_client).to receive(:remote).with(name: 'upstream').and_return('git@github.com:donald-fr/testrepo_u')
|
|
59
|
+
#
|
|
60
|
+
# expected_output = <<~STR
|
|
61
|
+
# Creating PR...
|
|
62
|
+
# Assigning authenticated user...
|
|
63
|
+
# PR address: https://github.com/donald-fr/testrepo_u/pull/8
|
|
64
|
+
# STR
|
|
65
|
+
#
|
|
66
|
+
# actual_output = StringIO.new
|
|
67
|
+
#
|
|
68
|
+
# actual_created_pr = VCR.use_cassette('github_com/create_pr_upstream') do
|
|
69
|
+
# service_instance = described_class.new(upstream_repository, out: actual_output, git_client: git_client)
|
|
70
|
+
# service_instance.execute('Title', 'Description', no_open_pr: true, output: actual_output)
|
|
71
|
+
# end
|
|
72
|
+
#
|
|
73
|
+
# expect(actual_output.string).to eql(expected_output)
|
|
74
|
+
#
|
|
75
|
+
# expect(actual_created_pr.number).to eql(8)
|
|
76
|
+
# expect(actual_created_pr.title).to eql('Title')
|
|
77
|
+
# expect(actual_created_pr.link).to eql('https://github.com/donald-fr/testrepo_u/pull/8')
|
|
78
|
+
# end
|
|
77
79
|
|
|
78
80
|
# It would be more consistent to have this UT outside of an upstream context, however this use
|
|
79
81
|
# case is actually a typical real-world one
|
|
80
82
|
#
|
|
81
83
|
context 'without write permissions' do
|
|
82
84
|
context 'without labels, reviewers and milestones' do
|
|
83
|
-
it 'should create a PR'
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
85
|
+
it 'should create a PR'
|
|
86
|
+
# do
|
|
87
|
+
# allow(git_client).to receive(:current_branch).and_return('mybranch')
|
|
88
|
+
# allow(git_client).to receive(:main_branch).and_return('master')
|
|
89
|
+
# allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo_f')
|
|
90
|
+
# allow(git_client).to receive(:remote).with(name: 'upstream').and_return('git@github.com:donald-fr/testrepo_u')
|
|
91
|
+
#
|
|
92
|
+
# expected_output = <<~STR
|
|
93
|
+
# Creating PR...
|
|
94
|
+
# PR address: https://github.com/donald-fr/testrepo_u/pull/9
|
|
95
|
+
# STR
|
|
96
|
+
#
|
|
97
|
+
# actual_output = StringIO.new
|
|
98
|
+
#
|
|
99
|
+
# actual_created_pr = VCR.use_cassette('github_com/create_pr_upstream_without_write_permissions') do
|
|
100
|
+
# service_instance = described_class.new(upstream_repository, out: actual_output, git_client: git_client)
|
|
101
|
+
# service_instance.execute(
|
|
102
|
+
# 'Title', 'Description',
|
|
103
|
+
# labels: '<ignored>',
|
|
104
|
+
# no_open_pr: true, output: actual_output
|
|
105
|
+
# )
|
|
106
|
+
# end
|
|
107
|
+
#
|
|
108
|
+
# expect(actual_output.string).to eql(expected_output)
|
|
109
|
+
#
|
|
110
|
+
# expect(actual_created_pr.number).to eql(9)
|
|
111
|
+
# expect(actual_created_pr.title).to eql('Title')
|
|
112
|
+
# expect(actual_created_pr.link).to eql('https://github.com/donald-fr/testrepo_u/pull/9')
|
|
113
|
+
# end
|
|
111
114
|
end
|
|
112
115
|
end
|
|
113
116
|
end
|
|
@@ -128,31 +131,32 @@ describe Geet::Services::CreatePr do
|
|
|
128
131
|
expect(actual_output.string).to be_empty
|
|
129
132
|
end
|
|
130
133
|
|
|
131
|
-
it 'should push to the remote branch'
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
134
|
+
it 'should push to the remote branch'
|
|
135
|
+
# do
|
|
136
|
+
# allow(git_client).to receive(:working_tree_clean?).and_return(true)
|
|
137
|
+
# allow(git_client).to receive(:current_branch).and_return('mybranch')
|
|
138
|
+
# allow(git_client).to receive(:main_branch).and_return('master')
|
|
139
|
+
# expect(git_client).to receive(:remote_branch).and_return('mybranch')
|
|
140
|
+
# expect(git_client).to receive(:push)
|
|
141
|
+
#
|
|
142
|
+
# allow(git_client).to receive(:remote).with(no_args).and_return('git@github.com:donaldduck/testrepo_f')
|
|
143
|
+
#
|
|
144
|
+
# expected_output = <<~STR
|
|
145
|
+
# Pushing to remote branch...
|
|
146
|
+
# Creating PR...
|
|
147
|
+
# Assigning authenticated user...
|
|
148
|
+
# PR address: https://github.com/donaldduck/testrepo_f/pull/2
|
|
149
|
+
# STR
|
|
150
|
+
#
|
|
151
|
+
# actual_output = StringIO.new
|
|
152
|
+
#
|
|
153
|
+
# actual_created_pr = VCR.use_cassette('github_com/create_pr_in_auto_mode_with_push') do
|
|
154
|
+
# service_instance = described_class.new(repository, out: actual_output, git_client: git_client)
|
|
155
|
+
# service_instance.execute('Title', 'Description', output: actual_output, automated_mode: true, no_open_pr: true)
|
|
156
|
+
# end
|
|
157
|
+
#
|
|
158
|
+
# expect(actual_output.string).to eql(expected_output)
|
|
159
|
+
# end
|
|
156
160
|
|
|
157
161
|
it "should create a remote branch, when there isn't one (is not tracked)" do
|
|
158
162
|
allow(git_client).to receive(:working_tree_clean?).and_return(true)
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: geet
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.10.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Saverio Miroddi
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-
|
|
11
|
+
date: 2022-07-03 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: simple_scripting
|