version 1.2 initial commit

Adds new validation for SUBMIT and ANNOUNCE: new field SOFTWARE_TYPE, one of
enumerations Type.B (BUSINESS) or Type.S (SCIENTIFIC).  If BUSINESS type, at
least one SPONSORING ORGANIZATION is also required.

modified MetadataTest unit tests appropriately; also changed method names to
be consistent with terminology already in place.
Signed-off-by: Neal Ensor <[email protected]>

Author: nensor

pom.xml

@@ -4,7 +4,7 @@
 	<groupId>gov.osti</groupId>
 	<artifactId>doecode</artifactId>
 	<packaging>war</packaging>
-	<version>1.1</version>
+	<version>1.2</version>
 	<name>DOE Code Web Application</name>
 	<url>http://maven.apache.org</url>
 

src/main/java/gov/osti/entity/DOECodeMetadata.java

@@ -123,14 +123,33 @@ public String label() {
         }
     }
 
+    /**
+     * Define the valid SOFTWARE TYPES.
+     */
+    public enum Type {
+        S ("Scientific"),
+        B ("Business");
+        
+        private final String label;
+        
+        private Type(String label) {
+            this.label = label;
+        }
+        
+        public String label() {
+            return this.label;
+        }
+    }
+    
     // Attributes
     private Long codeId;
     private String siteOwnershipCode = null;
     private Boolean openSource = null;
     private String  repositoryLink = null;
     private String landingPage = null;
     private Accessibility accessibility = null;
-    
+    // the SOFTWARE TYPE
+    private Type softwareType;
     // set of Access Limitations (Strings)
     @JacksonXmlElementWrapper (localName = "accessLimitations")
     @JacksonXmlProperty (localName = "accessLimitation")
@@ -666,4 +685,25 @@ void updatedAt() {
         public boolean hasSetReleaseDate() {
             return setReleaseDate;
         }
+        
+        /**
+         * Obtain the SOFTWARE TYPE: one of Type.S (scientific) or Type.B (Business)
+         * 
+         * @return the type the SOFTWARE TYPE
+         */
+        @Basic (optional = false)
+        @Column (name = "SOFTWARE_TYPE", length = 1)
+        @Enumerated (EnumType.STRING)
+        public Type getSoftwareType() {
+            return softwareType;
+        }
+
+        /**
+         * Set the SOFTWARE TYPE value.
+         * 
+         * @param type the type to set
+         */
+        public void setSoftwareType(Type type) {
+            this.softwareType = type;
+        }
 }

src/main/java/gov/osti/services/Metadata.java

@@ -1479,6 +1479,13 @@ else if (m.getLicenses().contains(DOECodeMetadata.License.Other.value()) && Stri
             if (!Validation.isValidUrl(m.getLandingPage()))
                 reasons.add("A valid Landing Page URL is required for non-open source submissions.");
         }
+        // SOFTWARE TYPE is REQUIRED; BUSINESS type requires SPONSORING ORGANIZATION
+        if (null==m.getSoftwareType())
+            reasons.add("Software type is required.");
+        else if (DOECodeMetadata.Type.B.equals(m.getSoftwareType()))
+            if (null==m.getSponsoringOrganizations() || m.getSponsoringOrganizations().isEmpty())
+                reasons.add("A sponsor is required for Business software.");
+                
         // if repository link is present, it needs to be valid too
         if (StringUtils.isNotBlank(m.getRepositoryLink()) && !Validation.isValidRepositoryLink(m.getRepositoryLink()))
             reasons.add("Repository URL is not a valid repository.");

src/test/java/gov/osti/services/MetadataTest.java

@@ -4,6 +4,7 @@
 
 import gov.osti.entity.DOECodeMetadata;
 import gov.osti.entity.Developer;
+import gov.osti.entity.SponsoringOrganization;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -17,7 +18,8 @@
 import org.junit.Test;
 
 /**
- *
+ * Test various METADATA related functionality.
+ * 
  * @author ensornl
  */
 public class MetadataTest {
@@ -42,10 +44,10 @@ public void tearDown() {
     }
 
     /**
-     * Test that PUBLISHED VALIDATIONS work.
+     * Test that SUBMIT VALIDATIONS work.
      */
     @Test
-    public void testValidatePublished() {
+    public void testValidateSubmit() {
         DOECodeMetadata m = new DOECodeMetadata();
 
         // empty metadata should have numerous errors
@@ -59,7 +61,8 @@ public void testValidatePublished() {
             "Description is required.",
             "A License is required.",
             "At least one developer is required.",
-            "A valid Landing Page URL is required for non-open source submissions."
+            "A valid Landing Page URL is required for non-open source submissions.",
+            "Software type is required."
         };
 
         for ( String message : validations ) {
@@ -75,6 +78,7 @@ public void testValidatePublished() {
         assertFalse("Still requiring title?", reasons.contains("Software title is required."));
         assertFalse("Still requiring accessibility", reasons.contains("Missing Source Accessibility."));
         assertTrue ("Missing OS validation", reasons.contains("Repository URL is required for open source submissions."));
+        assertTrue ("Missing software type validation", reasons.contains("Software type is required."));
 
         // test developer issues
         Developer d = new Developer();
@@ -127,18 +131,37 @@ public void testValidatePublished() {
         m.setDevelopers(developers);
         m.setProprietaryUrl("http://mylicense.com/terms.html");
         m.setDescription("This is a testing description.");
+        m.setSoftwareType(DOECodeMetadata.Type.S);
 
         reasons = Metadata.validateSubmit(m);
 
         assertTrue ("Should be no more errors: " + StringUtils.join(reasons, ", "), reasons.isEmpty());
 
+        // assert that the BUSINESS additional requirement is there
+        m.setSoftwareType(DOECodeMetadata.Type.B);
+        
+        reasons = Metadata.validateSubmit(m);
+        
+        assertFalse("Missing business validation", reasons.isEmpty());
+        assertTrue ("Reason is wrong", reasons.contains("A sponsor is required for Business software."));
+        
+        // fix it
+        SponsoringOrganization sponsor = new SponsoringOrganization();
+        sponsor.setPrimaryAward("AWARD");
+        sponsor.setOrganizationName("Testing Business Validation");
+        
+        m.setSponsoringOrganizations(Arrays.asList(sponsor));
+        
+        reasons = Metadata.validateSubmit(m);
+        
+        assertTrue ("Still have errors:" + StringUtils.join(reasons, ", "), reasons.isEmpty());
     }
 
     /**
-     * Test some SUBMIT validations.
+     * Test some ANNOUNCE validations.
      */
     @Test
-    public void testValidateSubmit() {
+    public void testValidateAnnounce() {
         // test that published ones also apply here
         DOECodeMetadata m = new DOECodeMetadata();
 
@@ -153,9 +176,10 @@ public void testValidateSubmit() {
             "Description is required.",
             "A License is required.",
             "At least one developer is required.",
-            "A valid Landing Page URL is required for non-open source submissions."
+            "A valid Landing Page URL is required for non-open source submissions.",
+            "Software type is required."
         };
-        String[] submit_validations = {
+        String[] announce_validations = {
             "Release date is required.",
             "At least one sponsoring organization is required.",
             "At least one research organization is required.",
@@ -169,8 +193,8 @@ public void testValidateSubmit() {
             assertTrue ("Missing: " + message, reasons.contains(message));
         }
 
-        // also check submit only validations
-        for ( String message : submit_validations ) {
+        // also check announce only validations
+        for ( String message : announce_validations ) {
             assertTrue ("Missing: " + message, reasons.contains(message));
         }
     }