org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/SideBandOutputStreamTest.java - jgit - Git at Google

 /*
  * Copyright (C) 2009-2010, Google Inc.
  * 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.transport;

 import static java.lang.Integer.valueOf;
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.eclipse.jgit.transport.SideBandOutputStream.CH_DATA;
 import static org.eclipse.jgit.transport.SideBandOutputStream.CH_ERROR;
 import static org.eclipse.jgit.transport.SideBandOutputStream.CH_PROGRESS;
 import static org.eclipse.jgit.transport.SideBandOutputStream.HDR_SIZE;
 import static org.eclipse.jgit.transport.SideBandOutputStream.MAX_BUF;
 import static org.eclipse.jgit.transport.SideBandOutputStream.SMALL_BUF;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.fail;

 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.OutputStream;
 import java.text.MessageFormat;

 import org.eclipse.jgit.internal.JGitText;
 import org.junit.Before;
 import org.junit.Test;

 // Note, test vectors created with:
 //
 // perl -e 'printf "%4.4x%s\n", 4+length($ARGV[0]),$ARGV[0]'

 public class SideBandOutputStreamTest {
 	private ByteArrayOutputStream rawOut;

 	@Before
 	public void setUp() throws Exception {
 		rawOut = new ByteArrayOutputStream();
 	}

 	@Test
 	public void testWrite_CH_DATA() throws IOException {
 		try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA,
 				SMALL_BUF, rawOut)) {
 			out.write(new byte[] { 'a', 'b', 'c' });
 			out.flush();
 		}
 		assertBuffer("0008\001abc");
 	}

 	@Test
 	public void testWrite_CH_PROGRESS() throws IOException {
 		try (SideBandOutputStream out = new SideBandOutputStream(CH_PROGRESS,
 				SMALL_BUF, rawOut)) {
 			out.write(new byte[] { 'a', 'b', 'c' });
 			out.flush();
 		}
 		assertBuffer("0008\002abc");
 	}

 	@Test
 	public void testWrite_CH_ERROR() throws IOException {
 		try (SideBandOutputStream out = new SideBandOutputStream(CH_ERROR,
 				SMALL_BUF, rawOut)) {
 			out.write(new byte[] { 'a', 'b', 'c' });
 			out.flush();
 		}
 		assertBuffer("0008\003abc");
 	}

 	@Test
 	public void testWrite_Small() throws IOException {
 		try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA,
 				SMALL_BUF, rawOut)) {
 			out.write('a');
 			out.write('b');
 			out.write('c');
 			out.flush();
 		}
 		assertBuffer("0008\001abc");
 	}

 	@Test
 	public void testWrite_SmallBlocks1() throws IOException {
 		try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA, 6,
 				rawOut)) {
 			out.write('a');
 			out.write('b');
 			out.write('c');
 			out.flush();
 		}
 		assertBuffer("0006\001a0006\001b0006\001c");
 	}

 	@Test
 	public void testWrite_SmallBlocks2() throws IOException {
 		try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA, 6,
 				rawOut)) {
 			out.write(new byte[] { 'a', 'b', 'c' });
 			out.flush();
 		}
 		assertBuffer("0006\001a0006\001b0006\001c");
 	}

 	@Test
 	public void testWrite_SmallBlocks3() throws IOException {
 		try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA, 7,
 				rawOut)) {
 			out.write('a');
 			out.write(new byte[] { 'b', 'c' });
 			out.flush();
 		}
 		assertBuffer("0007\001ab0006\001c");
 	}

 	@Test
 	public void testWrite_Large() throws IOException {
 		final int buflen = MAX_BUF - HDR_SIZE;
 		final byte[] buf = new byte[buflen];
 		for (int i = 0; i < buf.length; i++) {
 			buf[i] = (byte) i;
 		}

 		try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA,
 				MAX_BUF, rawOut)) {
 			out.write(buf);
 			out.flush();
 		}

 		final byte[] act = rawOut.toByteArray();
 		final String explen = Integer.toString(buf.length + HDR_SIZE, 16);
 		assertEquals(HDR_SIZE + buf.length, act.length);
 		assertEquals(new String(act, 0, 4, "UTF-8"), explen);
 		assertEquals(1, act[4]);
 		for (int i = 0, j = HDR_SIZE; i < buf.length; i++, j++) {
 			assertEquals(buf[i], act[j]);
 		}
 	}

 	@Test
 	public void testFlush() throws IOException {
 		final int[] flushCnt = new int[1];
 		final OutputStream mockout = new OutputStream() {
 			@Override
 			public void write(int arg0) throws IOException {
 				fail("should not write");
 			}

 			@Override
 			public void flush() throws IOException {
 				flushCnt[0]++;
 			}
 		};

 		try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA,
 				SMALL_BUF, mockout)) {
 			out.flush();
 		}
 		assertEquals(1, flushCnt[0]);
 	}

 	private void createSideBandOutputStream(int chan, int sz, OutputStream os)
 			throws Exception {
 		try (SideBandOutputStream s = new SideBandOutputStream(chan, sz, os)) {
 			// Unused
 		}
 	}

 	@Test
 	public void testConstructor_RejectsBadChannel() throws Exception {
 		try {
 			createSideBandOutputStream(-1, MAX_BUF, rawOut);
 			fail("Accepted -1 channel number");
 		} catch (IllegalArgumentException e) {
 			assertEquals("channel -1 must be in range [1, 255]", e.getMessage());
 		}

 		try {
 			createSideBandOutputStream(0, MAX_BUF, rawOut);
 			fail("Accepted 0 channel number");
 		} catch (IllegalArgumentException e) {
 			assertEquals("channel 0 must be in range [1, 255]", e.getMessage());
 		}

 		try {
 			createSideBandOutputStream(256, MAX_BUF, rawOut);
 			fail("Accepted 256 channel number");
 		} catch (IllegalArgumentException e) {
 			assertEquals("channel 256 must be in range [1, 255]", e
 					.getMessage());
 		}
 	}

 	@Test
 	public void testConstructor_RejectsBadBufferSize() throws Exception {
 		try {
 			createSideBandOutputStream(CH_DATA, -1, rawOut);
 			fail("Accepted -1 for buffer size");
 		} catch (IllegalArgumentException e) {
 			assertEquals("packet size -1 must be >= 5", e.getMessage());
 		}

 		try {
 			createSideBandOutputStream(CH_DATA, 0, rawOut);
 			fail("Accepted 0 for buffer size");
 		} catch (IllegalArgumentException e) {
 			assertEquals("packet size 0 must be >= 5", e.getMessage());
 		}

 		try {
 			createSideBandOutputStream(CH_DATA, 1, rawOut);
 			fail("Accepted 1 for buffer size");
 		} catch (IllegalArgumentException e) {
 			assertEquals("packet size 1 must be >= 5", e.getMessage());
 		}

 		try {
 			createSideBandOutputStream(CH_DATA, Integer.MAX_VALUE, rawOut);
 			fail("Accepted " + Integer.MAX_VALUE + " for buffer size");
 		} catch (IllegalArgumentException e) {
 			assertEquals(MessageFormat.format(
 					JGitText.get().packetSizeMustBeAtMost,
 					valueOf(Integer.MAX_VALUE), valueOf(65520)), e.getMessage());
 		}
 	}

 	private void assertBuffer(String exp) {
 		assertEquals(exp, new String(rawOut.toByteArray(), UTF_8));
 	}
 }
	/*
	* Copyright (C) 2009-2010, Google Inc.
	* 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.transport;

	import static java.lang.Integer.valueOf;
	import static java.nio.charset.StandardCharsets.UTF_8;
	import static org.eclipse.jgit.transport.SideBandOutputStream.CH_DATA;
	import static org.eclipse.jgit.transport.SideBandOutputStream.CH_ERROR;
	import static org.eclipse.jgit.transport.SideBandOutputStream.CH_PROGRESS;
	import static org.eclipse.jgit.transport.SideBandOutputStream.HDR_SIZE;
	import static org.eclipse.jgit.transport.SideBandOutputStream.MAX_BUF;
	import static org.eclipse.jgit.transport.SideBandOutputStream.SMALL_BUF;
	import static org.junit.Assert.assertEquals;
	import static org.junit.Assert.fail;

	import java.io.ByteArrayOutputStream;
	import java.io.IOException;
	import java.io.OutputStream;
	import java.text.MessageFormat;

	import org.eclipse.jgit.internal.JGitText;
	import org.junit.Before;
	import org.junit.Test;

	// Note, test vectors created with:
	//
	// perl -e 'printf "%4.4x%s\n", 4+length($ARGV[0]),$ARGV[0]'

	public class SideBandOutputStreamTest {
	private ByteArrayOutputStream rawOut;

	@Before
	public void setUp() throws Exception {
	rawOut = new ByteArrayOutputStream();
	}

	@Test
	public void testWrite_CH_DATA() throws IOException {
	try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA,
	SMALL_BUF, rawOut)) {
	out.write(new byte[] { 'a', 'b', 'c' });
	out.flush();
	}
	assertBuffer("0008\001abc");
	}

	@Test
	public void testWrite_CH_PROGRESS() throws IOException {
	try (SideBandOutputStream out = new SideBandOutputStream(CH_PROGRESS,
	SMALL_BUF, rawOut)) {
	out.write(new byte[] { 'a', 'b', 'c' });
	out.flush();
	}
	assertBuffer("0008\002abc");
	}

	@Test
	public void testWrite_CH_ERROR() throws IOException {
	try (SideBandOutputStream out = new SideBandOutputStream(CH_ERROR,
	SMALL_BUF, rawOut)) {
	out.write(new byte[] { 'a', 'b', 'c' });
	out.flush();
	}
	assertBuffer("0008\003abc");
	}

	@Test
	public void testWrite_Small() throws IOException {
	try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA,
	SMALL_BUF, rawOut)) {
	out.write('a');
	out.write('b');
	out.write('c');
	out.flush();
	}
	assertBuffer("0008\001abc");
	}

	@Test
	public void testWrite_SmallBlocks1() throws IOException {
	try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA, 6,
	rawOut)) {
	out.write('a');
	out.write('b');
	out.write('c');
	out.flush();
	}
	assertBuffer("0006\001a0006\001b0006\001c");
	}

	@Test
	public void testWrite_SmallBlocks2() throws IOException {
	try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA, 6,
	rawOut)) {
	out.write(new byte[] { 'a', 'b', 'c' });
	out.flush();
	}
	assertBuffer("0006\001a0006\001b0006\001c");
	}

	@Test
	public void testWrite_SmallBlocks3() throws IOException {
	try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA, 7,
	rawOut)) {
	out.write('a');
	out.write(new byte[] { 'b', 'c' });
	out.flush();
	}
	assertBuffer("0007\001ab0006\001c");
	}

	@Test
	public void testWrite_Large() throws IOException {
	final int buflen = MAX_BUF - HDR_SIZE;
	final byte[] buf = new byte[buflen];
	for (int i = 0; i < buf.length; i++) {
	buf[i] = (byte) i;
	}

	try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA,
	MAX_BUF, rawOut)) {
	out.write(buf);
	out.flush();
	}

	final byte[] act = rawOut.toByteArray();
	final String explen = Integer.toString(buf.length + HDR_SIZE, 16);
	assertEquals(HDR_SIZE + buf.length, act.length);
	assertEquals(new String(act, 0, 4, "UTF-8"), explen);
	assertEquals(1, act[4]);
	for (int i = 0, j = HDR_SIZE; i < buf.length; i++, j++) {
	assertEquals(buf[i], act[j]);
	}
	}

	@Test
	public void testFlush() throws IOException {
	final int[] flushCnt = new int[1];
	final OutputStream mockout = new OutputStream() {
	@Override
	public void write(int arg0) throws IOException {
	fail("should not write");
	}

	@Override
	public void flush() throws IOException {
	flushCnt[0]++;
	}
	};

	try (SideBandOutputStream out = new SideBandOutputStream(CH_DATA,
	SMALL_BUF, mockout)) {
	out.flush();
	}
	assertEquals(1, flushCnt[0]);
	}

	private void createSideBandOutputStream(int chan, int sz, OutputStream os)
	throws Exception {
	try (SideBandOutputStream s = new SideBandOutputStream(chan, sz, os)) {
	// Unused
	}
	}

	@Test
	public void testConstructor_RejectsBadChannel() throws Exception {
	try {
	createSideBandOutputStream(-1, MAX_BUF, rawOut);
	fail("Accepted -1 channel number");
	} catch (IllegalArgumentException e) {
	assertEquals("channel -1 must be in range [1, 255]", e.getMessage());
	}

	try {
	createSideBandOutputStream(0, MAX_BUF, rawOut);
	fail("Accepted 0 channel number");
	} catch (IllegalArgumentException e) {
	assertEquals("channel 0 must be in range [1, 255]", e.getMessage());
	}

	try {
	createSideBandOutputStream(256, MAX_BUF, rawOut);
	fail("Accepted 256 channel number");
	} catch (IllegalArgumentException e) {
	assertEquals("channel 256 must be in range [1, 255]", e
	.getMessage());
	}
	}

	@Test
	public void testConstructor_RejectsBadBufferSize() throws Exception {
	try {
	createSideBandOutputStream(CH_DATA, -1, rawOut);
	fail("Accepted -1 for buffer size");
	} catch (IllegalArgumentException e) {
	assertEquals("packet size -1 must be >= 5", e.getMessage());
	}

	try {
	createSideBandOutputStream(CH_DATA, 0, rawOut);
	fail("Accepted 0 for buffer size");
	} catch (IllegalArgumentException e) {
	assertEquals("packet size 0 must be >= 5", e.getMessage());
	}

	try {
	createSideBandOutputStream(CH_DATA, 1, rawOut);
	fail("Accepted 1 for buffer size");
	} catch (IllegalArgumentException e) {
	assertEquals("packet size 1 must be >= 5", e.getMessage());
	}

	try {
	createSideBandOutputStream(CH_DATA, Integer.MAX_VALUE, rawOut);
	fail("Accepted " + Integer.MAX_VALUE + " for buffer size");
	} catch (IllegalArgumentException e) {
	assertEquals(MessageFormat.format(
	JGitText.get().packetSizeMustBeAtMost,
	valueOf(Integer.MAX_VALUE), valueOf(65520)), e.getMessage());
	}
	}

	private void assertBuffer(String exp) {
	assertEquals(exp, new String(rawOut.toByteArray(), UTF_8));
	}
	}