luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

UI: remove references to comma separation for string array edit types (#20163) 

* remove intercepting helpText

* add subtext directly to StringList input component

* update tests and add coverage for new openapi-attrs util

* update test

* add warning validation to input

* lol is this right i dont know go

* literally no idea what im doing

* add Description to display attrs struct

* update struct comment

* add descriptions to remaining go fields

* add missing comma

* remaining commas..."

* add description to display attrs

* update tests

* update tests

* add changelog;

* Update ui/app/utils/openapi-to-attrs.js

* update tests following backend changes

* clearly name variable

* format files

* no longer need to test for modified tooltip since coming from backend now
This commit is contained in:
claire bontempo 2023-04-19 09:16:30 -07:00 committed by GitHub
parent d115fda4e0
commit 5f64520dac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
27 changed files with 183 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
builtin/credential/aws/path_role.go
View File

@ -87,6 +87,9 @@ auth_type is ec2 or inferred_entity_type is ec2_instance.`,
given instance IDs. Can be a list or comma-separated string of EC2 instance
IDs. This is only applicable when auth_type is ec2 or inferred_entity_type is
ec2_instance.`,
DisplayAttrs: &framework.DisplayAttributes{
Description: "If set, defines a constraint on the EC2 instances to have one of the given instance IDs. A list of EC2 instance IDs. This is only applicable when auth_type is ec2 or inferred_entity_type is ec2_instance.",
},
},
"resolve_aws_unique_ids": {
Type: framework.TypeBool,

33
builtin/credential/cert/path_certs.go
View File

@ -77,6 +77,9 @@ Must be x509 PEM encoded.`,
Type: framework.TypeCommaStringSlice,
Description: `A comma-separated list of OCSP server addresses. If unset, the OCSP server is determined
from the AuthorityInformationAccess extension on the certificate being inspected.`,
DisplayAttrs: &framework.DisplayAttributes{
Description: "A list of OCSP server addresses. If unset, the OCSP server is determined from the AuthorityInformationAccess extension on the certificate being inspected.",
},
},
"ocsp_fail_open": {
Type: framework.TypeBool,
@ -95,7 +98,8 @@ At least one must exist in either the Common Name or SANs. Supports globbing.
This parameter is deprecated, please use allowed_common_names, allowed_dns_sans,
allowed_email_sans, allowed_uri_sans.`,
DisplayAttrs: &framework.DisplayAttributes{
Group: "Constraints",
Group: "Constraints",
Description: "A list of names. At least one must exist in either the Common Name or SANs. Supports globbing. This parameter is deprecated, please use allowed_common_names, allowed_dns_sans, allowed_email_sans, allowed_uri_sans.",
},
},
@ -104,7 +108,8 @@ allowed_email_sans, allowed_uri_sans.`,
Description: `A comma-separated list of names.
At least one must exist in the Common Name. Supports globbing.`,
DisplayAttrs: &framework.DisplayAttributes{
Group: "Constraints",
Group: "Constraints",
Description: "A list of names. At least one must exist in the Common Name. Supports globbing.",
},
},
@ -113,8 +118,9 @@ At least one must exist in the Common Name. Supports globbing.`,
Description: `A comma-separated list of DNS names.
At least one must exist in the SANs. Supports globbing.`,
DisplayAttrs: &framework.DisplayAttributes{
Name: "Allowed DNS SANs",
Group: "Constraints",
Name: "Allowed DNS SANs",
Group: "Constraints",
Description: "A list of DNS names. At least one must exist in the SANs. Supports globbing.",
},
},
@ -123,8 +129,9 @@ At least one must exist in the SANs. Supports globbing.`,
Description: `A comma-separated list of Email Addresses.
At least one must exist in the SANs. Supports globbing.`,
DisplayAttrs: &framework.DisplayAttributes{
Name: "Allowed Email SANs",
Group: "Constraints",
Name: "Allowed Email SANs",
Group: "Constraints",
Description: "A list of Email Addresses. At least one must exist in the SANs. Supports globbing.",
},
},
@ -133,8 +140,9 @@ At least one must exist in the SANs. Supports globbing.`,
Description: `A comma-separated list of URIs.
At least one must exist in the SANs. Supports globbing.`,
DisplayAttrs: &framework.DisplayAttributes{
Name: "Allowed URI SANs",
Group: "Constraints",
Name: "Allowed URI SANs",
Group: "Constraints",
Description: "A list of URIs. At least one must exist in the SANs. Supports globbing.",
},
},
@ -143,7 +151,8 @@ At least one must exist in the SANs. Supports globbing.`,
Description: `A comma-separated list of Organizational Units names.
At least one must exist in the OU field.`,
DisplayAttrs: &framework.DisplayAttributes{
Group: "Constraints",
Group: "Constraints",
Description: "A list of Organizational Units names. At least one must exist in the OU field.",
},
},
@ -152,6 +161,9 @@ At least one must exist in the OU field.`,
Description: `A comma-separated string or array of extensions
formatted as "oid:value". Expects the extension value to be some type of ASN1 encoded string.
All values much match. Supports globbing on "value".`,
DisplayAttrs: &framework.DisplayAttributes{
Description: "A list of extensions formatted as 'oid:value'. Expects the extension value to be some type of ASN1 encoded string. All values much match. Supports globbing on 'value'.",
},
},
"allowed_metadata_extensions": {
@ -160,6 +172,9 @@ All values much match. Supports globbing on "value".`,
Upon successful authentication, these extensions will be added as metadata if they are present
in the certificate. The metadata key will be the string consisting of the oid numbers
separated by a dash (-) instead of a dot (.) to allow usage in ACL templates.`,
DisplayAttrs: &framework.DisplayAttributes{
Description: "A list of OID extensions. Upon successful authentication, these extensions will be added as metadata if they are present in the certificate. The metadata key will be the string consisting of the OID numbers separated by a dash (-) instead of a dot (.) to allow usage in ACL templates.",
},
},
"display_name": {

3
builtin/credential/ldap/path_groups.go
View File

@ -52,6 +52,9 @@ func pathGroups(b *backend) *framework.Path {
"policies": {
Type: framework.TypeCommaStringSlice,
Description: "Comma-separated list of policies associated to the group.",
DisplayAttrs: &framework.DisplayAttributes{
Description: "A list of policies associated to the group.",
},
},
},

6
builtin/credential/ldap/path_users.go
View File

@ -53,11 +53,17 @@ func pathUsers(b *backend) *framework.Path {
"groups": {
Type: framework.TypeCommaStringSlice,
Description: "Comma-separated list of additional groups associated with the user.",
DisplayAttrs: &framework.DisplayAttributes{
Description: "A list of additional groups associated with the user.",
},
},
"policies": {
Type: framework.TypeCommaStringSlice,
Description: "Comma-separated list of policies associated with the user.",
DisplayAttrs: &framework.DisplayAttributes{
Description: "A list of policies associated with the user.",
},
},
},

3
builtin/credential/okta/path_groups.go
View File

@ -52,6 +52,9 @@ func pathGroups(b *backend) *framework.Path {
"policies": {
Type: framework.TypeCommaStringSlice,
Description: "Comma-separated list of policies associated to the group.",
DisplayAttrs: &framework.DisplayAttributes{
Description: "A list of policies associated to the group.",
},
},
},

5
builtin/credential/radius/path_config.go
View File

@ -44,9 +44,10 @@ func pathConfig(b *backend) *framework.Path {
"unregistered_user_policies": {
Type: framework.TypeString,
Default: "",
Description: "Comma-separated list of policies to grant upon successful RADIUS authentication of an unregisted user (default: empty)",
Description: "Comma-separated list of policies to grant upon successful RADIUS authentication of an unregistered user (default: empty)",
DisplayAttrs: &framework.DisplayAttributes{
Name: "Policies for unregistered users",
Name: "Policies for unregistered users",
Description: "List of policies to grant upon successful RADIUS authentication of an unregistered user (default: empty)",
},
},
"dial_timeout": {

3
builtin/credential/radius/path_users.go
View File

@ -53,6 +53,9 @@ func pathUsers(b *backend) *framework.Path {
"policies": {
Type: framework.TypeCommaStringSlice,
Description: "Comma-separated list of policies associated to the user.",
DisplayAttrs: &framework.DisplayAttributes{
Description: "A list of policies associated to the user.",
},
},
},

3
builtin/credential/userpass/path_user_policies.go
View File

@ -36,6 +36,9 @@ func pathUserPolicies(b *backend) *framework.Path {
"token_policies": {
Type: framework.TypeCommaStringSlice,
Description: "Comma-separated list of policies",
DisplayAttrs: &framework.DisplayAttributes{
Description: "A list of policies that will apply to the generated token for this user.",
},
},
},

3
changelog/20163.txt Normal file
View File

@ -0,0 +1,3 @@
```release-note:improvement
ui: adds warning for commas in stringArray inputs and updates tooltip help text to remove references to comma separation
```

5
sdk/framework/path.go
View File

@ -207,6 +207,11 @@ type DisplayAttributes struct {
// Name is the name of the field suitable as a label or documentation heading.
Name string `json:"name,omitempty"`
// Description of the field that renders as tooltip help text beside the label (name) in the UI.
// This may be used to replace descriptions that reference comma separation but correspond
// to UI inputs where only arrays are valid. For example params with Type: framework.TypeCommaStringSlice
Description string `json:"description,omitempty"`
// Value is a sample value to display for this field. This may be used
// to indicate a default value, but it is for display only and completely separate
// from any Default member handling.

10
sdk/helper/tokenutil/tokenutil.go
View File

@ -78,8 +78,9 @@ func TokenFields() map[string]*framework.FieldSchema {
Type: framework.TypeCommaStringSlice,
Description: `Comma separated string or JSON list of CIDR blocks. If set, specifies the blocks of IP addresses which are allowed to use the generated token.`,
DisplayAttrs: &framework.DisplayAttributes{
Name: "Generated Token's Bound CIDRs",
Group: "Tokens",
Name: "Generated Token's Bound CIDRs",
Group: "Tokens",
Description: "A list of CIDR blocks. If set, specifies the blocks of IP addresses which are allowed to use the generated token.",
},
},
@ -123,8 +124,9 @@ func TokenFields() map[string]*framework.FieldSchema {
Type: framework.TypeCommaStringSlice,
Description: "Comma-separated list of policies",
DisplayAttrs: &framework.DisplayAttributes{
Name: "Generated Token's Policies",
Group: "Tokens",
Name: "Generated Token's Policies",
Group: "Tokens",
Description: "A list of policies that will apply to the generated token for this user.",
},
},

10
ui/app/components/generated-item.js
View File

@ -53,16 +53,6 @@ export default Component.extend({
),
init() {
this._super(...arguments);
this.model.fieldGroups.forEach((element) => {
// overwriting the helpText for Token Polices.
// HelpText from the backend says add a comma separated list, which works on the CLI but not here on the UI.
// This effects TLS Certificates, Userpass, and Kubernetes. https://github.com/hashicorp/vault/issues/10346
if (element.Tokens) {
element.Tokens.find((attr) => attr.name === 'tokenPolicies').options.helpText =
'Add policies that will apply to the generated token for this user. One policy per row.';
}
});
if (this.mode === 'edit') {
// For validation to work in edit mode,
// reconstruct the model values from field group

10
ui/app/models/pki/certificate/base.js
View File

@ -59,7 +59,7 @@ export default class PkiCertificateBaseModel extends Model {
@attr('string', {
label: 'Subject Alternative Names (SANs)',
subText:
'The requested Subject Alternative Names; if email protection is enabled for the role, this may contain email addresses. Add one per row.',
'The requested Subject Alternative Names; if email protection is enabled for the role, this may contain email addresses.',
editType: 'stringArray',
})
altNames;
@ -67,20 +67,18 @@ export default class PkiCertificateBaseModel extends Model {
// SANs below are editType: stringArray from openApi
@attr('string', {
label: 'IP Subject Alternative Names (IP SANs)',
subText: 'Only valid if the role allows IP SANs (which is the default). Add one per row.',
subText: 'Only valid if the role allows IP SANs (which is the default).',
})
ipSans;
@attr('string', {
label: 'URI Subject Alternative Names (URI SANs)',
subText:
'If any requested URIs do not match role policy, the entire request will be denied. Add one per row.',
subText: 'If any requested URIs do not match role policy, the entire request will be denied.',
})
uriSans;
@attr('string', {
subText:
'Requested other SANs with the format <oid>;UTF8:<utf8 string value> for each entry. Add one per row.',
subText: 'Requested other SANs with the format <oid>;UTF8:<utf8 string value> for each entry.',
})
otherSans;

2
ui/app/models/pki/issuer.js
View File

@ -107,7 +107,7 @@ export default class PkiIssuerModel extends Model {
@attr('string', {
subText:
'The URL values for the Issuing Certificate field. These are different URLs for the same resource, and should be added individually, not in a comma-separated list.',
'The URL values for the Issuing Certificate field; these are different URLs for the same resource.',
editType: 'stringArray',
})
issuingCertificates;

8
ui/app/models/pki/role.js
View File

@ -159,7 +159,7 @@ export default class PkiRoleModel extends Model {
/* Overriding OpenApi Domain handling options */
@attr({
label: 'Allowed domains',
subText: 'Specifies the domains this role is allowed to issue certificates for. Add one item per row.',
subText: 'Specifies the domains this role is allowed to issue certificates for.',
editType: 'stringArray',
})
allowedDomains;
@ -196,7 +196,7 @@ export default class PkiRoleModel extends Model {
/* Overriding API Policy identifier option */
@attr({
label: 'Policy identifiers',
subText: 'A comma-separated string or list of policy object identifiers (OIDs). Add one per row. ',
subText: 'A list of policy object identifiers (OIDs).',
editType: 'stringArray',
})
policyIdentifiers;
@ -213,7 +213,7 @@ export default class PkiRoleModel extends Model {
@attr({
label: 'URI Subject Alternative Names (URI SANs)',
subText: 'Defines allowed URI Subject Alternative Names. Add one item per row',
subText: 'Defines allowed URI Subject Alternative Names.',
editType: 'stringArray',
docLink: '/vault/docs/concepts/policies',
})
@ -229,7 +229,7 @@ export default class PkiRoleModel extends Model {
@attr({
label: 'Other SANs',
subText: 'Defines allowed custom OID/UTF8-string SANs. Add one item per row.',
subText: 'Defines allowed custom OID/UTF8-string SANs.',
editType: 'stringArray',
})
allowedOtherSans;

2
ui/app/models/pki/urls.js
View File

@ -20,7 +20,7 @@ export default class PkiUrlsModel extends Model {
@attr({
label: 'Issuing certificates',
subText:
'The URL values for the Issuing Certificate field. These are different URLs for the same resource, and should be added individually, not in a comma-separated list.',
'The URL values for the Issuing Certificate field; these are different URLs for the same resource.',
showHelpText: false,
editType: 'stringArray',
})

4
ui/app/styles/core/forms.scss
View File

@ -341,6 +341,10 @@ fieldset.form-fieldset {
border: none;
}
.has-warning-border {
border: 1px solid $yellow-500;
}
.has-error-border,
select.has-error-border {
border: 1px solid $red-500;

17
ui/app/utils/openapi-to-attrs.js
View File

@ -16,12 +16,23 @@ export const expandOpenApiProps = function (props) {
if (deprecated === true) {
continue;
}
let { name, value, group, sensitive, editType } = prop['x-vault-displayAttrs'] || {};
let {
name,
value,
group,
sensitive,
editType,
description: displayDescription,
} = prop['x-vault-displayAttrs'] || {};
if (type === 'integer') {
type = 'number';
}
if (displayDescription) {
description = displayDescription;
}
editType = editType || type;
if (format === 'seconds') {
@ -50,8 +61,8 @@ export const expandOpenApiProps = function (props) {
attrDefn.sensitive = true;
}
//only set a label if we have one from OpenAPI
//otherwise the propName will be humanized by the form-field component
// only set a label if we have one from OpenAPI
// otherwise the propName will be humanized by the form-field component
if (name) {
attrDefn.label = name;
}

3
ui/lib/core/addon/components/form-field.hbs
View File

@ -209,12 +209,11 @@
<StringList
data-test-input={{@attr.name}}
@label={{this.labelString}}
@warning={{@attr.options.warning}}
@helpText={{if this.showHelpText @attr.options.helpText}}
@inputValue={{get @model this.valuePath}}
@onChange={{this.setAndBroadcast}}
@attrName={{@attr.name}}
@subText={{@attr.options.subText}}
@subText="{{@attr.options.subText}} Add one item per row."
/>
{{else if (eq @attr.options.sensitive true)}}
{{! Masked Input }}

19
ui/lib/core/addon/components/string-list.hbs
View File

@ -9,8 +9,8 @@
{{#if @label}}
<label class="is-label" data-test-string-list-label="true">
{{@label}}
{{#if this.helpText}}
<InfoTooltip>{{this.helpText}}</InfoTooltip>
{{#if @helpText}}
<InfoTooltip>{{@helpText}}</InfoTooltip>
{{/if}}
</label>
{{#if @subText}}
@ -19,15 +19,12 @@
</p>
{{/if}}
{{/if}}
{{#if @warning}}
<AlertBanner @type="warning" @message={{@warning}} />
{{/if}}
{{#each this.inputList as |data index|}}
<div class="field is-grouped" data-test-string-list-row={{index}}>
<div class="control is-expanded">
<Textarea
data-test-string-list-input={{index}}
class="input"
class="input {{if (includes index this.indicesWithComma) 'has-warning-border'}}"
@value={{data.value}}
name={{concat this.elementId "-" index}}
id={{concat this.elementId "-" index}}
@ -56,6 +53,16 @@
</button>
{{/if}}
</div>
{{#if (includes index this.indicesWithComma)}}
<Icon class="is-flex-v-centered has-text-highlight" @name="alert-triangle-fill" />
{{/if}}
</div>
{{/each}}
{{#if this.indicesWithComma}}
<AlertInline
@type="warning"
@message="Input contains a comma. Please separate values into individual rows."
@isMarginless={{true}}
/>
{{/if}}
</div>

23
ui/lib/core/addon/components/string-list.js
View File

@ -9,6 +9,7 @@ import autosize from 'autosize';
import { action } from '@ember/object';
import { set } from '@ember/object';
import { next } from '@ember/runloop';
import { tracked } from '@glimmer/tracking';
/**
* @module StringList
@ -20,7 +21,6 @@ import { next } from '@ember/runloop';
* @param {string} label - Text displayed in the header above all the inputs.
* @param {function} onChange - Function called when any of the inputs change.
* @param {string} inputValue - A string or an array of strings.
* @param {string} warning - Text displayed as a warning.
* @param {string} helpText - Text displayed as a tooltip.
* @param {string} type=array - Optional type for inputValue.
* @param {string} attrName - We use this to check the type so we can modify the tooltip content.
@ -28,6 +28,8 @@ import { next } from '@ember/runloop';
*/
export default class StringList extends Component {
@tracked indicesWithComma = [];
constructor() {
super(...arguments);
@ -75,14 +77,6 @@ export default class StringList extends Component {
return inputs;
}
get helpText() {
if (this.args.attrName === 'tokenBoundCidrs') {
return 'Specifies the blocks of IP addresses which are allowed to use the generated token. One entry per row.';
} else {
return this.args.helpText;
}
}
@action
autoSize(element) {
autosize(element.querySelector('textarea'));
@ -95,10 +89,14 @@ export default class StringList extends Component {
@action
inputChanged(idx, event) {
if (event.target.value.includes(',') && !this.indicesWithComma.includes(idx)) {
this.indicesWithComma.pushObject(idx);
}
if (!event.target.value.includes(',')) this.indicesWithComma.removeObject(idx);
const inputObj = this.inputList.objectAt(idx);
const onChange = this.args.onChange;
set(inputObj, 'value', event.target.value);
onChange(this.toVal());
this.args.onChange(this.toVal());
}
@action
@ -111,9 +109,8 @@ export default class StringList extends Component {
@action
removeInput(idx) {
const onChange = this.args.onChange;
const inputs = this.inputList;
inputs.removeObject(inputs.objectAt(idx));
onChange(this.toVal());
this.args.onChange(this.toVal());
}
}

1
ui/lib/pki/addon/components/pki-generate-toggle-groups.hbs
View File

@ -39,7 +39,6 @@
{{else if (eq group "Additional subject fields")}}
These fields provide more information about the client to which the certificate belongs.
{{/if}}
Add one item per row.
</p>
{{#each fields as |fieldName|}}
{{#let (find-by "name" fieldName @model.allFields) as |attr|}}

4
ui/lib/pki/addon/components/pki-key-usage.hbs
View File

@ -21,11 +21,11 @@
<StringList
class="is-box-shadowless"
data-test-input="extKeyUsageOids"
@label="Extended key usage oids"
@label="Extended key usage OIDs"
@inputValue={{get @model "extKeyUsageOids"}}
@onChange={{this.onStringListChange}}
@attrName="extKeyUsageOids"
@subText="A list of extended key usage oids. Add one item per row."
@subText="A list of extended key usage OIDs. Add one item per row."
@showHelpText={{false}}
/>
</div>

22
ui/tests/acceptance/auth-list-test.js
View File

@ -4,16 +4,7 @@
*/
/* eslint qunit/no-conditional-assertions: "warn" */
import {
click,
fillIn,
settled,
visit,
triggerEvent,
triggerKeyEvent,
find,
waitUntil,
} from '@ember/test-helpers';
import { click, fillIn, settled, visit, triggerKeyEvent, find, waitUntil } from '@ember/test-helpers';
import { module, test } from 'qunit';
import { setupApplicationTest } from 'ember-qunit';
import { v4 as uuidv4 } from 'uuid';
@ -80,17 +71,6 @@ module('Acceptance | auth backend list', function (hooks) {
await triggerKeyEvent('[data-test-input="username"]', 'keyup', 65);
await fillIn('[data-test-textarea]', user2);
await triggerKeyEvent('[data-test-textarea]', 'keyup', 65);
// test for modified helpText on generated token policies
await click('[data-test-toggle-group="Tokens"]');
const policyFormField = document.querySelector('[data-test-input="tokenPolicies"]');
const tooltipTrigger = policyFormField.querySelector('[data-test-tool-tip-trigger]');
await triggerEvent(tooltipTrigger, 'mouseenter');
assert
.dom('[data-test-info-tooltip-content]')
.hasText(
'Add policies that will apply to the generated token for this user. One policy per row.',
'Overwritten tooltip text displays in token form field.'
);
await click('[data-test-save-config="true"]');

6
ui/tests/integration/components/pki/pki-generate-root-test.js
View File

@ -53,9 +53,7 @@ module('Integration | Component | pki-generate-root', function (hooks) {
await click(SELECTORS.additionalGroupToggle);
assert
.dom(SELECTORS.toggleGroupDescription)
.hasText(
'These fields provide more information about the client to which the certificate belongs. Add one item per row.'
);
.hasText('These fields provide more information about the client to which the certificate belongs.');
assert
.dom(`[data-test-group="Additional subject fields"] ${SELECTORS.formField}`)
.exists({ count: 7 }, '7 form fields under Additional Fields toggle');
@ -64,7 +62,7 @@ module('Integration | Component | pki-generate-root', function (hooks) {
assert
.dom(SELECTORS.toggleGroupDescription)
.hasText(
'SAN fields are an extension that allow you specify additional host names (sites, IP addresses, common names, etc.) to be protected by a single certificate. Add one item per row.'
'SAN fields are an extension that allow you specify additional host names (sites, IP addresses, common names, etc.) to be protected by a single certificate.'
);
assert
.dom(`[data-test-group="Subject Alternative Name (SAN) Options"] ${SELECTORS.formField}`)

14
ui/tests/integration/components/string-list-test.js
View File

@ -5,7 +5,7 @@
import { module, test } from 'qunit';
import { setupRenderingTest } from 'ember-qunit';
import { render, click, fillIn, triggerKeyEvent, triggerEvent } from '@ember/test-helpers';
import { render, click, fillIn, triggerKeyEvent } from '@ember/test-helpers';
import sinon from 'sinon';
import hbs from 'htmlbars-inline-precompile';
@ -137,16 +137,4 @@ module('Integration | Component | string list', function (hooks) {
assert.dom('[data-test-string-list-input="0"]').hasValue('bar');
assert.dom('[data-test-string-list-input="1"]').hasValue('');
});
test('it replaces helpText if name is tokenBoundCidrs', async function (assert) {
assert.expect(1);
await render(hbs`<StringList @label={{'blah'}} @helpText={{'blah'}} @attrName={{'tokenBoundCidrs'}} />`);
const tooltipTrigger = document.querySelector('[data-test-tool-tip-trigger]');
await triggerEvent(tooltipTrigger, 'mouseenter');
assert
.dom('[data-test-info-tooltip-content]')
.hasText(
'Specifies the blocks of IP addresses which are allowed to use the generated token. One entry per row.'
);
});
});

63
ui/tests/unit/utils/openapi-to-attrs-test.js
View File

@ -6,6 +6,7 @@
import { attr } from '@ember-data/model';
import { expandOpenApiProps, combineAttributes, combineFieldGroups } from 'vault/utils/openapi-to-attrs';
import { module, test } from 'qunit';
import { camelize } from '@ember/string';
module('Unit | Util | OpenAPI Data Utilities', function () {
const OPENAPI_RESPONSE_PROPS = {
@ -145,6 +146,56 @@ module('Unit | Util | OpenAPI Data Utilities', function () {
const NEW_FIELDS = ['one', 'two', 'three'];
const OPENAPI_DESCRIPTIONS = {
token_bound_cidrs: {
type: 'array',
description:
'Comma separated string or JSON list of CIDR blocks. If set, specifies the blocks of IP addresses which are allowed to use the generated token.',
items: {
type: 'string',
},
'x-vault-displayAttrs': {
description:
'List of CIDR blocks. If set, specifies the blocks of IP addresses which are allowed to use the generated token.',
name: "Generated Token's Bound CIDRs",
group: 'Tokens',
},
},
blah_blah: {
type: 'array',
description: 'Comma-separated list of policies',
items: {
type: 'string',
},
'x-vault-displayAttrs': {
name: "Generated Token's Policies",
group: 'Tokens',
},
},
only_display_description: {
type: 'array',
items: {
type: 'string',
},
'x-vault-displayAttrs': {
description: 'Hello there, you look nice today',
},
},
};
const STRING_ARRAY_DESCRIPTIONS = {
token_bound_cidrs: {
helpText:
'List of CIDR blocks. If set, specifies the blocks of IP addresses which are allowed to use the generated token.',
},
blah_blah: {
helpText: 'Comma-separated list of policies',
},
only_display_description: {
helpText: 'Hello there, you look nice today',
},
};
test('it creates objects from OpenAPI schema props', function (assert) {
assert.expect(6);
const generatedProps = expandOpenApiProps(OPENAPI_RESPONSE_PROPS);
@ -229,4 +280,16 @@ module('Unit | Util | OpenAPI Data Utilities', function () {
assert.deepEqual(fieldGroups[groupName], expectedGroups[groupName], 'it incorporates all new fields');
}
});
test('it uses the description from the display attrs block if it exists', async function (assert) {
assert.expect(3);
const generatedProps = expandOpenApiProps(OPENAPI_DESCRIPTIONS);
for (const propName in STRING_ARRAY_DESCRIPTIONS) {
assert.strictEqual(
generatedProps[camelize(propName)].helpText,
STRING_ARRAY_DESCRIPTIONS[propName].helpText,
`correctly updates helpText for ${propName}`
);
}
});
});