Merge pull request #86 from lognaturel/jr-3.3.0

Validate forms with itemsets using external instances and custom refs

Author: lognaturel

build.gradle

@@ -28,9 +28,9 @@ sourceCompatibility = '1.8'
 
 dependencies {
     compile group: 'net.sf.kxml', name: 'kxml2', version: '2.3.0'
-    compile group: 'org.getodk', name: 'javarosa', version: '3.1.0'
+    compile group: 'org.getodk', name: 'javarosa', version: '3.3.0'
     compile group: 'org.slf4j', name: 'slf4j-nop', version: '1.7.25'
-    testCompile 'junit:junit:4.12'
+    testCompile 'junit:junit:4.13.2'
     testCompile 'org.hamcrest:hamcrest-all:1.3'
 }
 

src/org/opendatakit/validate/StubReference.java

@@ -2,64 +2,11 @@
 
 import org.javarosa.core.reference.Reference;
 
-import java.io.File;
-import java.io.FileOutputStream;
 import java.io.InputStream;
-import java.io.IOException;
 import java.io.OutputStream;
 
-/**
- * Provides the local URI of a simple XML or CSV document. This allows forms with external secondary instances to
- * pass validation.
- *
- * The fake XML instance has the following structure:
- *
- * <pre>{@code
- * <root>
- *     <item>
- *         <name>an-xml-item</name>
- *         <label>An XML Item</label>
- *     </item>
- * </root>
- *}</pre>
- *
- * The fake CSV instance has the following structure:
- *
- * <pre>{@code
- * name,label
- * a-csv-item, "A CSV Item"
- *}</pre>
- *
- * This means only itemset declarations that define {@code name} as the node name referring to the select underlying
- * value and {@code label} as the node name referring to the label will pass validation.
- *
- * Passes validation:
- * <pre>{@code
- *  <itemset nodeset="instance('lgas')/root/item[state=/nigeria_wards_external/state]">
- *    <value ref="name"/>
- *    <label ref="label"/>
- *  </itemset>
- * }</pre>
- *
- * Fails validation:
- * <pre>{@code
- *  <itemset nodeset="instance('lgas')/root/item[state=/nigeria_wards_external/state]">
- *    <value ref="value"/>
- *    <label ref="something-else"/>
- *  </itemset>
- * }</pre>
- *
- *
- *
- */
 public class StubReference implements Reference {
 
-    private String uri;
-
-    public StubReference(String URI) {
-        uri = URI;
-    }
-
     @Override
     public boolean doesBinaryExist() {
         return true;
@@ -77,13 +24,7 @@ public String getURI() {
 
     @Override
     public String getLocalURI() {
-        if (uri.toLowerCase().startsWith("jr://file/")) {
-            return getResourceAsFile("fake-itemset.xml").toURI().getPath();
-        } else if (uri.toLowerCase().startsWith("jr://file-csv/")) {
-            return getResourceAsFile("fake-itemset.csv").toURI().getPath();
-        } else {
-            return null;
-        }
+        return "Can't be found";
     }
 
     @Override
@@ -98,40 +39,10 @@ public OutputStream getOutputStream() {
 
     @Override
     public void remove() {
-
     }
 
     @Override
     public Reference[] probeAlternativeReferences() {
         return new Reference[0];
     }
-
-    // getResource() on a file will fail when Validate is run as a jar.
-    // getResourceAsStream() is the workaround, but because we need a path,
-    // we need to copy the stream to a temp file. The temp file is deleted
-    // when the JVM exits
-    // https://stackoverflow.com/a/35466006/152938
-    private static File getResourceAsFile(String resourcePath) {
-        try {
-            InputStream in = ClassLoader.getSystemClassLoader().getResourceAsStream(resourcePath);
-            if (in == null) {
-                return null;
-            }
-
-            File tempFile = File.createTempFile(String.valueOf(in.hashCode()), ".tmp");
-            tempFile.deleteOnExit();
-
-            try (FileOutputStream out = new FileOutputStream(tempFile)) {
-                byte[] buffer = new byte[1024];
-                int bytesRead;
-                while ((bytesRead = in.read(buffer)) != -1) {
-                    out.write(buffer, 0, bytesRead);
-                }
-            }
-            return tempFile;
-        } catch (IOException e) {
-            e.printStackTrace();
-            return null;
-        }
-    }
 }

src/org/opendatakit/validate/StubReferenceFactory.java

@@ -16,11 +16,11 @@ public boolean derives(String URI) {
 
     @Override
     public Reference derive(String URI) {
-        return new StubReference(URI);
+        return new StubReference();
     }
 
     @Override
     public Reference derive(String URI, String context) {
-        return new StubReference(URI);
+        return new StubReference();
     }
 }

src/test/java/org/opendatakit/validate/ValidateExternalSecondaryInstancesTest.java

@@ -13,25 +13,31 @@
 
 public class ValidateExternalSecondaryInstancesTest {
     @Test
-    public void supports_xlsforms_value_and_label_refs_in_itemsets_using_secondary_external_instances_xml() throws URISyntaxException {
-        supports_xlsforms_value_and_label_refs_in_itemsets_using_secondary_external_instances("external_secondary_instance_xml.xml");
+    public void supportsXlsformsDefaultValueAndLabelRefs_inItemsets_usingXMLExternalSecondaryInstance() throws URISyntaxException {
+        final Path path = getPathOf("xml_external_instance.xml");
+        final FormValidator validator = new FormValidator();
+
+        Output output = Output.runAndGet(() -> validator.validate(path.toString()));
+        assertThat(output.err, isEmptyString());
+        assertThat(output.std, containsString("Xform is valid"));
     }
 
     @Test
-    public void supports_xlsforms_value_and_label_refs_in_itemsets_using_secondary_external_instances_csv() throws URISyntaxException {
-        supports_xlsforms_value_and_label_refs_in_itemsets_using_secondary_external_instances("external_secondary_instance_csv.xml");
+    public void supportsXlsformsDefaultValueAndLabelRefs_inItemsets_usingCsvSecondaryExternalInstance() throws URISyntaxException {
+        final Path path = getPathOf("csv_external_instance.xml");
+        final FormValidator validator = new FormValidator();
+
+        Output output = Output.runAndGet(() -> validator.validate(path.toString()));
+        assertThat(output.err, isEmptyString());
+        assertThat(output.std, containsString("Xform is valid"));
     }
 
-    private void supports_xlsforms_value_and_label_refs_in_itemsets_using_secondary_external_instances(String secondaryInstancePath) throws URISyntaxException  {
-        final Path path = getPathOf(secondaryInstancePath);
+    @Test
+    public void supportsCustomValueAndLabelRefs_inItemsets_usingExternalSecondaryInstance() throws URISyntaxException {
+        final Path path = getPathOf("external_instance_custom_refs.xml");
         final FormValidator validator = new FormValidator();
 
-        Output output = Output.runAndGet(new Runnable() {
-            @Override
-            public void run() {
-                validator.validate(path.toString());
-            }
-        });
+        Output output = Output.runAndGet(() -> validator.validate(path.toString()));
         assertThat(output.err, isEmptyString());
         assertThat(output.std, containsString("Xform is valid"));
     }

src/test/resources/external_secondary_instance_csv.xml renamed to src/test/resources/csv_external_instance.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<h:html xmlns="http://www.w3.org/2002/xforms" xmlns:h="http://www.w3.org/1999/xhtml" xmlns:jr="http://openrosa.org/javarosa">
+    <h:head>
+        <h:title>External Secondary Instance with xlsforms generated itemset value/label refs</h:title>
+        <model>
+            <instance>
+                <data id="external-choices">
+                    <some-value/>
+                    <meta>
+                        <instanceID/>
+                    </meta>
+                </data>
+            </instance>
+            <instance id="external-choices" src="jr://file-csv/external-choices.csv"/>
+            <bind nodeset="/data/some-value" type="select1"/>
+            <bind calculate="concat('uuid:', uuid())" nodeset="/data/meta/instanceID" readonly="true()" type="string"/>
+        </model>
+    </h:head>
+    <h:body>
+        <select1 ref="/data/some-value">
+            <label>Value 1</label>
+            <itemset nodeset="instance('external-choices')/root/item">
+                <value ref="id"/>
+                <label ref="a_custom_label"/>
+            </itemset>
+        </select1>
+    </h:body>
+</h:html>