#705

Committed 17 Apr 2024 02:55PM CUT coverage: 22.137%. Remained the same

Build # #705

Build Type

Pull #315

github

Committed by

web-flow

Commit Message

Update JamesIves/github-pages-deploy-action action to v4.6.0

Pull Request Pull Request #315: Update JamesIves/github-pages-deploy-action action to v4.6.0

Run Details

28 of 226 branches covered (12.39%)

116 of 524 relevant lines covered (22.14%)

0.22 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/main/java/org/mybatis/maven/mvnmigrate/report/StatusCommandReportMojo.java

/*
 *    Copyright 2010-2022 the original author or authors.
 *
 *    Licensed 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
 *
 *       https://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.mybatis.maven.mvnmigrate.report;

import java.io.File;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;

import org.apache.ibatis.migration.Change;
import org.apache.ibatis.migration.commands.StatusCommand;
import org.apache.ibatis.migration.operations.StatusOperation;
import org.apache.ibatis.migration.options.SelectedOptions;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.siterenderer.Renderer;
import org.apache.maven.model.ReportPlugin;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.apache.maven.reporting.AbstractMavenReport;
import org.apache.maven.reporting.MavenReportException;
import org.codehaus.plexus.util.xml.Xpp3Dom;

/**
 * Extends {@link AbstractMavenReport}. <br>
 * Class to generate a Maven report.
 */
@Mojo(name = "status-report")
public final class StatusCommandReportMojo extends AbstractMavenReport {

  private static final File DEFAULT_REPO = new File(".");

  private static final String DEFAULT_ENVIRONMENT = "development";

  private static final boolean DEFAULT_FORCE = false;

  /**
   * The Maven project to analyze.
   */
  @Parameter(property = "project", required = true, readonly = true)
  private MavenProject project;

  /**
   * Target folder.
   */
  @Parameter(property = "project.build.directory", readonly = true)
  private File outputDirectory;

  /**
   * The projects in the reactor for aggregation report.
   */
  @Parameter(property = "reactorProjects", readonly = true)
  protected List<MavenProject> reactorProjects;

  /**
   * The project site renderer.
   */
  @Component(role = Renderer.class)
  private Renderer siteRenderer;

  /**
   * Location of migrate repository.
   */
  @Parameter(property = "migration.path", defaultValue = ".")
  protected File repository;

  /**
   * Environment to configure. Default environment is 'development'.
   */
  @Parameter(property = "migration.env", defaultValue = "development")
  protected String environment;

  /**
   * Forces script to continue even if SQL errors are encountered.
   */
  @Parameter(property = "migration.force", defaultValue = "false")
  protected boolean force;

  /**
   * Skip migration actions.
   */
  @Parameter(property = "migration.skip", defaultValue = "false")
  protected boolean skip;

  /**
   * Aggregate report results.
   */
  @Parameter(property = "migration.aggregate", defaultValue = "false")
  protected boolean aggregate;

