/*
HTTP stub server written in Java with embedded Jetty
Copyright (C) 2012 Alexander Zagniotov, Isa Goksu and Eric Mrak
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package by.stub.yaml;
import by.stub.utils.ConsoleUtils;
import by.stub.utils.FileUtils;
import by.stub.utils.ReflectionUtils;
import by.stub.utils.StringUtils;
import by.stub.yaml.stubs.StubHttpLifecycle;
import by.stub.yaml.stubs.StubRequest;
import by.stub.yaml.stubs.StubResponse;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.constructor.Constructor;
import org.yaml.snakeyaml.representer.Representer;
import org.yaml.snakeyaml.resolver.Resolver;
import java.io.IOException;
import java.io.Reader;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
@SuppressWarnings("unchecked")
public final class YamlParser {
private String dataConfigHomeDirectory;
private final static Yaml SNAKE_YAML;
static {
final class YamlParserResolver extends Resolver {
YamlParserResolver() {
super();
}
@Override
protected void addImplicitResolvers() {
// no implicit resolvers - resolve everything to String
}
}
SNAKE_YAML = new Yaml(new Constructor(), new Representer(), new DumperOptions(), new YamlParserResolver());
}
private static final String YAML_NODE_REQUEST = "request";
private static final String YAML_NODE_METHOD = "method";
private static final String YAML_NODE_FILE = "file";
public List<StubHttpLifecycle> parse(final String dataConfigHomeDirectory, final Reader yamlReader) throws Exception {
final Object loadedYaml = SNAKE_YAML.load(yamlReader);
if (!(loadedYaml instanceof List)) {
throw new IOException("Loaded YAML root node must be an instance of ArrayList, otherwise something went wrong. Check provided YAML");
}
this.dataConfigHomeDirectory = dataConfigHomeDirectory;
final List<?> loadedYamlData = (List) loadedYaml;
final List<StubHttpLifecycle> httpLifecycles = new LinkedList<StubHttpLifecycle>();
for (final Object rawParentNode : loadedYamlData) {
final Map<String, Object> parentNodePropertiesMap = (Map<String, Object>) rawParentNode;
httpLifecycles.add(unmarshallYamlNodeToHttpLifeCycle(parentNodePropertiesMap));
}
return httpLifecycles;
}
@SuppressWarnings("unchecked")
protected StubHttpLifecycle unmarshallYamlNodeToHttpLifeCycle(final Map<String, Object> parentNodesMap) throws Exception {
final StubHttpLifecycle httpLifecycle = new StubHttpLifecycle();
for (final Map.Entry<String, Object> parentNode : parentNodesMap.entrySet()) {
final Object parentNodeValue = parentNode.getValue();
if (parentNodeValue instanceof Map) {
handleMapNode(httpLifecycle, parentNode);
} else if (parentNodeValue instanceof List) {
handleListNode(httpLifecycle, parentNode);
}
}
return httpLifecycle;
}
private void handleMapNode(final StubHttpLifecycle stubHttpLifecycle, final Map.Entry<String, Object> parentNode) throws Exception {
final Map<String, Object> yamlProperties = (Map<String, Object>) parentNode.getValue();
if (parentNode.getKey().equals(YAML_NODE_REQUEST)) {
final StubRequest targetStub = unmarshallYamlMapToTargetStub(yamlProperties, StubRequest.class);
stubHttpLifecycle.setRequest(targetStub);
ConsoleUtils.logUnmarshalledStubRequest(targetStub);
} else {
final StubResponse targetStub = unmarshallYamlMapToTargetStub(yamlProperties, StubResponse.class);
stubHttpLifecycle.setResponse(targetStub);
}
}
@SuppressWarnings("unchecked")
protected <T> T unmarshallYamlMapToTargetStub(final Map<String, Object> yamlProperties, final Class<T> targetStubClass) throws Exception {
final T targetStub = targetStubClass.newInstance();
for (final Map.Entry<String, Object> pair : yamlProperties.entrySet()) {
final Object rawPairValue = pair.getValue();
final String pairKey = pair.getKey();
final Object massagedPairValue;
if (rawPairValue instanceof List) {
massagedPairValue = rawPairValue;
} else if (rawPairValue instanceof Map) {
massagedPairValue = encodeAuthorizationHeader(rawPairValue);
} else if (pairKey.toLowerCase().equals(YAML_NODE_METHOD)) {
massagedPairValue = new ArrayList<String>(1) {{
add(StringUtils.objectToString(rawPairValue));
}};
} else if (pairKey.toLowerCase().equals(YAML_NODE_FILE)) {
massagedPairValue = FileUtils.fileToBytes(dataConfigHomeDirectory, StringUtils.objectToString(rawPairValue));
} else {
massagedPairValue = StringUtils.objectToString(rawPairValue);
}
ReflectionUtils.setPropertyValue(targetStub, pairKey, massagedPairValue);
}
return targetStub;
}
private void handleListNode(final StubHttpLifecycle stubHttpLifecycle, final Map.Entry<String, Object> parentNode) throws Exception {
final List yamlProperties = (List) parentNode.getValue();
final List<StubResponse> populatedResponseStub = unmarshallYamlListToTargetStub(yamlProperties, StubResponse.class);
stubHttpLifecycle.setResponse(populatedResponseStub);
}
@SuppressWarnings("unchecked")
private <T> List<T> unmarshallYamlListToTargetStub(final List yamlProperties, final Class<T> targetStubClass) throws Exception {
final List<T> targetStubList = new LinkedList<T>();
for (final Object arrayListEntry : yamlProperties) {
final Map<String, Object> rawSequenceEntry = (Map<String, Object>) arrayListEntry;
final T targetStub = targetStubClass.newInstance();
for (final Map.Entry<String, Object> mapEntry : rawSequenceEntry.entrySet()) {
final String rawSequenceEntryKey = mapEntry.getKey();
final Object rawSequenceEntryValue = mapEntry.getValue();
ReflectionUtils.setPropertyValue(targetStub, rawSequenceEntryKey, rawSequenceEntryValue);
}
targetStubList.add(targetStub);
}
return targetStubList;
}
private Map<String, String> encodeAuthorizationHeader(final Object value) {
final Map<String, String> pairValue = (Map<String, String>) value;
if (!pairValue.containsKey(StubRequest.AUTH_HEADER)) {
return pairValue;
}
final String rawHeader = pairValue.get(StubRequest.AUTH_HEADER);
final String authorizationHeader = StringUtils.isSet(rawHeader) ? rawHeader.trim() : rawHeader;
final String encodedAuthorizationHeader = String.format("%s %s", "Basic", StringUtils.encodeBase64(authorizationHeader));
pairValue.put(StubRequest.AUTH_HEADER, encodedAuthorizationHeader);
return pairValue;
}
}