smartrics.rest.fitnesse.fixture.FitFormatter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smartrics-RestFixture Show documentation

The RestFixture is a FitNesse (http://fitnesse.org) fixture that allows developers and/or product owners to write test fixtures for REST services with simplicity in mind. The idea is to write tests that are self documenting and easy to write and read, without the need to write Java code. The fixture allows test writers to express tests as actions (any of the allowed HTTP methods) to operate on resource URIs and express expectations on the content of the return code, headers and body. All without writing one single line of Java code. And it also works as a living/executable documentation of the API.

There is a newer version: 4.4

Show newest version

/*  Copyright 2011 Fabrizio Cannizzo
 *
 *  This file is part of RestFixture.
 *
 *  RestFixture (http://code.google.com/p/rest-fixture/) is free software:
 *  you can redistribute it and/or modify it under the terms of the
 *  GNU Lesser General Public License as published by the Free Software Foundation,
 *  either version 3 of the License, or (at your option) any later version.
 *
 *  RestFixture is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with RestFixture.  If not, see .
 *
 *  If you want to contact the author please leave a comment here
 *  http://smartrics.blogspot.com/2008/08/get-fitnesse-with-some-rest.html
 */
package smartrics.rest.fitnesse.fixture;

import smartrics.rest.fitnesse.fixture.support.CellFormatter;
import smartrics.rest.fitnesse.fixture.support.CellWrapper;
import smartrics.rest.fitnesse.fixture.support.RestDataTypeAdapter;
import smartrics.rest.fitnesse.fixture.support.Tools;
import fit.ActionFixture;
import fit.Parse;
import fit.exception.FitFailureException;

/**
 * Cell formatter for the Fit runner.
 * 
 * @author smartrics
 * 
 */
public class FitFormatter implements CellFormatter {

    private ActionFixture fixture;
    private boolean displayActual;
    private int minLenForToggle = -1;

    public FitFormatter() {
    }
    
    /**
     * sets the action fixture delegate to forward formatting messages.
     * @param f
     */
    public void setActionFixtureDelegate(ActionFixture f) {
        this.fixture = f;
    }

    @Override
    public boolean isDisplayActual() {
        return displayActual;
    }

    @Override
    public void setMinLenghtForToggleCollapse(int minLen) {
        this.minLenForToggle = minLen;
    }

    @Override
    public void setDisplayActual(boolean d) {
        this.displayActual = d;
    }

    @Override
    public void exception(CellWrapper cell, String exceptionMessage) {
        Parse wrapped = cell.getWrapped();
        fixture.exception(wrapped, new FitFailureException(exceptionMessage));
    }

	@Override
	public void exception(CellWrapper cell, Throwable exception) {
		Parse wrapped = cell.getWrapped();
        fixture.exception(wrapped, exception);
	}

	@Override
    public void check(CellWrapper valueCell, RestDataTypeAdapter adapter) {
        valueCell.body(Tools.toHtml(valueCell.body()));
		fixture.check(valueCell.getWrapped(), adapter);
	}

	@Override
	public String label(String string) {
        return ActionFixture.label(string);
	}

	@Override
    public void wrong(CellWrapper expected, RestDataTypeAdapter typeAdapter) {
        String expectedContent = expected.body();
        String body = Tools.makeContentForWrongCell(expectedContent, typeAdapter, this, minLenForToggle);
        expected.body(body);
        fixture.wrong(expected.getWrapped());
	}

	@Override
    public void right(CellWrapper expected, RestDataTypeAdapter typeAdapter) {
        String expectedContent = expected.body();
        expected.body(Tools.makeContentForRightCell(expectedContent, typeAdapter, this, minLenForToggle));
        fixture.right(expected.getWrapped());
	}

	@Override
	public String gray(String string) {
        return ActionFixture.gray(Tools.toHtml(string));
	}

    @Override
    public void asLink(CellWrapper cell, String link, String text) {
        cell.body(Tools.toHtmlLink(link, text));
    }

    @Override
    public String fromRaw(String text) {
        return text;
    }
}