Issue #37: inject, invoke maven command, read file and clean up #50
There are no files selected for viewing
This file contains 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 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 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 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,168 @@ | ||
| //////////////////////////////////////////////////////////////////////////////// | ||
| // checkstyle: Checks Java source code for adherence to a set of rules. | ||
| // Copyright (C) 2001-2017 the original author or authors. | ||
| // | ||
| // This library is free software; you can redistribute it and/or | ||
| // modify it under the terms of the GNU Lesser General Public | ||
| // License as published by the Free Software Foundation; either | ||
| // version 2.1 of the License, or (at your option) any later version. | ||
| // | ||
| // This library is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| // Lesser General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU Lesser General Public | ||
| // License along with this library; if not, write to the Free Software | ||
| // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | ||
| //////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| package com.github.checkstyle.regression.extract; | ||
|
|
||
| import java.io.Closeable; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.util.Arrays; | ||
|
|
||
| import org.apache.commons.io.FileUtils; | ||
| import org.apache.maven.shared.invoker.DefaultInvocationRequest; | ||
| import org.apache.maven.shared.invoker.DefaultInvoker; | ||
| import org.apache.maven.shared.invoker.InvocationRequest; | ||
| import org.apache.maven.shared.invoker.InvocationResult; | ||
| import org.apache.maven.shared.invoker.Invoker; | ||
| import org.apache.maven.shared.invoker.MavenInvocationException; | ||
| import org.eclipse.jgit.api.Git; | ||
| import org.eclipse.jgit.api.errors.GitAPIException; | ||
| import org.eclipse.jgit.lib.Repository; | ||
| import org.eclipse.jgit.storage.file.FileRepositoryBuilder; | ||
|
|
||
| /** | ||
| * Injects files to checkstyle repository, which would be invoked by maven command | ||
| * to generate module extract info. | ||
| * @author LuoLiangchen | ||
| */ | ||
| final class CheckstyleInjector implements Closeable { | ||
| /** The path to checkstyle repository. */ | ||
| private final String repoPath; | ||
|
|
||
| /** The name of PR branch. */ | ||
| private final String branch; | ||
|
|
||
| /** The checkstyle repository. */ | ||
| private final Repository repository; | ||
|
|
||
| /** | ||
| * Creates a new instance of CheckstyleInjector. | ||
| * @param repoPath the path to checkstyle repository | ||
| * @param branch the name of PR branch | ||
| */ | ||
| CheckstyleInjector(String repoPath, String branch) { | ||
| this.repoPath = repoPath; | ||
| this.branch = branch; | ||
|
|
||
| final File gitDir = new File(repoPath, ".git"); | ||
| final Repository repo; | ||
| try { | ||
| repo = new FileRepositoryBuilder().setGitDir(gitDir) | ||
| .readEnvironment().findGitDir().build(); | ||
| } | ||
| catch (IOException ex) { | ||
| throw new IllegalStateException(ex); | ||
| } | ||
| repository = repo; | ||
| } | ||
|
|
||
| /** | ||
| * Generates the module extract info file. | ||
| * @return the module extract info file | ||
| * @throws InjectException failure of generation | ||
| */ | ||
| public File generateExtractInfoFile() throws InjectException { | ||
| try { | ||
| checkoutToPrBranch(); | ||
| copyInjectFilesToCheckstyleRepo(); | ||
| invokeMavenCommand(); | ||
| return new File(repoPath, "checkstyle_modules.json"); | ||
| } | ||
| catch (IOException | GitAPIException ex) { | ||
| throw new InjectException("unable to generate extract info file", ex); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Clears the injected files and the generated info file in checkstyle repository. | ||
| * @throws InjectException failure of clearing | ||
| */ | ||
| public void clearInjections() throws InjectException { | ||
| final Git git = new Git(repository); | ||
|
|
||
| try { | ||
| git.clean().setCleanDirectories(true).call(); | ||
| } | ||
| catch (GitAPIException ex) { | ||
| throw new InjectException("unable to clear injections", ex); | ||
| } | ||
| finally { | ||
| git.close(); | ||
| } | ||
| } | ||
|
|
||
| /** Closes the repository resource. */ | ||
| @Override | ||
| public void close() { | ||
| repository.close(); | ||
| } | ||
|
|
||
| /** | ||
| * Invokes Maven command to generate the extract info file in checkstyle repository. | ||
| * @throws InjectException failure of invoking Maven | ||
| */ | ||
| private void invokeMavenCommand() throws InjectException { | ||
| final InvocationRequest request = new DefaultInvocationRequest(); | ||
| request.setPomFile(new File(repoPath, "pom.xml")); | ||
| request.setGoals(Arrays.asList( | ||
| "test", "-Dtest=ExtractInfoGeneratorTest#generateExtractInfoFile")); | ||
| final Invoker invoker = new DefaultInvoker(); | ||
| try { | ||
| final InvocationResult result = invoker.execute(request); | ||
| if (result.getExitCode() != 0) { | ||
| throw new InjectException("maven process exit with code: " + result.getExitCode()); | ||
| } | ||
| } | ||
| catch (MavenInvocationException ex) { | ||
| throw new InjectException("maven invocation failed", ex); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Copies the injection files to checkstyle repository. | ||
| * @throws IOException failure of copying | ||
| */ | ||
| private void copyInjectFilesToCheckstyleRepo() throws IOException { | ||
| final File srcDir = | ||
| new File("src/main/resources/com/github/checkstyle/regression/extract/"); | ||
| final File destDir = new File(repoPath, "src/test/java/com/puppycrawl/tools/checkstyle/"); | ||
| final String[] injections = {"ExtractInfoGeneratorTest.java", "JsonUtil.java"}; | ||
| for (String injection : injections) { | ||
| final File srcFile = new File(srcDir, injection); | ||
| final File destFile = new File(destDir, injection); | ||
| FileUtils.copyFile(srcFile, destFile); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Checkouts to the PR branch in the given repository. | ||
| * @throws GitAPIException JGit library exception | ||
| */ | ||
| private void checkoutToPrBranch() | ||
| throws GitAPIException { | ||
| final Git git = new Git(repository); | ||
|
|
||
| try { | ||
| git.checkout().setName(branch).call(); | ||
| } | ||
| finally { | ||
| git.close(); | ||
| } | ||
| } | ||
| } |
This file contains 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 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,53 @@ | ||
| //////////////////////////////////////////////////////////////////////////////// | ||
| // checkstyle: Checks Java source code for adherence to a set of rules. | ||
| // Copyright (C) 2001-2017 the original author or authors. | ||
| // | ||
| // This library is free software; you can redistribute it and/or | ||
| // modify it under the terms of the GNU Lesser General Public | ||
| // License as published by the Free Software Foundation; either | ||
| // version 2.1 of the License, or (at your option) any later version. | ||
| // | ||
| // This library is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| // Lesser General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU Lesser General Public | ||
| // License along with this library; if not, write to the Free Software | ||
| // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | ||
| //////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| package com.github.checkstyle.regression.extract; | ||
|
|
||
| /** | ||
| * Signals that an exception occurs when injecting. | ||
| * The cause could be a Git exception, IO exception of creating/copying/reading operation | ||
| * or non-zero exit code of Maven result. | ||
| * @author LuoLiangchen | ||
| */ | ||
| public class InjectException extends Exception { | ||
| private static final long serialVersionUID = 1042082793270688141L; | ||
|
|
||
| /** | ||
| * Constructs an InjectException with the specified detail | ||
| * message. A detail message is a String that describes this particular | ||
| * exception. | ||
| * @param message the String that contains a detailed message | ||
| */ | ||
| public InjectException(String message) { | ||
| super(message); | ||
| } | ||
|
|
||
| /** | ||
| * Constructs a new exception with the specified detail message and cause. | ||
| * @param message the detail message (which is saved for later retrieval | ||
| * by the {@link Throwable#getMessage()} method). | ||
| * @param cause the cause (which is saved for later retrieval by the | ||
| * {@link Throwable#getCause()} method). (A <tt>null</tt> value | ||
| * is permitted, and indicates that the cause is nonexistent or | ||
| * unknown.) | ||
| */ | ||
| public InjectException(String message, Throwable cause) { | ||
| super(message, cause); | ||
| } | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#54