View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.scm.plugin;
20  
21  import java.io.IOException;
22  
23  import org.apache.maven.plugin.MojoExecutionException;
24  import org.apache.maven.plugins.annotations.Mojo;
25  import org.apache.maven.plugins.annotations.Parameter;
26  import org.apache.maven.scm.ScmException;
27  import org.apache.maven.scm.command.status.StatusScmResult;
28  import org.apache.maven.scm.repository.ScmRepository;
29  
30  /**
31   * This mojo will fail the build if there is any local modifications
32   *
33   * @author Olivier Lamy
34   * @since 1.2
35   */
36  @Mojo(name = "check-local-modification")
37  public class CheckLocalModificationsMojo extends AbstractScmMojo {
38  
39      /**
40       * Custom error message
41       */
42      @Parameter(
43              property = "scm.checkLocalModification.errorMessage",
44              defaultValue = "The build will stop as there is local modifications")
45      private String errorMessage;
46  
47      /**
48       * Skip the check for local modifications if set to {@code true}.
49       */
50      @Parameter(property = "scm.checkLocalModification.skip", defaultValue = "false")
51      private boolean skip;
52  
53      public void execute() throws MojoExecutionException {
54          if (skip) {
55              getLog().info("check-local-modification execution has been skipped");
56              return;
57          }
58          super.execute();
59  
60          StatusScmResult result = null;
61  
62          try {
63              ScmRepository repository = getScmRepository();
64              result = getScmManager().status(repository, getFileSet());
65          } catch (IOException | ScmException e) {
66              throw new MojoExecutionException(e.getMessage(), e);
67          }
68  
69          if (!result.isSuccess()) {
70              throw new MojoExecutionException(
71                      "Unable to check for local modifications : " + result.getProviderMessage());
72          }
73  
74          if (!result.getChangedFiles().isEmpty()) {
75              getLog().error(errorMessage);
76              throw new MojoExecutionException(errorMessage);
77          }
78      }
79  }