Put suite metadata items in a meta section #2387

challurip · 2017-08-10T00:19:44Z

meta section of suite contains title, description, URL and other user-defined items about suite.

Modified tests which may get affected

Deprecated suite items

hjoliver · 2017-08-10T00:43:36Z

(Not essential for next release, but this goes nicely with the runtime [meta] change).

hjoliver · 2017-08-10T04:45:35Z

@challurip - I've put up a PR to your branch to fix the scan tests.

hjoliver · 2017-08-10T10:16:00Z

@challurip - another merge from master should make the authentication tests pass on Travis CI now.

hjoliver

Looks good, tests all passing now. One more thing would be nice: could you modify tests/events/20-suite-event-handlers to test that a custom metadata item such as suite-priority = HIGH or similar, can be passed to an event handler as expected?

hjoliver · 2017-08-14T01:59:34Z

lib/cylc/suite_srv_files_mgr.py

@@ -540,7 +540,6 @@ def _get_suite_title(self, reg):
            match = re.match('^\s*title\s*=\s*(.*)\s*$', line)
            if match:
                title = match.groups()[0].strip('"\'')
-                break


Did you mean to delete this line?

Yes. It was not there before, and I'm not sure if I can break once the match is found ( as if title is matched then there is no need to continuing and matching other lines, but was not sure if that affects anything else so removed)

hjoliver

nice

hjoliver · 2017-08-15T00:56:30Z

@oliver-sanders - can you review or re-assign, while Matt is away?

hjoliver

Re-reviewing! @challurip - could you please:

merge my new small pull request to your branch
update the suite.rc reference in the user guide for these meta items
and finally, we should make all suite meta items available to task event handlers, as %(suite_ITEM)s as we do already for suite URL (and update documentation accordingly). So in task event handlers, we would allow suite_URL, as well as the backward compat suite_url

oliver-sanders

Nearly there! Some minor comments:

oliver-sanders · 2017-08-21T08:38:08Z

lib/cylc/task_events_mgr.py

+                        if key == "URL":
+                            handler_data["suite_url"] = quote(value)
+                        else:
+                            handler_data["suite_"+key] = quote(value)


Should this statement be outside the else so that the suite_url is accessible as suite_URL?

oliver-sanders · 2017-08-21T08:40:04Z

doc/src/cylc-user-guide/suiterc.tex

@@ -1624,12 +1624,18 @@ \subsection{[runtime]}
    \item \%(message)s: event message, if any
 \end{myitemize}

-Can also include the patterns from [[[meta]]] section of the task, for example:
+Can include the patterns from [[[meta]]] section of the task, for example:


The template can also include the patterns ...

oliver-sanders · 2017-08-21T08:41:20Z

doc/src/cylc-user-guide/suiterc.tex

 \begin{myitemize}
    \item \%(importance)s: task priority
    \item \%(color)s: task color
 \end{myitemize}

+Also able to include patterns from [meta] section of the suite, for example:


Patterns from the [meta] section of the suite can also be used, for example:

oliver-sanders · 2017-08-21T09:01:07Z

doc/src/cylc-user-guide/suiterc.tex

@@ -315,6 +342,12 @@ \subsection{[cylc]}
    \item \%(message)s: event message, if any
 \end{myitemize}

+Can also include the patterns from [meta] section of the suite, for example:


It can also include ...

... from the [meta] section...

hjoliver

Just a few minor doc changes.

hjoliver · 2017-08-21T22:00:59Z

doc/src/cylc-user-guide/suiterc.tex

+Section containing metadata items for this suite. Several items
+(title, description, URL) are pre-defined and are used by the GUI. Others can be 
+user-defined and passed to suite event handlers to be interpreted according to your 
+needs. For example, the value of an "suite-priority" item could determine how an event 


'a "suite-priorty" item' (not 'an')

Note also text quotes in LaTeX are `` (two left single quotes) then '' (two right single quotes)

hjoliver · 2017-08-21T22:03:04Z

