Commit 2e9320d3 authored by Dheeraj Joshi's avatar Dheeraj Joshi Committed by Natalia Tepluhina

Add help texts for DAST site profile form

For exclude urls, request header fields
- Add instructions and tooltip
- Add max length constraint
parent ba636cb7
......@@ -7,19 +7,24 @@ import {
GlFormInput,
GlModal,
GlFormTextarea,
GlFormText,
} from '@gitlab/ui';
import * as Sentry from '@sentry/browser';
import { isEqual } from 'lodash';
import { returnToPreviousPageFactory } from 'ee/security_configuration/dast_profiles/redirect';
import { initFormField } from 'ee/security_configuration/utils';
import { serializeFormObject } from '~/lib/utils/forms';
import { __, s__ } from '~/locale';
import { __, s__, n__, sprintf } from '~/locale';
import validation from '~/vue_shared/directives/validation';
import glFeatureFlagsMixin from '~/vue_shared/mixins/gl_feature_flags_mixin';
import tooltipIcon from '../../dast_scanner_profiles/components/tooltip_icon.vue';
import dastSiteProfileCreateMutation from '../graphql/dast_site_profile_create.mutation.graphql';
import dastSiteProfileUpdateMutation from '../graphql/dast_site_profile_update.mutation.graphql';
import DastSiteAuthSection from './dast_site_auth_section.vue';
const MAX_CHAR_LIMIT_EXCLUDED_URLS = 2048;
const MAX_CHAR_LIMIT_REQUEST_HEADERS = 2048;
export default {
name: 'DastSiteProfileForm',
components: {
......@@ -31,6 +36,8 @@ export default {
GlModal,
GlFormTextarea,
DastSiteAuthSection,
GlFormText,
tooltipIcon,
},
directives: {
validation: validation(),
......@@ -111,6 +118,23 @@ export default {
okTitle: __('Discard'),
cancelTitle: __('Cancel'),
},
excludedUrls: {
label: s__('DastProfiles|Excluded URLs (Optional)'),
description: s__('DastProfiles|Enter URLs in a comma-separated list.'),
tooltip: s__(
'DastProfiles|URLs to skip during the authenticated scan. Use regular expression syntax to match multiple URLs.',
),
placeholder: 'https://example.com/logout, https://example.com/send_mail',
},
requestHeaders: {
label: s__('DastProfiles|Additional request headers (Optional)'),
description: s__('DastProfiles|Enter headers in a comma-separated list.'),
tooltip: s__(
'DastProfiles|Request header names and values. Headers are added to every request made by DAST.',
),
// eslint-disable-next-line @gitlab/require-i18n-strings
placeholder: 'Cache-control: no-cache, User-Agent: DAST/1.0',
},
};
},
formTouched() {
......@@ -200,8 +224,17 @@ export default {
this.errors = [];
this.hasAlert = false;
},
getCharacterLimitText(value, limit) {
return value.length
? n__('%d character remaining', '%d characters remaining', limit - value.length)
: sprintf(__('Maximum character limit - %{limit}'), {
limit,
});
},
},
modalId: 'deleteDastProfileModal',
MAX_CHAR_LIMIT_EXCLUDED_URLS,
MAX_CHAR_LIMIT_REQUEST_HEADERS,
};
</script>
......@@ -265,21 +298,45 @@ export default {
:invalid-feedback="form.fields.excludedUrls.feedback"
class="col-md-6"
>
<template #label>
{{ i18n.excludedUrls.label }}
<tooltip-icon :title="i18n.excludedUrls.tooltip" />
<gl-form-text class="gl-mt-3">{{ i18n.excludedUrls.description }}</gl-form-text>
</template>
<gl-form-textarea
v-model="form.fields.excludedUrls.value"
:maxlength="$options.MAX_CHAR_LIMIT_EXCLUDED_URLS"
:placeholder="i18n.excludedUrls.placeholder"
:no-resize="false"
data-testid="excluded-urls-input"
/>
<gl-form-text>{{
getCharacterLimitText(
form.fields.excludedUrls.value,
$options.MAX_CHAR_LIMIT_EXCLUDED_URLS,
)
}}</gl-form-text>
</gl-form-group>
<gl-form-group
:label="s__('DastProfiles|Additional request headers (Optional)')"
:invalid-feedback="form.fields.requestHeaders.feedback"
class="col-md-6"
>
<gl-form-group :invalid-feedback="form.fields.requestHeaders.feedback" class="col-md-6">
<template #label>
{{ i18n.requestHeaders.label }}
<tooltip-icon :title="i18n.requestHeaders.tooltip" />
<gl-form-text class="gl-mt-3">{{ i18n.requestHeaders.description }}</gl-form-text>
</template>
<gl-form-textarea
v-model="form.fields.requestHeaders.value"
:maxlength="$options.MAX_CHAR_LIMIT_REQUEST_HEADERS"
:placeholder="i18n.requestHeaders.placeholder"
:no-resize="false"
data-testid="request-headers-input"
/>
<gl-form-text>{{
getCharacterLimitText(
form.fields.requestHeaders.value,
$options.MAX_CHAR_LIMIT_REQUEST_HEADERS,
)
}}</gl-form-text>
</gl-form-group>
</div>
......
......@@ -168,6 +168,11 @@ describe('DastSiteProfileForm', () => {
expect(findExcludedUrlsInput().exists()).toBe(true);
expect(findRequestHeadersInput().exists()).toBe(true);
});
it('should have maxlength constraint', () => {
expect(findExcludedUrlsInput().attributes('maxlength')).toBe('2048');
expect(findRequestHeadersInput().attributes('maxlength')).toBe('2048');
});
});
describe.each`
......
......@@ -120,6 +120,11 @@ msgid_plural "%d changed files"
msgstr[0] ""
msgstr[1] ""
msgid "%d character remaining"
msgid_plural "%d characters remaining"
msgstr[0] ""
msgstr[1] ""
msgid "%d child epic"
msgid_plural "%d child epics"
msgstr[0] ""
......@@ -9434,6 +9439,12 @@ msgstr ""
msgid "DastProfiles|Enable Authentication"
msgstr ""
msgid "DastProfiles|Enter URLs in a comma-separated list."
msgstr ""
msgid "DastProfiles|Enter headers in a comma-separated list."
msgstr ""
msgid "DastProfiles|Error Details"
msgstr ""
......@@ -9494,6 +9505,9 @@ msgstr ""
msgid "DastProfiles|Profile name"
msgstr ""
msgid "DastProfiles|Request header names and values. Headers are added to every request made by DAST."
msgstr ""
msgid "DastProfiles|Request headers"
msgstr ""
......@@ -9563,6 +9577,9 @@ msgstr ""
msgid "DastProfiles|URL"
msgstr ""
msgid "DastProfiles|URLs to skip during the authenticated scan. Use regular expression syntax to match multiple URLs."
msgstr ""
msgid "DastProfiles|Username"
msgstr ""
......@@ -18623,6 +18640,9 @@ msgstr ""
msgid "Maximum capacity"
msgstr ""
msgid "Maximum character limit - %{limit}"
msgstr ""
msgid "Maximum concurrency of Elasticsearch bulk requests per indexing operation."
msgstr ""
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment