Enhabce oVirt provider create, view/edit credentials help text fields #785

sgratch · 2023-11-21T15:57:25Z

Reference: #646

Rephrase all oVirt fields help text messages and add hints for the following dialogs:

Create oVirt provider,
oVirt Credentials view/edit modes.

The main changes include:

Rephrase help text messages for user, password, insecureSkipVerify, cacert fields (name and url fields were already rephrased in separate PRs)
Support 'warning' validation state for the 'user' field.
Add help text tooltips for insecureSkipVerify, cacert fields.

This fix assumes that leaving the 'cacert' field empty, will trigger verifying the the system CA certificates.

Screenshots

Create

View Credentials

Edit Credentials

yaacov · 2023-11-21T16:05:02Z

can you add a little space above the blue hint box ?

sgratch · 2023-11-21T17:06:41Z

can you add a little space above the blue hint box ?

@yaacov Done, please check the new screenshot added to the description comment

sgratch · 2023-11-21T17:15:14Z

cc:// @RichardHoch @anarnold97
Please review text changes

sgratch · 2023-11-21T17:28:16Z

This fix assumes that leaving the 'cacert' field empty, will trigger verifying the the system CA certificates.

@ahadas
Do we still support the combination of unchecking the 'skip cert validation' and leaving the oVirt provider's CA field empty for retrieving the system engine CA certificate by the webhook?

Based on https://redhat-internal.slack.com/archives/C049WBVTRD2/p1694592350447549?thread_ts=1694517736.539569&cid=C049WBVTRD2, there was an issue with that. It's currently not working for me as well. What is the status of this?

@RichardHoch
If above issue is still supported and should work then we need to document it as well since currently this option is not mentioned for the oVirt provider.

yaacov · 2023-11-27T12:27:03Z

...oviders/views/details/components/CredentialsSection/components/edit/OvirtCredentialsEdit.tsx

+        <Hint>
+          <HintBody>
+            {cacertHelperTextMsgs.hint}
+            <Button


please move the button inside the hint msg

For supporting a href link, I can't add the link text into the text message, but rather just replace Button with ExternalLink and wrap both with the Trans component.
The text message split is still required, please see the fix.

...oviders/views/details/components/CredentialsSection/components/edit/OvirtCredentialsEdit.tsx

...oviders/views/details/components/CredentialsSection/components/list/OvirtCredentialsList.tsx

ahadas · 2023-11-28T07:39:44Z

This fix assumes that leaving the 'cacert' field empty, will trigger verifying the the system CA certificates.

@ahadas Do we still support the combination of unchecking the 'skip cert validation' and leaving the oVirt provider's CA field empty for retrieving the system engine CA certificate by the webhook?

Based on https://redhat-internal.slack.com/archives/C049WBVTRD2/p1694592350447549?thread_ts=1694517736.539569&cid=C049WBVTRD2, there was an issue with that. It's currently not working for me as well. What is the status of this?

it is supposed to work once the certificate is added to the system certification pool but we didn't test it

sonarqubecloud · 2023-11-28T12:34:51Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
2 Code Smells

No Coverage information
0.6% Duplication

yaacov · 2023-11-28T15:09:27Z

...oviders/views/details/components/CredentialsSection/components/edit/OvirtCredentialsEdit.tsx

