[JIRA] (OVIRT-1689) Improve error messages in STDCI environment variable handling

24 Oct 2017


      This is a multi-part message in MIME format...

------------=_1508875170-18269-631
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit


     [ https://ovirt-jira.atlassian.net/browse/OVIRT-1689?page=com.atlassian.jira.p... ]

Barak Korren updated OVIRT-1689:
--------------------------------
    Summary: Improve error messages in STDCI environment variable handling  (was: Improve error messages )
...
Improve error messages in STDCI environment variable handling
-------------------------------------------------------------
Key: OVIRT-1689
                URL: https://ovirt-jira.atlassian.net/browse/OVIRT-1689
            Project: oVirt - virtualization made easy
         Issue Type: Improvement
         Components: oVirt CI
           Reporter: Daniel Belenky
           Assignee: infra
* All references to things like 'xdg-home' need to be replaced with specifications of actual paths, as users are not expected to know what XDG is.
* Accurate indication of what is missing from which file and what can be done to fix it need to be given in all error messages.
* When variable/key names are given in error messages, they need to be quoted for clarity.
* Edge cases like for example an existing but empty secrets file and a missing 'secrets_data' key need to be handled better, with clear error messages
*  Error message when a requested env var is missing needs to be improved to tell the user what to do. Current message can be very confusing when trying to use 'mock_runner.sh' for the 'jenkins' repo for example.
--
This message was sent by Atlassian Jira
(v1001.0.0-SNAPSHOT#100068)

------------=_1508875170-18269-631
Content-Type: text/html; charset="UTF-8"
Content-Disposition: inline
Content-Transfer-Encoding: 7bit

<html><body>
<pre>[ https://ovirt-jira.atlassian.net/browse/OVIRT-1689?page=com.atlassian.jira.p... ]</pre>
<h3>Barak Korren updated OVIRT-1689:</h3>
<pre>Summary: Improve error messages in STDCI environment variable handling  (was: Improve error messages )</pre>
<blockquote><h3>Improve error messages in STDCI environment variable handling</h3>
<pre>     Key: OVIRT-1689
     URL: https://ovirt-jira.atlassian.net/browse/OVIRT-1689
 Project: oVirt - virtualization made easy
         Issue Type: Improvement
         Components: oVirt CI
Reporter: Daniel Belenky
Assignee: infra</pre>
<ul><li><p>All references to things like ‘xdg-home’ need to be replaced with specifications of actual paths, as users are not expected to know what XDG is.</p></li>
<li><p>Accurate indication of what is missing from which file and what can be done to fix it need to be given in all error messages.</p></li>
<li><p>When variable/key names are given in error messages, they need to be quoted for clarity.</p></li>
<li><p>Edge cases like for example an existing but empty secrets file and a missing ‘secrets_data’ key need to be handled better, with clear error messages</p></li>
<li><p>Error message when a requested env var is missing needs to be improved to tell the user what to do. Current message can be very confusing when trying to use ‘mock_runner.sh’ for the ‘jenkins’ repo for example.</p></li></ul></blockquote>
<p>— This message was sent by Atlassian Jira (v1001.0.0-SNAPSHOT#100068)</p>

<img src="https://u4043402.ct.sendgrid.net/wf/open?upn=i5TMWGV99amJbNxJpSp2-2BCmpYLyzY..." alt="" width="1" height="1" border="0" style="height:1px !important;width:1px !important;border-width:0 !important;margin-top:0 !important;margin-bottom:0 !important;margin-right:0 !important;margin-left:0 !important;padding-top:0 !important;padding-bottom:0 !important;padding-right:0 !important;padding-left:0 !important;"/>
</body></html>

------------=_1508875170-18269-631--

Barak Korren (oVirt JIRA)

tags

participants (1)