Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Update to allow different merge methods in pulls_service #333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 31, 2022
Merged

Update to allow different merge methods in pulls_service #333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5527f90
Updated to allow different merge methods in pulls_service.
Oct 24, 2022
338fb82
Adding tests for pulls service merge changes.
Oct 28, 2022
3917542
Merge branch 'master' into merge_support
ricardoamador Oct 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions lib/src/common/pulls_service.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,15 +121,27 @@ class PullRequestsService extends Service {
RepositorySlug slug,
int number, {
String? message,
MergeMethod mergeMethod = MergeMethod.merge,
String? requestSha,
}) {
final json = <String, dynamic>{};

if (message != null) {
json['commit_message'] = message;
}
if (requestSha != null) {
json['sha'] = requestSha;
}

json['merge_method'] = mergeMethod.name;

// Recommended Accept header when making a merge request.
Map<String, String>? headers = <String, String>{};
headers['Accept'] = 'application/vnd.github+json';

return github
.request('PUT', '/repos/${slug.fullName}/pulls/$number/merge',
headers: headers,
body: GitHubJson.encode(json))
.then((response) {
return PullRequestMerge.fromJson(
Expand Down Expand Up @@ -184,3 +196,9 @@ class PullRequestsService extends Service {
);
}
}

enum MergeMethod {
merge,
squash,
rebase,
}
143 changes: 143 additions & 0 deletions test/pulls_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
import 'dart:async';

import 'package:github/src/common.dart';
import 'package:http/http.dart' as http;
import 'package:mockito/mockito.dart';
import 'package:test/test.dart';

import 'src/mocks.mocks.dart';

void main() {
late MockGitHub github;
late PullRequestsService pulls;
late RepositorySlug repo;
const someSha = 'someSHA';

setUp(() {
github = MockGitHub();
pulls = PullRequestsService(github);
repo = RepositorySlug('o', 'n');
});

group('Merge', () {
test('Merge() normal', () async {
const expectedMessage = 'Pull Request successfully merged';
const expectedMerge = true;

when(github.request(any, any, headers: anyNamed("headers"), body: anyNamed("body")))
.thenAnswer((_) => Future.value(
http.Response('''{
"sha": "$someSha",
"merged": $expectedMerge,
"message": "$expectedMessage"
}''', 200)
));

var pullRequestMerge = await pulls.merge(repo, 1);

verify(github.request('PUT', '/repos/o/n/pulls/1/merge',
headers: anyNamed("headers"), body: '''{"merge_method":"merge"}'''));

expect(pullRequestMerge.merged, isTrue);
expect(pullRequestMerge.message, expectedMessage);
expect(pullRequestMerge.sha, someSha);
});

test('Merge() with squash', () async {
const expectedMessage = 'Pull Request successfully merged';
const expectedMerge = true;

when(github.request(any, any, headers: anyNamed("headers"), body: anyNamed("body")))
.thenAnswer((_) => Future.value(
http.Response('''{
"sha": "$someSha",
"merged": $expectedMerge,
"message": "$expectedMessage"
}''', 200)
));

var pullRequestMerge = await pulls.merge(repo, 1, mergeMethod: MergeMethod.squash);

verify(github.request('PUT', '/repos/o/n/pulls/1/merge',
headers: anyNamed("headers"), body: '''{"merge_method":"squash"}'''));

expect(pullRequestMerge.merged, isTrue);
expect(pullRequestMerge.message, expectedMessage);
expect(pullRequestMerge.sha, someSha);
});

test('Merge() with rebase', () async {
const expectedMessage = 'Pull Request successfully merged';
const expectedMerge = true;

when(github.request(any, any, headers: anyNamed("headers"), body: anyNamed("body")))
.thenAnswer((_) => Future.value(
http.Response('''{
"sha": "$someSha",
"merged": $expectedMerge,
"message": "$expectedMessage"
}''', 200)
));

var pullRequestMerge = await pulls.merge(repo, 1, mergeMethod: MergeMethod.rebase);

verify(github.request('PUT', '/repos/o/n/pulls/1/merge',
headers: anyNamed("headers"), body: '''{"merge_method":"rebase"}'''));

expect(pullRequestMerge.merged, isTrue);
expect(pullRequestMerge.message, expectedMessage);
expect(pullRequestMerge.sha, someSha);
});

test('Merge() with commitMessage', () async {
const expectedMessage = 'Pull Request successfully merged';
const expectedMerge = true;
const commitMessage = 'Some message';

when(github.request(any, any, headers: anyNamed("headers"), body: anyNamed("body")))
.thenAnswer((_) => Future.value(
http.Response('''{
"sha": "$someSha",
"merged": $expectedMerge,
"message": "$expectedMessage"
}''', 200)
));

var pullRequestMerge = await pulls.merge(repo, 1, message: commitMessage, mergeMethod: MergeMethod.squash);

verify(github.request('PUT', '/repos/o/n/pulls/1/merge',
headers: anyNamed("headers"), body: '''{"commit_message":"$commitMessage","merge_method":"squash"}'''));

expect(pullRequestMerge.merged, isTrue);
expect(pullRequestMerge.message, expectedMessage);
expect(pullRequestMerge.sha, someSha);
});

test('Merge() with commitMessage, with sha', () async {
const expectedMessage = 'Pull Request successfully merged';
const expectedMerge = true;
const commitMessage = 'Some message';
const commitSha = 'commitSha';

when(github.request(any, any, headers: anyNamed("headers"), body: anyNamed("body")))
.thenAnswer((_) => Future.value(
http.Response('''{
"sha": "$someSha",
"merged": $expectedMerge,
"message": "$expectedMessage"
}''', 200)
));

var pullRequestMerge = await pulls.merge(repo, 1, message: commitMessage,
mergeMethod: MergeMethod.squash, requestSha: commitSha);

verify(github.request('PUT', '/repos/o/n/pulls/1/merge',
headers: anyNamed("headers"),
body: '''{"commit_message":"$commitMessage","sha":"$commitSha","merge_method":"squash"}'''));

expect(pullRequestMerge.merged, isTrue);
expect(pullRequestMerge.message, expectedMessage);
expect(pullRequestMerge.sha, someSha);
});
});
}