/ee/spec/models/ee/clusters/platforms/kubernetes_spec.rb

# frozen_string_literal: true

require 'spec_helper'

describe Clusters::Platforms::Kubernetes do
  include KubernetesHelpers
  include ReactiveCachingHelpers

  shared_examples 'resource not found error' do |message|
    it 'raises error' do
      result = subject

      expect(result[:error]).to eq(message)
      expect(result[:status]).to eq(:error)
    end
  end

  shared_examples 'kubernetes API error' do |error_code|
    it 'raises error' do
      result = subject

      expect(result[:error]).to eq("Kubernetes API returned status code: #{error_code}")
      expect(result[:status]).to eq(:error)
    end
  end

  describe '#rollout_status' do
    let(:deployments) { [] }
    let(:pods) { [] }
    let(:service) { create(:cluster_platform_kubernetes, :configured) }
    let!(:cluster) { create(:cluster, :project, enabled: true, platform_kubernetes: service) }
    let(:project) { cluster.project }
    let(:environment) { build(:environment, project: project, name: "env", slug: "env-000000") }
    let(:cache_data) { Hash(deployments: deployments, pods: pods) }

    subject(:rollout_status) { service.rollout_status(environment, cache_data) }

    context 'legacy deployments based on app label' do
      let(:legacy_deployment) do
        kube_deployment(name: 'legacy-deployment').tap do |deployment|
          deployment['metadata']['annotations'].delete('app.gitlab.com/env')
          deployment['metadata']['annotations'].delete('app.gitlab.com/app')
          deployment['metadata']['labels']['app'] = environment.slug
        end
      end

      let(:legacy_pod) do
        kube_pod(name: 'legacy-pod').tap do |pod|
          pod['metadata']['annotations'].delete('app.gitlab.com/env')
          pod['metadata']['annotations'].delete('app.gitlab.com/app')
          pod['metadata']['labels']['app'] = environment.slug
        end
      end

      context 'only legacy deployments' do
        let(:deployments) { [legacy_deployment] }
        let(:pods) { [legacy_pod] }

        it 'contains nothing' do
          expect(rollout_status).to be_kind_of(::Gitlab::Kubernetes::RolloutStatus)

          expect(rollout_status.deployments).to eq([])
        end

        it 'has the has_legacy_app_label flag' do
          expect(rollout_status).to be_has_legacy_app_label
        end
      end

      context 'new deployment based on annotations' do
        let(:matched_deployment) { kube_deployment(name: 'matched-deployment', environment_slug: environment.slug, project_slug: project.full_path_slug) }
        let(:matched_pod) { kube_pod(environment_slug: environment.slug, project_slug: project.full_path_slug) }
        let(:deployments) { [matched_deployment, legacy_deployment] }
        let(:pods) { [matched_pod, legacy_pod] }

        it 'contains only matching deployments' do
          expect(rollout_status).to be_kind_of(::Gitlab::Kubernetes::RolloutStatus)

          expect(rollout_status.deployments.map(&:name)).to contain_exactly('matched-deployment')
        end

        it 'does have the has_legacy_app_label flag' do
          expect(rollout_status).to be_has_legacy_app_label
        end
      end

      context 'deployment with app label not matching the environment' do
        let(:other_deployment) do
          kube_deployment(name: 'other-deployment').tap do |deployment|
            deployment['metadata']['annotations'].delete('app.gitlab.com/env')
            deployment['metadata']['annotations'].delete('app.gitlab.com/app')
            deployment['metadata']['labels']['app'] = 'helm-app-label'
          end
        end

        let(:other_pod) do
          kube_pod(name: 'other-pod').tap do |pod|
            pod['metadata']['annotations'].delete('app.gitlab.com/env')
            pod['metadata']['annotations'].delete('app.gitlab.com/app')
            pod['metadata']['labels']['app'] = environment.slug
          end
        end

        let(:deployments) { [other_deployment] }
        let(:pods) { [other_pod] }

        it 'does not have the has_legacy_app_label flag' do
          expect(rollout_status).not_to be_has_legacy_app_label
        end
      end
    end

    context 'with valid deployments' do
      let(:matched_deployment) { kube_deployment(environment_slug: environment.slug, project_slug: project.full_path_slug) }
      let(:unmatched_deployment) { kube_deployment }
      let(:matched_pod) { kube_pod(environment_slug: environment.slug, project_slug: project.full_path_slug) }
      let(:unmatched_pod) { kube_pod(environment_slug: environment.slug, project_slug: project.full_path_slug, status: 'Pending') }
      let(:deployments) { [matched_deployment, unmatched_deployment] }
      let(:pods) { [matched_pod, unmatched_pod] }

      it 'creates a matching RolloutStatus' do
        expect(rollout_status).to be_kind_of(::Gitlab::Kubernetes::RolloutStatus)
        expect(rollout_status.deployments.map(&:annotations)).to eq([
          { 'app.gitlab.com/app' => project.full_path_slug, 'app.gitlab.com/env' => 'env-000000' }
        ])
      end
    end

    context 'with empty list of deployments' do
      it 'creates a matching RolloutStatus' do
        expect(rollout_status).to be_kind_of(::Gitlab::Kubernetes::RolloutStatus)
        expect(rollout_status).to be_not_found
      end
    end
  end

  describe '#read_pod_logs' do
    let(:environment) { create(:environment) }
    let(:cluster) { create(:cluster, :project, platform_kubernetes: service) }
    let(:service) { create(:cluster_platform_kubernetes, :configured) }
    let(:pod_name) { 'pod-1' }
    let(:namespace) { 'app' }
    let(:container) { 'some-container' }

    subject { service.read_pod_logs(environment.id, pod_name, namespace, container: container) }

    shared_examples 'successful log request' do
      it do
        expect(subject[:logs]).to eq(["Log 1", "Log 2", "Log 3"])
        expect(subject[:status]).to eq(:success)
        expect(subject[:pod_name]).to eq(pod_name)
        expect(subject[:container_name]).to eq(container)
      end
    end

    shared_examples 'returns pod_name and container_name' do
      it do
        expect(subject[:pod_name]).to eq(pod_name)
        expect(subject[:container_name]).to eq(container)
      end
    end

    context 'with reactive cache' do
      before do
        synchronous_reactive_cache(service)
      end

      context 'when ElasticSearch is enabled' do
        let(:cluster) { create(:cluster, :project, platform_kubernetes: service) }
        let!(:elastic_stack) { create(:clusters_applications_elastic_stack, cluster: cluster) }

        before do
          expect_any_instance_of(::Clusters::Applications::ElasticStack).to receive(:elasticsearch_client).at_least(:once).and_return(Elasticsearch::Transport::Client.new)
          expect_any_instance_of(::Gitlab::Elasticsearch::Logs).to receive(:pod_logs).and_return(["Log 1", "Log 2", "Log 3"])
          stub_feature_flags(enable_cluster_application_elastic_stack: true)
        end

        include_examples 'successful log request'
      end

      context 'when kubernetes responds with valid logs' do
        before do
          stub_kubeclient_logs(pod_name, namespace, container: container)
        end

        context 'on a project level cluster' do
          let(:cluster) { create(:cluster, :project, platform_kubernetes: service) }

          include_examples 'successful log request'
        end

        context 'on a group level cluster' do
          let(:cluster) { create(:cluster, :group, platform_kubernetes: service) }

          include_examples 'successful log request'
        end

        context 'on an instance level cluster' do
          let(:cluster) { create(:cluster, :instance, platform_kubernetes: service) }

          include_examples 'successful log request'
        end
      end

      context 'when kubernetes responds with 500s' do
        before do
          stub_kubeclient_logs(pod_name, namespace, container: 'some-container', status: 500)
        end

        it_behaves_like 'kubernetes API error', 500

        it_behaves_like 'returns pod_name and container_name'
      end

      context 'when container does not exist' do
        before do
          container = 'some-container'

          stub_kubeclient_logs(pod_name, namespace, container: container,
            status: 400, message: "container #{container} is not valid for pod #{pod_name}")
        end

        it_behaves_like 'kubernetes API error', 400

        it_behaves_like 'returns pod_name and container_name'
      end

      context 'when kubernetes responds with 404s' do
        before do
          stub_kubeclient_logs(pod_name, namespace, container: 'some-container', status: 404)
        end

        it_behaves_like 'resource not found error', 'Pod not found'

        it_behaves_like 'returns pod_name and container_name'
      end

      context 'when container name is not specified' do
        let(:container) { 'container-0' }

        subject { service.read_pod_logs(environment.id, pod_name, namespace) }

        before do
          stub_kubeclient_pod_details(pod_name, namespace)
          stub_kubeclient_logs(pod_name, namespace, container: container)
        end

        include_examples 'successful log request'
      end
    end

    context 'with caching', :use_clean_rails_memory_store_caching do
      let(:opts) do
        [
          'get_pod_log',
          {
            'environment_id' => environment.id,
            'pod_name' => pod_name,
            'namespace' => namespace,
            'container' => container
          }
        ]
      end

      context 'result is cacheable' do
        before do
          stub_kubeclient_logs(pod_name, namespace, container: container)
        end

        it do
          result = subject

          expect { stub_reactive_cache(service, result, opts) }.not_to raise_error
        end
      end

      context 'when value present in cache' do
        let(:return_value) { { 'status' => :success, 'logs' => 'logs' } }

        before do
          stub_reactive_cache(service, return_value, opts)
        end

        it 'returns cached value' do
          result = subject

          expect(result).to eq(return_value)
        end
      end

      context 'when value not present in cache' do
        it 'returns nil' do
          expect(ReactiveCachingWorker)
            .to receive(:perform_async)
            .with(service.class, service.id, *opts)

          result = subject

          expect(result).to eq(nil)
        end
      end
    end

    context '#reactive_cache_updated' do
      let(:opts) do
        {
          'environment_id' => environment.id,
          'pod_name' => pod_name,
          'namespace' => namespace,
          'container' => container
        }
      end

      subject { service.reactive_cache_updated('get_pod_log', opts) }

      it 'expires k8s_pod_logs etag cache' do
        expect_next_instance_of(Gitlab::EtagCaching::Store) do |store|
          expect(store).to receive(:touch)
            .with(
              ::Gitlab::Routing.url_helpers.k8s_pod_logs_project_environment_path(
                environment.project,
                environment,
                opts['pod_name'],
                opts['container_name'],
                format: :json
              )
            )
            .and_call_original
        end

        subject
      end
    end
  end

  describe '#calculate_reactive_cache_for' do
    let(:cluster) { create(:cluster, :project, platform_kubernetes: service) }
    let(:service) { create(:cluster_platform_kubernetes, :configured) }
    let(:namespace) { 'app' }
    let(:environment) { instance_double(Environment, deployment_namespace: namespace) }

    subject { service.calculate_reactive_cache_for(environment) }

    before do
      allow(service).to receive(:read_pods).and_return([])
    end

    context 'when kubernetes responds with valid deployments' do
      before do
        stub_kubeclient_deployments(namespace)
      end

      shared_examples 'successful deployment request' do
        it { is_expected.to include(deployments: [kube_deployment]) }
      end

      context 'on a project level cluster' do
        let(:cluster) { create(:cluster, :project, platform_kubernetes: service) }

        include_examples 'successful deployment request'
      end

      context 'on a group level cluster' do
        let(:cluster) { create(:cluster, :group, platform_kubernetes: service) }

        include_examples 'successful deployment request'
      end

      context 'on an instance level cluster' do
        let(:cluster) { create(:cluster, :instance, platform_kubernetes: service) }

        include_examples 'successful deployment request'
      end
    end

    context 'when kubernetes responds with 500s' do
      before do
        stub_kubeclient_deployments(namespace, status: 500)
      end

      it { expect { subject }.to raise_error(::Kubeclient::HttpError) }
    end

    context 'when kubernetes responds with 404s' do
      before do
        stub_kubeclient_deployments(namespace, status: 404)
      end

      it { is_expected.to include(deployments: []) }
    end
  end
end