org.eclipse.jetty.toolchain.test.matchers.IsOrderedCollectionContaining Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jetty-test-helper Show documentation
Unit Testing Support for Jetty (common classes for some unit tests)
There is a newer version: 6.3
//
//  ========================================================================
//  Copyright (c) 1995-2018 Mort Bay Consulting Pty. Ltd.
//  ------------------------------------------------------------------------
//  All rights reserved. This program and the accompanying materials
//  are made available under the terms of the Eclipse Public License v1.0
//  and Apache License v2.0 which accompanies this distribution.
//
//      The Eclipse Public License is available at
//      http://www.eclipse.org/legal/epl-v10.html
//
//      The Apache License v2.0 is available at
//      http://www.opensource.org/licenses/apache2.0.php
//
//  You may elect to redistribute this code under either of these licenses.
//  ========================================================================
//

package org.eclipse.jetty.toolchain.test.matchers;

import java.util.ArrayList;
import java.util.List;

import org.hamcrest.BaseMatcher;
import org.hamcrest.Description;
import org.hamcrest.SelfDescribing;

/**
 * @param  the type
 */
public class IsOrderedCollectionContaining extends BaseMatcher>
{
    private class MismatchDescription implements SelfDescribing
    {
        private final String id;
        private final List entries;
        
        public MismatchDescription(String id, List entries)
        {
            this.id = id;
            this.entries = entries;
        }

        @Override
        public void describeTo(Description description)
        {
            description.appendText(String.format("%s Entries (size: %d)",id,entries.size()));
            for (int i = 0; i < entries.size(); i++)
            {
                Object actualObj = entries.get(i);
                char indicator = badEntries.contains(i)?'>':' ';
                description.appendText(String.format("%n%s[%d] %s",indicator,i,actualObj==null?"":actualObj.toString()));
            }
        }
    }
    
    private final List expectedList;
    private String failureReason;
    private List badEntries = new ArrayList<>();
    private IsOrderedCollectionContaining.MismatchDescription actualFailureDescription;
    private IsOrderedCollectionContaining.MismatchDescription expectedFailureDescription;
    
    /**
     * @param expectedList the expected list
     */
    public IsOrderedCollectionContaining(List expectedList)
    {
        this.expectedList = expectedList;
    }
    
    @Override
    public boolean matches(Object collection)
    {
        if (collection == null)
        {
            failureReason = "is ";
            return false;
        }
        
        if(!(collection instanceof List))
        {
            failureReason = "is not an instance of " + List.class.getName();
            return false;
        }
        
        @SuppressWarnings("unchecked")
        List actualList = (List)collection;
        
        // same size?
        boolean sizeMismatch = expectedList.size() != actualList.size();

        // test content
        this.badEntries = new ArrayList<>();
        int min = Math.min(expectedList.size(),actualList.size());
        int max = Math.max(expectedList.size(),actualList.size());
        for (int i = 0; i < min; i++)
        {
            if (!expectedList.get(i).equals(actualList.get(i)))
            {
                badEntries.add(i);
            }
        }
        for (int i = min; i < max; i++)
        {
            badEntries.add(i);
        }
        
        if (sizeMismatch || badEntries.size() > 0)
        {
            // build up detailed error message
            
            // The core failure reason
            if (sizeMismatch)
            {
                this.failureReason = String.format("size mismatch: expected <%d> entries, but got <%d> entries instead",expectedList.size(),actualList.size());
            }
            else if (badEntries.size() > 0)
            {
                this.failureReason = String.format("<%d> entr%s not matched",badEntries.size(),badEntries.size()>1?"ies":"y");
                this.actualFailureDescription = new MismatchDescription("Actual",actualList);
                this.expectedFailureDescription = new MismatchDescription("Expected",expectedList);
            }
            
            return false;
        }
        
        return true;
    }

    // Describe Expectation (reason or entries)
    @Override
    public void describeTo(Description description)
    {
        description.appendDescriptionOf(this.expectedFailureDescription);
    }
    
    // Describe Actual (entries)
    @Override
    public void describeMismatch(Object item, Description description)
    {
        description.appendText(this.failureReason);
        if (this.actualFailureDescription != null)
        {
            description.appendText(System.lineSeparator());
            description.appendDescriptionOf(this.actualFailureDescription);
        }
    }
}