Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2019 Coveros, Inc.
*
* This file is part of Selenified.
*
* Selenified is 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 com.coveros.selenified.services;
import com.coveros.selenified.utilities.Reporter;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import java.util.Map;
import static com.coveros.selenified.utilities.Constants.*;
/**
* Check will handle all verifications performed on the actual web services
* calls themselves. These asserts are custom to the framework, and in addition to
* providing easy object oriented capabilities, they assist in
* troubleshooting and debugging failing tests.
*
* @author Max Saperstone
* @version 3.2.0
* @lastupdate 6/25/2019
*/
abstract class Check {
// this will be the name of the file we write all commands out to
Reporter reporter;
// this is the driver that will be used for all selenium actions
Response response;
/**
* Casts an unknown JsonElement into an object, based on the expected behavior of it
*
* @param known - what value are we expecting
* @param unknown - what JsonElement are we trying to cast
* @return Object - the expected object, properly cast
*/
public Object castObject(Object known, JsonElement unknown) {
Object objectVal;
try {
if (known instanceof String) {
objectVal = unknown.getAsString();
} else if (known instanceof Integer) {
objectVal = unknown.getAsInt();
} else if (known instanceof Double) {
objectVal = unknown.getAsDouble();
} else if (known instanceof Float) {
objectVal = unknown.getAsFloat();
} else if (known instanceof Long) {
objectVal = unknown.getAsLong();
} else if (known instanceof Boolean) {
objectVal = unknown.getAsBoolean();
} else if (known instanceof Byte) {
objectVal = unknown.getAsByte();
} else if (known instanceof Character) {
objectVal = unknown.getAsCharacter();
} else if (known instanceof JsonArray) {
objectVal = unknown.getAsJsonArray();
} else if (known instanceof JsonObject) {
objectVal = unknown.getAsJsonObject();
} else {
objectVal = unknown;
}
return objectVal;
} catch (UnsupportedOperationException | NumberFormatException | IllegalStateException e) {
return unknown;
}
}
///////////////////////////////////////////////////////////////////
// checks for our services
///////////////////////////////////////////////////////////////////
/**
* Checks the actual response code is equals to the expected response
* code, and writes that out to the output file
*
* @param expectedCode - the expected response code
*/
@SuppressWarnings("squid:S1201")
abstract void equals(int expectedCode);
/**
* Checks the actual response code is equals to the expected response
* code, and writes that out to the output file
*
* @param expectedCode - the expected response code
*/
int checkEquals(int expectedCode) {
int actualCode = this.response.getCode();
if (actualCode == expectedCode) {
this.reporter.pass("", "Expected to find a response code of " + expectedCode + ENDB, "Found a response code of " + actualCode + ENDB);
} else {
this.reporter.fail("", "Expected to find a response code of " + expectedCode + ENDB, "Found a response code of " + actualCode + ENDB);
}
return actualCode;
}
/**
* Checks the actual response json payload is equal to the expected
* response json payload, and writes that out to the output file
*
* @param expectedJson - the expected response json object
*/
@SuppressWarnings("squid:S1201")
abstract void equals(JsonObject expectedJson);
/**
* Checks the actual response json payload is equal to the expected
* response json payload, and writes that out to the output file
*
* @param expectedJson - the expected response json object
*/
JsonObject checkEquals(JsonObject expectedJson) {
boolean pass = false;
JsonObject actualJson = null;
if (this.response.getObjectData() != null) {
actualJson = this.response.getObjectData();
pass = actualJson.equals(expectedJson);
}
if (pass) {
this.reporter.pass("", EXPECTED_TO_FIND + DIV_I + Reporter.formatHTML(GSON.toJson(expectedJson)) + END_IDIV, FOUND + Reporter.formatResponse(this.response));
} else {
this.reporter.fail("", EXPECTED_TO_FIND + DIV_I + Reporter.formatHTML(GSON.toJson(expectedJson)) + END_IDIV, FOUND + Reporter.formatResponse(this.response));
}
return actualJson;
}
/**
* Checks the actual response json payload is equal to the expected
* response json payload, and writes that out to the output file
*
* @param expectedJson - the expected response json array
*/
@SuppressWarnings("squid:S1201")
abstract void equals(JsonArray expectedJson);
/**
* Checks the actual response json payload is equal to the expected
* response json payload, and writes that out to the output file
*
* @param expectedJson - the expected response json array
*/
JsonArray checkEquals(JsonArray expectedJson) {
boolean pass = false;
JsonArray actualJson = null;
if (this.response.getArrayData() != null) {
actualJson = this.response.getArrayData();
pass = actualJson.equals(expectedJson);
}
if (pass) {
this.reporter.pass("", EXPECTED_TO_FIND + DIV_I + Reporter.formatHTML(GSON.toJson(expectedJson)) + END_IDIV, FOUND + Reporter.formatResponse(this.response));
} else {
this.reporter.fail("", EXPECTED_TO_FIND + DIV_I + Reporter.formatHTML(GSON.toJson(expectedJson)) + END_IDIV, FOUND + Reporter.formatResponse(this.response));
}
return actualJson;
}
/**
* Checks the actual response payload is equal to the expected
* response payload, and writes that out to the output file
*
* @param expectedMessage - the expected response message
*/
@SuppressWarnings("squid:S1201")
abstract void equals(String expectedMessage);
/**
* Checks the actual response payload is equal to the expected
* response payload, and writes that out to the output file
*
* @param expectedMessage - the expected response message
*/
String checkEquals(String expectedMessage) {
boolean pass = false;
String actualMessage = null;
if (this.response.getMessage() != null) {
actualMessage = this.response.getMessage();
pass = actualMessage.equals(expectedMessage);
}
if (pass) {
this.reporter.pass("", EXPECTED_TO_FIND + STARTI + expectedMessage + ENDI, FOUND + STARTI + this.response.getMessage() + ENDI);
} else {
this.reporter.fail("", EXPECTED_TO_FIND + STARTI + expectedMessage + ENDI, FOUND + STARTI + this.response.getMessage() + ENDI);
}
return actualMessage;
}
/**
* Checks the actual response json payload contains each of the pair
* values provided, and writes that to the output file
*
* @param expectedPairs a hashmap with string key value pairs expected in the json
* response
*/
abstract void contains(Map expectedPairs);
/**
* Checks the actual response json payload contains each of the pair
* values provided, and writes that to the output file
*
* @param expectedPairs a hashmap with string key value pairs expected in the json
* response
*/
boolean checkContains(Map expectedPairs) {
boolean pass = (this.response.getObjectData() != null);
for (Map.Entry entry : expectedPairs.entrySet()) {
if (this.response.getObjectData() != null && this.response.getObjectData().has(entry.getKey())) {
Object objectVal = castObject(entry.getValue(), this.response.getObjectData().get(entry.getKey()));
if (!entry.getValue().equals(objectVal)) {
pass = false;
}
} else {
pass = false;
}
}
if (pass) {
this.reporter.pass("", EXPECTED_TO_FIND_A_RESPONSE_CONTAINING + DIV_I + Reporter.formatKeyPair(expectedPairs) + END_IDIV, FOUND + Reporter.formatResponse(this.response));
} else {
this.reporter.fail("", EXPECTED_TO_FIND_A_RESPONSE_CONTAINING + DIV_I + Reporter.formatKeyPair(expectedPairs) + END_IDIV, FOUND + Reporter.formatResponse(this.response));
}
return pass;
}
/**
* Checks the actual response json payload contains to the expected json
* element, and writes that out to the output file
*
* @param expectedJson - the expected response json array
*/
abstract void contains(JsonElement expectedJson);
/**
* Checks the actual response json payload contains to the expected json
* element, and writes that out to the output file
*
* @param expectedJson - the expected response json array
*/
boolean checkContains(JsonElement expectedJson) {
boolean pass = false;
if (this.response.getArrayData() != null) {
pass = this.response.getArrayData().contains(expectedJson);
}
if (pass) {
this.reporter.pass("", EXPECTED_TO_FIND_A_RESPONSE_CONTAINING +
DIV_I + Reporter.formatHTML(GSON.toJson(expectedJson)) + END_IDIV, FOUND + Reporter.formatResponse(this.response));
} else {
this.reporter.fail("", EXPECTED_TO_FIND_A_RESPONSE_CONTAINING +
DIV_I + Reporter.formatHTML(GSON.toJson(expectedJson)) + END_IDIV, FOUND + Reporter.formatResponse(this.response));
}
return pass;
}
/**
* Checks the actual response json payload contains to the expected json
* element, and writes that out to the output file
*
* @param expectedMessage - the expected response json array
*/
abstract void contains(String expectedMessage);
/**
* Checks the actual response json payload contains to the expected json
* element, and writes that out to the output file
*
* @param expectedMessage - the expected response json array
*/
boolean checkContains(String expectedMessage) {
boolean pass = false;
if (this.response.getMessage() != null) {
pass = this.response.getMessage().contains(expectedMessage);
}
if (pass) {
this.reporter.pass("", EXPECTED_TO_FIND_A_RESPONSE_CONTAINING + STARTI + expectedMessage + ENDI, FOUND + STARTI + this.response.getMessage() + ENDI);
} else {
this.reporter.fail("", EXPECTED_TO_FIND_A_RESPONSE_CONTAINING + STARTI + expectedMessage + ENDI, FOUND + STARTI + this.response.getMessage() + ENDI);
}
return pass;
}
}
