package com.github.mygreen.supercsv.cellprocessor.constraint;
import static org.junit.Assert.*;
import java.lang.annotation.Annotation;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import static org.assertj.core.api.Assertions.*;
import static com.github.mygreen.supercsv.tool.TestUtils.*;
import static com.github.mygreen.supercsv.tool.HasCellProcessorAssert.*;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TestName;
import org.supercsv.cellprocessor.ift.CellProcessor;
import com.github.mygreen.supercsv.annotation.CsvBean;
import com.github.mygreen.supercsv.annotation.CsvColumn;
import com.github.mygreen.supercsv.annotation.constraint.CsvLengthExact;
import com.github.mygreen.supercsv.builder.ProcessorBuilderResolver;
import com.github.mygreen.supercsv.builder.BeanMapping;
import com.github.mygreen.supercsv.builder.BeanMappingFactory;
import com.github.mygreen.supercsv.builder.BuildCase;
import com.github.mygreen.supercsv.builder.ColumnMapping;
import com.github.mygreen.supercsv.builder.Configuration;
import com.github.mygreen.supercsv.builder.FieldAccessor;
import com.github.mygreen.supercsv.builder.standard.StringProcessorBuilder;
import com.github.mygreen.supercsv.cellprocessor.format.TextFormatter;
import com.github.mygreen.supercsv.exception.SuperCsvInvalidAnnotationException;
import com.github.mygreen.supercsv.exception.SuperCsvValidationException;
import com.github.mygreen.supercsv.validation.CsvExceptionConverter;
/**
* {@link LengthExactFactory}のテスタ
*
* @since 2.0
* @author T.TSUCHIE
*
*/
public class LengthExactFactoryTest {
@Rule
public TestName name = new TestName();
private LengthExactFactory factory;
private Configuration config;
private Comparator<Annotation> comparator;
private ProcessorBuilderResolver builderResolver;
private BeanMappingFactory beanMappingFactory;
private CsvExceptionConverter exceptionConverter;
private final Class<?>[] groupEmpty = new Class[]{};
@Before
public void setUp() throws Exception {
this.factory = new LengthExactFactory();
this.config = new Configuration();
this.beanMappingFactory = new BeanMappingFactory();
beanMappingFactory.setConfiguration(config);
this.exceptionConverter = new CsvExceptionConverter();
this.comparator = config.getAnnoationComparator();
this.builderResolver = config.getBuilderResolver();
}
private static final String TEST_VALUE_VALID_INPUT = "abcde";
private static final String TEST_VALUE_WRONG_INPUT = "abcd";
@CsvBean
private static class TestCsv {
@CsvColumn(number=1, label="カラム1")
@CsvLengthExact(value={5, 10})
private String col_default;
@CsvColumn(number=2)
@CsvLengthExact(value={10, -1, 0, 0, 5, 5, 10})
private String col_length_duplicate_minus;
@CsvColumn(number=10)
@CsvLengthExact(value={5, 10}, message="テストメッセージ")
private String col_message;
@CsvColumn(number=11)
@CsvLengthExact(value={5, 10}, message="")
private String col_message_empty;
@CsvColumn(number=12)
@CsvLengthExact(value={5, 10},
message="lineNumber={lineNumber}, rowNumber={rowNumber}, columnNumber={columnNumber}, label={label}, validatedValue={validatedValue}, length={length}, requiredLengths=${f:join(requiredLengths, ', ')}")
private String col_message_variables;
@CsvColumn(number=13)
@CsvLengthExact(value=5)
private String col_message_length1;
}
@CsvBean
private static class ErrorCsv {
@CsvColumn(number=1)
@CsvLengthExact(value={-1})
private String col_value_empty;
}
@Test
public void testCreate_default() {
FieldAccessor field = getFieldAccessor(TestCsv.class, "col_default", comparator);
StringProcessorBuilder builder = (StringProcessorBuilder) builderResolver.resolve(String.class);
TextFormatter<String> formatter = builder.getFormatter(field, config);
CsvLengthExact anno = field.getAnnotationsByGroup(CsvLengthExact.class, groupEmpty).get(0);
{
//next null
Optional<CellProcessor> processor = factory.create(anno, Optional.empty(), field, formatter, config);
printCellProcessorChain(processor.get(), name.getMethodName());
assertThat(processor.get()).isInstanceOf(LengthExact.class);
LengthExact actual = (LengthExact)processor.get();
assertThat(actual.getRequiredLengths()).containsExactly(5, 10);
{
// valid input
String input = TEST_VALUE_VALID_INPUT;
assertThat((Object)actual.execute(input, ANONYMOUS_CSVCONTEXT)).isEqualTo(input);
}
{
// wrong input
String input = TEST_VALUE_WRONG_INPUT;
assertThatThrownBy(() -> actual.execute(input, ANONYMOUS_CSVCONTEXT)).isInstanceOf(SuperCsvValidationException.class);
}
assertThat(actual.getValidationMessage()).isEqualTo("{com.github.mygreen.supercsv.annotation.constraint.CsvLengthExact.message}");
}
{
//next exist
Optional<CellProcessor> processor = factory.create(anno, Optional.of(new NextCellProcessor()), field, formatter, config);
printCellProcessorChain(processor.get(), name.getMethodName());
assertThat(processor.get()).isInstanceOf(LengthExact.class);
LengthExact actual = (LengthExact)processor.get();
assertThat(actual.getRequiredLengths()).containsExactly(5, 10);
{
// valid input
String input = TEST_VALUE_VALID_INPUT;
assertThat((Object)actual.execute(input, ANONYMOUS_CSVCONTEXT)).isEqualTo(input);
}
{
// wrong input
String input = TEST_VALUE_WRONG_INPUT;
assertThatThrownBy(() -> actual.execute(input, ANONYMOUS_CSVCONTEXT)).isInstanceOf(SuperCsvValidationException.class);
}
assertThat(actual.getValidationMessage()).isEqualTo("{com.github.mygreen.supercsv.annotation.constraint.CsvLengthExact.message}");
}
}
/**
* 属性valueのテスト - 重複、負数を含む場合
*/
@Test
public void testCreate_attrValue_duplicate_minus() {
FieldAccessor field = getFieldAccessor(TestCsv.class, "col_length_duplicate_minus", comparator);
StringProcessorBuilder builder = (StringProcessorBuilder) builderResolver.resolve(String.class);
TextFormatter<String> formatter = builder.getFormatter(field, config);
CsvLengthExact anno = field.getAnnotationsByGroup(CsvLengthExact.class, groupEmpty).get(0);
Optional<CellProcessor> processor = factory.create(anno, Optional.empty(), field, formatter, config);
printCellProcessorChain(processor.get(), name.getMethodName());
assertThat(processor.get()).isInstanceOf(LengthExact.class);
LengthExact actual = (LengthExact)processor.get();
assertThat(actual.getRequiredLengths()).containsExactly(0, 5, 10);
}
/**
* 属性valueのテスト - 正常な値がない場合
*/
@Test
public void testCreate_attrValue_empty() {
FieldAccessor field = getFieldAccessor(ErrorCsv.class, "col_value_empty", comparator);
StringProcessorBuilder builder = (StringProcessorBuilder) builderResolver.resolve(String.class);
TextFormatter<String> formatter = builder.getFormatter(field, config);
CsvLengthExact anno = field.getAnnotationsByGroup(CsvLengthExact.class, groupEmpty).get(0);
try {
factory.create(anno, Optional.empty(), field, formatter, config);
fail();
} catch(Exception e) {
assertThat(e).isInstanceOf(SuperCsvInvalidAnnotationException.class)
.hasMessage("'%s' において、アノテーション @CsvLengthExact の属性 'value' の指定は必須です。",
field.getNameWithClass());
}
}
/**
* 属性messageのテスト
*/
@Test
public void testCreate_attrMessage() {
FieldAccessor field = getFieldAccessor(TestCsv.class, "col_message", comparator);
StringProcessorBuilder builder = (StringProcessorBuilder) builderResolver.resolve(String.class);
TextFormatter<String> formatter = builder.getFormatter(field, config);
CsvLengthExact anno = field.getAnnotationsByGroup(CsvLengthExact.class, groupEmpty).get(0);
Optional<CellProcessor> processor = factory.create(anno, Optional.empty(), field, formatter, config);
printCellProcessorChain(processor.get(), name.getMethodName());
assertThat(processor.get()).isInstanceOf(LengthExact.class);
LengthExact actual = (LengthExact)processor.get();
assertThat(actual.getValidationMessage()).isEqualTo("テストメッセージ");
}
/**
* エラーメッセージのテスト - 標準
*/
@Test
public void testErrorMessage_default() {
BeanMapping<TestCsv> beanMapping = beanMappingFactory.create(TestCsv.class, groupEmpty);
ColumnMapping columnMapping = beanMapping.getColumnMapping("col_default").get();
CellProcessor processor = columnMapping.getCellProcessorForReading();
printCellProcessorChain(processor, name.getMethodName());
assertThat(processor).hasCellProcessor(LengthExact.class);
String input = TEST_VALUE_WRONG_INPUT;
try {
processor.execute(input, testCsvContext(columnMapping, input));
fail();
} catch(Exception e) {
assertThat(e).isInstanceOf(SuperCsvValidationException.class);
List<String> messages = exceptionConverter.convertAndFormat((SuperCsvValidationException)e, beanMapping);
assertThat(messages).hasSize(1).contains("[2行, 1列] : 項目「カラム1」の文字列長（4）は、5, 10文字の何れかでなければなりません。");
}
}
/**
* エラーメッセージのテスト - アノテーションの属性「message」の指定
*/
@Test
public void testErrorMessage_message() {
BeanMapping<TestCsv> beanMapping = beanMappingFactory.create(TestCsv.class, groupEmpty);
ColumnMapping columnMapping = beanMapping.getColumnMapping("col_message").get();
CellProcessor processor = columnMapping.getCellProcessorForReading();
printCellProcessorChain(processor, name.getMethodName());
assertThat(processor).hasCellProcessor(LengthExact.class);
String input = TEST_VALUE_WRONG_INPUT;
try {
processor.execute(input, testCsvContext(columnMapping, input));
fail();
} catch(Exception e) {
assertThat(e).isInstanceOf(SuperCsvValidationException.class);
List<String> messages = exceptionConverter.convertAndFormat((SuperCsvValidationException)e, beanMapping);
assertThat(messages).hasSize(1)
.contains("テストメッセージ");
}
}
/**
* エラーメッセージのテスト - アノテーションの属性「message」が空文字の場合
*/
@Test
public void testErrorMessage_empty() {
BeanMapping<TestCsv> beanMapping = beanMappingFactory.create(TestCsv.class, groupEmpty);
ColumnMapping columnMapping = beanMapping.getColumnMapping("col_message_empty").get();
CellProcessor processor = columnMapping.getCellProcessorForReading();
printCellProcessorChain(processor, name.getMethodName());
assertThat(processor).hasCellProcessor(LengthExact.class);
String input = TEST_VALUE_WRONG_INPUT;
try {
processor.execute(input, testCsvContext(columnMapping, input));
fail();
} catch(Exception e) {
assertThat(e).isInstanceOf(SuperCsvValidationException.class);
List<String> messages = exceptionConverter.convertAndFormat((SuperCsvValidationException)e, beanMapping);
assertThat(messages).hasSize(1)
.contains("[2行, 11列] : 項目「col_message_empty」の文字列長（4）は、5, 10文字の何れかでなければなりません。");
}
}
/**
* エラーメッセージのテスト - メッセージ変数の確認
*/
@Test
public void testErrorMessage_variables() {
BeanMapping<TestCsv> beanMapping = beanMappingFactory.create(TestCsv.class, groupEmpty);
ColumnMapping columnMapping = beanMapping.getColumnMapping("col_message_variables").get();
CellProcessor processor = columnMapping.getCellProcessorForReading();
printCellProcessorChain(processor, name.getMethodName());
assertThat(processor).hasCellProcessor(LengthExact.class);
String input = TEST_VALUE_WRONG_INPUT;
try {
processor.execute(input, testCsvContext(columnMapping, input));
fail();
} catch(Exception e) {
assertThat(e).isInstanceOf(SuperCsvValidationException.class);
List<String> messages = exceptionConverter.convertAndFormat((SuperCsvValidationException)e, beanMapping);
assertThat(messages).hasSize(1)
.contains("lineNumber=1, rowNumber=2, columnNumber=12, label=col_message_variables, validatedValue=abcd, length=4, requiredLengths=5, 10");
}
}
/**
* エラーメッセージのテスト - 指定した文字長が1つの場合
*/
@Test
public void testErrorMessage_length1() {
BeanMapping<TestCsv> beanMapping = beanMappingFactory.create(TestCsv.class, groupEmpty);
ColumnMapping columnMapping = beanMapping.getColumnMapping("col_message_length1").get();
CellProcessor processor = columnMapping.getCellProcessorForReading();
printCellProcessorChain(processor, name.getMethodName());
assertThat(processor).hasCellProcessor(LengthExact.class);
String input = TEST_VALUE_WRONG_INPUT;
try {
processor.execute(input, testCsvContext(columnMapping, input));
fail();
} catch(Exception e) {
assertThat(e).isInstanceOf(SuperCsvValidationException.class);
List<String> messages = exceptionConverter.convertAndFormat((SuperCsvValidationException)e, beanMapping);
assertThat(messages).hasSize(1)
.contains("[2行, 13列] : 項目「col_message_length1」の文字列長（4）は、5文字でなければなりません。");
}
}
}