Merge branch 'ak/all-pods' into 'master'

Add all pods view to logs explorer

See merge request gitlab-org/gitlab!26883

app/assets/javascripts/logs/components/environment_logs.vue

@@ -5,11 +5,13 @@ import {
   GlSprintf,
   GlAlert,
   GlDropdown,
+  GlDropdownDivider,
   GlDropdownItem,
   GlFormGroup,
   GlSearchBoxByClick,
   GlInfiniteScroll,
 } from '@gitlab/ui';
+import { s__ } from '~/locale';
 import DateTimePicker from '~/vue_shared/components/date_time_picker/date_time_picker.vue';
 import LogControlButtons from './log_control_buttons.vue';
 
@@ -22,6 +24,7 @@ export default {
     GlSprintf,
     GlAlert,
     GlDropdown,
+    GlDropdownDivider,
     GlDropdownItem,
     GlFormGroup,
     GlSearchBoxByClick,
@@ -90,6 +93,16 @@ export default {
     shouldShowElasticStackCallout() {
       return !this.isElasticStackCalloutDismissed && this.disableAdvancedControls;
     },
+
+    podDropdownText() {
+      if (this.pods.current) {
+        return this.pods.current;
+      } else if (this.advancedFeaturesEnabled) {
+        // "All pods" is a valid option when advanced querying is available
+        return s__('Environments|All pods');
+      }
+      return s__('Environments|No pod selected');
+    },
   },
   mounted() {
     this.setInitData({
@@ -178,11 +191,17 @@ export default {
         >
           <gl-dropdown
             id="pods-dropdown"
-            :text="pods.current || s__('Environments|No pods to display')"
+            :text="podDropdownText"
             :disabled="environments.isLoading"
             class="d-flex gl-h-32 js-pods-dropdown"
             toggle-class="dropdown-menu-toggle"
           >
+            <template v-if="advancedFeaturesEnabled">
+              <gl-dropdown-item key="all-pods" @click="showPodLogs(null)">
+                {{ s__('Environments|All pods') }}
+              </gl-dropdown-item>
+              <gl-dropdown-divider />
+            </template>
             <gl-dropdown-item
               v-for="podName in pods.options"
               :key="podName"

app/assets/javascripts/logs/stores/actions.js

@@ -82,7 +82,6 @@ export const setTimeRange = ({ dispatch, commit }, timeRange) => {
 
 export const showEnvironment = ({ dispatch, commit }, environmentName) => {
   commit(types.SET_PROJECT_ENVIRONMENT, environmentName);
-  commit(types.SET_CURRENT_POD_NAME, null);
   dispatch('fetchLogs');
 };
 
@@ -107,16 +106,16 @@ export const fetchEnvironments = ({ commit, dispatch }, environmentsPath) => {
 };
 
 export const fetchLogs = ({ commit, state }) => {
-  commit(types.REQUEST_PODS_DATA);
   commit(types.REQUEST_LOGS_DATA);
 
   return requestLogsUntilData(state)
     .then(({ data }) => {
       const { pod_name, pods, logs, cursor } = data;
+      commit(types.RECEIVE_LOGS_DATA_SUCCESS, { logs, cursor });
+
       commit(types.SET_CURRENT_POD_NAME, pod_name);
 
       commit(types.RECEIVE_PODS_DATA_SUCCESS, pods);
-      commit(types.RECEIVE_LOGS_DATA_SUCCESS, { logs, cursor });
     })
     .catch(() => {
       commit(types.RECEIVE_PODS_DATA_ERROR);

app/assets/javascripts/logs/stores/getters.js

 import { formatDate } from '../utils';
 
-const mapTrace = ({ timestamp = null, message = '' }) =>
-  [timestamp ? formatDate(timestamp) : '', message].join(' | ');
+const mapTrace = ({ timestamp = null, pod = '', message = '' }) =>
+  [timestamp ? formatDate(timestamp) : '', pod, message].join(' | ');
 
 export const trace = state => state.logs.lines.map(mapTrace).join('\n');
 

app/assets/javascripts/logs/stores/mutation_types.js

@@ -14,6 +14,5 @@ export const REQUEST_LOGS_DATA_PREPEND = 'REQUEST_LOGS_DATA_PREPEND';
 export const RECEIVE_LOGS_DATA_PREPEND_SUCCESS = 'RECEIVE_LOGS_DATA_PREPEND_SUCCESS';
 export const RECEIVE_LOGS_DATA_PREPEND_ERROR = 'RECEIVE_LOGS_DATA_PREPEND_ERROR';
 
-export const REQUEST_PODS_DATA = 'REQUEST_PODS_DATA';
 export const RECEIVE_PODS_DATA_SUCCESS = 'RECEIVE_PODS_DATA_SUCCESS';
 export const RECEIVE_PODS_DATA_ERROR = 'RECEIVE_PODS_DATA_ERROR';

app/assets/javascripts/logs/stores/mutations.js

 import * as types from './mutation_types';
 import { convertToFixedRange } from '~/lib/utils/datetime_range';
 
-const mapLine = ({ timestamp, message }) => ({
+const mapLine = ({ timestamp, pod, message }) => ({
   timestamp,
+  pod,
   message,
 });
 
@@ -21,6 +22,10 @@ export default {
   // Environments Data
   [types.SET_PROJECT_ENVIRONMENT](state, environmentName) {
     state.environments.current = environmentName;
+
+    // Clear current pod options
+    state.pods.current = null;
+    state.pods.options = [];
   },
   [types.REQUEST_ENVIRONMENTS_DATA](state) {
     state.environments.options = [];
@@ -81,9 +86,6 @@ export default {
   [types.SET_CURRENT_POD_NAME](state, podName) {
     state.pods.current = podName;
   },
-  [types.REQUEST_PODS_DATA](state) {
-    state.pods.options = [];
-  },
   [types.RECEIVE_PODS_DATA_SUCCESS](state, podOptions) {
     state.pods.options = podOptions;
   },

app/services/pod_logs/base_service.rb

@@ -55,22 +55,10 @@ module PodLogs
       return error(_('Cluster does not exist')) if cluster.nil?
       return error(_('Namespace is empty')) if namespace.blank?
 
-      success(result)
-    end
-
-    def check_param_lengths(_result)
-      pod_name = params['pod_name'].presence
-      container_name = params['container_name'].presence
+      result[:pod_name] = params['pod_name'].presence
+      result[:container_name] = params['container_name'].presence
 
-      if pod_name&.length.to_i > K8S_NAME_MAX_LENGTH
-        return error(_('pod_name cannot be larger than %{max_length}'\
-          ' chars' % { max_length: K8S_NAME_MAX_LENGTH }))
-      elsif container_name&.length.to_i > K8S_NAME_MAX_LENGTH
-        return error(_('container_name cannot be larger than'\
-          ' %{max_length} chars' % { max_length: K8S_NAME_MAX_LENGTH }))
-      end
-
-      success(pod_name: pod_name, container_name: container_name)
+      success(result)
     end
 
     def get_raw_pods(result)
@@ -85,40 +73,6 @@ module PodLogs
       success(result)
     end
 
-    def check_pod_name(result)
-      # If pod_name is not received as parameter, get the pod logs of the first
-      # pod of this namespace.
-      result[:pod_name] ||= result[:pods].first
-
-      unless result[:pod_name]
-        return error(_('No pods available'))
-      end
-
-      unless result[:pods].include?(result[:pod_name])
-        return error(_('Pod does not exist'))
-      end
-
-      success(result)
-    end
-
-    def check_container_name(result)
-      pod_details = result[:raw_pods].first { |p| p.metadata.name == result[:pod_name] }
-      containers = pod_details.spec.containers.map(&:name)
-
-      # select first container if not specified
-      result[:container_name] ||= containers.first
-
-      unless result[:container_name]
-        return error(_('No containers available'))
-      end
-
-      unless containers.include?(result[:container_name])
-        return error(_('Container does not exist'))
-      end
-
-      success(result)
-    end
-
     def pod_logs(result)
       raise NotImplementedError
     end

app/services/pod_logs/elasticsearch_service.rb

@@ -3,11 +3,8 @@
 module PodLogs
   class ElasticsearchService < PodLogs::BaseService
     steps :check_arguments,
-          :check_param_lengths,
           :get_raw_pods,
           :get_pod_names,
-          :check_pod_name,
-          :check_container_name,
           :check_times,
           :check_search,
           :check_cursor,
@@ -53,7 +50,7 @@ module PodLogs
 
       response = ::Gitlab::Elasticsearch::Logs.new(client).pod_logs(
         namespace,
-        result[:pod_name],
+        pod_name: result[:pod_name],
         container_name: result[:container_name],
         search: result[:search],
         start_time: result[:start],

app/services/pod_logs/kubernetes_service.rb

@@ -8,7 +8,6 @@ module PodLogs
     EncodingHelperError = Class.new(StandardError)
 
     steps :check_arguments,
-          :check_param_lengths,
           :get_raw_pods,
           :get_pod_names,
           :check_pod_name,
@@ -22,6 +21,50 @@ module PodLogs
 
     private
 
+    def check_pod_name(result)
+      # If pod_name is not received as parameter, get the pod logs of the first
+      # pod of this namespace.
+      result[:pod_name] ||= result[:pods].first
+
+      unless result[:pod_name]
+        return error(_('No pods available'))
+      end
+
+      unless result[:pod_name].length.to_i <= K8S_NAME_MAX_LENGTH
+        return error(_('pod_name cannot be larger than %{max_length}'\
+          ' chars' % { max_length: K8S_NAME_MAX_LENGTH }))
+      end
+
+      unless result[:pods].include?(result[:pod_name])
+        return error(_('Pod does not exist'))
+      end
+
+      success(result)
+    end
+
+    def check_container_name(result)
+      pod_details = result[:raw_pods].first { |p| p.metadata.name == result[:pod_name] }
+      containers = pod_details.spec.containers.map(&:name)
+
+      # select first container if not specified
+      result[:container_name] ||= containers.first
+
+      unless result[:container_name]
+        return error(_('No containers available'))
+      end
+
+      unless result[:container_name].length.to_i <= K8S_NAME_MAX_LENGTH
+        return error(_('container_name cannot be larger than'\
+          ' %{max_length} chars' % { max_length: K8S_NAME_MAX_LENGTH }))
+      end
+
+      unless containers.include?(result[:container_name])
+        return error(_('Container does not exist'))
+      end
+
+      success(result)
+    end
+
     def pod_logs(result)
       result[:logs] = cluster.kubeclient.get_pod_log(
         result[:pod_name],
@@ -62,7 +105,8 @@ module PodLogs
         values = line.split(' ', 2)
         {
           timestamp: values[0],
-          message: values[1]
+          message: values[1],
+          pod: result[:pod_name]
         }
       end
 

changelogs/unreleased/ak-all-pods.yml

+---
+title: Add all pods view to logs explorer
+merge_request: 26883
+author:
+type: added

ee/spec/features/projects/environments_pod_logs_spec.rb

@@ -57,7 +57,7 @@ describe 'Environment > Pod Logs', :js do
           expect(item.text).to eq(pod_names[i])
         end
       end
-      expect(page).to have_content("Dec 13 14:04:22.123Z | Log 1 Dec 13 14:04:23.123Z | Log 2 Dec 13 14:04:24.123Z | Log 3")
+      expect(page).to have_content("Dec 13 14:04:22.123Z | kube-pod | Log 1 Dec 13 14:04:23.123Z | kube-pod | Log 2 Dec 13 14:04:24.123Z | kube-pod | Log 3")
     end
   end
 end

lib/gitlab/elasticsearch/logs.rb

@@ -12,7 +12,7 @@ module Gitlab
         @client = client
       end
 
-      def pod_logs(namespace, pod_name, container_name: nil, search: nil, start_time: nil, end_time: nil, cursor: nil)
+      def pod_logs(namespace, pod_name: nil, container_name: nil, search: nil, start_time: nil, end_time: nil, cursor: nil)
         query = { bool: { must: [] } }.tap do |q|
           filter_pod_name(q, pod_name)
           filter_namespace(q, namespace)
@@ -38,7 +38,7 @@ module Gitlab
             { "offset": { order: :desc } }
           ],
           # only return these fields in the response
-          _source: ["@timestamp", "message"],
+          _source: ["@timestamp", "message", "kubernetes.pod.name"],
           # fixed limit for now, we should support paginated queries
           size: ::Gitlab::Elasticsearch::Logs::LOGS_LIMIT
         }
@@ -51,6 +51,9 @@ module Gitlab
       end
 
       def filter_pod_name(query, pod_name)
+        # We can filter by "all pods" with a null pod_name
+        return if pod_name.nil?
+
         query[:bool][:must] << {
           match_phrase: {
             "kubernetes.pod.name" => {
@@ -113,7 +116,8 @@ module Gitlab
         results = results.map do |hit|
           {
             timestamp: hit["_source"]["@timestamp"],
-            message: hit["_source"]["message"]
+            message: hit["_source"]["message"],
+            pod: hit["_source"]["kubernetes"]["pod"]["name"]
           }
         end
 

locale/gitlab.pot

@@ -7651,6 +7651,9 @@ msgstr ""
 msgid "EnvironmentsDashboard|This dashboard displays a maximum of 7 projects and 3 environments per project. %{readMoreLink}"
 msgstr ""
 
+msgid "Environments|All pods"
+msgstr ""
+
 msgid "Environments|An error occurred while canceling the auto stop, please try again"
 msgstr ""
 
@@ -7732,7 +7735,7 @@ msgstr ""
 msgid "Environments|No deployments yet"
 msgstr ""
 
-msgid "Environments|No pods to display"
+msgid "Environments|No pod selected"
 msgstr ""
 
 msgid "Environments|Note that this action will stop the environment, but it will %{emphasisStart}not%{emphasisEnd} have an effect on any existing deployment due to no “stop environment action” being defined in the %{ciConfigLinkStart}.gitlab-ci.yml%{ciConfigLinkEnd} file."

spec/fixtures/lib/elasticsearch/logs_response.json

@@ -19,7 +19,12 @@
         "_score": null,
         "_source": {
           "message": "10.8.2.1 - - [25/Oct/2019:08:03:22 UTC] \"GET / HTTP/1.1\" 200 13",
-          "@timestamp": "2019-12-13T14:35:34.034Z"
+          "@timestamp": "2019-12-13T14:35:34.034Z",
+          "kubernetes": {
+            "pod": {
+              "name": "production-6866bc8974-m4sk4"
+            }
+          }
         },
         "sort": [
           9999998,
@@ -33,7 +38,12 @@
         "_score": null,
         "_source": {
           "message": "10.8.2.1 - - [27/Oct/2019:23:49:54 UTC] \"GET / HTTP/1.1\" 200 13",
-          "@timestamp": "2019-12-13T14:35:35.034Z"
+          "@timestamp": "2019-12-13T14:35:35.034Z",
+          "kubernetes": {
+            "pod": {
+              "name": "production-6866bc8974-m4sk4"
+            }
+          }
         },
         "sort": [
           9999949,
@@ -47,7 +57,12 @@
         "_score": null,
         "_source": {
           "message": "10.8.2.1 - - [04/Nov/2019:23:09:24 UTC] \"GET / HTTP/1.1\" 200 13",
-          "@timestamp": "2019-12-13T14:35:36.034Z"
+          "@timestamp": "2019-12-13T14:35:36.034Z",
+          "kubernetes": {
+            "pod": {
+              "name": "production-6866bc8974-m4sk4"
+            }
+          }
         },
         "sort": [
           9999944,
@@ -61,7 +76,12 @@
         "_score": null,
         "_source": {
           "message": "- -\u003e /",
-          "@timestamp": "2019-12-13T14:35:37.034Z"
+          "@timestamp": "2019-12-13T14:35:37.034Z",
+          "kubernetes": {
+            "pod": {
+              "name": "production-6866bc8974-m4sk4"
+            }
+          }
         },
         "sort": [
           9999934,

spec/fixtures/lib/elasticsearch/query.json

@@ -33,7 +33,8 @@
   ],
   "_source": [
     "@timestamp",
-    "message"
+    "message",
+    "kubernetes.pod.name"
   ],
   "size": 500
 }

spec/fixtures/lib/elasticsearch/query_with_container.json

@@ -40,7 +40,8 @@
   ],
   "_source": [
     "@timestamp",
-    "message"
+    "message",
+    "kubernetes.pod.name"
   ],
   "size": 500
 }

spec/fixtures/lib/elasticsearch/query_with_cursor.json

@@ -37,7 +37,8 @@
   ],
   "_source": [
     "@timestamp",
-    "message"
+    "message",
+    "kubernetes.pod.name"
   ],
   "size": 500
 }

spec/fixtures/lib/elasticsearch/query_with_end_time.json

@@ -42,7 +42,8 @@
   ],
   "_source": [
     "@timestamp",
-    "message"
+    "message",
+    "kubernetes.pod.name"
   ],
   "size": 500
 }

spec/fixtures/lib/elasticsearch/query_with_search.json

@@ -42,7 +42,8 @@
   ],
   "_source": [
     "@timestamp",
-    "message"
+    "message",
+    "kubernetes.pod.name"
   ],
   "size": 500
 }

spec/fixtures/lib/elasticsearch/query_with_start_time.json

@@ -42,7 +42,8 @@
   ],
   "_source": [
     "@timestamp",
-    "message"
+    "message",
+    "kubernetes.pod.name"
   ],
   "size": 500
 }

spec/fixtures/lib/elasticsearch/query_with_times.json

@@ -43,7 +43,8 @@
   ],
   "_source": [
     "@timestamp",
-    "message"
+    "message",
+    "kubernetes.pod.name"
   ],
   "size": 500
 }

spec/frontend/logs/components/environment_logs_spec.js

@@ -300,9 +300,10 @@ describe('EnvironmentLogs', () => {
       const items = findPodsDropdown().findAll(GlDropdownItem);
 
       expect(findPodsDropdown().props('text')).toBe(mockPodName);
-      expect(items.length).toBe(mockPods.length);
+      expect(items.length).toBe(mockPods.length + 1);
+      expect(items.at(0).text()).toBe('All pods');
       mockPods.forEach((pod, i) => {
-        const item = items.at(i);
+        const item = items.at(i + 1);
         expect(item.text()).toBe(pod);
       });
     });
@@ -345,7 +346,7 @@ describe('EnvironmentLogs', () => {
 
         expect(dispatch).not.toHaveBeenCalledWith(`${module}/showPodLogs`, expect.anything());
 
-        items.at(index).vm.$emit('click');
+        items.at(index + 1).vm.$emit('click');
 
         expect(dispatch).toHaveBeenCalledWith(`${module}/showPodLogs`, mockPods[index]);
       });

spec/frontend/logs/mock_data.js

@@ -32,15 +32,93 @@ export const mockPods = [
 ];
 
 export const mockLogsResult = [
-  { timestamp: '2019-12-13T13:43:18.2760123Z', message: 'Log 1' },
-  { timestamp: '2019-12-13T13:43:18.2760123Z', message: 'Log 2' },
-  { timestamp: '2019-12-13T13:43:26.8420123Z', message: 'Log 3' },
+  {
+    timestamp: '2019-12-13T13:43:18.2760123Z',
+    message: '10.36.0.1 - - [16/Oct/2019:06:29:48 UTC] "GET / HTTP/1.1" 200 13',
+    pod: 'foo',
+  },
+  {
+    timestamp: '2019-12-13T13:43:18.2760123Z',
+    message: '- -> /',
+    pod: 'bar',
+  },
+  {
+    timestamp: '2019-12-13T13:43:26.8420123Z',
+    message: '10.36.0.1 - - [16/Oct/2019:06:29:57 UTC] "GET / HTTP/1.1" 200 13',
+    pod: 'foo',
+  },
+  {
+    timestamp: '2019-12-13T13:43:26.8420123Z',
+    message: '- -> /',
+    pod: 'bar',
+  },
+  {
+    timestamp: '2019-12-13T13:43:28.3710123Z',
+    message: '10.36.0.1 - - [16/Oct/2019:06:29:58 UTC] "GET / HTTP/1.1" 200 13',
+    pod: 'foo',
+  },
+  {
+    timestamp: '2019-12-13T13:43:28.3710123Z',
+    message: '- -> /',
+    pod: 'bar',
+  },
+  {
+    timestamp: '2019-12-13T13:43:36.8860123Z',
+    message: '10.36.0.1 - - [16/Oct/2019:06:30:07 UTC] "GET / HTTP/1.1" 200 13',
+    pod: 'foo',
+  },
+  {
+    timestamp: '2019-12-13T13:43:36.8860123Z',
+    message: '- -> /',
+    pod: 'bar',
+  },
+  {
+    timestamp: '2019-12-13T13:43:38.4000123Z',
+    message: '10.36.0.1 - - [16/Oct/2019:06:30:08 UTC] "GET / HTTP/1.1" 200 13',
+    pod: 'foo',
+  },
+  {
+    timestamp: '2019-12-13T13:43:38.4000123Z',
+    message: '- -> /',
+    pod: 'bar',
+  },
+  {
+    timestamp: '2019-12-13T13:43:46.8420123Z',
+    message: '10.36.0.1 - - [16/Oct/2019:06:30:17 UTC] "GET / HTTP/1.1" 200 13',
+    pod: 'foo',
+  },
+  {
+    timestamp: '2019-12-13T13:43:46.8430123Z',
+    message: '- -> /',
+    pod: 'bar',
+  },
+  {
+    timestamp: '2019-12-13T13:43:48.3240123Z',
+    message: '10.36.0.1 - - [16/Oct/2019:06:30:18 UTC] "GET / HTTP/1.1" 200 13',
+    pod: 'foo',
+  },
+  {
+    timestamp: '2019-12-13T13:43:48.3250123Z',
+    message: '- -> /',
+    pod: 'bar',
+  },
 ];
 
 export const mockTrace = [
-  'Dec 13 13:43:18.276Z | Log 1',
-  'Dec 13 13:43:18.276Z | Log 2',
-  'Dec 13 13:43:26.842Z | Log 3',
+  'Dec 13 13:43:18.276Z | foo | 10.36.0.1 - - [16/Oct/2019:06:29:48 UTC] "GET / HTTP/1.1" 200 13',
+  'Dec 13 13:43:18.276Z | bar | - -> /',
+  'Dec 13 13:43:26.842Z | foo | 10.36.0.1 - - [16/Oct/2019:06:29:57 UTC] "GET / HTTP/1.1" 200 13',
+  'Dec 13 13:43:26.842Z | bar | - -> /',
+  'Dec 13 13:43:28.371Z | foo | 10.36.0.1 - - [16/Oct/2019:06:29:58 UTC] "GET / HTTP/1.1" 200 13',
+  'Dec 13 13:43:28.371Z | bar | - -> /',
+  'Dec 13 13:43:36.886Z | foo | 10.36.0.1 - - [16/Oct/2019:06:30:07 UTC] "GET / HTTP/1.1" 200 13',
+  'Dec 13 13:43:36.886Z | bar | - -> /',
+  'Dec 13 13:43:38.400Z | foo | 10.36.0.1 - - [16/Oct/2019:06:30:08 UTC] "GET / HTTP/1.1" 200 13',
+  'Dec 13 13:43:38.400Z | bar | - -> /',
+  'Dec 13 13:43:46.842Z | foo | 10.36.0.1 - - [16/Oct/2019:06:30:17 UTC] "GET / HTTP/1.1" 200 13',
+  'Dec 13 13:43:46.843Z | bar | - -> /',
+  'Dec 13 13:43:48.324Z | foo | 10.36.0.1 - - [16/Oct/2019:06:30:18 UTC] "GET / HTTP/1.1" 200 13',
+  'Dec 13 13:43:48.325Z | bar | - -> /',
 ];
 
 export const mockResponse = {

spec/frontend/logs/stores/actions_spec.js

@@ -172,14 +172,13 @@ describe('Logs Store actions', () => {
     describe('fetchLogs', () => {
       beforeEach(() => {
         expectedMutations = [
-          { type: types.REQUEST_PODS_DATA },
           { type: types.REQUEST_LOGS_DATA },
-          { type: types.SET_CURRENT_POD_NAME, payload: mockPodName },
-          { type: types.RECEIVE_PODS_DATA_SUCCESS, payload: mockPods },
           {
             type: types.RECEIVE_LOGS_DATA_SUCCESS,
             payload: { logs: mockLogsResult, cursor: mockNextCursor },
           },
+          { type: types.SET_CURRENT_POD_NAME, payload: mockPodName },
+          { type: types.RECEIVE_PODS_DATA_SUCCESS, payload: mockPods },
         ];
 
         expectedActions = [];
@@ -364,7 +363,6 @@ describe('Logs Store actions', () => {
         null,
         state,
         [
-          { type: types.REQUEST_PODS_DATA },
           { type: types.REQUEST_LOGS_DATA },
           { type: types.RECEIVE_PODS_DATA_ERROR },
           { type: types.RECEIVE_LOGS_DATA_ERROR },

spec/frontend/logs/stores/mutations_spec.js

@@ -223,17 +223,6 @@ describe('Logs Store Mutations', () => {
     });
   });
 
-  describe('REQUEST_PODS_DATA', () => {
-    it('receives pods data', () => {
-      mutations[types.REQUEST_PODS_DATA](state);
-
-      expect(state.pods).toEqual(
-        expect.objectContaining({
-          options: [],
-        }),
-      );
-    });
-  });
   describe('RECEIVE_PODS_DATA_SUCCESS', () => {
     it('receives pods data success', () => {
       mutations[types.RECEIVE_PODS_DATA_SUCCESS](state, mockPods);

spec/lib/gitlab/elasticsearch/logs_spec.rb

@@ -5,10 +5,10 @@ require 'spec_helper'
 describe Gitlab::Elasticsearch::Logs do
   let(:client) { Elasticsearch::Transport::Client }
 
-  let(:es_message_1) { { timestamp: "2019-12-13T14:35:34.034Z", message: "10.8.2.1 - - [25/Oct/2019:08:03:22 UTC] \"GET / HTTP/1.1\" 200 13" } }
-  let(:es_message_2) { { timestamp: "2019-12-13T14:35:35.034Z", message: "10.8.2.1 - - [27/Oct/2019:23:49:54 UTC] \"GET / HTTP/1.1\" 200 13" } }
-  let(:es_message_3) { { timestamp: "2019-12-13T14:35:36.034Z", message: "10.8.2.1 - - [04/Nov/2019:23:09:24 UTC] \"GET / HTTP/1.1\" 200 13" } }
-  let(:es_message_4) { { timestamp: "2019-12-13T14:35:37.034Z", message: "- -\u003e /" } }
+  let(:es_message_1) { { timestamp: "2019-12-13T14:35:34.034Z", pod: "production-6866bc8974-m4sk4", message: "10.8.2.1 - - [25/Oct/2019:08:03:22 UTC] \"GET / HTTP/1.1\" 200 13" } }
+  let(:es_message_2) { { timestamp: "2019-12-13T14:35:35.034Z", pod: "production-6866bc8974-m4sk4", message: "10.8.2.1 - - [27/Oct/2019:23:49:54 UTC] \"GET / HTTP/1.1\" 200 13" } }
+  let(:es_message_3) { { timestamp: "2019-12-13T14:35:36.034Z", pod: "production-6866bc8974-m4sk4", message: "10.8.2.1 - - [04/Nov/2019:23:09:24 UTC] \"GET / HTTP/1.1\" 200 13" } }
+  let(:es_message_4) { { timestamp: "2019-12-13T14:35:37.034Z", pod: "production-6866bc8974-m4sk4", message: "- -\u003e /" } }
 
   let(:es_response) { JSON.parse(fixture_file('lib/elasticsearch/logs_response.json')) }
 
@@ -40,49 +40,49 @@ describe Gitlab::Elasticsearch::Logs do
     it 'returns the logs as an array' do
       expect(client).to receive(:search).with(body: a_hash_equal_to_json(body)).and_return(es_response)
 
-      result = subject.pod_logs(namespace, pod_name)
+      result = subject.pod_logs(namespace, pod_name: pod_name)
       expect(result).to eq(logs: [es_message_4, es_message_3, es_message_2, es_message_1], cursor: cursor)
     end
 
     it 'can further filter the logs by container name' do
       expect(client).to receive(:search).with(body: a_hash_equal_to_json(body_with_container)).and_return(es_response)
 
-      result = subject.pod_logs(namespace, pod_name, container_name: container_name)
+      result = subject.pod_logs(namespace, pod_name: pod_name, container_name: container_name)
       expect(result).to eq(logs: [es_message_4, es_message_3, es_message_2, es_message_1], cursor: cursor)
     end
 
     it 'can further filter the logs by search' do
       expect(client).to receive(:search).with(body: a_hash_equal_to_json(body_with_search)).and_return(es_response)
 
-      result = subject.pod_logs(namespace, pod_name, search: search)
+      result = subject.pod_logs(namespace, pod_name: pod_name, search: search)
       expect(result).to eq(logs: [es_message_4, es_message_3, es_message_2, es_message_1], cursor: cursor)
     end
 
     it 'can further filter the logs by start_time and end_time' do
       expect(client).to receive(:search).with(body: a_hash_equal_to_json(body_with_times)).and_return(es_response)
 
-      result = subject.pod_logs(namespace, pod_name, start_time: start_time, end_time: end_time)
+      result = subject.pod_logs(namespace, pod_name: pod_name, start_time: start_time, end_time: end_time)
       expect(result).to eq(logs: [es_message_4, es_message_3, es_message_2, es_message_1], cursor: cursor)
     end
 
     it 'can further filter the logs by only start_time' do
       expect(client).to receive(:search).with(body: a_hash_equal_to_json(body_with_start_time)).and_return(es_response)
 
-      result = subject.pod_logs(namespace, pod_name, start_time: start_time)
+      result = subject.pod_logs(namespace, pod_name: pod_name, start_time: start_time)
       expect(result).to eq(logs: [es_message_4, es_message_3, es_message_2, es_message_1], cursor: cursor)
     end
 
     it 'can further filter the logs by only end_time' do
       expect(client).to receive(:search).with(body: a_hash_equal_to_json(body_with_end_time)).and_return(es_response)
 
-      result = subject.pod_logs(namespace, pod_name, end_time: end_time)
+      result = subject.pod_logs(namespace, pod_name: pod_name, end_time: end_time)
       expect(result).to eq(logs: [es_message_4, es_message_3, es_message_2, es_message_1], cursor: cursor)
     end
 
     it 'can search after a cursor' do
       expect(client).to receive(:search).with(body: a_hash_equal_to_json(body_with_cursor)).and_return(es_response)
 
-      result = subject.pod_logs(namespace, pod_name, cursor: cursor)
+      result = subject.pod_logs(namespace, pod_name: pod_name, cursor: cursor)
       expect(result).to eq(logs: [es_message_4, es_message_3, es_message_2, es_message_1], cursor: cursor)
     end
   end

spec/services/pod_logs/base_service_spec.rb

@@ -78,9 +78,7 @@ describe ::PodLogs::BaseService do
         expect(result[:message]).to eq('Namespace is empty')
       end
     end
-  end
 
-  describe '#check_param_lengths' do
     context 'when pod_name and container_name are provided' do
       let(:params) do
         {
@@ -90,43 +88,13 @@ describe ::PodLogs::BaseService do
       end
 
       it 'returns success' do
-        result = subject.send(:check_param_lengths, {})
+        result = subject.send(:check_arguments, {})
 
         expect(result[:status]).to eq(:success)
         expect(result[:pod_name]).to eq(pod_name)
         expect(result[:container_name]).to eq(container_name)
       end
     end
-
-    context 'when pod_name is too long' do
-      let(:params) do
-        {
-        'pod_name' => "a very long string." * 15
-      }
-      end
-
-      it 'returns an error' do
-        result = subject.send(:check_param_lengths, {})
-
-        expect(result[:status]).to eq(:error)
-        expect(result[:message]).to eq('pod_name cannot be larger than 253 chars')
-      end
-    end
-
-    context 'when container_name is too long' do
-      let(:params) do
-        {
-          'container_name' => "a very long string." * 15
-        }
-      end
-
-      it 'returns an error' do
-        result = subject.send(:check_param_lengths, {})
-
-        expect(result[:status]).to eq(:error)
-        expect(result[:message]).to eq('container_name cannot be larger than 253 chars')
-      end
-    end
   end
 
   describe '#get_raw_pods' do
@@ -150,80 +118,4 @@ describe ::PodLogs::BaseService do
       expect(result[:pods]).to eq([pod_name])
     end
   end
-
-  describe '#check_pod_name' do
-    it 'returns success if pod_name was specified' do
-      result = subject.send(:check_pod_name, pod_name: pod_name, pods: [pod_name])
-
-      expect(result[:status]).to eq(:success)
-      expect(result[:pod_name]).to eq(pod_name)
-    end
-
-    it 'returns success if pod_name was not specified but there are pods' do
-      result = subject.send(:check_pod_name, pod_name: nil, pods: [pod_name])
-
-      expect(result[:status]).to eq(:success)
-      expect(result[:pod_name]).to eq(pod_name)
-    end
-
-    it 'returns error if pod_name was not specified and there are no pods' do
-      result = subject.send(:check_pod_name, pod_name: nil, pods: [])
-
-      expect(result[:status]).to eq(:error)
-      expect(result[:message]).to eq('No pods available')
-    end
-
-    it 'returns error if pod_name was specified but does not exist' do
-      result = subject.send(:check_pod_name, pod_name: 'another_pod', pods: [pod_name])
-
-      expect(result[:status]).to eq(:error)
-      expect(result[:message]).to eq('Pod does not exist')
-    end
-  end
-
-  describe '#check_container_name' do
-    it 'returns success if container_name was specified' do
-      result = subject.send(:check_container_name,
-        container_name: container_name,
-        pod_name: pod_name,
-        raw_pods: raw_pods
-      )
-
-      expect(result[:status]).to eq(:success)
-      expect(result[:container_name]).to eq(container_name)
-    end
-
-    it 'returns success if container_name was not specified and there are containers' do
-      result = subject.send(:check_container_name,
-        pod_name: pod_name,
-        raw_pods: raw_pods
-      )
-
-      expect(result[:status]).to eq(:success)
-      expect(result[:container_name]).to eq(container_name)
-    end
-
-    it 'returns error if container_name was not specified and there are no containers on the pod' do
-      raw_pods.first.spec.containers = []
-
-      result = subject.send(:check_container_name,
-        pod_name: pod_name,
-        raw_pods: raw_pods
-      )
-
-      expect(result[:status]).to eq(:error)
-      expect(result[:message]).to eq('No containers available')
-    end
-
-    it 'returns error if container_name was specified but does not exist' do
-      result = subject.send(:check_container_name,
-        container_name: 'foo',
-        pod_name: pod_name,
-        raw_pods: raw_pods
-      )
-
-      expect(result[:status]).to eq(:error)
-      expect(result[:message]).to eq('Container does not exist')
-    end
-  end
 end

spec/services/pod_logs/elasticsearch_service_spec.rb

@@ -170,7 +170,7 @@ describe ::PodLogs::ElasticsearchService do
         .and_return(Elasticsearch::Transport::Client.new)
       allow_any_instance_of(::Gitlab::Elasticsearch::Logs)
         .to receive(:pod_logs)
-        .with(namespace, pod_name, container_name: container_name, search: search, start_time: start_time, end_time: end_time, cursor: cursor)
+        .with(namespace, pod_name: pod_name, container_name: container_name, search: search, start_time: start_time, end_time: end_time, cursor: cursor)
         .and_return({ logs: expected_logs, cursor: expected_cursor })
 
       result = subject.send(:pod_logs, result_arg)

spec/services/pod_logs/kubernetes_service_spec.rb

@@ -9,13 +9,18 @@ describe ::PodLogs::KubernetesService do
   let(:namespace) { 'autodevops-deploy-9-production' }
 
   let(:pod_name) { 'pod-1' }
-  let(:container_name) { 'container-1' }
+  let(:container_name) { 'container-0' }
   let(:params) { {} }
 
   let(:raw_logs) do
     "2019-12-13T14:04:22.123456Z Log 1\n2019-12-13T14:04:23.123456Z Log 2\n" \
       "2019-12-13T14:04:24.123456Z Log 3"
   end
+  let(:raw_pods) do
+    JSON.parse([
+      kube_pod(name: pod_name)
+    ].to_json, object_class: OpenStruct)
+  end
 
   subject { described_class.new(cluster, namespace, params: params) }
 
@@ -140,9 +145,9 @@ describe ::PodLogs::KubernetesService do
 
     let(:expected_logs) do
       [
-        { message: "Log 1", timestamp: "2019-12-13T14:04:22.123456Z" },
-        { message: "Log 2", timestamp: "2019-12-13T14:04:23.123456Z" },
-        { message: "Log 3", timestamp: "2019-12-13T14:04:24.123456Z" }
+        { message: "Log 1", pod: 'pod-1', timestamp: "2019-12-13T14:04:22.123456Z" },
+        { message: "Log 2", pod: 'pod-1', timestamp: "2019-12-13T14:04:23.123456Z" },
+        { message: "Log 3", pod: 'pod-1', timestamp: "2019-12-13T14:04:24.123456Z" }
       ]
     end
 
@@ -163,4 +168,98 @@ describe ::PodLogs::KubernetesService do
       end
     end
   end
+
+  describe '#check_pod_name' do
+    it 'returns success if pod_name was specified' do
+      result = subject.send(:check_pod_name, pod_name: pod_name, pods: [pod_name])
+
+      expect(result[:status]).to eq(:success)
+      expect(result[:pod_name]).to eq(pod_name)
+    end
+
+    it 'returns success if pod_name was not specified but there are pods' do
+      result = subject.send(:check_pod_name, pod_name: nil, pods: [pod_name])
+
+      expect(result[:status]).to eq(:success)
+      expect(result[:pod_name]).to eq(pod_name)
+    end
+
+    it 'returns error if pod_name was not specified and there are no pods' do
+      result = subject.send(:check_pod_name, pod_name: nil, pods: [])
+
+      expect(result[:status]).to eq(:error)
+      expect(result[:message]).to eq('No pods available')
+    end
+
+    it 'returns error if pod_name was specified but does not exist' do
+      result = subject.send(:check_pod_name, pod_name: 'another_pod', pods: [pod_name])
+
+      expect(result[:status]).to eq(:error)
+      expect(result[:message]).to eq('Pod does not exist')
+    end
+
+    it 'returns error if pod_name is too long' do
+      result = subject.send(:check_pod_name, pod_name: "a very long string." * 15, pods: [pod_name])
+
+      expect(result[:status]).to eq(:error)
+      expect(result[:message]).to eq('pod_name cannot be larger than 253 chars')
+    end
+  end
+
+  describe '#check_container_name' do
+    it 'returns success if container_name was specified' do
+      result = subject.send(:check_container_name,
+        container_name: container_name,
+        pod_name: pod_name,
+        raw_pods: raw_pods
+      )
+
+      expect(result[:status]).to eq(:success)
+      expect(result[:container_name]).to eq(container_name)
+    end
+
+    it 'returns success if container_name was not specified and there are containers' do
+      result = subject.send(:check_container_name,
+        pod_name: pod_name,
+        raw_pods: raw_pods
+      )
+
+      expect(result[:status]).to eq(:success)
+      expect(result[:container_name]).to eq(container_name)
+    end
+
+    it 'returns error if container_name was not specified and there are no containers on the pod' do
+      raw_pods.first.spec.containers = []
+
+      result = subject.send(:check_container_name,
+        pod_name: pod_name,
+        raw_pods: raw_pods
+      )
+
+      expect(result[:status]).to eq(:error)
+      expect(result[:message]).to eq('No containers available')
+    end
+
+    it 'returns error if container_name was specified but does not exist' do
+      result = subject.send(:check_container_name,
+        container_name: 'foo',
+        pod_name: pod_name,
+        raw_pods: raw_pods
+      )
+
+      expect(result[:status]).to eq(:error)
+      expect(result[:message]).to eq('Container does not exist')
+    end
+
+    it 'returns error if container_name is too long' do
+      result = subject.send(:check_container_name,
+        container_name: "a very long string." * 15,
+        pod_name: pod_name,
+        raw_pods: raw_pods
+      )
+
+      expect(result[:status]).to eq(:error)
+      expect(result[:message]).to eq('container_name cannot be larger than 253 chars')
+    end
+  end
 end