Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#721: Add matcher for TeeInput class #731

Merged
merged 2 commits into from
Mar 20, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 136 additions & 0 deletions src/main/java/org/cactoos/matchers/TeeInputHasResult.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
/**
* The MIT License (MIT)
*
* Copyright (c) 2017-2018 Yegor Bugayenko
*
* 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 NON-INFRINGEMENT. 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 org.cactoos.matchers;

import java.io.File;
import org.cactoos.Text;
import org.cactoos.io.TeeInput;
import org.cactoos.text.ComparableText;
import org.cactoos.text.FormattedText;
import org.cactoos.text.TextOf;
import org.cactoos.text.UncheckedText;
import org.hamcrest.Description;
import org.hamcrest.TypeSafeMatcher;

/**
* Matcher for the {@link TeeInput}'s results.
*
* @author Roman Proshin (roman@proshin.org)
* @version $Id$
* @since 1.0
*/
public final class TeeInputHasResult extends TypeSafeMatcher<TeeInput> {

/**
* Format for matcher description.
*/
private static final String DESCRIPTION =
"TeeInput with result \"%s\" and copied value \"%s\"";
/**
* Value that is expected to be returned from the given TeeInput.
*/
private final ComparableText expected;
/**
* Value that is expected to be copied into the output of TeeInput.
*/
private final ComparableText copied;
/**
* Actual value returned from the given TeeInput.
*/
private ComparableText actual;

/**
* Ctor.
* @param expected Value that is expected to be returned from the TeeInput
* @param file Value that is expected to be copied into the output of
* the TeeInput
*/
public TeeInputHasResult(
final String expected,
final File file
) {
this(
new TextOf(expected),
new TextOf(file)
);
}

/**
* Ctor.
* @param expected Value that is expected to be returned from the TeeInput
* @param copied Value that is expected to be copied into the output of
* the TeeInput
*/
public TeeInputHasResult(
final String expected,
final Text copied) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

formatting is not consistent

this(
new TextOf(expected),
copied
);
}

/**
* Ctor.
* @param expected Value that is expected to be returned from the TeeInput
* @param copied Value that is expected to be copied into the output of
* the TeeInput
*/
public TeeInputHasResult(
final Text expected,
final Text copied) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

formatting is not consistent

super();
this.expected = new ComparableText(expected);
this.copied = new ComparableText(copied);
this.actual = new ComparableText(new TextOf(""));
}

@Override
public boolean matchesSafely(final TeeInput item) {
this.actual = new ComparableText(new TextOf(item));
return
this.expected.compareTo(this.actual) == 0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use org.cactoos.scalar.Equals here

&& this.expected.compareTo(this.copied) == 0;
}

@Override
public void describeTo(final Description description) {
description.appendText(
new UncheckedText(
new FormattedText(
TeeInputHasResult.DESCRIPTION,
new UncheckedText(this.expected).asString(),
new UncheckedText(this.expected).asString()
Copy link
Contributor

@neonailol neonailol Mar 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicated line new UncheckedText(this.expected).asString() possible something other should be here

)
).asString()
);
}

@Override
public void describeMismatchSafely(
final TeeInput item,
final Description description) {
this.describeTo(description);
}
}
57 changes: 25 additions & 32 deletions src/test/java/org/cactoos/io/TeeInputFromByteArrayTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@

import java.io.File;
import java.nio.charset.StandardCharsets;
import org.cactoos.text.TextOf;
import org.cactoos.matchers.TeeInputHasResult;
import org.hamcrest.MatcherAssert;
import org.hamcrest.core.IsEqual;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
Expand All @@ -54,17 +53,15 @@ public void copiesFromByteArrayToPath() throws Exception {
final String message =
"Hello, товарищ path äÄ üÜ öÖ and ß";
final File output = this.folder.newFile();
final TeeInput input = new TeeInput(
message.getBytes(StandardCharsets.UTF_8),
output.toPath()
);
MatcherAssert.assertThat(
new TextOf(input).asString(),
new IsEqual<>(message)
);
MatcherAssert.assertThat(
new TextOf(output).asString(),
new IsEqual<>(message)
new TeeInput(
message.getBytes(StandardCharsets.UTF_8),
output.toPath()
),
new TeeInputHasResult(
message,
output
)
);
}

