smartrics.rest.fitnesse.fixture.support.Variables 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 2008 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.support;

import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import fit.Fixture;

/**
 * Facade to FitNesse global symbols map.
 * 
 * @author smartrics
 */
public abstract class Variables {
	/**
	 * pattern matching a variable name: {@code \%([a-zA-Z0-9_]+)\%}
	 */
	public static final Pattern VARIABLES_PATTERN = Pattern.compile("\\%([a-zA-Z0-9_]+)\\%");
	private static final String FIT_NULL_VALUE = fitSymbolForNull();
	private String nullValue = "null";

	/**
	 * initialises variables with default config. See @link
	 * {@link #Variables(Config)}
	 */
	Variables() {
		this(Config.getConfig());
	}

	/**
	 * initialises the variables. reade
	 * {@code restfixture.null.value.representation} to know how to render
	 * {@code null}s.
	 * 
	 * @param c
	 */
	Variables(Config c) {
		if (c != null) {
			this.nullValue = c.get("restfixture.null.value.representation", "null");
		}
	}

	/**
	 * puts a value.
	 * 
	 * @param label
	 * @param val
	 */
	abstract public void put(String label, String val);

	/**
	 * gets a value.
	 * 
	 * @param label
	 * @return the value.
	 */
	abstract public String get(String label);

	/**
	 * replaces a text with variable values.
	 * @param text
	 * @return the substituted text.
	 */
	public final String substitute(String text) {
		if (text == null) {
			return null;
		}
		Matcher m = VARIABLES_PATTERN.matcher(text);
		Map replacements = new HashMap();
		while (m.find()) {
			int gc = m.groupCount();
			if (gc == 1) {
				String g0 = m.group(0);
				String g1 = m.group(1);
				String value = get(g1);
				if (FIT_NULL_VALUE.equals(value)) {
					value = nullValue;
				}
				replacements.put(g0, value);
			}
		}
		String newText = text;
		for (Entry en : replacements.entrySet()) {
			String k = en.getKey();
			String replacement = replacements.get(k);
			if (replacement != null) {
				newText = newText.replaceAll(k, replacement);
			}
		}
		return newText;
	}

	private static String fitSymbolForNull() {
		final String k = "somerandomvaluetogettherepresentationofnull-1234567890";
		Fixture.setSymbol(k, null);
		return Fixture.getSymbol(k).toString();
	}

	/**
	 * @param s
	 * @return the null representation if the input is null.
	 */
	public final String replaceNull(String s) {
		if (s == null) {
			return nullValue;
		}
		return s;
	}
}