View Javadoc
1   /*
2    * Copyright (C) 2018, Google LLC.
3    * and other copyright owners as documented in the project's IP log.
4    *
5    * This program and the accompanying materials are made available
6    * under the terms of the Eclipse Distribution License v1.0 which
7    * accompanies this distribution, is reproduced below, and is
8    * available at http://www.eclipse.org/org/documents/edl-v10.php
9    *
10   * All rights reserved.
11   *
12   * Redistribution and use in source and binary forms, with or
13   * without modification, are permitted provided that the following
14   * conditions are met:
15   *
16   * - Redistributions of source code must retain the above copyright
17   *   notice, this list of conditions and the following disclaimer.
18   *
19   * - Redistributions in binary form must reproduce the above
20   *   copyright notice, this list of conditions and the following
21   *   disclaimer in the documentation and/or other materials provided
22   *   with the distribution.
23   *
24   * - Neither the name of the Eclipse Foundation, Inc. nor the
25   *   names of its contributors may be used to endorse or promote
26   *   products derived from this software without specific prior
27   *   written permission.
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42   */
43  package org.eclipse.jgit.transport;
44  
45  import java.util.Collection;
46  import java.util.Set;
47  import java.util.stream.Collectors;
48  
49  import org.eclipse.jgit.lib.ObjectId;
50  import org.eclipse.jgit.lib.Sets;
51  import org.hamcrest.Description;
52  import org.hamcrest.Factory;
53  import org.hamcrest.Matcher;
54  import org.hamcrest.TypeSafeMatcher;
55  
56  /**
57   * Multiple tests check that a collection of ObjectIds contain certain SHA1
58   * (written as strings). This matcher hides the ObjectId to string conversion to
59   * make the assertion more readable:
60   *
61   * assertThat(req.getWantsIds(), hasOnlyObjectIds("123123", "234234"));
62   */
63  class ObjectIdMatcher extends TypeSafeMatcher<Collection<ObjectId>> {
64  
65  	private final Set<ObjectId> expectedOids;
66  
67  	private ObjectIdMatcher(Set<String> oids) {
68  		this.expectedOids = oids.stream().map(ObjectId::fromString)
69  				.collect(Collectors.toSet());
70  	}
71  
72  	@Override
73  	public void describeTo(Description desc) {
74  		desc.appendText("Object ids:");
75  		desc.appendValueList("<", ",", ">", expectedOids);
76  	}
77  
78  	@Override
79  	protected boolean matchesSafely(Collection<ObjectId> resultOids) {
80  		return resultOids.containsAll(expectedOids)
81  				&& expectedOids.containsAll(resultOids);
82  	}
83  
84  	/**
85  	 * Assert that all and only the received {@link ObjectId object ids} are in
86  	 * the expected set.
87  	 * <p>
88  	 * ObjectIds are compared by SHA1.
89  	 *
90  	 * @param oids
91  	 *            Object ids to examine.
92  	 * @return true if examined and specified sets contains exactly the same
93  	 *         elements.
94  	 */
95  	@Factory
96  	static Matcher<Collection<ObjectId>> hasOnlyObjectIds(
97  			String... oids) {
98  		return new ObjectIdMatcher(Sets.of(oids));
99  	}
100 }