  @Override
  protected void executeReport(Locale locale) throws MavenReportException {
    if (aggregate && !project.isExecutionRoot()) {
      return;
    }

    if (skip && !aggregate) {
      if (this.getLog().isInfoEnabled()) {
        this.getLog().info(getBundle(locale).getString("migration.status.report.skipped"));
      }
      return;
    }

    // Step 0: Checking pom availability
    if ("pom".equals(this.project.getPackaging()) && !aggregate) {
      if (this.getLog().isInfoEnabled()) {
        this.getLog().info("migration.status.report.skipped.pom");
      }
      return;
    }

    if (this.outputDirectory == null || !this.outputDirectory.exists()) {
      if (this.getLog().isInfoEnabled()) {
        this.getLog().info(
            getBundle(locale).getString(getBundle(locale).getString("migration.status.report.skipped.no.target")));
      }
      return;
    }

    Map<MavenProject, List<Change>> aggregateReport = new HashMap<MavenProject, List<Change>>();

    for (MavenProject mavenProject : reactorProjects) {

      Map<String, ReportPlugin> reportPluginMap = mavenProject.getReporting().getReportPluginsAsMap();
      ReportPlugin plug = reportPluginMap.get(getBundle(locale).getString("migration.plugin.key"));

      Xpp3Dom configurationDom = (Xpp3Dom) plug.getConfiguration();

      File reactorRepo = DEFAULT_REPO;
      String reactorEnv = DEFAULT_ENVIRONMENT;
      boolean reactorForce = DEFAULT_FORCE;
      boolean skipStatusCommand = false;

      for (int i = 0; i < configurationDom.getChildCount(); i++) {
        Xpp3Dom child = configurationDom.getChild(i);
        if ("repository".equalsIgnoreCase(child.getName())) {
          reactorRepo = new File(child.getValue());
        } else if ("environment".equalsIgnoreCase(child.getName())) {
          reactorEnv = child.getValue();
        } else if ("force".equalsIgnoreCase(child.getName())) {
          reactorForce = Boolean.valueOf(child.getValue());
        } else if ("skip".equalsIgnoreCase(child.getName())) {
          skipStatusCommand = Boolean.valueOf(child.getValue());
        }
      }

      if (skipStatusCommand) {
        continue;
      }

      final SelectedOptions options = new SelectedOptions();
      options.getPaths().setBasePath(reactorRepo);
      options.setEnvironment(reactorEnv);
      options.setForce(reactorForce);

      StatusCommand analyzer = new StatusCommand(options);
      try {
        analyzer.execute();
        StatusOperation operation = analyzer.getOperation();
        List<Change> analysis = operation.getCurrentStatus();

        aggregateReport.put(mavenProject, analysis);
      } catch (RuntimeException e) {
        throw e;
      } catch (Exception e) {
        throw new MavenReportException(getBundle(locale).getString("migration.status.report.error"), e);
      }
    }

    // Step 2: Create sink and bundle
    Sink sink = getSink();
    ResourceBundle bundle = getBundle(locale);

    // Step 3: Generate the report
    MigrationStatusReportView view = new MigrationStatusReportView();
    view.generateReport(aggregateReport, sink, bundle, aggregate);
  }

  @Override
  protected String getOutputDirectory() {
    if (this.getLog().isInfoEnabled()) {
      this.getLog().info(outputDirectory.toString());
    }
    return this.outputDirectory.toString();
  }

  @Override
  protected MavenProject getProject() {
    return this.project;
  }

  @Override
  protected Renderer getSiteRenderer() {
    return this.siteRenderer;
  }

  /**
   * Return the output name of the report.
   *
   * @return the output name.
   */
  @Override
  public String getOutputName() {
    return "migration-status-analysis";
  }

  /**
   * Return the name of the report.
   *
   * @return the name of the report.
   */
  @Override
  public String getName(Locale locale) {
    return getBundle(locale).getString("migration.status.report.name");
  }

  /**
   * Return the description of the report.
   *
   * @return the description of the report.
   */
  @Override
  public String getDescription(Locale locale) {
    return getBundle(locale).getString("migration.status.report.description");
  }

  /**
   * Return the {@link ResourceBundle} given the current locale.
   *
   * @param locale
   *          the current locale.
   */
  protected ResourceBundle getBundle(Locale locale) {
    return ResourceBundle.getBundle("migration-report", locale, this.getClass().getClassLoader());
  }

}

