Add builder for LdifReader.

Resolves #BATCH-2600
This commit is contained in:
Glenn Renfro
2017-05-09 18:25:12 -04:00
committed by Michael Minella
parent 0e510112a9
commit 77d9ff9d95
3 changed files with 356 additions and 1 deletions

View File

@@ -0,0 +1,164 @@
/*
* Copyright 2017 the original author or authors.
*
* 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.
*/
package org.springframework.batch.core.test.ldif.builder;
import org.junit.After;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.batch.item.ExecutionContext;
import org.springframework.batch.item.ItemStreamException;
import org.springframework.batch.item.ldif.LdifReader;
import org.springframework.batch.item.ldif.RecordCallbackHandler;
import org.springframework.batch.item.ldif.builder.LdifReaderBuilder;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Configuration;
import org.springframework.ldap.core.LdapAttributes;
import org.springframework.test.context.junit4.SpringRunner;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.fail;
/**
* @author Glenn Renfro
*/
@RunWith(SpringRunner.class)
public class LdifReaderBuilderTests {
@Autowired
private ApplicationContext context;
private LdifReader ldifReader;
private String callbackAttributeName;
@After
public void tearDown() {
this.callbackAttributeName = null;
if (this.ldifReader != null) {
this.ldifReader.close();
}
}
@Test
public void testSkipRecord() throws Exception {
this.ldifReader = new LdifReaderBuilder().recordsToSkip(1).resource(context.getResource("classpath:/test.ldif"))
.name("foo").build();
LdapAttributes ldapAttributes = firstRead();
assertEquals("The attribute name for the second record did not match expected result",
"cn=Bjorn Jensen, ou=Accounting, dc=airius, dc=com", ldapAttributes.getName().toString());
}
@Test
public void testBasicRead() throws Exception {
this.ldifReader = new LdifReaderBuilder().resource(context.getResource("classpath:/test.ldif")).name("foo").build();
LdapAttributes ldapAttributes = firstRead();
assertEquals("The attribute name for the first record did not match expected result",
"cn=Barbara Jensen, ou=Product Development, dc=airius, dc=com", ldapAttributes.getName().toString());
}
@Test
public void testCurrentItemCount() throws Exception {
this.ldifReader = new LdifReaderBuilder().currentItemCount(3)
.resource(context.getResource("classpath:/test.ldif")).name("foo").build();
LdapAttributes ldapAttributes = firstRead();
assertEquals("The attribute name for the third record did not match expected result",
"cn=Gern Jensen, ou=Product Testing, dc=airius, dc=com", ldapAttributes.getName().toString());
}
@Test
public void testMaxItemCount() throws Exception {
this.ldifReader = new LdifReaderBuilder().maxItemCount(1).resource(context.getResource("classpath:/test.ldif"))
.name("foo").build();
LdapAttributes ldapAttributes = firstRead();
assertEquals("The attribute name for the first record did not match expected result",
"cn=Barbara Jensen, ou=Product Development, dc=airius, dc=com", ldapAttributes.getName().toString());
ldapAttributes = this.ldifReader.read();
assertNull("The second read should have returned null", ldapAttributes);
}
@Test
public void testSkipRecordCallback() throws Exception {
this.ldifReader = new LdifReaderBuilder().recordsToSkip(1).skippedRecordsCallback(new TestCallBackHandler())
.resource(context.getResource("classpath:/test.ldif")).name("foo").build();
firstRead();
assertEquals("The attribute name from the callback handler did not match the expected result",
"cn=Barbara Jensen, ou=Product Development, dc=airius, dc=com", this.callbackAttributeName);
}
@Test
public void testSaveState() throws Exception {
this.ldifReader = new LdifReaderBuilder().resource(context.getResource("classpath:/test.ldif")).name("foo").build();
ExecutionContext executionContext = new ExecutionContext();
firstRead(executionContext);
this.ldifReader.update(executionContext);
assertEquals("foo.read.count did not have the expected result", 1,
executionContext.getInt("foo.read.count"));
}
@Test
public void testSaveStateDisabled() throws Exception {
this.ldifReader = new LdifReaderBuilder().saveState(false).resource(context.getResource("classpath:/test.ldif"))
.build();
ExecutionContext executionContext = new ExecutionContext();
firstRead(executionContext);
this.ldifReader.update(executionContext);
assertEquals("ExecutionContext should have been empty", 0, executionContext.size());
}
@Test
public void testStrict() {
// Test that strict when enabled will throw an exception.
try {
this.ldifReader = new LdifReaderBuilder().resource(context.getResource("classpath:/teadsfst.ldif")).name("foo").build();
this.ldifReader.open(new ExecutionContext());
fail("IllegalStateException should have been thrown, because strict was set to true");
}
catch (ItemStreamException ise) {
assertEquals("IllegalStateException message did not match the expected result.",
"Failed to initialize the reader", ise.getMessage());
}
// Test that strict when disabled will still allow the ldap resource to be opened.
this.ldifReader = new LdifReaderBuilder().strict(false)
.resource(context.getResource("classpath:/teadsfst.ldif")).name("foo").build();
this.ldifReader.open(new ExecutionContext());
}
private LdapAttributes firstRead() throws Exception {
return firstRead(new ExecutionContext());
}
private LdapAttributes firstRead(ExecutionContext executionContext) throws Exception {
this.ldifReader.open(executionContext);
return this.ldifReader.read();
}
@Configuration
public static class LdifConfiguration {
}
public class TestCallBackHandler implements RecordCallbackHandler {
@Override
public void handleRecord(LdapAttributes attributes) {
callbackAttributeName = attributes.getName().toString();
}
}
}