org.assertj.neo4j.api.NodeAssert Maven / Gradle / Ivy
/**
* 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.
*
* Copyright 2013-2017 the original author or authors.
*/
package org.assertj.neo4j.api;
import org.assertj.core.internal.Failures;
import org.assertj.core.internal.Objects;
import org.neo4j.graphdb.Label;
import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.Transaction;
import static org.assertj.neo4j.error.ShouldHaveLabel.shouldHaveLabel;
import static org.assertj.neo4j.error.ShouldNotHaveLabel.shouldNotHaveLabel;
/**
* Assertions for Neo4J {@link org.neo4j.graphdb.Node}
*
* @author Florent Biville
*/
public class NodeAssert extends PropertyContainerAssert {
protected NodeAssert(Node actual) {
super(actual, NodeAssert.class);
}
public Node getActual() {
return actual;
}
/**
* Verifies that the actual {@link org.neo4j.graphdb.Node} has the given label name
*
* Example:
*
*
* GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
* Node node = graph.createNode();
* node.addLabel(DynamicLabel.label("DOUGHNUT_LOVER"));
*
* assertThat(node).hasLabel("DOUGHNUT_LOVER");
*
*
* If the labelValue is {@code null}, an {@link IllegalArgumentException} is thrown.
*
*
* @param labelValue the label name to look for in the actual {@link org.neo4j.graphdb.Node}
* @return this {@link NodeAssert} for assertions chaining
*
* @throws IllegalArgumentException if labelValue is {@code null}.
* @throws AssertionError if the actual {@link org.neo4j.graphdb.Node} does not contain the given label
*/
public NodeAssert hasLabel(String labelValue) {
Objects.instance().assertNotNull(info, actual);
if (labelValue == null) {
throw new IllegalArgumentException("The label value to look for should not be null");
}
if (!hasFoundLabel(labelValue)) {
throw Failures.instance().failure(info, shouldHaveLabel(actual, labelValue));
}
return this;
}
/**
* Verifies that the actual {@link org.neo4j.graphdb.Node} does NOT have the given label name
*
* Example:
*
*
* GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
* Node node = graph.createNode();
* node.addLabel(DynamicLabel.label("DOUGHNUT_LOVER"));
*
* assertThat(node).doesNotHaveLabel("FRUIT_LOVER");
*
*
* If the labelValue is {@code null}, an {@link IllegalArgumentException} is thrown.
*
*
* @param labelValue the label name to look for in the actual {@link org.neo4j.graphdb.Node}
* @return this {@link NodeAssert} for assertions chaining
*
* @throws IllegalArgumentException if labelValue is {@code null}.
* @throws AssertionError if the actual {@link org.neo4j.graphdb.Node} does contain the given label
*/
public NodeAssert doesNotHaveLabel(String labelValue) {
Objects.instance().assertNotNull(info, actual);
if (labelValue == null) {
throw new IllegalArgumentException("The label value to look for should not be null");
}
if (hasFoundLabel(labelValue)) {
throw Failures.instance().failure(info, shouldNotHaveLabel(actual, labelValue));
}
return this;
}
/**
* Verifies that the actual {@link org.neo4j.graphdb.Node} has the given label
*
* Example:
*
*
* GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
* Node node = graph.createNode();
* Label doughnutLover = DynamicLabel.label("DOUGHNUT_LOVER");
* node.addLabel(doughnutLover);
*
* assertThat(node).hasLabel(doughnutLover);
*
*
* If the label is {@code null}, an {@link IllegalArgumentException} is thrown.
*
*
* @param label the label to look for in the actual {@link org.neo4j.graphdb.Node}
* @return this {@link NodeAssert} for assertions chaining
*
* @throws IllegalArgumentException if label is {@code null}.
* @throws AssertionError if the actual {@link org.neo4j.graphdb.Node} does not contain the given label
*/
public NodeAssert hasLabel(Label label) {
Objects.instance().assertNotNull(info, actual);
if (label == null) {
throw new IllegalArgumentException("The label to look for should not be null");
}
if (!actual.hasLabel(label)) {
throw Failures.instance().failure(info, shouldHaveLabel(actual, label.name()));
}
return this;
}
/**
* Verifies that the actual {@link org.neo4j.graphdb.Node} does NOT have the given label
*
* Example:
*
*
* GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
* Node node = graph.createNode();
* node.addLabel(DynamicLabel.label("DOUGHNUT_LOVER"));
*
* assertThat(node).doesNotHaveLabel(DynamicLabel.label("FRUIT_LOVER"));
*
*
* If the label is {@code null}, an {@link IllegalArgumentException} is thrown.
*
*
* @param label the label to look for in the actual {@link org.neo4j.graphdb.Node}
* @return this {@link NodeAssert} for assertions chaining
*
* @throws IllegalArgumentException if label is {@code null}.
* @throws AssertionError if the actual {@link org.neo4j.graphdb.Node} does contain the given label
*/
public NodeAssert doesNotHaveLabel(Label label) {
Objects.instance().assertNotNull(info, actual);
if (label == null) {
throw new IllegalArgumentException("The label to look for should not be null");
}
if (actual.hasLabel(label)) {
throw Failures.instance().failure(info, shouldNotHaveLabel(actual, label.name()));
}
return this;
}
private boolean hasFoundLabel(String labelValue) {
try (Transaction tx = actual.getGraphDatabase().beginTx()) {
for (Label label : actual.getLabels()) {
if (labelValue.equals(label.name())) {
return true;
}
}
tx.success();
}
return false;
}
}