From jira at ovirt-jira.atlassian.net Sun Oct 15 08:17:07 2017 Content-Type: multipart/mixed; boundary="===============4826749196457498230==" MIME-Version: 1.0 From: eyal edri (oVirt JIRA) To: infra at ovirt.org Subject: [JIRA] (OVIRT-1689) Improve error messages Date: Sun, 15 Oct 2017 08:17:06 +0000 Message-ID: In-Reply-To: JIRA.33215.1507457201000@Atlassian.JIRA --===============4826749196457498230== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable This is a multi-part message in MIME format... ------------=3D_1508055425-13372-146 Content-Type: text/plain; charset=3DUTF-8 Content-Transfer-Encoding: 7bit [ https://ovirt-jira.atlassian.net/browse/OVIRT-1689?page=3Dcom.atlassi= an.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=3D35= 134#comment-35134 ] = eyal edri commented on OVIRT-1689: ---------------------------------- Can you improve the title and description? its not clear which errors messa= ges you're referring to. > Improve error messages = > ----------------------- > > 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 speci= fications 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 qu= oted for clarity. > * Edge cases like for example an existing but empty secrets file and a mi= ssing 'secrets_data' key need to be handled better, with clear error messag= es > * 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 tr= ying to use 'mock_runner.sh' for the 'jenkins' repo for example. -- This message was sent by Atlassian Jira (v1001.0.0-SNAPSHOT#100065) ------------=3D_1508055425-13372-146 Content-Type: text/html; charset=3D"UTF-8" Content-Disposition: inline Content-Transfer-Encoding: 7bit
[ https://ovirt-jira.atlassian.net/browse/OVIRT-1689?page=3Dcom.atlass=
ian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=
=3D35134#comment-35134 ]

eyal edri commented on OVIRT-1689:

Can you improve the title and description? its not clear which errors me= ssages you're referring to.

Improve error messages

     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 cle= ar error messages

  • Error message when a requested env var is missing needs to be improv= ed to tell the user what to do. Current message can be very confusing when = trying to use ‘mock_runner.sh’ for the ‘jenkins’ re= po for example.

— This message was sent by Atlassian Jira (v1001.0.0-SNAPSHOT#1000= 65)

3D"" ------------=3D_1508055425-13372-146-- --===============4826749196457498230== Content-Type: multipart/alternative MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="attachment.bin" VGhpcyBpcyBhIG11bHRpLXBhcnQgbWVzc2FnZSBpbiBNSU1FIGZvcm1hdC4uLgoKLS0tLS0tLS0t LS0tPV8xNTA4MDU1NDI1LTEzMzcyLTE0NgpDb250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJz ZXQ9VVRGLTgKQ29udGVudC1UcmFuc2Zlci1FbmNvZGluZzogN2JpdAoKCiAgICBbIGh0dHBzOi8v b3ZpcnQtamlyYS5hdGxhc3NpYW4ubmV0L2Jyb3dzZS9PVklSVC0xNjg5P3BhZ2U9Y29tLmF0bGFz c2lhbi5qaXJhLnBsdWdpbi5zeXN0ZW0uaXNzdWV0YWJwYW5lbHM6Y29tbWVudC10YWJwYW5lbCZm b2N1c2VkQ29tbWVudElkPTM1MTM0I2NvbW1lbnQtMzUxMzQgXSAKCmV5YWwgZWRyaSBjb21tZW50 ZWQgb24gT1ZJUlQtMTY4OToKLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLQoKQ2Fu IHlvdSBpbXByb3ZlIHRoZSB0aXRsZSBhbmQgZGVzY3JpcHRpb24/IGl0cyBub3QgY2xlYXIgd2hp Y2ggZXJyb3JzIG1lc3NhZ2VzIHlvdSdyZSByZWZlcnJpbmcgdG8uCgo+IEltcHJvdmUgZXJyb3Ig bWVzc2FnZXMgCj4gLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0KPgo+ICAgICAgICAgICAgICAgICBL ZXk6IE9WSVJULTE2ODkKPiAgICAgICAgICAgICAgICAgVVJMOiBodHRwczovL292aXJ0LWppcmEu YXRsYXNzaWFuLm5ldC9icm93c2UvT1ZJUlQtMTY4OQo+ICAgICAgICAgICAgIFByb2plY3Q6IG9W aXJ0IC0gdmlydHVhbGl6YXRpb24gbWFkZSBlYXN5Cj4gICAgICAgICAgSXNzdWUgVHlwZTogSW1w cm92ZW1lbnQKPiAgICAgICAgICBDb21wb25lbnRzOiBvVmlydCBDSQo+ICAgICAgICAgICAgUmVw b3J0ZXI6IERhbmllbCBCZWxlbmt5Cj4gICAgICAgICAgICBBc3NpZ25lZTogaW5mcmEKPgo+ICog QWxsIHJlZmVyZW5jZXMgdG8gdGhpbmdzIGxpa2UgJ3hkZy1ob21lJyBuZWVkIHRvIGJlIHJlcGxh Y2VkIHdpdGggc3BlY2lmaWNhdGlvbnMgb2YgYWN0dWFsIHBhdGhzLCBhcyB1c2VycyBhcmUgbm90 IGV4cGVjdGVkIHRvIGtub3cgd2hhdCBYREcgaXMuCj4gKiBBY2N1cmF0ZSBpbmRpY2F0aW9uIG9m IHdoYXQgaXMgbWlzc2luZyBmcm9tIHdoaWNoIGZpbGUgYW5kIHdoYXQgY2FuIGJlIGRvbmUgdG8g Zml4IGl0IG5lZWQgdG8gYmUgZ2l2ZW4gaW4gYWxsIGVycm9yIG1lc3NhZ2VzLgo+ICogV2hlbiB2 YXJpYWJsZS9rZXkgbmFtZXMgYXJlIGdpdmVuIGluIGVycm9yIG1lc3NhZ2VzLCB0aGV5IG5lZWQg dG8gYmUgcXVvdGVkIGZvciBjbGFyaXR5Lgo+ICogRWRnZSBjYXNlcyBsaWtlIGZvciBleGFtcGxl IGFuIGV4aXN0aW5nIGJ1dCBlbXB0eSBzZWNyZXRzIGZpbGUgYW5kIGEgbWlzc2luZyAnc2VjcmV0 c19kYXRhJyBrZXkgbmVlZCB0byBiZSBoYW5kbGVkIGJldHRlciwgd2l0aCBjbGVhciBlcnJvciBt ZXNzYWdlcwo+ICogIEVycm9yIG1lc3NhZ2Ugd2hlbiBhIHJlcXVlc3RlZCBlbnYgdmFyIGlzIG1p c3NpbmcgbmVlZHMgdG8gYmUgaW1wcm92ZWQgdG8gdGVsbCB0aGUgdXNlciB3aGF0IHRvIGRvLiBD dXJyZW50IG1lc3NhZ2UgY2FuIGJlIHZlcnkgY29uZnVzaW5nIHdoZW4gdHJ5aW5nIHRvIHVzZSAn bW9ja19ydW5uZXIuc2gnIGZvciB0aGUgJ2plbmtpbnMnIHJlcG8gZm9yIGV4YW1wbGUuCgoKCi0t ClRoaXMgbWVzc2FnZSB3YXMgc2VudCBieSBBdGxhc3NpYW4gSmlyYQoodjEwMDEuMC4wLVNOQVBT SE9UIzEwMDA2NSkKCi0tLS0tLS0tLS0tLT1fMTUwODA1NTQyNS0xMzM3Mi0xNDYKQ29udGVudC1U eXBlOiB0ZXh0L2h0bWw7IGNoYXJzZXQ9IlVURi04IgpDb250ZW50LURpc3Bvc2l0aW9uOiBpbmxp bmUKQ29udGVudC1UcmFuc2Zlci1FbmNvZGluZzogN2JpdAoKPGh0bWw+PGJvZHk+CjxwcmU+WyBo dHRwczovL292aXJ0LWppcmEuYXRsYXNzaWFuLm5ldC9icm93c2UvT1ZJUlQtMTY4OT9wYWdlPWNv bS5hdGxhc3NpYW4uamlyYS5wbHVnaW4uc3lzdGVtLmlzc3VldGFicGFuZWxzOmNvbW1lbnQtdGFi cGFuZWwmYW1wO2ZvY3VzZWRDb21tZW50SWQ9MzUxMzQjY29tbWVudC0zNTEzNCBdPC9wcmU+Cjxo Mz5leWFsIGVkcmkgY29tbWVudGVkIG9uIE9WSVJULTE2ODk6PC9oMz4KPHA+Q2FuIHlvdSBpbXBy b3ZlIHRoZSB0aXRsZSBhbmQgZGVzY3JpcHRpb24/IGl0cyBub3QgY2xlYXIgd2hpY2ggZXJyb3Jz IG1lc3NhZ2VzIHlvdSdyZSByZWZlcnJpbmcgdG8uPC9wPgo8YmxvY2txdW90ZT48aDM+SW1wcm92 ZSBlcnJvciBtZXNzYWdlczwvaDM+CjxwcmU+ICAgICBLZXk6IE9WSVJULTE2ODkKICAgICBVUkw6 IGh0dHBzOi8vb3ZpcnQtamlyYS5hdGxhc3NpYW4ubmV0L2Jyb3dzZS9PVklSVC0xNjg5CiBQcm9q ZWN0OiBvVmlydCAtIHZpcnR1YWxpemF0aW9uIG1hZGUgZWFzeQogICAgICAgICBJc3N1ZSBUeXBl OiBJbXByb3ZlbWVudAogICAgICAgICBDb21wb25lbnRzOiBvVmlydCBDSQpSZXBvcnRlcjogRGFu aWVsIEJlbGVua3kKQXNzaWduZWU6IGluZnJhPC9wcmU+Cjx1bD48bGk+PHA+QWxsIHJlZmVyZW5j ZXMgdG8gdGhpbmdzIGxpa2UgJmxzcXVvO3hkZy1ob21lJnJzcXVvOyBuZWVkIHRvIGJlIHJlcGxh Y2VkIHdpdGggc3BlY2lmaWNhdGlvbnMgb2YgYWN0dWFsIHBhdGhzLCBhcyB1c2VycyBhcmUgbm90 IGV4cGVjdGVkIHRvIGtub3cgd2hhdCBYREcgaXMuPC9wPjwvbGk+CjxsaT48cD5BY2N1cmF0ZSBp bmRpY2F0aW9uIG9mIHdoYXQgaXMgbWlzc2luZyBmcm9tIHdoaWNoIGZpbGUgYW5kIHdoYXQgY2Fu IGJlIGRvbmUgdG8gZml4IGl0IG5lZWQgdG8gYmUgZ2l2ZW4gaW4gYWxsIGVycm9yIG1lc3NhZ2Vz LjwvcD48L2xpPgo8bGk+PHA+V2hlbiB2YXJpYWJsZS9rZXkgbmFtZXMgYXJlIGdpdmVuIGluIGVy cm9yIG1lc3NhZ2VzLCB0aGV5IG5lZWQgdG8gYmUgcXVvdGVkIGZvciBjbGFyaXR5LjwvcD48L2xp Pgo8bGk+PHA+RWRnZSBjYXNlcyBsaWtlIGZvciBleGFtcGxlIGFuIGV4aXN0aW5nIGJ1dCBlbXB0 eSBzZWNyZXRzIGZpbGUgYW5kIGEgbWlzc2luZyAmbHNxdW87c2VjcmV0c19kYXRhJnJzcXVvOyBr ZXkgbmVlZCB0byBiZSBoYW5kbGVkIGJldHRlciwgd2l0aCBjbGVhciBlcnJvciBtZXNzYWdlczwv cD48L2xpPgo8bGk+PHA+RXJyb3IgbWVzc2FnZSB3aGVuIGEgcmVxdWVzdGVkIGVudiB2YXIgaXMg bWlzc2luZyBuZWVkcyB0byBiZSBpbXByb3ZlZCB0byB0ZWxsIHRoZSB1c2VyIHdoYXQgdG8gZG8u IEN1cnJlbnQgbWVzc2FnZSBjYW4gYmUgdmVyeSBjb25mdXNpbmcgd2hlbiB0cnlpbmcgdG8gdXNl ICZsc3F1bzttb2NrX3J1bm5lci5zaCZyc3F1bzsgZm9yIHRoZSAmbHNxdW87amVua2lucyZyc3F1 bzsgcmVwbyBmb3IgZXhhbXBsZS48L3A+PC9saT48L3VsPjwvYmxvY2txdW90ZT4KPHA+Jm1kYXNo OyBUaGlzIG1lc3NhZ2Ugd2FzIHNlbnQgYnkgQXRsYXNzaWFuIEppcmEgKHYxMDAxLjAuMC1TTkFQ U0hPVCMxMDAwNjUpPC9wPgoKPGltZyBzcmM9Imh0dHBzOi8vdTQwNDM0MDIuY3Quc2VuZGdyaWQu bmV0L3dmL29wZW4/dXBuPWk1VE1XR1Y5OWFtSmJOeEpwU3AyLTJCQ21wWUx5ellTM3IxUTkzOVQy c2d6M0Y1MXFRV0tzd1VZSllRLTJCSjRIOWlZdHJDUXRwOEVYcmh3bWduR081M3M2TXc2ci0yQnJV TjRPSDAtMkZtcXhnLTJGVXJrQ2Y2RGNkeVV3YjVadWQ2eFlzbGItMkJsbm83NzN5MkItMkZudlFr N3drYVAtMkY2TjZ1d1YtMkJMUEo4UmJNR2JSY0kwb3VaMzVPWU5iQlAzU0Q2WTFVSkEtMkI4MU9r aVFKakwybTVRSUcwY2EwcGpsdGVrQ2FPRVFVdlg4NDFEMGI1Vlh1NGVCQS0zRCIgYWx0PSIiIHdp ZHRoPSIxIiBoZWlnaHQ9IjEiIGJvcmRlcj0iMCIgc3R5bGU9ImhlaWdodDoxcHggIWltcG9ydGFu dDt3aWR0aDoxcHggIWltcG9ydGFudDtib3JkZXItd2lkdGg6MCAhaW1wb3J0YW50O21hcmdpbi10 b3A6MCAhaW1wb3J0YW50O21hcmdpbi1ib3R0b206MCAhaW1wb3J0YW50O21hcmdpbi1yaWdodDow ICFpbXBvcnRhbnQ7bWFyZ2luLWxlZnQ6MCAhaW1wb3J0YW50O3BhZGRpbmctdG9wOjAgIWltcG9y dGFudDtwYWRkaW5nLWJvdHRvbTowICFpbXBvcnRhbnQ7cGFkZGluZy1yaWdodDowICFpbXBvcnRh bnQ7cGFkZGluZy1sZWZ0OjAgIWltcG9ydGFudDsiLz4KPC9ib2R5PjwvaHRtbD4KCi0tLS0tLS0t LS0tLT1fMTUwODA1NTQyNS0xMzM3Mi0xNDYtLQo= --===============4826749196457498230==--