summaryrefslogtreecommitdiff
path: root/spec/frontend/registry/shared/components/expiration_policy_fields_spec.js
blob: bee9bca53694292be49b1c200e0383de7c3e6eb5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
import { shallowMount } from '@vue/test-utils';
import { GlSprintf } from '@gitlab/ui';
import component from '~/registry/shared/components/expiration_policy_fields.vue';

import { NAME_REGEX_LENGTH, ENABLED_TEXT, DISABLED_TEXT } from '~/registry/shared/constants';
import { formOptions } from '../mock_data';

describe('Expiration Policy Form', () => {
  let wrapper;

  const FORM_ELEMENTS_ID_PREFIX = '#expiration-policy';

  const findFormGroup = name => wrapper.find(`${FORM_ELEMENTS_ID_PREFIX}-${name}-group`);
  const findFormElements = (name, parent = wrapper) =>
    parent.find(`${FORM_ELEMENTS_ID_PREFIX}-${name}`);

  const mountComponent = props => {
    wrapper = shallowMount(component, {
      stubs: {
        GlSprintf,
      },
      propsData: {
        formOptions,
        ...props,
      },
      methods: {
        // override idGenerator to avoid having to test with dynamic uid
        idGenerator: value => value,
      },
    });
  };

  afterEach(() => {
    wrapper.destroy();
  });

  it('renders', () => {
    mountComponent();
    expect(wrapper.element).toMatchSnapshot();
  });

  describe.each`
    elementName        | modelName          | value    | disabledByToggle
    ${'toggle'}        | ${'enabled'}       | ${true}  | ${'not disabled'}
    ${'interval'}      | ${'olderThan'}     | ${'foo'} | ${'disabled'}
    ${'schedule'}      | ${'cadence'}       | ${'foo'} | ${'disabled'}
    ${'latest'}        | ${'keepN'}         | ${'foo'} | ${'disabled'}
    ${'name-matching'} | ${'nameRegex'}     | ${'foo'} | ${'disabled'}
    ${'keep-name'}     | ${'nameRegexKeep'} | ${'bar'} | ${'disabled'}
  `(
    `${FORM_ELEMENTS_ID_PREFIX}-$elementName form element`,
    ({ elementName, modelName, value, disabledByToggle }) => {
      it(`${elementName} form group exist in the dom`, () => {
        mountComponent();
        const formGroup = findFormGroup(elementName);
        expect(formGroup.exists()).toBe(true);
      });

      it(`${elementName} form group has a label-for property`, () => {
        mountComponent();
        const formGroup = findFormGroup(elementName);
        expect(formGroup.attributes('label-for')).toBe(`expiration-policy-${elementName}`);
      });

      it(`${elementName} form group has a label-cols property`, () => {
        mountComponent({ labelCols: '1' });
        const formGroup = findFormGroup(elementName);
        return wrapper.vm.$nextTick().then(() => {
          expect(formGroup.attributes('label-cols')).toBe('1');
        });
      });

      it(`${elementName} form group has a label-align property`, () => {
        mountComponent({ labelAlign: 'foo' });
        const formGroup = findFormGroup(elementName);
        return wrapper.vm.$nextTick().then(() => {
          expect(formGroup.attributes('label-align')).toBe('foo');
        });
      });

      it(`${elementName} form group contains an input element`, () => {
        mountComponent();
        const formGroup = findFormGroup(elementName);
        expect(findFormElements(elementName, formGroup).exists()).toBe(true);
      });

      it(`${elementName} form element change updated ${modelName} with ${value}`, () => {
        mountComponent();
        const formGroup = findFormGroup(elementName);
        const element = findFormElements(elementName, formGroup);

        const modelUpdateEvent = element.vm.$options.model
          ? element.vm.$options.model.event
          : 'input';
        element.vm.$emit(modelUpdateEvent, value);
        return wrapper.vm.$nextTick().then(() => {
          expect(wrapper.emitted('input')).toEqual([
            [{ newValue: { [modelName]: value }, modified: modelName }],
          ]);
        });
      });

      it(`${elementName} is ${disabledByToggle} by enabled set to false`, () => {
        mountComponent({ settings: { enabled: false } });
        const formGroup = findFormGroup(elementName);
        const expectation = disabledByToggle === 'disabled' ? 'true' : undefined;
        expect(findFormElements(elementName, formGroup).attributes('disabled')).toBe(expectation);
      });
    },
  );

  describe('when isLoading is true', () => {
    beforeEach(() => {
      mountComponent({ isLoading: true });
    });

    it.each`
      elementName
      ${'toggle'}
      ${'interval'}
      ${'schedule'}
      ${'latest'}
      ${'name-matching'}
      ${'keep-name'}
    `(`${FORM_ELEMENTS_ID_PREFIX}-$elementName is disabled`, ({ elementName }) => {
      expect(findFormElements(elementName).attributes('disabled')).toBe('true');
    });
  });

  describe.each`
    modelName          | elementName
    ${'nameRegex'}     | ${'name-matching'}
    ${'nameRegexKeep'} | ${'keep-name'}
  `('regex textarea validation', ({ modelName, elementName }) => {
    const invalidString = new Array(NAME_REGEX_LENGTH + 2).join(',');

    describe('when apiError contains an error message', () => {
      const errorMessage = 'something went wrong';

      it('shows the error message on the relevant field', () => {
        mountComponent({ apiErrors: { [modelName]: errorMessage } });
        expect(findFormGroup(elementName).attributes('invalid-feedback')).toBe(errorMessage);
      });

      it('gives precedence to API errors compared to local ones', () => {
        mountComponent({
          apiErrors: { [modelName]: errorMessage },
          value: { [modelName]: invalidString },
        });
        expect(findFormGroup(elementName).attributes('invalid-feedback')).toBe(errorMessage);
      });
    });

    describe('when apiErrors is empty', () => {
      it('if the user did not type validation is null', async () => {
        mountComponent({ value: { [modelName]: '' } });
        expect(findFormGroup(elementName).attributes('state')).toBeUndefined();
        expect(wrapper.emitted('validated')).toBeTruthy();
      });

      it(`if the user typed and is less than ${NAME_REGEX_LENGTH} state is true`, () => {
        mountComponent({ value: { [modelName]: 'foo' } });

        const formGroup = findFormGroup(elementName);
        const formElement = findFormElements(elementName, formGroup);
        expect(formGroup.attributes('state')).toBeTruthy();
        expect(formElement.attributes('state')).toBeTruthy();
      });

      describe(`when name regex is longer than ${NAME_REGEX_LENGTH}`, () => {
        beforeEach(() => {
          mountComponent({ value: { [modelName]: invalidString } });
        });

        it('textAreaValidation state is false', () => {
          expect(findFormGroup(elementName).attributes('state')).toBeUndefined();
          // we are forced to check the model attribute because falsy attrs are all casted to undefined in attrs
          // while in this case false shows an error and null instead shows nothing.
          expect(wrapper.vm.textAreaValidation[modelName].state).toBe(false);
        });

        it('emit the @invalidated event', () => {
          expect(wrapper.emitted('invalidated')).toBeTruthy();
        });
      });
    });
  });

  describe('help text', () => {
    it('toggleDescriptionText show disabled when settings.enabled is false', () => {
      mountComponent();
      const toggleHelpText = findFormGroup('toggle').find('span');
      expect(toggleHelpText.html()).toContain(DISABLED_TEXT);
    });

    it('toggleDescriptionText show enabled when settings.enabled is true', () => {
      mountComponent({ value: { enabled: true } });
      const toggleHelpText = findFormGroup('toggle').find('span');
      expect(toggleHelpText.html()).toContain(ENABLED_TEXT);
    });
  });
});