com.arpitos.utils.Guardian Maven / Gradle / Ivy
// Copyright <2018>
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software
// and associated documentation files (the "Software"), to deal in the Software without restriction,
// including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
// OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package com.arpitos.utils;
import java.util.Arrays;
import com.arpitos.exception.ValueNotAsExpected;
import com.arpitos.exception.WrongFlow;
import com.arpitos.framework.FWStatic_Store;
/**
*
*
*
*/
public class Guardian {
static Convert _con = new Convert();
static String strEqual_fail = " values are not equal";
static String strNotEqual_fail = " values are equal";
static String strGreater_fail = " actual value is not greater than expected value";
static String strLess_fail = " actual value is not less than expected value";
static String strGreaterOrEqual_fail = " actual value is less than expected value";
static String strLessOrEqual_fail = " actual value is greater than expected value";
static String strFormatEqual_fail = " format are not same";
static String strFormatNotEqual_fail = " format are same";
static void print(String reference, String actual) {
FWStatic_Store.context.getLogger().info("Finding:" + "\nReference : " + reference + "\n Actual : " + actual);
}
static void print(byte reference, byte actual) {
FWStatic_Store.context.getLogger().info(
"Finding:" + "\nReference : " + _con.bytesToHexString(reference, true) + "\n Actual : " + _con.bytesToHexString(actual, true));
}
static void print(byte reference, byte actual, byte delta) {
FWStatic_Store.context.getLogger().info("Finding:" + "\nReference : " + _con.bytesToHexString(reference, true) + "\n Actual : "
+ _con.bytesToHexString(actual, true) + "\n Delta : " + _con.bytesToHexString(delta, true));
}
static void print(byte[] reference, byte[] actual) {
FWStatic_Store.context.getLogger().info(
"Finding:" + "\nReference : " + _con.bytesToHexString(reference, true) + "\n Actual : " + _con.bytesToHexString(actual, true));
}
static void print(int reference, int actual) {
FWStatic_Store.context.getLogger().info("Finding:" + "\nReference : " + reference + "\n Actual : " + actual);
}
static void print(int reference, int actual, int delta) {
FWStatic_Store.context.getLogger().info("Finding:" + "\nReference : " + reference + "\n Actual : " + actual + "\n Delta : " + delta);
}
static void print(boolean reference, boolean actual) {
FWStatic_Store.context.getLogger().info("Finding:" + "\nReference : " + reference + "\n Actual : " + actual);
}
static void print(long reference, long actual) {
FWStatic_Store.context.getLogger().info("Finding:" + "\nReference : " + reference + "\n Actual : " + actual);
}
static void print(long reference, long actual, long delta) {
FWStatic_Store.context.getLogger().info("Finding:" + "\nReference : " + reference + "\n Actual : " + actual + "\n Delta : " + delta);
}
// *******************************************************************************************
// Null
// *******************************************************************************************
/**
* Validates that input is null and returns boolean as a result
*
*
* {@code
* Example : isNull(object);
* }
*
*
* @param obj
* Object to be verified
* @return true|false
*/
public static boolean isNull(Object obj) {
if (null == obj) {
return true;
}
return false;
}
// *******************************************************************************************
// String
// *******************************************************************************************
/**
* Validates that two strings are equal and returns boolean as a result
*
*
* {@code
* Example : isEquals("01.02.0001", "01.02.0001");
* }
*
*
* @param reference
* Reference string value
* @param actual
* Actual string value
* @return true|false
*/
public static boolean isEquals(String reference, String actual) {
if (actual.equals(reference)) {
return true;
}
return false;
}
/**
* Validates that two strings are equal. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardEquals("Version of the firmware", "01.02.0001", "01.02.0001");
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference string value
* @param actual
* Actual string value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardEquals(String desc, String reference, String actual) throws ValueNotAsExpected {
print(reference, actual);
if (!isEquals(reference, actual)) {
throw new ValueNotAsExpected(desc + strEqual_fail);
}
}
/**
* Validates that two strings are not equal. If they are, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* Example: guardE("Version of the firmware", "99.99.9999", "01.02.0001");
*
*
* @param desc
* Message to be printed
* @param reference
* Reference string value
* @param actual
* Actual string value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardNotEquals(String desc, String reference, String actual) throws ValueNotAsExpected {
print(reference, actual);
if (isEquals(reference, actual)) {
throw new ValueNotAsExpected(desc + strNotEqual_fail);
}
}
// *******************************************************************************************
// Boolean
// *******************************************************************************************
/**
* Validates that two boolean values are equal. Returns boolean response
*
*
* {@code
* Example : isEquals(true, doSomething());
* }
*
*
* @param reference
* Reference boolean value
* @param actual
* Actual boolean value
* @return true | false
*/
public static boolean isEquals(boolean reference, boolean actual) {
if (reference == actual) {
return true;
}
return false;
}
/**
* Validates that two boolean values are equal. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardEquals("Day of the week", true, isTodaySunday());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference boolean value
* @param actual
* Actual boolean value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardEquals(String desc, boolean reference, boolean actual) throws ValueNotAsExpected {
print(reference, actual);
if (!isEquals(reference, actual)) {
throw new ValueNotAsExpected(desc + strEqual_fail);
}
}
/**
* Validates that two boolean values are not equal. If they are, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardNotEquals("Day of the week", true, isTodaySunday());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference boolean value
* @param actual
* Actual boolean value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardNotEquals(String desc, boolean reference, boolean actual) throws ValueNotAsExpected {
print(reference, actual);
if (isEquals(reference, actual)) {
throw new ValueNotAsExpected(desc + strNotEqual_fail);
}
}
/**
* Validates that passed value is true. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardTrue("Day of the week", isTodaySunday());
* }
*
*
* @param desc
* Message to be printed
* @param actual
* Actual boolean value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardTrue(String desc, boolean actual) throws ValueNotAsExpected {
guardEquals(desc, true, actual);
}
/**
* Validates that passed value is false. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardFalse("Day of the week", isTodaySunday());
* }
*
*
* @param desc
* Message to be printed
* @param actual
* Actual boolean value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardFalse(String desc, boolean actual) throws ValueNotAsExpected {
guardEquals(desc, false, actual);
}
// *******************************************************************************************
// Format
// *******************************************************************************************
/**
* Validates that passed value follows reference format. Returns result in
* boolean format. Wild card character is $, if value 01.05.0012
* require format checking where . and 05 are static values then
* {@code format} value can be $$.05.$$$$
*
*
* {@code
* Example : isFormatEquals("$$.$$.$$$$", "01.02.0001");
* }
*
*
* @param format
* Format string (using $ as a wild card character)
* @param actual
* Actual string to be compared
* @return true | false
*/
public static boolean isFormatEquals(String format, String actual) {
if (UtilsString.compareStringFormat(actual, format)) {
return true;
}
return false;
}
/**
* Validates that passed value follows reference format. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message. Wild card
* character is $, if value 01.05.0012 require format checking where
* . and 05 are static values then {@code format} value can be $$.05.$$$$
*
*
* {@code
* Example : isFormatEquals("Version format checking", "$$.$$.$$$$", "01.02.0001");
* }
*
*
* @param desc
* Message to be printed
* @param format
* Format string (using $ as a wild card character)
* @param actual
* Actual string to be compared
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardFormatEquals(String desc, String format, String actual) throws ValueNotAsExpected {
print(format, actual);
if (!isFormatEquals(format, actual)) {
throw new ValueNotAsExpected(desc + strFormatEqual_fail);
}
}
/**
* Validates that passed value does not follow reference format. If
* it does, an {@link ValueNotAsExpected} is thrown with the given message.
* Wild card character is $, if value 01.05.0012 require format
* checking where . and 05 are static values then {@code format} value can
* be $$.05.$$$$
*
*
* {@code
* Example : guardFormatNotEquals("Version format checking", "$$.$$", "01.02.0001");
* }
*
*
* @param desc
* Message to be printed
* @param format
* Format string (using $ as a wild card character)
* @param actual
* Actual string to be compared
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardFormatNotEquals(String desc, String format, String actual) throws ValueNotAsExpected {
print(format, actual);
if (isFormatEquals(format, actual)) {
throw new ValueNotAsExpected(desc + strFormatNotEqual_fail);
}
}
// *******************************************************************************************
// Byte
// *******************************************************************************************
/**
* Validates that two byte values are equal. Appropriate boolean value will
* be returned based on comparison.
*
*
* {@code
* Example : isEquals((byte) 0x01, (byte) 0x01);
* }
*
*
* @param reference
* Reference byte value
* @param actual
* Actual byte value
* @return true | false
*/
public static boolean isEquals(byte reference, byte actual) {
if (reference == actual) {
return true;
}
return false;
}
/**
* Validates that two byte values are equal with allowed {@code delta} on
* either side. Appropriate boolean value will be returned based on
* comparison.
*
*
* {@code
* Example : isEquals((byte) 0x05, (byte) 0x06, (byte) 0x01);
* }
*
*
* @param reference
* Reference byte value
* @param actual
* Actual byte value
* @param delta
* Variant allowed on either side of the reference value
* @return true | false
*/
public static boolean isEquals(byte reference, byte actual, byte delta) {
// To ensure we do not exceed integer max boundary
byte MaxBoundry;
if (reference >= Byte.MAX_VALUE - delta) {
MaxBoundry = Byte.MAX_VALUE;
} else {
MaxBoundry = (byte) (reference + delta);
}
// To ensure we do not exceed integer min boundary
Byte MinBoundry;
if (reference <= Byte.MIN_VALUE + delta) {
MinBoundry = Byte.MIN_VALUE;
} else {
MinBoundry = (byte) (reference - delta);
}
if (actual >= MinBoundry && actual <= MaxBoundry) {
return true;
}
return false;
}
/**
* Validates that two byte values are equal. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardEquals("Return value of the function", (byte) 0x01, (byte) 0x01);
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference byte value
* @param actual
* Actual byte value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardEquals(String desc, byte reference, byte actual) throws ValueNotAsExpected {
print(reference, actual);
if (!isEquals(reference, actual)) {
throw new ValueNotAsExpected(desc + strEqual_fail);
}
}
/**
* Validates that two byte values are equal with allowed {@code delta}. If
* they are not, an {@link ValueNotAsExpected} is thrown with the given
* message.
*
*
* {@code
* Example : guardEquals("Return value of the function", (byte) 0x05, (byte) 0x06, (byte)0x01);
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference byte value
* @param delta
* Variant allowed on either side of reference value
* @param actual
* Actual byte value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardEquals(String desc, byte reference, byte actual, byte delta) throws ValueNotAsExpected {
print(reference, actual, delta);
if (!isEquals(reference, actual, delta)) {
throw new ValueNotAsExpected(desc + strEqual_fail);
}
}
/**
* Validates that two byte values are not equal. If they are, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardEquals("Return value of the function", (byte) 0x05, (byte) 0x01);
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference byte value
* @param actual
* Actual byte value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardNotEquals(String desc, byte reference, byte actual) throws ValueNotAsExpected {
print(reference, actual);
if (isEquals(reference, actual)) {
throw new ValueNotAsExpected(desc + strNotEqual_fail);
}
}
/**
* Validates that {@code actual} byte value is greater than
* {@code reference} byte value. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardGreaterThan("Return value of the function", (byte) 0x01, (byte) 0x05);
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference byte value
* @param actual
* Actual byte value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardGreaterThan(String desc, byte reference, byte actual) throws ValueNotAsExpected {
print(reference, actual);
if (reference <= actual) {
throw new ValueNotAsExpected(desc + strGreater_fail);
}
}
/**
* Validates that {@code actual} byte value is greater than or equal to
* {@code reference} byte value. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardGreaterOrEqualsTo("Return value of the function", (byte) 0x01, (byte) 0x05);
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference byte value
* @param actual
* Actual byte value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardGreaterOrEqualsTo(String desc, byte reference, byte actual) throws ValueNotAsExpected {
print(reference, actual);
if (reference < actual) {
throw new ValueNotAsExpected(desc + strGreaterOrEqual_fail);
}
}
/**
* Validates that {@code actual} byte value is less than {@code reference}
* byte value. If they are not, an {@link ValueNotAsExpected} is thrown with
* the given message.
*
*
* {@code
* Example : guardLessThan("Return value of the function", (byte) 0x05, (byte) 0x02);
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference byte value
* @param actual
* Actual byte value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardLessThan(String desc, byte reference, byte actual) throws ValueNotAsExpected {
print(reference, actual);
if (reference >= actual) {
throw new ValueNotAsExpected(desc + strLess_fail);
}
}
/**
* Validates that {@code actual} byte value is less than or equal to
* {@code reference} byte value. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardLessOrEqualsTo("Return value of the function", (byte) 0x05, (byte) 0x02);
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference byte value
* @param actual
* Actual byte value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardLessOrEqualsTo(String desc, byte reference, byte actual) throws ValueNotAsExpected {
print(reference, actual);
if (reference > actual) {
throw new ValueNotAsExpected(desc + strLessOrEqual_fail);
}
}
// *******************************************************************************************
// Byte Array
// *******************************************************************************************
/**
* Validates that two byte arrays are equal. Appropriate boolean value will
* be returned based on comparison.
*
*
* {@code
* Example : isEquals(new byte(){0x01, 0x02, 0x03}, new byte(){0x01, 0x02, 0x03});
* }
*
*
* @param reference
* Reference byte array
* @param actual
* Actual byte array
* @return true | false
*/
public static boolean isEquals(byte[] reference, byte[] actual) {
if (Arrays.equals(reference, actual)) {
return true;
}
return false;
}
/**
* Validates that two byte arrays are equal. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardEquals("Return value of the function", new byte(){0x01, 0x02, 0x03}, new byte(){0x01, 0x02, 0x03});
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference byte array
* @param actual
* Actual byte array
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardEquals(String desc, byte[] reference, byte[] actual) throws ValueNotAsExpected {
print(reference, actual);
if (!isEquals(reference, actual)) {
throw new ValueNotAsExpected(desc + strEqual_fail);
}
}
/**
* Validates that two byte arrays are not equal. If they are, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardNotEquals("Return value of the function", new byte(){0x01, 0x02, 0x03}, new byte(){0x05, 0x02, 0x03});
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference byte array
* @param actual
* Actual byte array
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardNotEquals(String desc, byte[] reference, byte[] actual) throws ValueNotAsExpected {
print(reference, actual);
if (isEquals(reference, actual)) {
throw new ValueNotAsExpected(desc + strNotEqual_fail);
}
}
// *******************************************************************************************
// Integer
// *******************************************************************************************
/**
* Validates that two integer values are equal. Appropriate boolean value
* will be returned based on comparison.
*
*
* {@code
* Example : isEquals(1, 2);
* }
*
*
* @param reference
* Reference integer value
* @param actual
* Actual integer value
* @return true | false
*/
public static boolean isEquals(int reference, int actual) {
if (reference == actual) {
return true;
}
return false;
}
/**
* Validates that two integer values are equal with allowed {@code delta} on
* either side. Appropriate boolean value will be returned based on
* comparison.
*
*
* {@code
* Example : isEquals(12, getValue(), 2);
* }
*
*
* @param reference
* Reference integer value
* @param actual
* Actual integer value
* @param delta
* Variant allowed on either side of the reference value
* @return true | false
*/
public static boolean isEquals(int reference, int actual, int delta) {
// To ensure we do not exceed integer max boundary
int MaxBoundry;
if (reference >= Integer.MAX_VALUE - delta) {
MaxBoundry = Integer.MAX_VALUE;
} else {
MaxBoundry = reference + delta;
}
// To ensure we do not exceed integer min boundary
int MinBoundry;
if (reference <= Integer.MIN_VALUE + delta) {
MinBoundry = Integer.MIN_VALUE;
} else {
MinBoundry = reference - delta;
}
if (actual >= MinBoundry && actual <= MaxBoundry) {
return true;
}
return false;
}
/**
* Validates that two integer values are equal. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardEquals("Return value of the function", 5, getValue());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference integer value
* @param actual
* Actual integer value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardEquals(String desc, int reference, int actual) throws ValueNotAsExpected {
print(reference, actual);
if (!isEquals(reference, actual)) {
throw new ValueNotAsExpected(desc + strEqual_fail);
}
}
/**
* Validates that two integer values are equal with allowed {@code delta} on
* either side. If they are not, an {@link ValueNotAsExpected} is thrown
* with the given message.
*
*
* {@code
* Example : guardEquals("Return value of the function", 123, getValue(), 2);
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference integer value
* @param actual
* Actual integer value
* @param delta
* Variant allowed on either side of the reference value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardEquals(String desc, int reference, int actual, int delta) throws ValueNotAsExpected {
print(reference, actual, delta);
if (!isEquals(reference, actual, delta)) {
throw new ValueNotAsExpected(desc + strEqual_fail);
}
}
/**
* Validates that two integer values are not equal. If they are, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardNotEquals("Return value of the function", 5, getValue());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference integer value
* @param actual
* Actual integer value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardNotEquals(String desc, int reference, int actual) throws ValueNotAsExpected {
print(reference, actual);
if (isEquals(reference, actual)) {
throw new ValueNotAsExpected(desc + strNotEqual_fail);
}
}
/**
* Validates that {@code reference} integer value is greater than
* {@code actual} integer value. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardGreaterThan("Return value of the function", 5, getValue());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference integer value
* @param actual
* Actual integer value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardGreaterThan(String desc, int reference, int actual) throws ValueNotAsExpected {
print(reference, actual);
if (reference <= actual) {
throw new ValueNotAsExpected(desc + strGreater_fail);
}
}
/**
* Validates that {@code reference} integer value is greater than or equal
* to {@code actual} integer value. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardGreaterOrEqualsTo("Return value of the function", 5, getValue());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference integer value
* @param actual
* Actual integer value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardGreaterOrEqualsTo(String desc, int reference, int actual) throws ValueNotAsExpected {
print(reference, actual);
if (reference < actual) {
throw new ValueNotAsExpected(desc + strGreaterOrEqual_fail);
}
}
/**
* Validates that {@code reference} integer value is less than
* {@code actual} integer value. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardLessThan("Return value of the function", 5, getValue());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference integer value
* @param actual
* Actual integer value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardLessThan(String desc, int reference, int actual) throws ValueNotAsExpected {
print(reference, actual);
if (reference >= actual) {
throw new ValueNotAsExpected(desc + strLess_fail);
}
}
/**
* Validates that {@code reference} integer value is less than or equal to
* {@code actual} integer value. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardLessOrEqualsTo("Return value of the function", 5, getValue());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference integer value
* @param actual
* Actual integer value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardLessOrEqualsTo(String desc, int reference, int actual) throws ValueNotAsExpected {
print(reference, actual);
if (reference > actual) {
throw new ValueNotAsExpected(desc + strLessOrEqual_fail);
}
}
// *******************************************************************************************
// Long
// *******************************************************************************************
/**
* Validates that two long values are equal. Appropriate boolean value will
* be returned based on comparison.
*
*
* {@code
* Example : isEquals(123456l, getValue());
* }
*
*
* @param reference
* Reference long value
* @param actual
* Actual long value
* @return true | false
*/
public static boolean isEquals(long reference, long actual) {
if (reference == actual) {
return true;
}
return false;
}
/**
* Validates that two long values are equal with allowed {@code delta} on
* either side. Appropriate boolean value will be returned based on
* comparison.
*
*
* {@code
* Example : isEquals(123456l, getValue(), 2l);
* }
*
*
* @param reference
* Reference long value
* @param actual
* Actual long value
* @param delta
* Variant allowed on either side of the reference value
* @return true | false
*/
public static boolean isEquals(long reference, long actual, long delta) {
// To ensure we do not exceed long max boundary
long MaxBoundry;
if (reference >= Long.MAX_VALUE - delta) {
MaxBoundry = Long.MAX_VALUE;
} else {
MaxBoundry = reference + delta;
}
// To ensure we do not exceed long min boundary
long MinBoundry;
if (reference <= Long.MIN_VALUE + delta) {
MinBoundry = Long.MIN_VALUE;
} else {
MinBoundry = reference - delta;
}
if (actual >= MinBoundry && actual <= MaxBoundry) {
return true;
}
return false;
}
/**
* Validates that two long values are equal. If they are not, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardEquals("Return value of the function", 1234567l, getValue());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference long value
* @param actual
* Actual long value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardEquals(String desc, long reference, long actual) throws ValueNotAsExpected {
print(reference, actual);
if (!isEquals(reference, actual)) {
throw new ValueNotAsExpected(desc + strEqual_fail);
}
}
/**
* Validates that two long values are equal with allowed {@code delta} on
* either side. If they are not, an {@link ValueNotAsExpected} is thrown
* with the given message.
*
*
* {@code
* Example : guardEquals("Return value of the function", 1234567l, getValue(), 2l);
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference long value
* @param actual
* Actual long value
* @param delta
* Variant allowed on either side of the reference value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardEquals(String desc, long reference, long actual, long delta) throws ValueNotAsExpected {
print(reference, actual, delta);
if (!isEquals(reference, actual, delta)) {
throw new ValueNotAsExpected(desc + strEqual_fail);
}
}
/**
* Validates that two long values are not equal. If they are, an
* {@link ValueNotAsExpected} is thrown with the given message.
*
*
* {@code
* Example : guardNotEquals("Return value of the function", 1234567l, getValue());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference long value
* @param actual
* Actual long value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardNotEquals(String desc, long reference, long actual) throws ValueNotAsExpected {
print(reference, actual);
if (isEquals(reference, actual)) {
throw new ValueNotAsExpected(desc + strNotEqual_fail);
}
}
/**
* Validates that {@code reference} long value is greater than
* {@code actual} long value. If they are not, an {@link ValueNotAsExpected}
* is thrown with the given message.
*
*
* {@code
* Example : guardGreaterThan("Return value of the function", 123456l, getValue());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference long value
* @param actual
* Actual long value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardGreaterThan(String desc, long reference, long actual) throws ValueNotAsExpected {
print(reference, actual);
if (reference <= actual) {
throw new ValueNotAsExpected(desc + strGreater_fail);
}
}
/**
* Validates that {@code reference} long value is greater than or equal to
* {@code actual} long value. If they are not, an {@link ValueNotAsExpected}
* is thrown with the given message.
*
*
* {@code
* Example : guardGreaterOrEquals("Return value of the function", 123456l, getValue());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference long value
* @param actual
* Actual long value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardGreaterOrEquals(String desc, long reference, long actual) throws ValueNotAsExpected {
print(reference, actual);
if (reference < actual) {
throw new ValueNotAsExpected(desc + strGreaterOrEqual_fail);
}
}
/**
* Validates that {@code reference} long value is less than {@code actual}
* long value. If they are not, an {@link ValueNotAsExpected} is thrown with
* the given message.
*
*
* {@code
* Example : guardLessThan("Return value of the function", 123456l, getValue());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference long value
* @param actual
* Actual long value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardLessThan(String desc, long reference, long actual) throws ValueNotAsExpected {
print(reference, actual);
if (reference >= actual) {
throw new ValueNotAsExpected(desc + strLess_fail);
}
}
/**
* Validates that {@code reference} long value is less than or equal to
* {@code actual} long value. If they are not, an {@link ValueNotAsExpected}
* is thrown with the given message.
*
*
* {@code
* Example : guardLessOrEqualsTo("Return value of the function", 123456l, getValue());
* }
*
*
* @param desc
* Message to be printed
* @param reference
* Reference long value
* @param actual
* Actual long value
* @throws ValueNotAsExpected
* Exception is thrown if value is not meeting defined criteria
*/
public static void guardLessOrEqualsTo(String desc, long reference, long actual) throws ValueNotAsExpected {
print(reference, actual);
if (reference > actual) {
throw new ValueNotAsExpected(desc + strLessOrEqual_fail);
}
}
// *******************************************************************************************
// Exception
// *******************************************************************************************
/**
* Validates that exception msg matches, if it does not then same exception
* is thrown back.
*
*
* {@code
* Example : guardEquals(e, "invalid value");
* }
*
*
* @param e
* Exception which required to be verified
* @param actual
* Actual string value
* @throws Exception
* if exception message is not as expected then same exception
* is thrown again
*/
public static void guardEquals(Exception e, String actual) throws Exception {
print(e.getMessage(), actual);
if (!e.getMessage().contains(actual)) {
throw e;
}
}
// *******************************************************************************************
// Flow
// *******************************************************************************************
/**
* Guard against wrong flow. If code hits this code then {@link WrongFlow}
* is thrown
*
*
* {@code
* Example : guardWrongFlow("invalid flow");
* }
*
*
* @param msg
* Message to be printed
* @throws WrongFlow
* Indicates that code is following wrong flow
*/
public static void guardWrongFlow(String msg) throws WrongFlow {
throw new WrongFlow(msg);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy