gitlab-org--gitlab-foss/spec/commands/metrics_server/metrics_server_spec.rb

# frozen_string_literal: true

require 'spec_helper'
require 'rake_helper'

require_relative '../../../metrics_server/metrics_server'

# End-to-end tests for the metrics server process we use to serve metrics
# from forking applications (Sidekiq, Puma) to the Prometheus scraper.
RSpec.describe 'GitLab metrics server', :aggregate_failures do
  let(:config_file) { Tempfile.new('gitlab.yml') }
  let(:address) { '127.0.0.1' }
  let(:port) { 3807 }
  let(:config) do
    {
      'test' => {
        'monitoring' => {
          'web_exporter' => {
            'address' => address,
            'enabled' => true,
            'port' => port
          },
          'sidekiq_exporter' => {
            'address' => address,
            'enabled' => true,
            'port' => port
          }
        }
      }
    }
  end

  before(:all) do
    Rake.application.rake_require 'tasks/gitlab/metrics_exporter'

    @exporter_path = Rails.root.join('tmp', 'test', 'gme')

    run_rake_task('gitlab:metrics_exporter:install', @exporter_path)
  end

  after(:all) do
    FileUtils.rm_rf(@exporter_path)
  end

  shared_examples 'serves metrics endpoint' do
    it 'serves /metrics endpoint' do
      start_server!

      expect do
        Timeout.timeout(10) do
          http_ok = false
          until http_ok
            sleep 1
            response = Gitlab::HTTP.try_get("http://#{address}:#{port}/metrics", allow_local_requests: true)
            http_ok = response&.success?
          end
        end
      end.not_to raise_error
    end
  end

  shared_examples 'spawns a server' do |target, use_golang_server|
    context "targeting #{target} when using Golang server is #{use_golang_server}" do
      let(:metrics_dir) { Dir.mktmpdir }

      subject(:start_server!) do
        @pid = MetricsServer.spawn(target, metrics_dir: metrics_dir, path: @exporter_path.join('bin'))
      end

      before do
        if use_golang_server
          stub_env('GITLAB_GOLANG_METRICS_SERVER', '1')
          allow(Settings).to receive(:monitoring).and_return(config.dig('test', 'monitoring'))
        else
          config_file.write(YAML.dump(config))
          config_file.close
          stub_env('GITLAB_CONFIG', config_file.path)
        end
        # We need to send a request to localhost
        WebMock.allow_net_connect!
      end

      after do
        webmock_enable!

        if @pid
          pgrp = Process.getpgid(@pid)

          Timeout.timeout(10) do
            Process.kill('TERM', -pgrp)
            Process.waitpid(@pid)
          end

          expect(Gitlab::ProcessManagement.process_alive?(@pid)).to be(false)
        end
      rescue Errno::ESRCH, Errno::ECHILD => _
        # 'No such process' or 'No child processes' means the process died before
      ensure
        config_file.unlink
        FileUtils.rm_rf(metrics_dir, secure: true)
      end

      it_behaves_like 'serves metrics endpoint'

      context 'when using Pathname instance as target directory' do
        let(:metrics_dir) { Pathname.new(Dir.mktmpdir) }

        it_behaves_like 'serves metrics endpoint'
      end
    end
  end

  it_behaves_like 'spawns a server', 'puma', true
  it_behaves_like 'spawns a server', 'puma', false
  it_behaves_like 'spawns a server', 'sidekiq', true
  it_behaves_like 'spawns a server', 'sidekiq', false
end