Merge pull request #1719 from ESMCI/erichlf/batch/email

Add Support for Email Options

Added an email option to env_batch.xml. Also, add the ability to send an email option through case.submit. The flags in case.submit follow slurm's usage, i.e. --mail-user and --mail-type, where type here is never, all, begin, end, fail.

Test suite: scripts_regression_tests.py (Anvil, Skybridge, and Climate)
various email options passed to case.submit on the above three machines, and similarly in env_batch.xml.
Test baseline:
Test namelist changes:
Test status: bit for bit

Fixes #797

User interface changes?: Added --mail-user and --mail-type to case.submit

Update gh-pages html (Y/N)?: N

Code review: @jgfouca @jedwards4b

config/acme/machines/config_batch.xsd

@@ -7,12 +7,12 @@
     <xs:complexType>
       <xs:sequence>
 
-	<!-- definition of batch_system complex elements -->
-	<xs:element name="batch_system" maxOccurs="unbounded">
-	  <xs:complexType>
-	    <xs:sequence>
+  <!-- definition of batch_system complex elements -->
+  <xs:element name="batch_system" maxOccurs="unbounded">
+    <xs:complexType>
+      <xs:sequence>
 
-	      <xs:element name="batch_query" minOccurs="1" maxOccurs="1">
+        <xs:element name="batch_query" minOccurs="1" maxOccurs="1">
                 <xs:complexType>
                   <xs:simpleContent>
                     <xs:extension base="xs:string">
@@ -22,33 +22,33 @@
                 </xs:complexType>
               </xs:element>
 
-	      <xs:element name="batch_submit" type="xs:string" minOccurs="1" maxOccurs="1"/>
-	      <xs:element name="batch_redirect" type="xs:string" minOccurs="0" maxOccurs="1"/>
-	      <xs:element name="batch_directive" type="xs:string" minOccurs="0" maxOccurs="1"/>
+        <xs:element name="batch_submit" type="xs:string" minOccurs="1" maxOccurs="1"/>
+        <xs:element name="batch_redirect" type="xs:string" minOccurs="0" maxOccurs="1"/>
+        <xs:element name="batch_directive" type="xs:string" minOccurs="0" maxOccurs="1"/>
 
-	      <xs:element name="directives" minOccurs="0" maxOccurs="1">
-		<xs:complexType>
-		  <xs:sequence>
+        <xs:element name="directives" minOccurs="0" maxOccurs="1">
+    <xs:complexType>
+      <xs:sequence>
 
-		    <xs:element name="directive" minOccurs="0" maxOccurs="unbounded">
+        <xs:element name="directive" minOccurs="0" maxOccurs="unbounded">
                       <xs:complexType>
-			<xs:simpleContent>
-			  <xs:extension base="xs:string">
-			    <xs:attribute name="name" type="xs:string" use="required"/>
-			    <xs:attribute name="default" type="xs:string"/>
-			  </xs:extension>
-			</xs:simpleContent>
+      <xs:simpleContent>
+        <xs:extension base="xs:string">
+          <xs:attribute name="name" type="xs:string" use="required"/>
+          <xs:attribute name="default" type="xs:string"/>
+        </xs:extension>
+      </xs:simpleContent>
                       </xs:complexType>
-		    </xs:element>
+        </xs:element>
 
-		  </xs:sequence>
-		</xs:complexType>
-	      </xs:element>
+      </xs:sequence>
+    </xs:complexType>
+        </xs:element>
 
-	    </xs:sequence>
-	    <xs:attribute name="type" type="xs:string" use="required"/>
-	    <xs:attribute name="version" type="xs:string" use="required"/>
-	  </xs:complexType>
+      </xs:sequence>
+      <xs:attribute name="type" type="xs:string" use="required"/>
+      <xs:attribute name="version" type="xs:string" use="required"/>
+    </xs:complexType>
         </xs:element>
 
       </xs:sequence>

config/acme/machines/template.case.run

@@ -51,7 +51,6 @@ OR
     parser.add_argument("--caseroot",
                         help="Case directory to build")
 
-
     parser.add_argument("--skip-preview-namelist", action="store_true",
                         help="Skip calling preview-namelist during case.run")