Add wildcard scopes to environments

- created ci_environments_dropdown.vue
- added test coverage for component/store
- refactored modal to use new component
- changes to mock data and store
- change to display default env text

app/assets/javascripts/ci_variable_list/components/ci_environments_dropdown.vue

+<script>
+import {
+  GlDropdown,
+  GlDropdownItem,
+  GlDropdownDivider,
+  GlSearchBoxByType,
+  GlIcon,
+} from '@gitlab/ui';
+import { __, sprintf } from '~/locale';
+import { mapGetters } from 'vuex';
+
+export default {
+  name: 'CiEnvironmentsDropdown',
+  components: {
+    GlDropdown,
+    GlDropdownItem,
+    GlDropdownDivider,
+    GlSearchBoxByType,
+    GlIcon,
+  },
+  props: {
+    value: {
+      type: String,
+      required: false,
+      default: '',
+    },
+  },
+  data() {
+    return {
+      searchTerm: this.value || '',
+    };
+  },
+  computed: {
+    ...mapGetters(['joinedEnvironments']),
+    composedCreateButtonLabel() {
+      return sprintf(__('Create wildcard: %{searchTerm}'), { searchTerm: this.searchTerm });
+    },
+    shouldRenderCreateButton() {
+      return this.searchTerm && !this.joinedEnvironments.includes(this.searchTerm);
+    },
+    filteredResults() {
+      const lowerCasedSearchTerm = this.searchTerm.toLowerCase();
+      return this.joinedEnvironments.filter(resultString =>
+        resultString.toLowerCase().includes(lowerCasedSearchTerm),
+      );
+    },
+  },
+  watch: {
+    value(newVal) {
+      this.searchTerm = newVal;
+    },
+  },
+  methods: {
+    selectEnvironment(selected) {
+      this.$emit('selectEnvironment', selected);
+      this.searchTerm = '';
+    },
+    createClicked() {
+      this.$emit('createClicked', this.searchTerm);
+      this.searchTerm = '';
+    },
+    isSelected(env) {
+      return this.value === env;
+    },
+  },
+};
+</script>
+<template>
+  <gl-dropdown :text="value">
+    <gl-search-box-by-type v-model.trim="searchTerm" class="m-2" />
+    <gl-dropdown-item
+      v-for="environment in filteredResults"
+      :key="environment"
+      @click="selectEnvironment(environment)"
+    >
+      <gl-icon
+        :class="{ invisible: !isSelected(environment) }"
+        name="mobile-issue-close"
+        class="vertical-align-middle"
+      />
+      {{ environment }}
+    </gl-dropdown-item>
+    <gl-dropdown-item v-if="!filteredResults.length" ref="noMatchingResults">{{
+      __('No matching results')
+    }}</gl-dropdown-item>
+    <template v-if="shouldRenderCreateButton">
+      <gl-dropdown-divider />
+      <gl-dropdown-item @click="createClicked">
+        {{ composedCreateButtonLabel }}
+      </gl-dropdown-item>
+    </template>
+  </gl-dropdown>
+</template>

app/assets/javascripts/ci_variable_list/components/ci_variable_modal.vue

@@ -2,6 +2,7 @@
 import { __ } from '~/locale';
 import { mapActions, mapState } from 'vuex';
 import { ADD_CI_VARIABLE_MODAL_ID } from '../constants';
