io.tapack.satisfy.ScanningStepsFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of satisfy-commons Show documentation
There is a newer version: 0.6.6
/*
 * Copyright © 2015 Tapack, and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Research Projects is dual-licensed under the GNU General Public
 * License, version 2.0 (GPLv2) and the Tapack Commercial License.
 *
 * Solely for non-commercial purposes. A purpose is non-commercial only if
 * it is in no manner primarily intended for or directed toward commercial
 * advantage or private monetary compensation.
 *
 * This Tapack Software is supplied to you by Tapack in consideration of your
 * agreement to the following terms, and your use, installation, modification
 * or redistribution of this Tapack Software constitutes acceptance of these
 * terms. If you do not agree with these terms, please do not use, install,
 * modify or redistribute this Tapack Software.
 *
 * Neither the name, trademarks, service marks or logos of Tapack may be used
 * to endorse or promote products derived from the Tapack Software without
 * specific prior written permission from Tapack.
 *
 * The Tapack Software is provided by Tapack on an "AS IS" basis. TAPACK
 * MAKES NO
 * WARRANTIES, EXPRESS  OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, REGARDING THE TAPACK SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
 * COMBINATION WITH YOUR PRODUCTS.
 *
 * IN NO EVENT SHALL TAPACK BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
 * AND/OR DISTRIBUTION OF THE TAPACK SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
 * THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
 * OTHERWISE, EVEN IF TAPACK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * A copy of the GNU General Public License is included in the distribution in
 * the file LICENSE and at
 *
 *     http://www.gnu.org/licenses/gpl-2.0.html
 *
 * If you are using the Research Projects for commercial purposes, we
 * encourage you to visit
 *
 *     http://products.tapack.io/license
 *
 * for more details.
 *
 * This software or hardware and documentation may provide access to
 * or information on content, products, and services from third parties.
 * Tapack and its affiliates are not responsible for and expressly disclaim
 * all warranties of any kind with respect to third-party content, products,
 * and services. Tapack and its affiliates will not be responsible for any loss,
 * costs, or damages incurred due to your access to or use of third-party
 * content, products, or services. If a third-party content exists, the
 * additional copyright notices and license terms applicable to portions of the
 * software are set forth in the THIRD_PARTY_LICENSE_README file.
 *
 * Please contact Tapack or visit www.tapack.io if you need additional
 * information or have any questions.
 */

package io.tapack.satisfy;

import net.thucydides.core.pages.Pages;
import net.thucydides.core.steps.SatisfyStepFactory;
import net.thucydides.core.steps.StepFactory;
import org.jbehave.core.annotations.AfterScenario;
import org.jbehave.core.annotations.AfterStories;
import org.jbehave.core.annotations.AfterStory;
import org.jbehave.core.annotations.AsParameterConverter;
import org.jbehave.core.annotations.BeforeScenario;
import org.jbehave.core.annotations.BeforeStories;
import org.jbehave.core.annotations.BeforeStory;
import org.jbehave.core.annotations.Given;
import org.jbehave.core.annotations.Then;
import org.jbehave.core.annotations.When;
import org.jbehave.core.configuration.Configuration;
import org.jbehave.core.steps.AbstractStepsFactory;
import org.junit.After;
import org.junit.Before;
import org.reflections.Reflections;
import org.reflections.scanners.MethodAnnotationsScanner;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

public class ScanningStepsFactory extends AbstractStepsFactory {

    private final Set> types = new HashSet<>();
    private final StepFactory stepFactory;
    private String matchingRegex = ".*";
    private String notMatchingRegex = "";

    public ScanningStepsFactory(Configuration configuration,
                                Class root, Pages pages) {
        super(configuration);
        types.addAll(scanTypes(root.getPackage().getName()));
        stepFactory = new SatisfyStepFactory(pages);
    }


    public ScanningStepsFactory matchingNames(String matchingRegex) {
        this.matchingRegex = matchingRegex;
        return this;
    }

    public ScanningStepsFactory notMatchingNames(String notMatchingRegex) {
        this.notMatchingRegex = notMatchingRegex;
        return this;
    }

    private Set> scanTypes(String packageName) {
        Reflections reflections = new Reflections(packageName,
                new MethodAnnotationsScanner());
        Set> types = new HashSet<>();
        types.addAll(typesAnnotatedWith(reflections, Given.class));
        types.addAll(typesAnnotatedWith(reflections, When.class));
        types.addAll(typesAnnotatedWith(reflections, Then.class));
        types.addAll(typesAnnotatedWith(reflections, Before.class));
        types.addAll(typesAnnotatedWith(reflections, After.class));
        types.addAll(typesAnnotatedWith(reflections, BeforeScenario.class));
        types.addAll(typesAnnotatedWith(reflections, AfterScenario.class));
        types.addAll(typesAnnotatedWith(reflections, BeforeStory.class));
        types.addAll(typesAnnotatedWith(reflections, AfterStory.class));
        types.addAll(typesAnnotatedWith(reflections, BeforeStories.class));
        types.addAll(typesAnnotatedWith(reflections, AfterStories.class));
        types.addAll(typesAnnotatedWith(reflections, AsParameterConverter
                .class));
        return types;
    }

    private Set> typesAnnotatedWith(Reflections reflections,
                                             Class
                                                     annotation) {
        Set> types = new HashSet<>();
        Set methodsAnnotatedWith = reflections
                .getMethodsAnnotatedWith(annotation);
        for (Method method : methodsAnnotatedWith) {
            types.add(method.getDeclaringClass());
        }
        return types;
    }

    @Override
    protected List> stepsTypes() {
        List> matchingTypes = new ArrayList<>();
        for (Class type : types) {
            String name = type.getName();
            if (name.matches(matchingRegex) && !name.matches
                    (notMatchingRegex)) {
                matchingTypes.add(type);
            }
        }
        return matchingTypes;
    }

    public Object createInstanceOfType(Class type) {
        return stepFactory.instantiateNewStepLibraryFor(type);
    }
}