SiteParser.isFullyInitialized(): add unit tests.

Addressed to #685

No functional changes.

Author: php-coder

src/main/java/ru/mystamps/web/util/extractor/SiteParser.java

@@ -29,12 +29,19 @@
 import org.jsoup.nodes.Element;
 
 import lombok.AccessLevel;
+import lombok.Getter;
 import lombok.Setter;
 
+// Getters/setters are being used in unit tests
+@Getter(AccessLevel.PROTECTED)
 @Setter(AccessLevel.PROTECTED)
 public class SiteParser {
 	private static final Logger LOG = LoggerFactory.getLogger(SiteParser.class);
 
+	// When you're adding a new field don't forget to also update:
+	// - SiteParser.setField()
+	// - SiteParser.isFullyInitialized() (optionally)
+	// - SiteParserTest.describe()
 	private String name;
 	private String matchedUrl;
 	private String categoryLocator;

src/test/java/ru/mystamps/web/tests/Random.java

@@ -170,4 +170,9 @@ public static String jsoupLocator() {
 		return sample(locators);
 	}
 
+	public static String tagAttributeName() {
+		List<String> attributes = Arrays.asList("href", "src", "data-dst");
+		return sample(attributes);
+	}
+	
 }

src/test/java/ru/mystamps/web/util/extractor/SiteParserTest.java

@@ -29,6 +29,7 @@
 import static io.qala.datagen.RandomValue.between;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.is;
 
 public class SiteParserTest {
 
@@ -65,6 +66,91 @@ public void setFieldShouldRequireNonBlankValue() {
 		parser.setField(anyValidFieldName, nullOrBlank());
 	}
 
+	//
+	// Tests for isFullyInitialized()
+	//
+	
+	@Test
+	public void isFullyInitializedMayBeOnlyWhenNameIsSet() {
+		parser.setMatchedUrl(Random.url());
+		parser.setCategoryLocator(Random.jsoupLocator());
+		parser.setCountryLocator(Random.jsoupLocator());
+		parser.setShortDescriptionLocator(Random.jsoupLocator());
+		parser.setImageUrlLocator(Random.jsoupLocator());
+		parser.setImageUrlAttribute(Random.tagAttributeName());
+		parser.setIssueDateLocator(Random.jsoupLocator());
+		
+		// ensure that required field is null
+		parser.setName(null);
+
+		String msg = describe(parser) + " expected to be not fully initialized";
+		assertThat(msg, parser.isFullyInitialized(), is(false));
+	}
+	
+	@Test
+	public void isFullyInitializedMayBeOnlyWhenMatchedUrlIsSet() {
+		parser.setName(Random.name());
+		parser.setCategoryLocator(Random.jsoupLocator());
+		parser.setCountryLocator(Random.jsoupLocator());
+		parser.setShortDescriptionLocator(Random.jsoupLocator());
+		parser.setImageUrlLocator(Random.jsoupLocator());
+		parser.setImageUrlAttribute(Random.tagAttributeName());
+		parser.setIssueDateLocator(Random.jsoupLocator());
+
+		// ensure that required field is null
+		parser.setMatchedUrl(null);
+
+		String msg = describe(parser) + " expected to be not fully initialized";
+		assertThat(msg, parser.isFullyInitialized(), is(false));
+	}
+	
+	@Test
+	public void isFullyInitializedMayBeOnlyWhenOneOfLocatorIsSet() {
+		parser.setName(Random.name());
+		parser.setMatchedUrl(Random.url());
+		parser.setImageUrlAttribute(Random.tagAttributeName());
+
+		// ensure that required fields are null
+		parser.setCategoryLocator(null);
+		parser.setCountryLocator(null);
+		parser.setShortDescriptionLocator(null);
+		parser.setImageUrlLocator(null);
+		parser.setIssueDateLocator(null);
+		
+		String msg = describe(parser) + " expected to be not fully initialized";
+		assertThat(msg, parser.isFullyInitialized(), is(false));
+	}
+	
+	@Test
+	public void isFullyInitializedWhenAllMandatoryFieldsAreSet() {
+		parser.setName(Random.name());
+		parser.setMatchedUrl(Random.url());
+		
+		final int countOfFieldsWithLocator = 5;
+		String[] locators = new String[countOfFieldsWithLocator];
+		
+		for (int i = 0; i < locators.length; i++) {
+			int guaranteedSetPosition = between(0, locators.length - 1).integer();
+			if (i == guaranteedSetPosition) {
+				locators[i] = Random.jsoupLocator();
+			} else {
+				locators[i] = nullOr(Random.jsoupLocator());
+			}
+		}
+		
+		parser.setCategoryLocator(locators[0]);
+		parser.setCountryLocator(locators[1]);
+		parser.setShortDescriptionLocator(locators[2]);
+		// CheckStyle: ignore MagicNumber for next 2 lines
+		parser.setImageUrlLocator(locators[3]);
+		parser.setIssueDateLocator(locators[4]);
+		
+		parser.setImageUrlAttribute(nullOr(Random.tagAttributeName()));
+		
+		String msg = describe(parser) + " expected to be fully initialized";
+		assertThat(msg, parser.isFullyInitialized(), is(true));
+	}
+	
 	//
 	// Tests for canParse()
 	//
@@ -112,4 +198,26 @@ public void toStringShouldReturnName() {
 		assertThat(parser.toString(), equalTo(expectedName));
 	}
 
+	private static String describe(SiteParser parser) {
+		StringBuilder sb = new StringBuilder();
+		sb.append("SiteParser[name=")
+			.append(parser.getName())
+			.append(", matchedUrl=")
+			.append(parser.getMatchedUrl())
+			.append(", categoryLocator=")
+			.append(parser.getCountryLocator())
+			.append(", countryLocator=")
+			.append(parser.getCountryLocator())
+			.append(", shortDescriptionLocator=")
+			.append(parser.getShortDescriptionLocator())
+			.append(", imageUrlLocator=")
+			.append(parser.getImageUrlLocator())
+			.append(", imageUrlAttribute=")
+			.append(parser.getImageUrlAttribute())
+			.append(", issueDateLocator=")
+			.append(parser.getIssueDateLocator())
+			.append(']');
+		return sb.toString();
+	}
+	
 }