Expand All @@ -73,17 +70,15 @@ public void copiesFromByteArrayToFile() throws Exception {
final String message =
"Hello, товарищ file äÄ üÜ öÖ and ß";
final File output = this.folder.newFile();
final TeeInput input = new TeeInput(
message.getBytes(StandardCharsets.UTF_8),
output
);
MatcherAssert.assertThat(
new TextOf(input).asString(),
new IsEqual<>(message)
);
MatcherAssert.assertThat(
new TextOf(output).asString(),
new IsEqual<>(message)
new TeeInput(
message.getBytes(StandardCharsets.UTF_8),
output
),
new TeeInputHasResult(
message,
output
)
);
}

Expand All @@ -92,17 +87,15 @@ public void copiesFromByteArrayToOutput() throws Exception {
final String message =
"Hello, товарищ output äÄ üÜ öÖ and ß";
final File output = this.folder.newFile();
final TeeInput input = new TeeInput(
message.getBytes(StandardCharsets.UTF_8),
new OutputTo(output)
);
MatcherAssert.assertThat(
new TextOf(input).asString(),
new IsEqual<>(message)
);
MatcherAssert.assertThat(
new TextOf(output).asString(),
new IsEqual<>(message)
new TeeInput(
message.getBytes(StandardCharsets.UTF_8),
new OutputTo(output)
),
new TeeInputHasResult(
message,
output
)
);
}
}
60 changes: 25 additions & 35 deletions src/test/java/org/cactoos/io/TeeInputFromBytesTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@

import java.io.File;
import java.io.IOException;
import org.cactoos.text.TextOf;
import org.cactoos.matchers.TeeInputHasResult;
import org.hamcrest.MatcherAssert;
import org.hamcrest.core.IsEqual;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
Expand All @@ -38,9 +37,6 @@
* @author Roman Proshin (roman@proshin.org)
* @version $Id$
* @since 1.0
* @todo #631:30min Create a new Matcher that will compare results of TeeInput
* as well as copied content to the original message. Apply this new matcher
* for this test and for {@link TeeInputFromByteArrayTest}.
* @checkstyle JavadocMethodCheck (100 lines)
* @checkstyle ClassDataAbstractionCouplingCheck (100 lines)
*/
Expand All @@ -57,17 +53,15 @@ public void copiesFromBytesToPath() throws IOException {
final String message =
"Hello, товарищ path äÄ üÜ öÖ and ß";
final File output = this.folder.newFile();
final TeeInput input = new TeeInput(
new BytesOf(message),
output.toPath()
);
MatcherAssert.assertThat(
new TextOf(input).asString(),
new IsEqual<>(message)
);
MatcherAssert.assertThat(
new TextOf(output).asString(),
new IsEqual<>(message)
new TeeInput(
new BytesOf(message),
output.toPath()
),
new TeeInputHasResult(
message,
output
)
);
}

Expand All @@ -76,17 +70,15 @@ public void copiesFromBytesToFile() throws IOException {
final String message =
"Hello, товарищ file äÄ üÜ öÖ and ß";
final File output = this.folder.newFile();
final TeeInput input = new TeeInput(
new BytesOf(message),
output
);
MatcherAssert.assertThat(
new TextOf(input).asString(),
new IsEqual<>(message)
);
MatcherAssert.assertThat(
new TextOf(output).asString(),
new IsEqual<>(message)
new TeeInput(
new BytesOf(message),
output
),
new TeeInputHasResult(
message,
output
)
);
}

Expand All @@ -95,17 +87,15 @@ public void copiesFromBytesToOutput() throws IOException {
final String message =
"Hello, товарищ output äÄ üÜ öÖ and ß";
final File output = this.folder.newFile();
final TeeInput input = new TeeInput(
new BytesOf(message),
new OutputTo(output)
);
MatcherAssert.assertThat(
new TextOf(input).asString(),
new IsEqual<>(message)
);
MatcherAssert.assertThat(
new TextOf(output).asString(),
new IsEqual<>(message)
new TeeInput(
new BytesOf(message),
new OutputTo(output)
),
new TeeInputHasResult(
message,
output
)
);
}
}
Loading