/*   
 *  Copyright 1999-2004 The Apache Sofware Foundation.
 *
 *  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 org.apache.tomcat.util.test.matchers;

import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Hashtable;
import java.util.StringTokenizer;

import org.apache.tomcat.util.test.Matcher;


/**
 *  Check if the Resposne body matches a golden file.
 */
public class GoldenMatch extends Matcher {

    // Match the body against a golden file
    String goldenFile;

    // ignore spaces ?
    boolean exactMatch=false;


    public GoldenMatch() {
    }

    // -------------------- 

    
    public void setExactMatch(boolean ex) {
	exactMatch=ex;
    }

    /** Compare with the golden file
     */
    public void setFile( String s ) {
	this.goldenFile=s;
    }

    public void setGoldenFile( String s ) {
	this.goldenFile=s;
    }

    public String getTestDescription() {
	StringBuffer desc=new StringBuffer();
	desc.append("( responseBody " );
	if( exactMatch )
	    desc.append( "equals file '" );
	else
	    desc.append( "like file '");
	int idx=goldenFile.lastIndexOf("/");
	String g=(idx>0) ? goldenFile.substring(idx) : goldenFile;
	desc.append( goldenFile + "') ");

	desc.append( " == " ).append( magnitude );
	return desc.toString();
    }

    // -------------------- Execute the request --------------------

    public void execute() {
        if( skipTest() )
           return;
	try {
	    result=checkResponse( magnitude );
	} catch(Exception ex ) {
	    ex.printStackTrace();
	    result=false;
	}
    }

    private boolean checkResponse(boolean testCondition)
	throws Exception
    {
	String responseLine=response.getResponseLine();
	Hashtable headers=response.getHeaders();
	
        boolean responseStatus = true;
	
	String responseBody=response.getResponseBody();
	    
	// compare the body
	if( goldenFile==null) return responseStatus;

	// Get the expected result from the "golden" file.
	StringBuffer expResult = getExpectedResult();
	
	// Compare the results and set the status
	boolean cmp=true;
	
	if(exactMatch)
	    cmp=compare(responseBody, expResult.toString() );
	else
	    cmp=compareWeek( responseBody, expResult.toString());
	
	if( cmp  != testCondition ) {
	    responseStatus = false;
	    log("ERROR (" + cmp + "," + testCondition + ")");
	    log("====================Expecting: ");
	    log(expResult.toString());
	    log("====================Got:");
	    log(responseBody);
	    log("====================");
	}	    
	
	return responseStatus;
    }
    
    // Parse a file into a String.
    private StringBuffer getExpectedResult()
	throws IOException
    {
        StringBuffer expResult = new StringBuffer("NONE");

        try {
	    InputStream in = new FileInputStream( goldenFile );
	    return readBody ( in );
        } catch (Exception ex) {
            log("\tGolden file not found: " + goldenFile);
            return expResult;
        }
    }


    // Compare the actual result and the expected result.
    private boolean compare(String str1, String str2) {
	if ( str1==null || str2==null) return false;
	if ( str1.length() != str2.length() ) {
	    log("Wrong size " + str1.length() +" " + str2.length() );
	    return false;
	}
	
        for(int i=0; i

  

      

        ... this post is sponsored by my books ...
      
  
  

      

        
           
#1 New Release!
      
      

        
           
FP Best Seller
      
  

 




new blog posts


Gampopa: Liberation is merely the end of error
Free Scala 3 online video training courses
My free Scala and FP online video training courses


FREE '''Introduction to Functional Programming''' video training course (index page)
My free '''Advanced Scala 3''' video training course
ZIO 2: STDOUT and STDERR console output with foldZIO, success, failure


A dream vacation for the meditator in your life
'''I Am That''' talk about the person, watcher/witness, obstacles, reality, enlightenment, and awakening
ScalaTest: How to print debug output in tests (to STDOUT)









 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com

All Rights Reserved.



A percentage of advertising revenue from

pages under the /java/jwarehouse 
URI on this website is

paid back to open source projects.