Add cylc scan --describe meta output and test

bin/cylc-scan

@@ -104,7 +104,7 @@ def main():
 
     parser.add_option(
         "-d", "--describe",
-        help="Print suite titles and descriptions if available.",
+        help="Print suite metadata if available.",
         action="store_true", default=False, dest="describe")
 
     parser.add_option(
@@ -267,40 +267,43 @@ def main():
 
         if options.describe:
             try:
-                title = suite_identity[KEY_META].get(KEY_TITLE)
+                meta_items = suite_identity[KEY_META]
             except KeyError:
                 # Compat:<=7.5.0
-                title = suite_identity.get(KEY_TITLE)
-            if title is None:
-                print indent + bold("(description and state totals withheld)")
+                meta_items = {
+                    "title": suite_identity.get(KEY_TITLE),
+                    "description": suite_identity.get(KEY_DESCRIPTION)
+                }
+
+            # Deal with the title first for case of just withheld statement
+            if not meta_items["title"]:
+                print indent + bold("(description and state totals "
+                                    "withheld)")
                 continue
-            print indent + bold("Title:")
-            if title == "":
-                line = "(no title)"
             else:
-                line = '"%s"' % title
-            print indent * 2 + line
-
-            try:
-                description = suite_identity[KEY_META].get(KEY_DESCRIPTION)
-            except KeyError:
-                # Compat:<=7.5.0
-                description = suite_identity.get(KEY_DESCRIPTION)
-            print indent + bold("Description:")
-            if description == "":
-                lines = "(no description)"
-            else:
-                lines = '"%s"' % description
-            line1 = True
-            for line in lines.split('\n'):
-                line = line.lstrip()
-                if not line1:
-                    # Indent under the double quote.
-                    line = " " + line
-                line1 = False
-                print indent * 2 + line
+                print (indent + bold("Title:\n") + indent * 2 +
+                       '"%s"' % meta_items["title"])
+                for metaitem in meta_items.keys():
+                    if metaitem != "title":
+                        if metaitem == "description" or metaitem == "group":
+                            print indent + bold(metaitem.capitalize() + ":")
+                        else:
+                            print indent + bold(metaitem + ":")
+                        if not meta_items[metaitem]:
+                            lines = "(no %s)" % metaitem
+                        else:
+                            lines = '"%s"' % meta_items[metaitem]
+                        line1 = True
+                        for line in lines.split('\n'):
+                            line = line.lstrip()
+                            if not line1:
+                                # Indent under the double quote.
+                                line = " " + line
+                            line1 = False
+                            print indent * 2 + line
 
         totals = suite_identity.get(KEY_STATES)
+
         if options.print_totals:
             if totals is None:
                 print indent + bold("(state totals withheld)")

tests/authentication/01-description.t

@@ -48,6 +48,10 @@ cmp_ok 'scan.out' <<__END__
 ${SUITE_NAME} ${USER}@${HOST}:${PORT}
    Title:
       "Authentication test suite."
+   URL:
+      (no URL)
+   Group:
+      (no group)
    Description:
       "Stalls when the first task fails."
    (state totals withheld)

tests/authentication/02-state-totals.t

@@ -48,6 +48,10 @@ cmp_ok 'scan.out' <<__END__
 ${SUITE_NAME} ${USER}@${HOST}:${PORT}
    Title:
       "Authentication test suite."
+   URL:
+      (no URL)
+   Group:
+      (no group)
    Description:
       "Stalls when the first task fails."
    Task state totals:

tests/authentication/03-full-read.t

@@ -48,6 +48,10 @@ cmp_ok 'scan.out' <<__END__
 ${SUITE_NAME} ${USER}@${HOST}:${PORT}
    Title:
       "Authentication test suite."
+   URL:
+      (no URL)
+   Group:
+      (no group)
    Description:
       "Stalls when the first task fails."
    Task state totals:

tests/authentication/04-shutdown.t

@@ -47,6 +47,10 @@ cmp_ok 'scan.out' <<__END__
 ${SUITE_NAME} ${USER}@${HOST}:${PORT}
    Title:
       "Authentication test suite."
+   URL:
+      (no URL)
+   Group:
+      (no group)
    Description:
       "Stalls when the first task fails."
    Task state totals:

tests/authentication/05-full-control.t

@@ -46,6 +46,10 @@ cmp_ok 'scan.out' <<__END__
 ${SUITE_NAME} ${USER}@${HOST}:${PORT}
    Title:
       "Authentication test suite."
+   URL:
+      (no URL)
+   Group:
+      (no group)
    Description:
       "Stalls when the first task fails."
    Task state totals:

tests/authentication/06-suite-override.t

@@ -48,6 +48,10 @@ cmp_ok 'scan.out' <<__END__
 ${SUITE_NAME} ${USER}@${HOST}:${PORT}
    Title:
       "Authentication test suite."
+   URL:
+      (no URL)
+   Group:
+      (no group)
    Description:
       "Stalls when the first task fails.
        Suite overrides global authentication settings."

tests/authentication/07-sha-hash.t

@@ -49,6 +49,10 @@ cmp_ok 'scan.out' <<__END__
 ${SUITE_NAME} ${USER}@${HOST}:${PORT}
    Title:
       "Authentication test suite."
+   URL:
+      (no URL)
+   Group:
+      (no group)
    Description:
       "Stalls when the first task fails."
    Task state totals:

tests/cylc-scan/00-simple.t

@@ -18,15 +18,50 @@
 # Test cylc scan is picking up running suite
 . $(dirname $0)/test_header
 #-------------------------------------------------------------------------------
-set_test_number 2
+set_test_number 6
 create_test_globalrc
+host_port_ref () {
+  SUITE=$1
+  FQDN=$(python -c "import sys
+sys.path.insert(0, '$CYLC_HOME')
+import cylc.hostuserutil
+print cylc.hostuserutil.get_fqdn_by_host('`hostname`')")
+  PORT=$(sed -n 's/CYLC_SUITE_PORT=//p' \
+    "${HOME}/cylc-run/${SUITE}/.service/contact")
+  echo "$SUITE `whoami`@$FQDN:$PORT"
+}
 #-------------------------------------------------------------------------------
-install_suite $TEST_NAME_BASE simple
+install_suite $TEST_NAME_BASE ctb-cylc-scan-simple
 #-------------------------------------------------------------------------------
 TEST_NAME=$TEST_NAME_BASE-validate
 run_ok $TEST_NAME cylc validate $SUITE_NAME
 #-------------------------------------------------------------------------------
 TEST_NAME=$TEST_NAME_BASE-run
-suite_run_ok $TEST_NAME cylc run --reference-test --debug --no-detach $SUITE_NAME
+run_ok $TEST_NAME cylc run $SUITE_NAME --hold
+SCAN_LINE=$(host_port_ref "${SUITE_NAME}")
 #-------------------------------------------------------------------------------
+TEST_NAME=$TEST_NAME_BASE-basic
+run_ok $TEST_NAME cylc scan --no-bold -n "$SUITE_NAME"
+cmp_ok "$TEST_NAME.stdout" <<<${SCAN_LINE}
+#-------------------------------------------------------------------------------
+TEST_NAME=$TEST_NAME_BASE-describe
+run_ok $TEST_NAME cylc scan --no-bold --describe -n "$SUITE_NAME"
+cmp_ok "$TEST_NAME.stdout" <<__SHOW_OUTPUT__
+${SCAN_LINE}
+   Title:
+      "A simple test"
+   Group:
+      (no group)
+   Description:
+      "A simple test to simply test whether cylc scan is
+       doing the right thing - let's see what happens."
+   URL:
+      (no URL)
+   datum:
+      "metadatum"
+   another_datum:
+      "another_metadatum"
+__SHOW_OUTPUT__
+#-------------------------------------------------------------------------------
+cylc stop $SUITE_NAME --now
 purge_suite $SUITE_NAME

tests/cylc-scan/ctb-cylc-scan-simple/suite.rc

@@ -0,0 +1,18 @@
+[meta]
+    title = A simple test
+    description = """A simple test to simply test whether cylc scan is
+                     doing the right thing - let's see what happens."""
+    datum = metadatum
+    another_datum = another_metadatum
+
+[cylc]
+    [[reference test]]
+        required run mode = live
+        live mode suite timeout = PT1M
+[scheduling]
+    [[dependencies]]
+        graph = "foo"
+[runtime]
+    [[foo]]
+    [[bar]]
+    [[baz]]