doc/src/cylc-user-guide/suiterc.tex

+
+\subsubsection[title]{ [meta] \textrightarrow title}
+
+A single line description of the suite. It is displayed in the db viewer


Not your fault, but "db viewer" is long outdated. Can you change that to 'displayed in the GUI "Open Another Suite" window'.

hjoliver · 2017-08-21T22:04:20Z

doc/src/cylc-user-guide/suiterc.tex

-window and can be used as a way of grouping related suites together.
-\lstinline=cylc show= command.
+A multi-line description of the suite. It can be retrieved by the db viewer
+right-click menu, or at run time with the \lstinline=cylc show= command.


(as above) just write "It can be retrieved at run time with the cylc show command".

hjoliver · 2017-08-21T22:05:11Z

doc/src/cylc-user-guide/suiterc.tex

@@ -315,6 +342,12 @@ \subsection{[cylc]}
    \item \%(message)s: event message, if any
 \end{myitemize}

+Can also include the patterns from [meta] section of the suite, for example:


... from the [meta] section...

hjoliver · 2017-08-21T22:10:19Z

I've also noticed the section level of the task (not suite) meta items isn't right - if you look at the side bar in a PDF viewer, [[[meta]]] should collapse and expand like [[[job]]] etc.

hjoliver · 2017-08-21T22:21:06Z

And finally, can you document - under the runtime meta section heading - that any suite meta item can now be passed to task event handlers by prefixing the string template item name with "suite_", e.g.:

   [[[events]]]
        failed handler = send-help.sh %(suite_title)s %(suite_importance)s %(title)s ...

hjoliver · 2017-08-21T23:15:55Z

And finally_2: there a bunch of example suites in the User Guide (cug.tex) that need title etc. put under the new meta section.

hjoliver

A few more doc changes, sorry!

hjoliver · 2017-08-22T08:05:46Z

doc/src/cylc-user-guide/suiterc.tex

+    [[root]]
+        [[[events]]]
+            failed handler = send-help.sh %(suite\_title)s %(suite\_importance)s %(title)s
+\end{lstlisting}


Underscores shouldn't be escaped with \ inside the lstlisting environment (the backslashes get printed here).

hjoliver · 2017-08-22T08:09:40Z

doc/src/cylc-user-guide/suiterc.tex

+\subsection[\_\_MANY\_\_]{ [meta] \textrightarrow \_\_MANY\_\_}
+
+Replace \_\_MANY\_\_ with any user-defined metadata item. These, like title, URL, etc. can be passed
+to suite event handlers to be interpreted according to your needs. For example, "suite-priority".


Another quoting error ("..." should be ``...'')

hjoliver · 2017-08-22T08:10:08Z

doc/src/cylc-user-guide/suiterc.tex

@@ -1234,7 +1267,17 @@ \subsection{[runtime]}
 needs. For example, the value of an "importance" item could determine how an event 


quotes again here

hjoliver · 2017-08-22T08:11:50Z

doc/src/cylc-user-guide/suiterc.tex

@@ -59,6 +70,22 @@ \subsubsection{URL} \label{SuiteURL}
 \item {\em example:} \lstinline=http://suites/${CYLC_SUITE_NAME}/index.html=
 \end{myitemize}

+\subsection[\_\_MANY\_\_]{ [meta] \textrightarrow \_\_MANY\_\_}


This should be a subsubsection, to collapse/expand into the meta section.

challurip added 5 commits August 9, 2017 22:02

Modified code to generalise suite details under meta section

34146a7

Modified tests which may get affected

Modified to remove pep8 errors

e0f958d

Merge branch 'master' of https://github.com/cylc/cylc into suite-meta

871b3f3

To pass event tests

3eae93b

Deprecated suite items

pep8 errors

e15f67f

hjoliver added this to the next release milestone Aug 10, 2017

hjoliver assigned challurip Aug 10, 2017

pep8 errors and registration test to pass

420f5ec

hjoliver self-requested a review August 10, 2017 04:42