1	/*
2	* Copyright 2010-2022 the original author or authors.
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* https://www.apache.org/licenses/LICENSE-2.0
9	*
10	* Unless required by applicable law or agreed to in writing, software
11	* distributed under the License is distributed on an "AS IS" BASIS,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16	package org.mybatis.maven.mvnmigrate.report;
17
18	import java.io.File;
19	import java.util.HashMap;
20	import java.util.List;
21	import java.util.Locale;
22	import java.util.Map;
23	import java.util.ResourceBundle;
24
25	import org.apache.ibatis.migration.Change;
26	import org.apache.ibatis.migration.commands.StatusCommand;
27	import org.apache.ibatis.migration.operations.StatusOperation;
28	import org.apache.ibatis.migration.options.SelectedOptions;
29	import org.apache.maven.doxia.sink.Sink;
30	import org.apache.maven.doxia.siterenderer.Renderer;
31	import org.apache.maven.model.ReportPlugin;
32	import org.apache.maven.plugins.annotations.Component;
33	import org.apache.maven.plugins.annotations.Mojo;
34	import org.apache.maven.plugins.annotations.Parameter;
35	import org.apache.maven.project.MavenProject;
36	import org.apache.maven.reporting.AbstractMavenReport;
37	import org.apache.maven.reporting.MavenReportException;
38	import org.codehaus.plexus.util.xml.Xpp3Dom;
39
40	/**
41	* Extends {@link AbstractMavenReport}. <br>
42	* Class to generate a Maven report.
43	*/
44	@Mojo(name = "status-report")
45	public final class StatusCommandReportMojo extends AbstractMavenReport {	×
46
47	private static final File DEFAULT_REPO = new File(".");	×
48
49	private static final String DEFAULT_ENVIRONMENT = "development";
50
51	private static final boolean DEFAULT_FORCE = false;
52
53	/**
54	* The Maven project to analyze.
55	*/
56	@Parameter(property = "project", required = true, readonly = true)
57	private MavenProject project;
58
59	/**
60	* Target folder.
61	*/
62	@Parameter(property = "project.build.directory", readonly = true)
63	private File outputDirectory;
64
65	/**
66	* The projects in the reactor for aggregation report.
67	*/
68	@Parameter(property = "reactorProjects", readonly = true)
69	protected List<MavenProject> reactorProjects;
70
71	/**
72	* The project site renderer.
73	*/
74	@Component(role = Renderer.class)
75	private Renderer siteRenderer;
76
77	/**
78	* Location of migrate repository.
79	*/
80	@Parameter(property = "migration.path", defaultValue = ".")
81	protected File repository;
82
83	/**
84	* Environment to configure. Default environment is 'development'.
85	*/
86	@Parameter(property = "migration.env", defaultValue = "development")
87	protected String environment;
88
89	/**
90	* Forces script to continue even if SQL errors are encountered.
91	*/
92	@Parameter(property = "migration.force", defaultValue = "false")
93	protected boolean force;
94
95	/**
96	* Skip migration actions.
97	*/
98	@Parameter(property = "migration.skip", defaultValue = "false")
99	protected boolean skip;
100
101	/**
102	* Aggregate report results.
103	*/
104	@Parameter(property = "migration.aggregate", defaultValue = "false")
105	protected boolean aggregate;
106
107	@Override
108	protected void executeReport(Locale locale) throws MavenReportException {
109	if (aggregate && !project.isExecutionRoot()) {	×
110	return;	×
111	}
112
113	if (skip && !aggregate) {	×
114	if (this.getLog().isInfoEnabled()) {	×
115	this.getLog().info(getBundle(locale).getString("migration.status.report.skipped"));	×
116	}
117	return;	×
118	}
119
120	// Step 0: Checking pom availability
121	if ("pom".equals(this.project.getPackaging()) && !aggregate) {	×
122	if (this.getLog().isInfoEnabled()) {	×
123	this.getLog().info("migration.status.report.skipped.pom");	×
124	}
125	return;	×
126	}
127
128	if (this.outputDirectory == null \|\| !this.outputDirectory.exists()) {	×
129	if (this.getLog().isInfoEnabled()) {	×
130	this.getLog().info(	×
131	getBundle(locale).getString(getBundle(locale).getString("migration.status.report.skipped.no.target")));	×
132	}
133	return;	×
134	}
135
136	Map<MavenProject, List<Change>> aggregateReport = new HashMap<MavenProject, List<Change>>();	×
137
138	for (MavenProject mavenProject : reactorProjects) {	×
139
140	Map<String, ReportPlugin> reportPluginMap = mavenProject.getReporting().getReportPluginsAsMap();	×
141	ReportPlugin plug = reportPluginMap.get(getBundle(locale).getString("migration.plugin.key"));	×
142
143	Xpp3Dom configurationDom = (Xpp3Dom) plug.getConfiguration();	×
144
145	File reactorRepo = DEFAULT_REPO;	×
146	String reactorEnv = DEFAULT_ENVIRONMENT;	×
147	boolean reactorForce = DEFAULT_FORCE;	×
148	boolean skipStatusCommand = false;	×
149
150	for (int i = 0; i < configurationDom.getChildCount(); i++) {	×
151	Xpp3Dom child = configurationDom.getChild(i);	×
152	if ("repository".equalsIgnoreCase(child.getName())) {	×
153	reactorRepo = new File(child.getValue());	×
154	} else if ("environment".equalsIgnoreCase(child.getName())) {	×
155	reactorEnv = child.getValue();	×
156	} else if ("force".equalsIgnoreCase(child.getName())) {	×
157	reactorForce = Boolean.valueOf(child.getValue());	×
158	} else if ("skip".equalsIgnoreCase(child.getName())) {	×
159	skipStatusCommand = Boolean.valueOf(child.getValue());	×
160	}
161	}
162
163	if (skipStatusCommand) {	×
164	continue;	×
165	}
166
167	final SelectedOptions options = new SelectedOptions();	×
168	options.getPaths().setBasePath(reactorRepo);	×
169	options.setEnvironment(reactorEnv);	×
170	options.setForce(reactorForce);	×
171
172	StatusCommand analyzer = new StatusCommand(options);	×
173	try {
174	analyzer.execute();	×
175	StatusOperation operation = analyzer.getOperation();	×
176	List<Change> analysis = operation.getCurrentStatus();	×
177
178	aggregateReport.put(mavenProject, analysis);	×
179	} catch (RuntimeException e) {	×
180	throw e;	×
181	} catch (Exception e) {	×
182	throw new MavenReportException(getBundle(locale).getString("migration.status.report.error"), e);	×
183	}	×
184	}	×
185
186	// Step 2: Create sink and bundle
187	Sink sink = getSink();	×
188	ResourceBundle bundle = getBundle(locale);	×
189
190	// Step 3: Generate the report
191	MigrationStatusReportView view = new MigrationStatusReportView();	×
192	view.generateReport(aggregateReport, sink, bundle, aggregate);	×
193	}	×
194
195	@Override
196	protected String getOutputDirectory() {
197	if (this.getLog().isInfoEnabled()) {	×
198	this.getLog().info(outputDirectory.toString());	×
199	}
200	return this.outputDirectory.toString();	×
201	}
202
203	@Override
204	protected MavenProject getProject() {
205	return this.project;	×
206	}
207
208	@Override
209	protected Renderer getSiteRenderer() {
210	return this.siteRenderer;	×
211	}
212
213	/**
214	* Return the output name of the report.
215	*
216	* @return the output name.
217	*/
218	@Override
219	public String getOutputName() {
220	return "migration-status-analysis";	×
221	}
222
223	/**
224	* Return the name of the report.
225	*
226	* @return the name of the report.
227	*/
228	@Override
229	public String getName(Locale locale) {
230	return getBundle(locale).getString("migration.status.report.name");	×
231	}
232
233	/**
234	* Return the description of the report.
235	*
236	* @return the description of the report.
237	*/
238	@Override
239	public String getDescription(Locale locale) {
240	return getBundle(locale).getString("migration.status.report.description");	×
241	}
242
243	/**
244	* Return the {@link ResourceBundle} given the current locale.
245	*
246	* @param locale
247	* the current locale.
248	*/
249	protected ResourceBundle getBundle(Locale locale) {
250	return ResourceBundle.getBundle("migration-report", locale, this.getClass().getClassLoader());	×
251	}
252
253	}

mybatis / migrations-maven-plugin / #705

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous