-
Notifications
You must be signed in to change notification settings - Fork 188
Add configurable skipMergeCommits parameter to Git info command #1381
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.
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
Open
GabriRuflex
wants to merge
2
commits into
apache:master
Choose a base branch
from
GabriRuflex:skip-merge-commits-1327
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
128 changes: 128 additions & 0 deletions
128
...rc/test/java/org/apache/maven/scm/provider/git/jgit/command/info/JGitInfoCommandTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.maven.scm.provider.git.jgit.command.info; | ||
|
|
||
| import java.io.File; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.nio.file.Files; | ||
|
|
||
| import org.apache.maven.scm.CommandParameter; | ||
| import org.apache.maven.scm.CommandParameters; | ||
| import org.apache.maven.scm.ScmFileSet; | ||
| import org.apache.maven.scm.command.info.InfoScmResult; | ||
| import org.eclipse.jgit.api.Git; | ||
| import org.eclipse.jgit.api.MergeCommand; | ||
| import org.eclipse.jgit.api.MergeResult; | ||
| import org.eclipse.jgit.lib.ObjectId; | ||
| import org.eclipse.jgit.lib.StoredConfig; | ||
| import org.eclipse.jgit.revwalk.RevCommit; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.io.TempDir; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertNotEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertNotNull; | ||
|
|
||
| /** | ||
| * Unit tests for the {@code skipMergeCommits} handling of {@link JGitInfoCommand}. | ||
| * A repository whose {@code HEAD} is a merge commit is built with the JGit API, then the | ||
| * {@code info} command is invoked with and without the {@link CommandParameter#SCM_SKIP_MERGE_COMMITS} flag. | ||
| */ | ||
| class JGitInfoCommandTest { | ||
|
|
||
| @TempDir | ||
| File workDir; | ||
|
|
||
| @Test | ||
| void includesMergeCommitWhenSkipMergeCommitsIsFalse() throws Exception { | ||
| ObjectId mergeCommit = buildRepositoryWithMergeHead(); | ||
|
|
||
| CommandParameters parameters = new CommandParameters(); | ||
| parameters.setString(CommandParameter.SCM_SKIP_MERGE_COMMITS, Boolean.FALSE.toString()); | ||
|
|
||
| InfoScmResult result = info(parameters); | ||
|
|
||
| assertNotNull(result); | ||
| assertEquals( | ||
| mergeCommit.getName(), | ||
| result.getInfoItems().get(0).getRevision(), | ||
| "HEAD merge commit must be reported when skipMergeCommits=false"); | ||
|
GabriRuflex marked this conversation as resolved.
|
||
| } | ||
|
|
||
| @Test | ||
| void skipsMergeCommitByDefault() throws Exception { | ||
| ObjectId mergeCommit = buildRepositoryWithMergeHead(); | ||
|
|
||
| InfoScmResult result = info(new CommandParameters()); | ||
|
|
||
| assertNotNull(result); | ||
| assertNotEquals( | ||
| mergeCommit.getName(), | ||
| result.getInfoItems().get(0).getRevision(), | ||
| "merge commit must be skipped by default, a non-merge commit must be reported"); | ||
|
GabriRuflex marked this conversation as resolved.
|
||
| } | ||
|
|
||
| private InfoScmResult info(CommandParameters parameters) throws Exception { | ||
| // executeCommand is package-private accessible and ignores the repository argument | ||
| return (InfoScmResult) new JGitInfoCommand().executeCommand(null, new ScmFileSet(workDir), parameters); | ||
| } | ||
|
|
||
| /** | ||
| * Builds a repository whose {@code HEAD} is a no-fast-forward merge commit (two parents). | ||
| * | ||
| * @return the id of the merge commit which is now {@code HEAD} | ||
| */ | ||
| private ObjectId buildRepositoryWithMergeHead() throws Exception { | ||
| try (Git git = Git.init().setDirectory(workDir).call()) { | ||
| StoredConfig config = git.getRepository().getConfig(); | ||
| config.setString("user", null, "name", "Test User"); | ||
| config.setString("user", null, "email", "test@example.com"); | ||
| config.setBoolean("commit", null, "gpgsign", false); | ||
| config.save(); | ||
|
|
||
| commit(git, "a.txt"); | ||
| String mainBranch = git.getRepository().getBranch(); | ||
|
|
||
| git.checkout().setCreateBranch(true).setName("feature").call(); | ||
| commit(git, "b.txt"); | ||
|
|
||
| git.checkout().setName(mainBranch).call(); | ||
| commit(git, "c.txt"); | ||
|
|
||
| MergeResult mergeResult = git.merge() | ||
| .include(git.getRepository().resolve("feature")) | ||
| .setFastForward(MergeCommand.FastForwardMode.NO_FF) | ||
| .setMessage("merge feature") | ||
| .call(); | ||
| return mergeResult.getNewHead(); | ||
|
GabriRuflex marked this conversation as resolved.
Outdated
|
||
| } | ||
| } | ||
|
|
||
| private RevCommit commit(Git git, String fileName) throws Exception { | ||
| File file = new File(git.getRepository().getWorkTree(), fileName); | ||
| Files.write(file.toPath(), ("content of " + fileName).getBytes(StandardCharsets.UTF_8)); | ||
| git.add().addFilepattern(fileName).call(); | ||
| return git.commit() | ||
| .setMessage("add " + fileName) | ||
| .setAuthor("Test User", "test@example.com") | ||
| .setCommitter("Test User", "test@example.com") | ||
| .setSign(false) | ||
| .call(); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.