Merge branch 'master' of https://github.com/cylc/cylc into suite-meta

d0f4d44

hjoliver requested changes Aug 13, 2017

View reviewed changes

tests for suite meta

285165d

challurip force-pushed the suite-meta branch from a23be36 to 285165d Compare August 14, 2017 01:13

cylc scan fix

0a40240

hjoliver reviewed Aug 14, 2017

View reviewed changes

fix tests

cf0b8f5

hjoliver approved these changes Aug 15, 2017

View reviewed changes

hjoliver requested a review from oliver-sanders August 15, 2017 00:56

hjoliver changed the title ~~General items of suite are now in meta section~~ Put suite metadata items in a meta section Aug 15, 2017

hjoliver requested changes Aug 15, 2017

View reviewed changes

suite meta doc

646b96e

challurip force-pushed the suite-meta branch from ff3187a to 646b96e Compare August 15, 2017 21:17

challurip added 3 commits August 18, 2017 01:25

allow plain URL

afc9b4b

get suite meta items in task event handler

deb5845

pep8 errors

9d8d38a

oliver-sanders reviewed Aug 21, 2017

View reviewed changes

hjoliver requested changes Aug 21, 2017

View reviewed changes

minor changes in documentation

1d47e8d

hjoliver requested changes Aug 22, 2017

View reviewed changes

minor changes in doc

27fc52a

hjoliver approved these changes Aug 23, 2017

View reviewed changes

oliver-sanders approved these changes Aug 24, 2017

View reviewed changes

oliver-sanders merged commit a310f7a into cylc:master Aug 24, 2017

oliver-sanders mentioned this pull request Sep 18, 2017

Consolidation of suite metadata metomi/rose#2056

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Put suite metadata items in a meta section #2387

Put suite metadata items in a meta section #2387

challurip commented Aug 10, 2017

hjoliver commented Aug 10, 2017 •

edited

Loading

hjoliver commented Aug 10, 2017

hjoliver commented Aug 10, 2017

hjoliver left a comment

hjoliver Aug 14, 2017

challurip Aug 14, 2017

hjoliver left a comment

hjoliver commented Aug 15, 2017

hjoliver left a comment •

edited

Loading

oliver-sanders left a comment

oliver-sanders Aug 21, 2017

oliver-sanders Aug 21, 2017

oliver-sanders Aug 21, 2017

oliver-sanders Aug 21, 2017

hjoliver Aug 21, 2017

hjoliver left a comment

hjoliver Aug 21, 2017

hjoliver Aug 21, 2017

hjoliver Aug 21, 2017

hjoliver Aug 21, 2017

hjoliver Aug 21, 2017

hjoliver commented Aug 21, 2017

hjoliver commented Aug 21, 2017

hjoliver commented Aug 21, 2017

hjoliver left a comment

hjoliver Aug 22, 2017

hjoliver Aug 22, 2017

hjoliver Aug 22, 2017

hjoliver Aug 22, 2017


		\subsubsection[title]{ [meta] \textrightarrow title}

		A single line description of the suite. It is displayed in the db viewer

		@@ -1234,7 +1267,17 @@ \subsection{[runtime]}
		needs. For example, the value of an "importance" item could determine how an event

Put suite metadata items in a meta section #2387

Put suite metadata items in a meta section #2387

Conversation

challurip commented Aug 10, 2017

hjoliver commented Aug 10, 2017 • edited Loading

hjoliver commented Aug 10, 2017

hjoliver commented Aug 10, 2017

hjoliver left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hjoliver left a comment

Choose a reason for hiding this comment

hjoliver commented Aug 15, 2017

hjoliver left a comment • edited Loading

Choose a reason for hiding this comment

oliver-sanders left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hjoliver left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hjoliver commented Aug 21, 2017

hjoliver commented Aug 21, 2017

hjoliver commented Aug 21, 2017

hjoliver left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hjoliver commented Aug 10, 2017 •

edited

Loading

hjoliver left a comment •

edited

Loading