com.github.restdriver.matchers.HasJsonPath Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rest-driver-shared Show documentation
There is a newer version: 2.0.1
/**
 * Copyright © 2010-2011 Nokia
 *
 * 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
 *
 *      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 com.github.restdriver.matchers;

import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeMatcher;

import com.fasterxml.jackson.databind.JsonNode;
import com.github.restdriver.exception.RuntimeJsonTypeMismatchException;
import com.jayway.jsonpath.InvalidPathException;
import com.jayway.jsonpath.JsonPath;

/**
 * Matcher to enable assertions on JSON objects using JSONpath.
 * 
 * @param  The type of the matcher.
 */
public final class HasJsonPath extends TypeSafeMatcher {
    
    private final String jsonPath;
    private final Matcher matcher;
    
    /**
     * Constructor.
     * 
     * @param jsonPath The JSONpath to use.
     */
    public HasJsonPath(String jsonPath) {
        this(jsonPath, null);
    }
    
    /**
     * Constructor.
     * 
     * @param jsonPath The JSONpath to use.
     * @param matcher The matcher to apply to the result of the JSONpath.
     */
    public HasJsonPath(String jsonPath, Matcher matcher) {
        this.jsonPath = jsonPath;
        this.matcher = matcher;
    }
    
    @Override
    public boolean matchesSafely(JsonNode jsonNode) {
        
        Object jsonPathResult = null;
        
        try {
            
            jsonPathResult = JsonPath.read(jsonNode.toString(), jsonPath);
            
            if (matcher == null) {
                return jsonPathResult != null;
            }
            
            boolean initialMatchResult = matcher.matches(jsonPathResult);
            
            // if matcher is for longs and jsonPath returns an integer, do our best
            if (!initialMatchResult && jsonPathResult instanceof Integer) {
                return matcher.matches(intToLong(jsonPathResult));
            }
            
            return initialMatchResult;
        } catch (InvalidPathException e) {
            return false;
        } catch (ClassCastException cce) {
            
            if (matcher.matches(intToLong(jsonPathResult))) {
                return true;
                
            } else {
                throw new RuntimeJsonTypeMismatchException("JSONpath returned a type unsuitable for matching with the given matcher: " + cce.getMessage(), cce);
                
            }
            
        }
        
    }
    
    private long intToLong(Object o) {
        
        int i;
        
        try {
            i = (Integer) o;
        } catch (ClassCastException cce) {
            throw new RuntimeJsonTypeMismatchException("JSONpath returned a type unsuitable for matching with the given matcher: " + cce.getMessage(), cce);
        }
        
        return i;
        
    }
    
    @Override
    public void describeTo(Description description) {
        description.appendText("a JSON object matching JSONpath \"" + jsonPath + "\"");
        
        if (matcher != null) {
            description.appendText(" with ");
            matcher.describeTo(description);
        }
        
    }
}