io.restassured.matcher.DetailedCookieMatcher Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of rest-assured Show documentation
Show all versions of rest-assured Show documentation
Java DSL for easy testing of REST services
/*
* Copyright 2019 the original author or authors.
*
* 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 io.restassured.matcher;
import io.restassured.http.Cookie;
import org.hamcrest.Matcher;
import org.hamcrest.Matchers;
import org.hamcrest.core.CombinableMatcher;
import java.util.Date;
import static org.hamcrest.Matchers.equalTo;
/**
* Fluent Hamcrest matcher for assertions related to {@link Cookie} instances.
* Can be instantiated via {@link RestAssuredMatchers} factory method.
*/
public class DetailedCookieMatcher extends CombinableMatcher {
DetailedCookieMatcher() {
this(Matchers.notNullValue());
}
private DetailedCookieMatcher(Matcher m) {
super(m);
}
/**
* Verifies whether value of cookie is equal to specified argument.
* @param expectedValue expected value of cookie
* @return A {@link DetailedCookieMatcher} instance with and-composed value property assertion
*/
public DetailedCookieMatcher value(String expectedValue) {
return value(equalTo(expectedValue));
}
/**
* Verifies whether value of cookie satisfies specified matcher.
* @param valueMatcher value assertion
* @return A {@link DetailedCookieMatcher} instance with and-composed value property assertion
*/
public DetailedCookieMatcher value(Matcher valueMatcher) {
return new DetailedCookieMatcher(and(Matchers.hasProperty("value", valueMatcher)));
}
/**
* Verifies whether comment of cookie is equal to specified argument.
* @param expectedComment expected comment of cookie
* @return A {@link DetailedCookieMatcher} instance with and-composed comment property assertion
*/
public DetailedCookieMatcher comment(String expectedComment) {
return comment(equalTo(expectedComment));
}
/**
* Verifies whether comment of cookie satisfies specified matcher.
* @param commentMatcher comment assertion
* @return A {@link DetailedCookieMatcher} instance with and-composed comment property assertion
*/
public DetailedCookieMatcher comment(Matcher commentMatcher) {
return new DetailedCookieMatcher(and(Matchers.hasProperty("comment", commentMatcher)));
}
/**
* Verifies whether expiry date of cookie is equal to specified argument.
* @param expectedExpiryDate expected expiry date of cookie
* @return A {@link DetailedCookieMatcher} instance with and-composed expiry date property assertion
*/
public DetailedCookieMatcher expiryDate(Date expectedExpiryDate) {
return expiryDate(equalTo(expectedExpiryDate));
}
/**
* Verifies whether expiry date of cookie satisfies specified matcher.
* @param expiryDateMatcher expiry date assertion
* @return A {@link DetailedCookieMatcher} instance with and-composed expiry date property assertion
*/
public DetailedCookieMatcher expiryDate(Matcher expiryDateMatcher) {
return new DetailedCookieMatcher(and(Matchers.hasProperty("expiryDate", expiryDateMatcher)));
}
/**
* Verifies whether domain of cookie is equal to specified argument.
* @param expectedDomain expected domain of cookie
* @return A {@link DetailedCookieMatcher} instance with and-composed domain property assertion
*/
public DetailedCookieMatcher domain(String expectedDomain) {
return domain(equalTo(expectedDomain));
}
/**
* Verifies whether domain of cookie satisfies specified matcher.
* @param domainMatcher assertion for domain property
* @return A {@link DetailedCookieMatcher} instance with and-composed domain property assertion
*/
public DetailedCookieMatcher domain(Matcher domainMatcher) {
return new DetailedCookieMatcher(and(Matchers.hasProperty("domain", domainMatcher)));
}
/**
* Verifies whether path of cookie is equal to specified argument.
* @param expectedPath expected path of cookie
* @return A {@link DetailedCookieMatcher} instance with and-composed path property assertion
*/
public DetailedCookieMatcher path(String expectedPath) {
return path(equalTo(expectedPath));
}
/**
* Verifies whether path of cookie satisfies specified matcher.
* @param pathMatcher assertion for path property
* @return A {@link DetailedCookieMatcher} instance with and-composed path property assertion
*/
public DetailedCookieMatcher path(Matcher pathMatcher) {
return new DetailedCookieMatcher(and(Matchers.hasProperty("path", pathMatcher)));
}
/**
* Verifies whether secured property of cookie is equal to specified argument.
* @param expectedSecuredValue expected value of secured property
* @return A {@link DetailedCookieMatcher} instance with and-composed secured property assertion
*/
public DetailedCookieMatcher secured(boolean expectedSecuredValue) {
return secured(equalTo(expectedSecuredValue));
}
/**
* Verifies whether secured property of cookie satisfies specified matcher.
* @param securedMatcher assertion for secured property
* @return A {@link DetailedCookieMatcher} instance with and-composed secured property assertion
*/
public DetailedCookieMatcher secured(Matcher securedMatcher) {
return new DetailedCookieMatcher(and(Matchers.hasProperty("secured", securedMatcher)));
}
/**
* Verifies whether http-only property of cookie is equal to specified argument.
* @param expectedHttpOnlyValue expected http-only property value
* @return A {@link DetailedCookieMatcher} instance with and-composed http-only property assertion
*/
public DetailedCookieMatcher httpOnly(boolean expectedHttpOnlyValue) {
return httpOnly(equalTo(expectedHttpOnlyValue));
}
/**
* Verifies whether http-only property of cookie satisfies specified matcher.
* @param httpOnlyMatcher assertion for domain property
* @return A {@link DetailedCookieMatcher} instance with and-composed http-only property assertion
*/
public DetailedCookieMatcher httpOnly(Matcher httpOnlyMatcher) {
return new DetailedCookieMatcher(and(Matchers.hasProperty("httpOnly", httpOnlyMatcher)));
}
/**
* Verifies whether version of cookie is equal to specified argument.
* @param expectedVersionValue expected version of cookie
* @return A {@link DetailedCookieMatcher} instance with and-composed version property assertion
*/
public DetailedCookieMatcher version(int expectedVersionValue) {
return version(equalTo(expectedVersionValue));
}
/**
* Verifies whether version of cookie satisfies specified matcher.
* @param versionMatcher assertion for version property
* @return A {@link DetailedCookieMatcher} instance with and-composed version property assertion
*/
public DetailedCookieMatcher version(Matcher versionMatcher) {
return new DetailedCookieMatcher(and(Matchers.hasProperty("version", versionMatcher)));
}
/**
* Verifies whether max age of cookie is equal to specified argument.
* @param expectedMaxAgeValue expected max age of cookie
* @return A {@link DetailedCookieMatcher} instance with and-composed max age property assertion
*/
public DetailedCookieMatcher maxAge(long expectedMaxAgeValue) {
return maxAge(equalTo(expectedMaxAgeValue));
}
/**
* Verifies whether max age of cookie satisfies specified matcher.
* @param maxAgeMatcher assertion for max age property
* @return A {@link DetailedCookieMatcher} instance with and-composed max age property assertion
*/
public DetailedCookieMatcher maxAge(Matcher maxAgeMatcher) {
return new DetailedCookieMatcher(and(Matchers.hasProperty("maxAge", maxAgeMatcher)));
}
/**
* Verifies whether SameSite Attribute of cookie is equal to specified argument.
* @param expectedSameSiteAttribute expected SameSite Attribute of cookie
* @return A {@link DetailedCookieMatcher} instance with and-composed SameSite Attribute property assertion
*/
public DetailedCookieMatcher sameSite(String expectedSameSiteAttribute) {
return sameSite(equalTo(expectedSameSiteAttribute));
}
/**
* Verifies whether SameSite Attribute of cookie satisfies specified matcher.
* @param sameSiteMatcher assertion for SameSite Attribute
* @return A {@link DetailedCookieMatcher} instance with and-composed sameSite property assertion
*/
public DetailedCookieMatcher sameSite(Matcher sameSiteMatcher) {
return new DetailedCookieMatcher(and(Matchers.hasProperty("sameSite", sameSiteMatcher)));
}
}