Add changelog validator

hapi-fhir-docs/src/test/java/ca/uhn/hapi/fhir/docs/ChangelogFilesTest.java

@@ -0,0 +1,81 @@
+package ca.uhn.hapi.fhir.docs;
+
+import ca.uhn.fhir.context.ConfigurationException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import com.google.common.base.Charsets;
+import org.apache.commons.collections4.IteratorUtils;
+import org.apache.commons.io.FileUtils;
+import org.junit.jupiter.api.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.InputStreamReader;
+import java.util.Collection;
+import java.util.List;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.empty;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.fail;
+
+public class ChangelogFilesTest {
+
+	private static final Logger ourLog = LoggerFactory.getLogger(ChangelogFilesTest.class);
+
+	@Test
+	public void testChangelogFiles() {
+		Collection<File> files = FileUtils.listFiles(
+			new File("src/main/resources/ca/uhn/hapi/fhir/changelog"),
+			new String[]{"yaml"},
+			true);
+
+		for (File next : files) {
+			ourLog.info("Checking file: {}", next);
+
+			String nextFilename = next.getName();
+			if (nextFilename.equals("changes.yaml")) {
+				continue;
+			}
+			if (nextFilename.equals("version.yaml")) {
+				continue;
+			}
+
+			if (!nextFilename.matches("[a-zA-Z0-9]+-[a-zA-Z0-9_-]+\\.yaml")) {
+				fail("Invalid changelog filename: " + next);
+			}
+
+			ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
+			ObjectNode tree;
+			try (FileInputStream fis = new FileInputStream(next)) {
+				tree = (ObjectNode) mapper.readTree(new InputStreamReader(fis, Charsets.UTF_8));
+			} catch (Exception e) {
+				throw new ConfigurationException("Failed to read " + next, e);
+			}
+
+			List<String> fieldNames = IteratorUtils.toList(tree.fieldNames());
+			boolean title = fieldNames.remove("title");
+			assertTrue(title, "No 'title' element in " + next);
+
+			boolean type = fieldNames.remove("type");
+			assertTrue(type, "No 'type' element in " + next);
+
+			// this one is optional
+			boolean haveIssue = fieldNames.remove("issue");
+
+			assertThat("Invalid element in " + next + ": " + fieldNames, fieldNames, empty());
+
+			if (haveIssue) {
+				String issue = tree.get("issue").asText();
+				try {
+					Integer.parseInt(issue);
+				} catch (NumberFormatException e) {
+					fail("Invalid issue value in " + next);
+				}
+			}
+		}
+	}
+}