org.openwebtop.maven.plugins.precheck.WebworkCheckerMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-precheck-plugin Show documentation
Webwork configuration & Prohibit text pre-check plugin
There is a newer version: 1.0.1
Show newest version
/**
 * Copyright (C) 2010  Jaehyeon Nam ([email protected])
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.openwebtop.maven.plugins.precheck;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.ArrayUtils;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.codehaus.plexus.util.DirectoryScanner;
import org.openwebtop.maven.plugins.precheck.webwork.WebworkConfigurationParser;
import org.openwebtop.maven.plugins.precheck.webwork.checker.DuplicateActionNameWebworkCheckerImpl;
import org.openwebtop.maven.plugins.precheck.webwork.checker.DuplicateNamespaceWebworkCheckerImpl;
import org.openwebtop.maven.plugins.precheck.webwork.checker.DuplicatedPackageNameWebworkCheckerImpl;
import org.openwebtop.maven.plugins.precheck.webwork.checker.WebworkChecker;
import org.openwebtop.maven.plugins.precheck.webwork.model.WebworkConfiguration;
import org.openwebtop.maven.plugins.precheck.webwork.model.WebworkConfigurationError;
import org.openwebtop.maven.plugins.precheck.webwork.model.WebworkPackage;
import org.xml.sax.SAXException;

/**
 * The WebworkCheckerMojo is used to check webwork configuration.
 *
 * @author Jaehyeon Nam ([email protected])
 * @since 2010. 5. 5.
 *
 * @goal webwork
 * @phase process-resources
 */
public class WebworkCheckerMojo extends AbstractPrecheckMojo {
	private final static String GOAL_NAME = "webwork";

	/**
	 * Webwork configuration
	 *
	 * @parameter
	 */
	private WebworkConfiguration webworkConfiguration;

	private WebworkConfigurationParser webworkConfigurationParser;
	private Set webworkCheckers;
	private DirectoryScanner directoryScanner;

	public WebworkCheckerMojo() {
		webworkConfigurationParser = new WebworkConfigurationParser();

		webworkCheckers = new HashSet();
		webworkCheckers.add(new DuplicateActionNameWebworkCheckerImpl());
		webworkCheckers.add(new DuplicatedPackageNameWebworkCheckerImpl());
		webworkCheckers.add(new DuplicateNamespaceWebworkCheckerImpl());

		directoryScanner = new DirectoryScanner();
	}

	@Override
	public String getGoalName() {
		return GOAL_NAME;
	}

	/**
	 * Mojo execute
	 *
	 * @throws MojoExecutionException MojoExecutionException
	 * @throws MojoFailureException MojoFailureException
	 */
	public void onExecute() throws MojoExecutionException, MojoFailureException {
		if (webworkConfiguration == null) {
			printInfoLog("There is no configuration for checking webwork configuration. skipping...");
			return;
		}

		directoryScanner.setBasedir(webworkConfiguration.getBasedir());
		directoryScanner.setIncludes(webworkConfiguration.getIncludes());
		directoryScanner.setExcludes(webworkConfiguration.getExcludes());
		directoryScanner.scan();

		final String[] filenames = directoryScanner.getIncludedFiles();
		printInfoLog(String.format("%d files has been founded.", ArrayUtils.getLength(filenames)));
		printInfoLog("Start checking...");

		if (ArrayUtils.isNotEmpty(filenames)) {
			final List webworkConfigurationFiles = new ArrayList();

			for (String filename : filenames) {
				webworkConfigurationFiles.add(new File(webworkConfiguration.getBasedir() + File.separator + filename));
			}

			final List webworkPackages = getWebworkConfiguration(webworkConfigurationFiles.toArray(new File[0]));

			final List webworkConfigurationErrors = new ArrayList();

			for (WebworkChecker webworkChecker : webworkCheckers) {
				webworkConfigurationErrors.addAll(webworkChecker.check(webworkPackages));
			}

			if (CollectionUtils.isNotEmpty(webworkConfigurationErrors)) {
				for (WebworkConfigurationError error : webworkConfigurationErrors) {
					printInfoLog(error.toString());
				}

				throw new MojoFailureException("Webwork configuration has problems.");
			}
		}
	}

	/**
	 * Get webwork configuration from file
	 * 
	 * @return Webwork package list
	 * @throws MojoFailureException MojoFailureException
	 */
	private List getWebworkConfiguration(File[] files) throws MojoFailureException {
		final List webworkPackages = new ArrayList();

		for (File webworkConfigurationFile : files) {
			try {
				webworkPackages.addAll(webworkConfigurationParser.getWebworkPackages(webworkConfigurationFile));
			} catch (IOException e) {
				throw new MojoFailureException(String.format("Cannot read configuration file! [%s]", webworkConfigurationFile.getName()));
			} catch (SAXException e) {
				throw new MojoFailureException(String.format("Cannot parse configuration file! [%s]", webworkConfigurationFile.getName()));
			}
		}
		return webworkPackages;
	}

	public void setWebworkConfiguration(WebworkConfiguration webworkConfiguration) {
		this.webworkConfiguration = webworkConfiguration;
	}

	public void setWebworkConfigurationParser(WebworkConfigurationParser webworkConfigurationParser) {
		this.webworkConfigurationParser = webworkConfigurationParser;
	}

	public void setDirectoryScanner(DirectoryScanner directoryScanner) {
		this.directoryScanner = directoryScanner;
	}

}