+import CiEnvironmentsDropdown from './ci_environments_dropdown.vue';
 import {
   GlButton,
   GlModal,
@@ -17,6 +18,7 @@ import {
 export default {
   modalId: ADD_CI_VARIABLE_MODAL_ID,
   components: {
+    CiEnvironmentsDropdown,
     GlButton,
     GlModal,
     GlFormSelect,
@@ -36,6 +38,7 @@ export default {
       'variableBeingEdited',
       'isGroup',
       'maskableRegex',
+      'selectedEnvironment',
     ]),
     canSubmit() {
       if (this.variableData.masked && this.maskedState === false) {
@@ -80,6 +83,10 @@ export default {
       'displayInputValue',
       'clearModal',
       'deleteVariable',
+      'setEnvironmentScope',
+      'addWildCardScope',
+      'resetSelectedEnvironment',
+      'setSelectedEnvironment',
     ]),
     updateOrAddVariable() {
       if (this.variableBeingEdited) {
@@ -95,6 +102,7 @@ export default {
       } else {
         this.clearModal();
       }
+      this.resetSelectedEnvironment();
     },
     hideModal() {
       this.$refs.modal.hide();
@@ -158,10 +166,11 @@ export default {
           label-for="ci-variable-env"
           class="w-50"
         >
-          <gl-form-select
-            id="ci-variable-env"
-            v-model="variableData.environment_scope"
-            :options="environments"
+          <ci-environments-dropdown
+            class="w-100"
+            :value="variableData.environment_scope"
+            @selectEnvironment="setEnvironmentScope"
+            @createClicked="addWildCardScope"
           />
         </gl-form-group>
       </div>

app/assets/javascripts/ci_variable_list/components/ci_variable_table.vue

@@ -92,6 +92,7 @@ export default {
       sort-by="key"
       sort-direction="asc"
       stacked="lg"
+      table-class="text-secondary"
       fixed
       show-empty
       sort-icon-left

app/assets/javascripts/ci_variable_list/constants.js

@@ -6,7 +6,7 @@ export const ADD_CI_VARIABLE_MODAL_ID = 'add-ci-variable';
 export const displayText = {
   variableText: __('Var'),
   fileText: __('File'),
-  allEnvironmentsText: __('All'),
+  allEnvironmentsText: __('All (default)'),
 };
 
 export const types = {

app/assets/javascripts/ci_variable_list/store/actions.js

@@ -153,3 +153,22 @@ export const fetchEnvironments = ({ dispatch, state }) => {
       createFlash(__('There was an error fetching the environments information.'));
     });
 };
+
+export const setEnvironmentScope = ({ commit, dispatch }, environment) => {
+  commit(types.SET_ENVIRONMENT_SCOPE, environment);
+  dispatch('setSelectedEnvironment', environment);
+};
+
+export const addWildCardScope = ({ commit, dispatch }, environment) => {
+  commit(types.ADD_WILD_CARD_SCOPE, environment);
+  commit(types.SET_ENVIRONMENT_SCOPE, environment);
+  dispatch('setSelectedEnvironment', environment);
+};
+
+export const resetSelectedEnvironment = ({ commit }) => {
+  commit(types.RESET_SELECTED_ENVIRONMENT);
+};
+
+export const setSelectedEnvironment = ({ commit }, environment) => {
+  commit(types.SET_SELECTED_ENVIRONMENT, environment);
+};

app/assets/javascripts/ci_variable_list/store/getters.js

+import { extractEnvironmentScopes } from './utils';
+
+export const joinedEnvironments = state => {
+  if (state.variables) {
+    const joined = state.environments.concat(extractEnvironmentScopes(state.variables));
+    return [...new Set(joined)].sort();
+  }
+  return null;
+};
+
+// prevent babel-plugin-rewire from generating an invalid default during karma tests
+export default () => {};

app/assets/javascripts/ci_variable_list/store/index.js

 import Vue from 'vue';
 import Vuex from 'vuex';
 import * as actions from './actions';
+import * as getters from './getters';
 import mutations from './mutations';
 import state from './state';
 
@@ -10,6 +11,7 @@ export default (initialState = {}) =>
   new Vuex.Store({
     actions,
     mutations,
+    getters,
     state: {
       ...state(),
       ...initialState,

app/assets/javascripts/ci_variable_list/store/mutation_types.js

@@ -20,3 +20,7 @@ export const RECEIVE_UPDATE_VARIABLE_ERROR = 'RECEIVE_UPDATE_VARIABLE_ERROR';
 
 export const REQUEST_ENVIRONMENTS = 'REQUEST_ENVIRONMENTS';
 export const RECEIVE_ENVIRONMENTS_SUCCESS = 'RECEIVE_ENVIRONMENTS_SUCCESS';
+export const SET_ENVIRONMENT_SCOPE = 'SET_ENVIRONMENT_SCOPE';
+export const ADD_WILD_CARD_SCOPE = 'ADD_WILD_CARD_SCOPE';
+export const RESET_SELECTED_ENVIRONMENT = 'RESET_SELECTED_ENVIRONMENT';
+export const SET_SELECTED_ENVIRONMENT = 'SET_SELECTED_ENVIRONMENT';

app/assets/javascripts/ci_variable_list/store/mutations.js

@@ -83,4 +83,25 @@ export default {
     state.variableBeingEdited = null;
     state.showInputValue = false;
   },
+
+  [types.SET_ENVIRONMENT_SCOPE](state, environment) {
+    if (state.variableBeingEdited) {
+      state.variableBeingEdited.environment_scope = environment;
+    } else {
+      state.variable.environment_scope = environment;
+    }
+  },
+
+  [types.ADD_WILD_CARD_SCOPE](state, environment) {
+    state.environments.push(environment);
+    state.environments.sort();
+  },
+
+  [types.RESET_SELECTED_ENVIRONMENT](state) {
+    state.selectedEnvironment = '';
+  },
+
+  [types.SET_SELECTED_ENVIRONMENT](state, environment) {
+    state.selectedEnvironment = environment;
+  },
 };

app/assets/javascripts/ci_variable_list/store/state.js

@@ -21,4 +21,5 @@ export default () => ({
   environments: [],
   typeOptions: [displayText.variableText, displayText.fileText],
   variableBeingEdited: null,
+  selectedEnvironment: '',
 });

app/assets/javascripts/ci_variable_list/store/utils.js

@@ -41,3 +41,14 @@ export const prepareDataForApi = (variable, destroy = false) => {
 };
 
 export const prepareEnvironments = environments => environments.map(e => e.name);
+
+/**
+ * Extract environment_scope from any variables that were created using
+ * wildcard environment scope
+ * @param {Array} variables - Array of variable objects
+ * @returns {Array} - Array of variable enviroment scopes
+ */
+
+export const extractEnvironmentScopes = variables => {
+  return [...new Set(variables.map(variable => variable.environment_scope))];
+};

locale/gitlab.pot

@@ -1631,6 +1631,9 @@ msgstr ""
 msgid "All %{replicableType} are being scheduled for %{action}"
 msgstr ""
 
+msgid "All (default)"
+msgstr ""
+
 msgid "All Members"
 msgstr ""
 
@@ -5904,6 +5907,9 @@ msgstr ""
 msgid "Create project label"
 msgstr ""
 
+msgid "Create wildcard: %{searchTerm}"
+msgstr ""
+
 msgid "Create your first page"
 msgstr ""
 

spec/frontend/ci_variable_list/components/ci_enviroments_dropdown_spec.js

+import Vuex from 'vuex';
+import CiEnvironmentsDropdown from '~/ci_variable_list/components/ci_environments_dropdown.vue';
+import { shallowMount, createLocalVue } from '@vue/test-utils';
+import { GlDropdownItem, GlIcon } from '@gitlab/ui';
+
+const localVue = createLocalVue();
+localVue.use(Vuex);
+
+describe('Ci environments dropdown', () => {
+  let wrapper;
+  let store;
+
+  const createComponent = term => {
+    store = new Vuex.Store({
+      getters: {
+        joinedEnvironments: () => ['dev', 'prod', 'staging'],
+      },
+    });
+
+    wrapper = shallowMount(CiEnvironmentsDropdown, {
+      store,
+      localVue,
+      propsData: {
+        value: term,
+      },
+    });
+  };
+
+  const findAllDropdownItems = () => wrapper.findAll(GlDropdownItem);
+  const findDropdownItemByIndex = index => wrapper.findAll(GlDropdownItem).at(index);
+  const findActiveIconByIndex = index => wrapper.findAll(GlIcon).at(index);
+
+  beforeEach(() => {
+    createComponent('prod');
+  });
+
+  afterEach(() => {
+    wrapper.destroy();
+  });
+
+  describe('No enviroments found', () => {
+    beforeEach(() => {
+      createComponent('stable');
+    });
+
+    it('renders create button with search term if enviroments do not contain search term', () => {
+      expect(findAllDropdownItems()).toHaveLength(2);
+      expect(findDropdownItemByIndex(1).text()).toBe('Create wildcard: stable');
+    });
+
+    it('renders empty results message', () => {
+      expect(findDropdownItemByIndex(0).text()).toBe('No matching results');
+    });
+  });
+
+  describe('Enviroments found', () => {
+    it('renders all enviroments when search term is empty', () => {
+      createComponent('');
+      expect(findAllDropdownItems()).toHaveLength(3);
+      expect(findDropdownItemByIndex(0).text()).toBe('dev');
+      expect(findDropdownItemByIndex(1).text()).toBe('prod');
+      expect(findDropdownItemByIndex(2).text()).toBe('staging');
+    });
+
+    it('renders only the enviroment searched for', () => {
+      expect(findAllDropdownItems()).toHaveLength(1);
+      expect(findDropdownItemByIndex(0).text()).toBe('prod');
+    });
+
+    it('should not display create button', () => {
+      const enviroments = findAllDropdownItems().filter(env => env.text().startsWith('Create'));
+      expect(enviroments).toHaveLength(0);
+      expect(findAllDropdownItems()).toHaveLength(1);
+    });
+
+    it('should not display empty results message', () => {
+      expect(wrapper.find({ ref: 'noMatchingResults' }).exists()).toBe(false);
+    });
+
+    it('should display active checkmark if active', () => {
+      createComponent('dev');
+      expect(findActiveIconByIndex(0).classes('invisible')).toBe(false);
+    });
+  });
+
+  describe('Custom events', () => {
+    it('should emit selectEnvironment if an environment is clicked', () => {
+      findDropdownItemByIndex(0).vm.$emit('click');
+      expect(wrapper.emitted('selectEnvironment')).toEqual([['prod']]);
+    });
+
+    it('should emit createClicked if an environment is clicked', () => {
+      createComponent('newscope');
+      findDropdownItemByIndex(1).vm.$emit('click');
+      expect(wrapper.emitted('createClicked')).toEqual([['newscope']]);
+    });
+  });
+});

spec/frontend/ci_variable_list/services/mock_data.js

 export default {
   mockVariables: [
     {
-      environment_scope: 'All environments',
+      environment_scope: 'All (default)',
       id: 113,
       key: 'test_var',
       masked: false,
@@ -37,7 +37,7 @@ export default {
 
   mockVariablesDisplay: [
     {
-      environment_scope: 'All',
+      environment_scope: 'All (default)',
       id: 113,
       key: 'test_var',
       masked: false,
@@ -47,7 +47,7 @@ export default {
       variable_type: 'Var',
     },
     {
-      environment_scope: 'All',
+      environment_scope: 'All (default)',
       id: 114,
       key: 'test_var_2',
       masked: false,
@@ -88,4 +88,67 @@ export default {
   ozakE+8p06BpxegR4BR3FMHf6p+0jQxUEAkAyb/mVgm66TyghDGC6/YkiKoZptXQ
   98TwDIK/39WEB/V607As+KoYazQG8drorw==
   -----END CERTIFICATE REQUEST-----`,
+
+  mockVariableScopes: [
+    {
+      id: 13,
+      key: 'test_var_1',
+      value: 'test_val_1',
+      variable_type: 'File',
+      protected: true,
+      masked: true,
+      environment_scope: 'All (default)',
+      secret_value: 'test_val_1',
+    },
+    {
+      id: 28,
+      key: 'goku_var',
+      value: 'goku_val',
+      variable_type: 'Var',
+      protected: true,
+      masked: true,
+      environment_scope: 'staging',
+      secret_value: 'goku_val',
+    },
+    {
+      id: 25,
+      key: 'test_var_4',
+      value: 'test_val_4',
+      variable_type: 'Var',
+      protected: false,
+      masked: false,
+      environment_scope: 'production',
+      secret_value: 'test_val_4',
+    },
+    {
+      id: 14,
+      key: 'test_var_2',
+      value: 'test_val_2',
+      variable_type: 'File',
+      protected: false,
+      masked: false,
+      environment_scope: 'staging',
+      secret_value: 'test_val_2',
+    },
+    {
+      id: 24,
+      key: 'test_var_3',
+      value: 'test_val_3',
+      variable_type: 'Var',
+      protected: false,
+      masked: false,
+      environment_scope: 'All (default)',
+      secret_value: 'test_val_3',
+    },
+    {
+      id: 26,
+      key: 'test_var_5',
+      value: 'test_val_5',
+      variable_type: 'Var',
+      protected: false,
+      masked: false,
+      environment_scope: 'production',
+      secret_value: 'test_val_5',
+    },
+  ],
 };

spec/frontend/ci_variable_list/store/getters_spec.js

+import * as getters from '~/ci_variable_list/store/getters';
+import mockData from '../services/mock_data';
+
+describe('Ci variable getters', () => {
+  describe('joinedEnvironments', () => {
+    it('should return "on" when isShowingLabels is true', () => {
+      const state = {
+        environments: ['All (default)', 'staging', 'deployment', 'prod'],
+        variables: mockData.mockVariableScopes,
+      };
+
+      expect(getters.joinedEnvironments(state)).toEqual([
+        'All (default)',
+        'deployment',
+        'prod',
+        'production',
+        'staging',
+      ]);
+    });
+  });
+});

spec/frontend/ci_variable_list/store/mutations_spec.js

@@ -4,6 +4,15 @@ import * as types from '~/ci_variable_list/store/mutation_types';
 
 describe('CI variable list mutations', () => {
   let stateCopy;
+  const variableBeingEdited = {
+    environment_scope: '*',
+    id: 63,
+    key: 'test_var',
+    masked: false,
+    protected: false,
+    value: 'test_val',
+    variable_type: 'env_var',
+  };
 
   beforeEach(() => {
     stateCopy = state();
@@ -21,16 +30,6 @@ describe('CI variable list mutations', () => {
 
   describe('VARIABLE_BEING_EDITED', () => {
     it('should set variable that is being edited', () => {
-      const variableBeingEdited = {
-        environment_scope: '*',
-        id: 63,
-        key: 'test_var',
-        masked: false,
-        protected: false,
-        value: 'test_val',
-        variable_type: 'env_var',
-      };
-
       mutations[types.VARIABLE_BEING_EDITED](stateCopy, variableBeingEdited);
 
       expect(stateCopy.variableBeingEdited).toEqual(variableBeingEdited);
@@ -53,7 +52,7 @@ describe('CI variable list mutations', () => {
         secret_value: '',
         protected: false,
         masked: false,
-        environment_scope: 'All',
+        environment_scope: 'All (default)',
       };
 
       mutations[types.CLEAR_MODAL](stateCopy);
@@ -61,4 +60,41 @@ describe('CI variable list mutations', () => {
       expect(stateCopy.variable).toEqual(modalState);
     });
   });
+
+  describe('RECEIVE_ENVIRONMENTS_SUCCESS', () => {
+    it('should set environments', () => {
+      const environments = ['env1', 'env2'];
+
+      mutations[types.RECEIVE_ENVIRONMENTS_SUCCESS](stateCopy, environments);
+
+      expect(stateCopy.environments).toEqual(['All (default)', 'env1', 'env2']);
+    });
+  });
+
+  describe('SET_ENVIRONMENT_SCOPE', () => {
+    const environment = 'production';
+
+    it('should set scope to variable being updated if updating variable', () => {
+      stateCopy.variableBeingEdited = variableBeingEdited;
+
+      mutations[types.SET_ENVIRONMENT_SCOPE](stateCopy, environment);
+
+      expect(stateCopy.variableBeingEdited.environment_scope).toBe('production');
+    });
+
+    it('should set scope to variable if adding new variable', () => {
+      mutations[types.SET_ENVIRONMENT_SCOPE](stateCopy, environment);
+
+      expect(stateCopy.variable.environment_scope).toBe('production');
+    });
+  });
+
+  describe('ADD_WILD_CARD_SCOPE', () => {
+    it('should add wild card scope to enviroments array and sort', () => {
+      stateCopy.environments = ['dev', 'staging'];
+      mutations[types.ADD_WILD_CARD_SCOPE](stateCopy, 'production');
+
+      expect(stateCopy.environments).toEqual(['dev', 'production', 'staging']);
+    });
+  });
 });

spec/frontend/ci_variable_list/store/utils_spec.js

@@ -2,6 +2,7 @@ import {
   prepareDataForDisplay,
   prepareEnvironments,
   prepareDataForApi,
+  extractEnvironmentScopes,
 } from '~/ci_variable_list/store/utils';
 import mockData from '../services/mock_data';
 
@@ -46,4 +47,12 @@ describe('CI variables store utils', () => {
   it('prepares environments for display', () => {
     expect(prepareEnvironments(mockData.mockEnvironments)).toStrictEqual(['staging', 'production']);
   });
+
+  it('returns variable environment scopes with no duplicates', () => {
+    expect(extractEnvironmentScopes(mockData.mockVariableScopes)).toStrictEqual([
+      'All (default)',
+      'staging',
+      'production',
+    ]);
+  });
 });