summaryrefslogtreecommitdiff
path: root/spec/frontend/ci/pipeline_editor/components/editor/ci_editor_header_spec.js
blob: f1a5c4169fbdfd46e5c0aa47063efcc7912c3ddf (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
import { shallowMount } from '@vue/test-utils';
import { extendedWrapper } from 'helpers/vue_test_utils_helper';
import { mockTracking, unmockTracking } from 'helpers/tracking_helper';
import CiEditorHeader from '~/ci/pipeline_editor/components/editor/ci_editor_header.vue';
import {
  pipelineEditorTrackingOptions,
  TEMPLATE_REPOSITORY_URL,
} from '~/ci/pipeline_editor/constants';

describe('CI Editor Header', () => {
  let wrapper;
  let trackingSpy = null;

  const createComponent = ({
    showDrawer = false,
    showJobAssistantDrawer = false,
    showAiAssistantDrawer = false,
    aiChatAvailable = false,
    aiCiConfigGenerator = false,
  } = {}) => {
    wrapper = extendedWrapper(
      shallowMount(CiEditorHeader, {
        provide: {
          aiChatAvailable,
          glFeatures: {
            aiCiConfigGenerator,
          },
        },
        propsData: {
          showDrawer,
          showJobAssistantDrawer,
          showAiAssistantDrawer,
        },
      }),
    );
  };

  const findLinkBtn = () => wrapper.findByTestId('template-repo-link');
  const findHelpBtn = () => wrapper.findByTestId('drawer-toggle');
  const findAiAssistnantBtn = () => wrapper.findByTestId('ai-assistant-drawer-toggle');

  afterEach(() => {
    unmockTracking();
  });

  const testTracker = async (element, expectedAction) => {
    const { label } = pipelineEditorTrackingOptions;

    trackingSpy = mockTracking(undefined, wrapper.element, jest.spyOn);
    await element.vm.$emit('click');

    expect(trackingSpy).toHaveBeenCalledWith(undefined, expectedAction, {
      label,
    });
  };
  describe('Ai Assistant toggle button', () => {
    describe('when feature is unavailable', () => {
      it('should not show ai button when feature toggle is off', () => {
        createComponent({ aiChatAvailable: true });
        mockTracking(undefined, wrapper.element, jest.spyOn);
        expect(findAiAssistnantBtn().exists()).toBe(false);
      });

      it('should not show ai button when feature is unavailable', () => {
        createComponent({ aiCiConfigGenerator: true });
        mockTracking(undefined, wrapper.element, jest.spyOn);
        expect(findAiAssistnantBtn().exists()).toBe(false);
      });
    });

    describe('when feature is available', () => {
      it('should show ai button', () => {
        createComponent({ aiCiConfigGenerator: true, aiChatAvailable: true });
        mockTracking(undefined, wrapper.element, jest.spyOn);
        expect(findAiAssistnantBtn().exists()).toBe(true);
      });
    });
  });
  describe('link button', () => {
    beforeEach(() => {
      createComponent();
      trackingSpy = mockTracking(undefined, wrapper.element, jest.spyOn);
    });

    it('finds the browse template button', () => {
      expect(findLinkBtn().exists()).toBe(true);
    });

    it('contains the link to the template repo', () => {
      expect(findLinkBtn().attributes('href')).toBe(TEMPLATE_REPOSITORY_URL);
    });

    it('has the external-link icon', () => {
      expect(findLinkBtn().props('icon')).toBe('external-link');
    });

    it('tracks the click on the browse button', () => {
      const { browseTemplates } = pipelineEditorTrackingOptions.actions;

      testTracker(findLinkBtn(), browseTemplates);
    });
  });

  describe('help button', () => {
    beforeEach(() => {
      createComponent();
    });

    it('finds the help button', () => {
      expect(findHelpBtn().exists()).toBe(true);
    });

    it('has the information-o icon', () => {
      expect(findHelpBtn().props('icon')).toBe('information-o');
    });

    describe('when pipeline editor drawer is closed', () => {
      beforeEach(() => {
        createComponent({ showDrawer: false });
      });

      it('emits open drawer event when clicked', () => {
        expect(wrapper.emitted('open-drawer')).toBeUndefined();

        findHelpBtn().vm.$emit('click');

        expect(wrapper.emitted('open-drawer')).toHaveLength(1);
      });

      it('tracks open help drawer action', () => {
        const { actions } = pipelineEditorTrackingOptions;

        testTracker(findHelpBtn(), actions.openHelpDrawer);
      });
    });

    describe('when pipeline editor drawer is open', () => {
      beforeEach(() => {
        createComponent({ showDrawer: true });
      });

      it('emits close drawer event when clicked', () => {
        expect(wrapper.emitted('close-drawer')).toBeUndefined();

        findHelpBtn().vm.$emit('click');

        expect(wrapper.emitted('close-drawer')).toHaveLength(1);
      });
    });
  });
});