+  const insecureSkipVerifyHelperTextMsgs = {
+    error: t('Error: this field must be set to a boolean value.'),
+    success: t("If true (check box is checked), the provider's CA certificate won't be validated."),
+    hint: t(


the hint is not a validation help message, e.g. success, warninig, error, it's a hint that is always the same, regardless of the validation state.
please create a new const for it.

The const name insecureSkipVerifyHelperTextMsgs doesn't include the word 'verify' so I see it as a collection of help text messages for this field and this specific hint is relevant for the insecureSkipVerify field only (explaining the enable/disable values).

But if you think that separating the help text based on component appearance is better then it's ok as well.

yes, the idea is that you can do insecureSkipVerifyHelperTextMsgs[ callVerificationMethod(text) ] in cases it makes sense, do the keys of the text array should be the same as the verification options.

yaacov · 2023-11-28T15:11:44Z

...oviders/views/details/components/CredentialsSection/components/edit/OvirtCredentialsEdit.tsx

+    hint: t(
+      'Note: enter the Manager CA certificate. unless it was replaced by a third-party certificate, in which case enter the Manager Apache CA certificate. You can retrieve the Manager CA certificate at: ',
+    ),
+    hintHyperReference:


the hint reference is part of the hint text, you can use to create one string that include the reference

<trans> some text <link> some link </link> </transe>

yaacov · 2023-11-28T15:12:54Z

...oviders/views/details/components/CredentialsSection/components/edit/OvirtCredentialsEdit.tsx

+      ) : (
+        <Hint>
+          <HintBody>
+            <Trans t={t} ns="plugin__forklift-console-plugin">


trans should include the text, this should look:
<HintBody>{hintBody}</HintBody>

yaacov · 2023-11-28T15:15:54Z

...oviders/views/details/components/CredentialsSection/components/list/OvirtCredentialsList.tsx

+      description: t(
+        "If true (check box is checked), the provider's CA certificate won't be validated.",
+      ),
+      hint: t(


hint is not specific to specific a field, hint is a form thing, please create a new const for the hint text, or just use it inline

yaacov · 2023-11-29T11:00:22Z

I see that mixing #646 for the help msgs and #541for the hints is not easy, lets separate the PR to one that do help msgs for the tasks in #646 and another for adding hints as required by #541, this way way we can focus better on each task

github-actions · 2023-12-30T02:07:22Z

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 15 days.

Reference: kubev2v#646 Rephrase all oVirt fields help text messages and add tooltips for the following dialogs: 1. Create oVirt provider, 2. oVirt Credentials view/edit modes. The main changes include: 1. Rephrase all help text messages. 2. Support 'warning' validation state for the 'user' field. 3. Add tooltips with a helpIcon for insecureSkipVerify, cacert fields. This fix assumes that leaving the 'cacert' field empty, will trigger verifying the the system CA certificates. Signed-off-by: Sharon Gratch <[email protected]>

sonarqubecloud · 2024-01-03T19:08:34Z

Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

2 New issues
0 Security Hotspots
No data about Coverage
0.4% Duplication on New Code

See analysis details on SonarCloud

sgratch · 2024-01-03T19:17:14Z

After having an offline discussion, it was decided to convert both hints into tooltips that will include relevant fields help text for now.

Reminder: It seems that that help text included relevant info for explaining how to use the fields, but since it's an extra info then tooltips seems preferable and less space expending.
We can discuss using hints in the separate 🐾 Add information Hint in the create provider form #541 issue.
This current fix addressed all comments mentioned above.
I also updated the main comment and screenshots with the changes

yaacov added this to the 2.6.0 milestone Nov 21, 2023

yaacov added the enhancement Categorizes issue or PR as related to a new feature. label Nov 21, 2023

sgratch force-pushed the enhance-ovirt-provider-help-text-fields branch 2 times, most recently from 7e73fdc to bbc98e2 Compare November 21, 2023 17:03

sgratch force-pushed the enhance-ovirt-provider-help-text-fields branch from bbc98e2 to b6663e8 Compare November 21, 2023 17:12

sgratch requested review from yaacov and rszwajko November 21, 2023 17:30

sgratch force-pushed the enhance-ovirt-provider-help-text-fields branch 4 times, most recently from 905051c to 533c808 Compare November 22, 2023 19:42

yaacov reviewed Nov 27, 2023

View reviewed changes

...oviders/views/details/components/CredentialsSection/components/edit/OvirtCredentialsEdit.tsx Outdated Show resolved Hide resolved

yaacov reviewed Nov 27, 2023

View reviewed changes

...oviders/views/details/components/CredentialsSection/components/list/OvirtCredentialsList.tsx Outdated Show resolved Hide resolved

sgratch force-pushed the enhance-ovirt-provider-help-text-fields branch 3 times, most recently from 9d02c05 to 9c05a4c Compare November 27, 2023 18:06

sgratch force-pushed the enhance-ovirt-provider-help-text-fields branch from 9c05a4c to 0c44e76 Compare November 28, 2023 12:34

sgratch requested a review from yaacov November 28, 2023 12:59

yaacov reviewed Nov 28, 2023

View reviewed changes

github-actions bot added the Stale label Dec 30, 2023

yaacov removed the Stale label Jan 2, 2024

sgratch force-pushed the enhance-ovirt-provider-help-text-fields branch from 0c44e76 to 549afeb Compare January 3, 2024 19:07

yaacov approved these changes Jan 3, 2024

View reviewed changes

yaacov merged commit 402ebac into kubev2v:main Jan 3, 2024
7 checks passed

sgratch deleted the enhance-ovirt-provider-help-text-fields branch January 3, 2024 19:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhabce oVirt provider create, view/edit credentials help text fields #785

Enhabce oVirt provider create, view/edit credentials help text fields #785

sgratch commented Nov 21, 2023 •

edited

Loading

yaacov commented Nov 21, 2023

sgratch commented Nov 21, 2023

sgratch commented Nov 21, 2023

sgratch commented Nov 21, 2023

yaacov Nov 27, 2023

sgratch Nov 28, 2023 •

edited

Loading

ahadas commented Nov 28, 2023

sonarqubecloud bot commented Nov 28, 2023

yaacov Nov 28, 2023

sgratch Nov 28, 2023 •

edited

Loading

yaacov Nov 29, 2023

yaacov Nov 28, 2023

yaacov Nov 28, 2023

yaacov Nov 28, 2023

yaacov commented Nov 29, 2023

github-actions bot commented Dec 30, 2023

sonarqubecloud bot commented Jan 3, 2024 •

edited

Loading

sgratch commented Jan 3, 2024

Enhabce oVirt provider create, view/edit credentials help text fields #785

Enhabce oVirt provider create, view/edit credentials help text fields #785

Conversation

sgratch commented Nov 21, 2023 • edited Loading

Screenshots

Create

View Credentials

Edit Credentials

yaacov commented Nov 21, 2023

sgratch commented Nov 21, 2023

sgratch commented Nov 21, 2023

sgratch commented Nov 21, 2023

yaacov Nov 27, 2023

Choose a reason for hiding this comment

sgratch Nov 28, 2023 • edited Loading

Choose a reason for hiding this comment

ahadas commented Nov 28, 2023

sonarqubecloud bot commented Nov 28, 2023

yaacov Nov 28, 2023

Choose a reason for hiding this comment

sgratch Nov 28, 2023 • edited Loading

Choose a reason for hiding this comment

yaacov Nov 29, 2023

Choose a reason for hiding this comment

yaacov Nov 28, 2023

Choose a reason for hiding this comment

yaacov Nov 28, 2023

Choose a reason for hiding this comment

yaacov Nov 28, 2023

Choose a reason for hiding this comment

yaacov commented Nov 29, 2023

github-actions bot commented Dec 30, 2023

sonarqubecloud bot commented Jan 3, 2024 • edited Loading

Quality Gate passed

sgratch commented Jan 3, 2024

sgratch commented Nov 21, 2023 •

edited

Loading

sgratch Nov 28, 2023 •

edited

Loading

sgratch Nov 28, 2023 •

edited

Loading

sonarqubecloud bot commented Jan 3, 2024 •

edited

Loading