src/main/java/org/apache/sling/hamcrest/ResourceMatchers.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 *
 *      http://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.apache.sling.hamcrest;

import java.util.Arrays;
import java.util.Collections;
import java.util.Map;

import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.hamcrest.matchers.ResourceChildrenMatcher;
import org.apache.sling.hamcrest.matchers.ResourceNameMatcher;
import org.apache.sling.hamcrest.matchers.ResourcePathMatcher;
import org.apache.sling.hamcrest.matchers.ResourcePropertiesMatcher;
import org.hamcrest.Matcher;
import org.hamcrest.Matchers;

/**
 * A collection of <tt>Matcher</tt>s that work on the Resource API level
 *
 */
public final class ResourceMatchers {
    
    /**
     * Matches resources which have amongst their children the specified <tt>children</tt>.
     * 
     * Child resources not contained in the specified <tt>children</tt> are not validated. The order of the children does not matter.
     * 
     * <pre>
     * assertThat(resource, hasChildren('child1', 'child2'));
     * </pre>
     * 
     * @param children the expected children, not <code>null</code> or empty
     * @return a matcher instance
     */
    public static Matcher<Resource> hasChildren(String... children) {
        return new ResourceChildrenMatcher(Arrays.asList(children), false, false);
    }
    
    /**
     * Matches resources which have exactly the children with the names given in <tt>children</tt>. The order is validated as well.
     * 
     * <pre>
     * assertThat(resource, containsChildren('child1', 'child2'));
     * </pre>
     * 
     * @param children the expected children, not <code>null</code> or empty
     * @return a matcher instance
     */
    public static Matcher<Resource> containsChildren(String... children) {
        return new ResourceChildrenMatcher(Arrays.asList(children), true, true);
    }
    
    
    /**
     * Matches resources which have exactly the children with the names given in <tt>children</tt>. The order is not validated.
     * 
     * <pre>
     * assertThat(resource, containsChildrenInAnyOrder('child1', 'child2'));
     * </pre>
     * 
     * @param children the expected children, not <code>null</code> or empty
     * @return a matcher instance
     */
    public static Matcher<Resource> containsChildrenInAnyOrder(String... children) {
        return new ResourceChildrenMatcher(Arrays.asList(children), true, false);
    }
    
    /**
     * Matches only if the resource has the given path
     * 
     * <pre>
     * assertThat(resource, hasName('/a/b/c'));
     * </pre>
     * 
     * @param path the resources path, not <code>null</code> or empty
     * @return a matcher instance
     */
    public static Matcher<Resource> path(String path) {
        return new ResourcePathMatcher(path);
    }

    /**
     * Matches only if the resource has the given name
     * 
     * <pre>
     * assertThat(resource, resourceWithName('resource1'));
     * </pre>
     * 
     * @param name the resources name, not <code>null</code> or empty
     * @return a matcher instance
     */
    public static Matcher<Resource> name(String name) {
        return new ResourceNameMatcher(name);
    }

    /**
     * Matches resources with a resource type set to the specified <tt>resourceType</tt>
     * 
     * <pre>
     * assertThat(resource, resourceOfType('my/app'));
     * </pre>
     * @param resourceType the resource type to match
     * @return a matcher instance
     */
    public static Matcher<Resource> resourceType(String resourceType) {
        return new ResourcePropertiesMatcher(Collections.<String, Object> singletonMap(ResourceResolver.PROPERTY_RESOURCE_TYPE, resourceType));
    }

    /**
     * Matches resources which has at least the specified <tt>properties</tt> defined with matching values
     * 
     * <p>Values not declared in the the <tt>properties</tt> parameter are not validated.</p>
     * <pre>
     * Map&lt;String, Object&gt; expectedProperties = new HashMap&lt;&gt;();
     * expectedProperties.put("jcr:title", "Node title");
     * expectedProperties.put("jcr:text",  "Some long text");
     * 
     * assertThat(resource, resourceWithProps(expectedProperties));
     * </pre>
     * 
     * @param properties the properties to match
     * @return a matcher instance
     */    
    public static Matcher<Resource> props(Map<String, Object> properties) {
        return new ResourcePropertiesMatcher(properties);
    }

    /**
     * Matches resources which has at least the specified <tt>properties</tt> defined with matching values
     * 
     * <p>Values not declared in the the <tt>properties</tt> parameter are not validated.</p>
     * <pre>
     * Map&lt;String, Object&gt; expectedProperties = new HashMap&lt;&gt;();
     * expectedProperties.put("jcr:title", "Node title");
     * expectedProperties.put("jcr:text",  "Some long text");
     * 
     * assertThat(resource, resourceWithProps(expectedProperties));
     * </pre>
     * 
     * @param properties the properties to match
     * @return a matcher instance
     */    
    public static Matcher<Resource> props(Object... properties) {
        return props(MapUtil.toMap(properties));
    }

    /**
     * Matches resources which has the given name and at least the specified <tt>properties</tt> defined with matching values
     * 
     * <p>Values not declared in the the <tt>properties</tt> parameter are not validated.</p>
     * <pre>
     * Map&lt;String, Object&gt; expectedProperties = new HashMap&lt;&gt;();
     * expectedProperties.put("jcr:title", "Node title");
     * expectedProperties.put("jcr:text",  "Some long text");
     * 
     * assertThat(resource, resourceWithProps(expectedProperties));
     * </pre>
     * 
     * @param name the expected name of the resource
     * @param properties the properties to match
     * @return a matcher instance
     */
    public static Matcher<Resource> nameAndProps(String name, Map<String, Object> properties) {
        return Matchers.allOf(new ResourceNameMatcher(name), new ResourcePropertiesMatcher(properties));
    }

    /**
     * Matches resources which has the given name and at least the specified <tt>properties</tt> defined with matching values
     * 
     * <p>Values not declared in the the <tt>properties</tt> parameter are not validated.</p>
     * <pre>
     * Map&lt;String, Object&gt; expectedProperties = new HashMap&lt;&gt;();
     * expectedProperties.put("jcr:title", "Node title");
     * expectedProperties.put("jcr:text",  "Some long text");
     * 
     * assertThat(resource, resourceWithProps(expectedProperties));
     * </pre>
     * 
     * @param name the expected name of the resource
     * @param properties the properties to match
     * @return a matcher instance
     */
    public static Matcher<Resource> nameAndProps(String name, Object... properties) {
        return nameAndProps(name, MapUtil.toMap(properties));
    }

    private ResourceMatchers() {
        // prevent instantiation
    }
}