codeocean/spec/models/execution_environment_spec.rb

# frozen_string_literal: true

require 'rails_helper'

describe ExecutionEnvironment do
  let(:execution_environment) { described_class.create.tap {|execution_environment| execution_environment.update(network_enabled: nil) } }

  it 'validates that the Docker image works', docker: true do
    allow(execution_environment).to receive(:validate_docker_image?).and_return(true)
    expect(execution_environment).to receive(:working_docker_image?)
    execution_environment.update(docker_image: FactoryBot.attributes_for(:ruby)[:docker_image])
  end

  it 'validates the presence of a Docker image name' do
    expect(execution_environment.errors[:docker_image]).to be_present
  end

  it 'validates the minimum value of the memory limit' do
    execution_environment.update(memory_limit: DockerClient::MINIMUM_MEMORY_LIMIT / 2)
    expect(execution_environment.errors[:memory_limit]).to be_present
  end

  it 'validates the numericality of the memory limit' do
    execution_environment.update(memory_limit: Math::PI)
    expect(execution_environment.errors[:memory_limit]).to be_present
  end

  it 'validates the presence of a memory limit' do
    execution_environment.update(memory_limit: nil)
    expect(execution_environment.errors[:memory_limit]).to be_present
  end

  it 'validates the minimum value of the cpu limit' do
    execution_environment.update(cpu_limit: 0)
    expect(execution_environment.errors[:cpu_limit]).to be_present
  end

  it 'validates that cpu limit is an integer' do
    execution_environment.update(cpu_limit: Math::PI)
    expect(execution_environment.errors[:cpu_limit]).to be_present
  end

  it 'validates the presence of a cpu limit' do
    execution_environment.update(cpu_limit: nil)
    expect(execution_environment.errors[:cpu_limit]).to be_present
  end

  it 'validates the presence of a name' do
    expect(execution_environment.errors[:name]).to be_present
  end

  it 'validates the presence of the network enabled flag' do
    expect(execution_environment.errors[:network_enabled]).to be_present
    execution_environment.update(network_enabled: false)
    expect(execution_environment.errors[:network_enabled]).to be_blank
  end

  it 'validates the numericality of the permitted run time' do
    execution_environment.update(permitted_execution_time: Math::PI)
    expect(execution_environment.errors[:permitted_execution_time]).to be_present
  end

  it 'validates the presence of a permitted run time' do
    execution_environment.update(permitted_execution_time: nil)
    expect(execution_environment.errors[:permitted_execution_time]).to be_present
  end

  it 'validates the numericality of the pool size' do
    execution_environment.update(pool_size: Math::PI)
    expect(execution_environment.errors[:pool_size]).to be_present
  end

  it 'validates the presence of a pool size' do
    execution_environment.update(pool_size: nil)
    expect(execution_environment.errors[:pool_size]).to be_present
  end

  it 'validates the presence of a run command' do
    expect(execution_environment.errors[:run_command]).to be_present
  end

  it 'validates the presence of a user' do
    expect(execution_environment.errors[:user_id]).to be_present
    expect(execution_environment.errors[:user_type]).to be_present
  end

  it 'validates the format of the exposed ports' do
    execution_environment.update(exposed_ports: '1,')
    expect(execution_environment.errors[:exposed_ports]).to be_present

    execution_environment.update(exposed_ports: '1,a')
    expect(execution_environment.errors[:exposed_ports]).to be_present
  end

  describe '#valid_test_setup?' do
    context 'with a test command and a testing framework' do
      before { execution_environment.update(test_command: FactoryBot.attributes_for(:ruby)[:test_command], testing_framework: FactoryBot.attributes_for(:ruby)[:testing_framework]) }

      it 'is valid' do
        expect(execution_environment.errors[:test_command]).to be_blank
      end
    end

    context 'with a test command but no testing framework' do
      before { execution_environment.update(test_command: FactoryBot.attributes_for(:ruby)[:test_command], testing_framework: nil) }

      it 'is invalid' do
        expect(execution_environment.errors[:test_command]).to be_present
      end
    end

    context 'with no test command but a testing framework' do
      before { execution_environment.update(test_command: nil, testing_framework: FactoryBot.attributes_for(:ruby)[:testing_framework]) }

      it 'is invalid' do
        expect(execution_environment.errors[:test_command]).to be_present
      end
    end

    context 'with no test command and no testing framework' do
      before { execution_environment.update(test_command: nil, testing_framework: nil) }

      it 'is valid' do
        expect(execution_environment.errors[:test_command]).to be_blank
      end
    end
  end

  describe '#validate_docker_image?' do
    it 'is false in the test environment' do
      expect(Rails.env.test?).to be true
      expect(execution_environment.send(:validate_docker_image?)).to be false
    end

    it 'is false without a Docker image' do
      expect(execution_environment.docker_image).to be_blank
      expect(execution_environment.send(:validate_docker_image?)).to be false
    end

    it 'is true otherwise' do
      execution_environment.docker_image = FactoryBot.attributes_for(:ruby)[:docker_image]
      allow(Rails.env).to receive(:test?).and_return(false)
      expect(execution_environment.send(:validate_docker_image?)).to be true
    end
  end

  describe '#working_docker_image?', docker: true do
    let(:working_docker_image?) { execution_environment.send(:working_docker_image?) }

    before { allow(DockerClient).to receive(:find_image_by_tag).and_return(Object.new) }

    it 'instantiates a Docker client' do
      expect(DockerClient).to receive(:new).with(execution_environment: execution_environment).and_call_original
      allow_any_instance_of(DockerClient).to receive(:execute_arbitrary_command).and_return({})
      working_docker_image?
    end

    it 'executes the validation command' do
      allow_any_instance_of(DockerClient).to receive(:execute_arbitrary_command).with(ExecutionEnvironment::VALIDATION_COMMAND).and_return({})
      working_docker_image?
    end

    context 'when the command produces an error' do
      it 'adds an error' do
        allow_any_instance_of(DockerClient).to receive(:execute_arbitrary_command).and_return(stderr: 'command not found')
        working_docker_image?
        expect(execution_environment.errors[:docker_image]).to be_present
      end
    end

    context 'when the Docker client produces an error' do
      it 'adds an error' do
        allow_any_instance_of(DockerClient).to receive(:execute_arbitrary_command).and_raise(DockerClient::Error)
        working_docker_image?
        expect(execution_environment.errors[:docker_image]).to be_present
      end
    end
  end

  describe '#exposed_ports_list' do
    it 'returns an empty array if no ports are exposed' do
      execution_environment.exposed_ports = nil
      expect(execution_environment.exposed_ports_list).to eq([])
    end

    it 'returns an array of integers representing the exposed ports' do
      execution_environment.exposed_ports = '1,2,3'
      expect(execution_environment.exposed_ports_list).to eq([1, 2, 3])

      execution_environment.exposed_ports_list.each do |port|
        expect(execution_environment.exposed_ports).to include(port.to_s)
      end
    end
  end

  describe '#copy_to_poseidon' do
    let(:execution_environment) { FactoryBot.create(:ruby) }

    it 'makes the correct request to Poseidon' do
      allow(Faraday).to receive(:put).and_return(Faraday::Response.new(status: 201))
      execution_environment.copy_to_poseidon
      expect(Faraday).to have_received(:put) do |url, body, headers|
        expect(url).to match(%r{execution-environments/#{execution_environment.id}\z})
        expect(body).to eq(execution_environment.to_json)
        expect(headers).to include({'Content-Type' => 'application/json'})
      end
    end

    shared_examples 'returns true when the api request was successful' do |status|
      it "returns true on status #{status}" do
        allow(Faraday).to receive(:put).and_return(Faraday::Response.new(status: status))
        expect(execution_environment.copy_to_poseidon).to be_truthy
      end
    end

    shared_examples 'returns false when the api request failed' do |status|
      it "returns false on status #{status}" do
        allow(Faraday).to receive(:put).and_return(Faraday::Response.new(status: status))
        expect(execution_environment.copy_to_poseidon).to be_falsey
      end
    end

    [201, 204].each do |status|
      include_examples 'returns true when the api request was successful', status
    end

    [400, 500].each do |status|
      include_examples 'returns false when the api request failed', status
    end
  end
end