From 6518d63317a8fda856a801cef71db9de1b1052fb Mon Sep 17 00:00:00 2001 From: David Pursehouse Date: Fri, 7 Jun 2019 10:51:21 +0900 Subject: [PATCH] NetscapeCookieFileTest: Split HttpCookiesMatcher to own class The bazel build fails due to NetscapeCookieFileTest's internal class not being visible to TransportHttpTest. Split the file out to its own class in the util package, so it's visible to both. Change-Id: I69236026eecb9d08a9a66e51752a80ea522b0c6a Signed-off-by: David Pursehouse --- org.eclipse.jgit.test/BUILD | 1 + .../http/NetscapeCookieFileTest.java | 104 +----------- .../jgit/transport/TransportHttpTest.java | 2 +- .../jgit/util/http/HttpCookiesMatcher.java | 150 ++++++++++++++++++ 4 files changed, 153 insertions(+), 104 deletions(-) create mode 100644 org.eclipse.jgit.test/tst/org/eclipse/jgit/util/http/HttpCookiesMatcher.java diff --git a/org.eclipse.jgit.test/BUILD b/org.eclipse.jgit.test/BUILD index be4fdbdea..5c0540fb9 100644 --- a/org.eclipse.jgit.test/BUILD +++ b/org.eclipse.jgit.test/BUILD @@ -28,6 +28,7 @@ HELPERS = glob( "treewalk/filter/AlwaysCloneTreeFilter.java", "test/resources/SampleDataRepositoryTestCase.java", "util/CPUTimeStopWatch.java", + "util/http/HttpCookiesMatcher.java", "util/io/Strings.java", ]] diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/transport/http/NetscapeCookieFileTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/transport/http/NetscapeCookieFileTest.java index 8f6cd3aae..0a3f89e23 100644 --- a/org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/transport/http/NetscapeCookieFileTest.java +++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/internal/transport/http/NetscapeCookieFileTest.java @@ -55,18 +55,14 @@ import java.time.Instant; import java.util.Arrays; import java.util.Date; import java.util.LinkedHashSet; -import java.util.LinkedList; import java.util.List; import java.util.Set; import java.util.regex.Pattern; import org.eclipse.jgit.internal.storage.file.LockFile; import org.eclipse.jgit.internal.transport.http.NetscapeCookieFile; +import org.eclipse.jgit.util.http.HttpCookiesMatcher; import org.hamcrest.CoreMatchers; -import org.hamcrest.Description; -import org.hamcrest.Matcher; -import org.hamcrest.TypeSafeMatcher; -import org.hamcrest.collection.IsIterableContainingInOrder; import org.junit.Assert; import org.junit.Before; import org.junit.Rule; @@ -340,102 +336,4 @@ public class NetscapeCookieFileTest { new NetscapeCookieFile(tmpFile) .getCookies(true); } - - public final static class HttpCookiesMatcher { - public static Matcher> containsInOrder( - Iterable expectedCookies) { - return containsInOrder(expectedCookies, 0); - } - - public static Matcher> containsInOrder( - Iterable expectedCookies, int allowedMaxAgeDelta) { - final List> cookieMatchers = new LinkedList<>(); - for (HttpCookie cookie : expectedCookies) { - cookieMatchers - .add(new HttpCookieMatcher(cookie, allowedMaxAgeDelta)); - } - return new IsIterableContainingInOrder<>(cookieMatchers); - } - } - - /** - * The default {@link HttpCookie#equals(Object)} is not good enough for - * testing purposes. Also the {@link HttpCookie#toString()} only emits some - * of the cookie attributes. For testing a dedicated matcher is needed which - * takes into account all attributes. - */ - private final static class HttpCookieMatcher - extends TypeSafeMatcher { - - private final HttpCookie cookie; - - private final int allowedMaxAgeDelta; - - public HttpCookieMatcher(HttpCookie cookie, int allowedMaxAgeDelta) { - this.cookie = cookie; - this.allowedMaxAgeDelta = allowedMaxAgeDelta; - } - - @Override - public void describeTo(Description description) { - describeCookie(description, cookie); - } - - @Override - protected void describeMismatchSafely(HttpCookie item, - Description mismatchDescription) { - mismatchDescription.appendText("was "); - describeCookie(mismatchDescription, item); - } - - @Override - protected boolean matchesSafely(HttpCookie otherCookie) { - // the equals method in HttpCookie is not specific enough, we want - // to consider all attributes! - return (equals(cookie.getName(), otherCookie.getName()) - && equals(cookie.getValue(), otherCookie.getValue()) - && equals(cookie.getDomain(), otherCookie.getDomain()) - && equals(cookie.getPath(), otherCookie.getPath()) - && (cookie.getMaxAge() >= otherCookie.getMaxAge() - - allowedMaxAgeDelta) - && (cookie.getMaxAge() <= otherCookie.getMaxAge() - + allowedMaxAgeDelta) - && cookie.isHttpOnly() == otherCookie.isHttpOnly() - && cookie.getSecure() == otherCookie.getSecure() - && cookie.getVersion() == otherCookie.getVersion()); - } - - private static boolean equals(String value1, String value2) { - if (value1 == null && value2 == null) { - return true; - } - if (value1 == null || value2 == null) { - return false; - } - return value1.equals(value2); - } - - @SuppressWarnings("boxing") - protected static void describeCookie(Description description, - HttpCookie cookie) { - description.appendText("HttpCookie["); - description.appendText("name: ").appendValue(cookie.getName()) - .appendText(", "); - description.appendText("value: ").appendValue(cookie.getValue()) - .appendText(", "); - description.appendText("domain: ").appendValue(cookie.getDomain()) - .appendText(", "); - description.appendText("path: ").appendValue(cookie.getPath()) - .appendText(", "); - description.appendText("maxAge: ").appendValue(cookie.getMaxAge()) - .appendText(", "); - description.appendText("httpOnly: ") - .appendValue(cookie.isHttpOnly()).appendText(", "); - description.appendText("secure: ").appendValue(cookie.getSecure()) - .appendText(", "); - description.appendText("version: ").appendValue(cookie.getVersion()) - .appendText(", "); - description.appendText("]"); - } - } } diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/TransportHttpTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/TransportHttpTest.java index 111c92523..ee0e0af8c 100644 --- a/org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/TransportHttpTest.java +++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/TransportHttpTest.java @@ -53,10 +53,10 @@ import java.util.LinkedHashSet; import java.util.Set; import org.eclipse.jgit.internal.transport.http.NetscapeCookieFile; -import org.eclipse.jgit.internal.transport.http.NetscapeCookieFileTest.HttpCookiesMatcher; import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.test.resources.SampleDataRepositoryTestCase; import org.eclipse.jgit.transport.http.HttpConnection; +import org.eclipse.jgit.util.http.HttpCookiesMatcher; import org.junit.Assert; import org.junit.Before; import org.junit.Test; diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/util/http/HttpCookiesMatcher.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/util/http/HttpCookiesMatcher.java new file mode 100644 index 000000000..8c5b127de --- /dev/null +++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/util/http/HttpCookiesMatcher.java @@ -0,0 +1,150 @@ +/* + * Copyright (C) 2018, Konrad Windszus + * and other copyright owners as documented in the project's IP log. + * + * This program and the accompanying materials are made available + * under the terms of the Eclipse Distribution License v1.0 which + * accompanies this distribution, is reproduced below, and is + * available at http://www.eclipse.org/org/documents/edl-v10.php + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or + * without modification, are permitted provided that the following + * conditions are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * - Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimer in the documentation and/or other materials provided + * with the distribution. + * + * - Neither the name of the Eclipse Foundation, Inc. nor the + * names of its contributors may be used to endorse or promote + * products derived from this software without specific prior + * written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package org.eclipse.jgit.util.http; + +import java.net.HttpCookie; +import java.util.LinkedList; +import java.util.List; + +import org.hamcrest.Description; +import org.hamcrest.Matcher; +import org.hamcrest.TypeSafeMatcher; +import org.hamcrest.collection.IsIterableContainingInOrder; + +public final class HttpCookiesMatcher { + public static Matcher> containsInOrder( + Iterable expectedCookies) { + return containsInOrder(expectedCookies, 0); + } + + public static Matcher> containsInOrder( + Iterable expectedCookies, int allowedMaxAgeDelta) { + final List> cookieMatchers = new LinkedList<>(); + for (HttpCookie cookie : expectedCookies) { + cookieMatchers + .add(new HttpCookieMatcher(cookie, allowedMaxAgeDelta)); + } + return new IsIterableContainingInOrder<>(cookieMatchers); + } + + /** + * The default {@link HttpCookie#equals(Object)} is not good enough for + * testing purposes. Also the {@link HttpCookie#toString()} only emits some + * of the cookie attributes. For testing a dedicated matcher is needed which + * takes into account all attributes. + */ + private static final class HttpCookieMatcher + extends TypeSafeMatcher { + + private final HttpCookie cookie; + + private final int allowedMaxAgeDelta; + + public HttpCookieMatcher(HttpCookie cookie, int allowedMaxAgeDelta) { + this.cookie = cookie; + this.allowedMaxAgeDelta = allowedMaxAgeDelta; + } + + @Override + public void describeTo(Description description) { + describeCookie(description, cookie); + } + + @Override + protected void describeMismatchSafely(HttpCookie item, + Description mismatchDescription) { + mismatchDescription.appendText("was "); + describeCookie(mismatchDescription, item); + } + + @Override + protected boolean matchesSafely(HttpCookie otherCookie) { + // the equals method in HttpCookie is not specific enough, we want + // to consider all attributes! + return (equals(cookie.getName(), otherCookie.getName()) + && equals(cookie.getValue(), otherCookie.getValue()) + && equals(cookie.getDomain(), otherCookie.getDomain()) + && equals(cookie.getPath(), otherCookie.getPath()) + && (cookie.getMaxAge() >= otherCookie.getMaxAge() + - allowedMaxAgeDelta) + && (cookie.getMaxAge() <= otherCookie.getMaxAge() + + allowedMaxAgeDelta) + && cookie.isHttpOnly() == otherCookie.isHttpOnly() + && cookie.getSecure() == otherCookie.getSecure() + && cookie.getVersion() == otherCookie.getVersion()); + } + + private static boolean equals(String value1, String value2) { + if (value1 == null && value2 == null) { + return true; + } + if (value1 == null || value2 == null) { + return false; + } + return value1.equals(value2); + } + + @SuppressWarnings("boxing") + protected static void describeCookie(Description description, + HttpCookie cookie) { + description.appendText("HttpCookie["); + description.appendText("name: ").appendValue(cookie.getName()) + .appendText(", "); + description.appendText("value: ").appendValue(cookie.getValue()) + .appendText(", "); + description.appendText("domain: ").appendValue(cookie.getDomain()) + .appendText(", "); + description.appendText("path: ").appendValue(cookie.getPath()) + .appendText(", "); + description.appendText("maxAge: ").appendValue(cookie.getMaxAge()) + .appendText(", "); + description.appendText("httpOnly: ") + .appendValue(cookie.isHttpOnly()).appendText(", "); + description.appendText("secure: ").appendValue(cookie.getSecure()) + .appendText(", "); + description.appendText("version: ").appendValue(cookie.getVersion()) + .appendText(", "); + description.appendText("]"); + } + } +} \ No newline at end of file