FilePatternDoesNotExistRule.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package org.glassfish.jersey.test.maven.rule;

import java.io.File;
import java.io.FileFilter;
import java.util.Arrays;
import java.util.Set;
import java.util.TreeSet;

import org.apache.commons.io.filefilter.WildcardFileFilter;
import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
import org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule;

/**
 * Maven enforcer rule to enforce that given set of files does not exist.<br/>
 * This rule is similar to apache {@code requireFilesDontExist} with a support for wildcards.
 *
 * @author Stepan Vavra (stepan.vavra at oracle.com)
 */
public class FilePatternDoesNotExistRule extends AbstractNonCacheableEnforcerRule {

    File[] files;

    public void execute(EnforcerRuleHelper helper)
            throws EnforcerRuleException {

        if (files == null) {
            return;
        }

        for (File file : files) {
            final String filePath = file.getPath();
            final String prefix = filePath.substring(0, filePath.indexOf("*"));
            final String dirName = prefix.substring(0, prefix.lastIndexOf(File.separator));
            final String fileItselfPattern = filePath.substring(dirName.length() + 1);

            final File dir = new File(dirName);
            if (!dir.isDirectory()) {
                continue;
            }

            final Set<File> matchedFiles = new TreeSet<>();
            for (File matchedFile : dir.listFiles((FileFilter) new WildcardFileFilter(fileItselfPattern))) {
                matchedFiles.add(matchedFile);
            }

            if (!matchedFiles.isEmpty()) {
                throw new EnforcerRuleException("Files found! " + Arrays.toString(matchedFiles.toArray()));
            }
        }
    }
}