cloudfoundry/cloud_controller_ng

require 'spec_helper'

module VCAP::CloudController
  RSpec.describe DropletModel do
    it { is_expected.to validates_includes DropletModel::DROPLET_STATES, :state, allow_missing: true }

    describe '#blobstore_key' do
      let(:droplet) { DropletModel.make(droplet_hash: droplet_hash, app: nil) }

      context 'when the droplet has been uploaded' do
        let(:droplet_hash) { 'foobar' }

        it 'returns the correct blobstore key' do
          expect(droplet.blobstore_key).to eq(File.join(droplet.guid, droplet_hash))
        end
      end

      context 'when the droplet has not been uploaded' do
        let(:droplet_hash) { nil }

        it 'returns nil' do
          expect(droplet.blobstore_key).to be_nil
        end
      end
    end

    describe '#staged?' do
      context 'when the droplet has been staged' do
        let!(:droplet_model) { DropletModel.make(state: 'STAGED', app: nil) }

        it 'returns true' do
          expect(droplet_model.staged?).to be true
        end
      end

      context 'when the droplet has not been staged' do
        let!(:droplet_model) { DropletModel.make(state: 'STAGING', app: nil) }

        it 'returns false' do
          expect(droplet_model.staged?).to be false
        end
      end
    end

    describe '#mark_as_staged' do
      let!(:droplet_model) { DropletModel.make(app: nil) }

      it 'changes the droplet state to STAGED' do
        droplet_model.mark_as_staged
        expect(droplet_model.state).to eq(DropletModel::STAGED_STATE)
      end
    end

    describe 'process_types' do
      let(:droplet_model) { DropletModel.make(app: nil) }

      it 'is a persistable hash' do
        info                        = { web: 'started', worker: 'started' }
        droplet_model.process_types = info
        droplet_model.save
        expect(droplet_model.reload.process_types['web']).to eq('started')
        expect(droplet_model.reload.process_types['worker']).to eq('started')
      end
    end

    describe '#lifecycle_type' do
      context 'when there is buildpack_lifecycle_data associated to the droplet' do
        let(:droplet_model) { DropletModel.make(:buildpack, app: nil) }
        let!(:lifecycle_data) { BuildpackLifecycleDataModel.make(droplet: droplet_model) }

        before do
          droplet_model.buildpack_lifecycle_data = lifecycle_data
          droplet_model.cnb_lifecycle_data = nil
          droplet_model.save
        end

        it 'returns the string "buildpack"' do
          expect(droplet_model.lifecycle_type).to eq('buildpack')
        end
      end

      context 'when there is cnb_lifecycle_data associated to the droplet' do
        let(:droplet_model) { DropletModel.make(:buildpack, app: nil) }
        let!(:lifecycle_data) { CNBLifecycleDataModel.make(droplet: droplet_model) }

        before do
          droplet_model.cnb_lifecycle_data = lifecycle_data
          droplet_model.buildpack_lifecycle_data = nil
          droplet_model.save
        end

        it 'returns the string "cnb"' do
          expect(droplet_model.lifecycle_type).to eq('cnb')
        end
      end

      context 'when there is no lifecycle data associated to the droplet' do
        let(:droplet_model) { DropletModel.make(:docker, app: nil) }

        before do
          droplet_model.buildpack_lifecycle_data = nil
          droplet_model.save
        end

        it 'returns the string "docker"' do
          expect(droplet_model.lifecycle_type).to eq('docker')
        end
      end
    end

    describe '#lifecycle_data' do
      context 'when there is buildpack_lifecycle_data associated to the droplet' do
        let(:droplet_model) { DropletModel.make(:buildpack, app: nil) }
        let!(:lifecycle_data) do
          BuildpackLifecycleDataModel.make(
            droplet: droplet_model,
            buildpacks: ['http://some-buildpack.com', 'http://another-buildpack.net']
          )
        end

        before do
          droplet_model.buildpack_lifecycle_data = lifecycle_data
          droplet_model.save
        end

        it 'returns buildpack_lifecycle_data if it is on the model' do
          expect(droplet_model.lifecycle_data).to eq(lifecycle_data)
        end

        it 'is a persistable hash' do
          expect(droplet_model.reload.lifecycle_data.buildpacks).to eq(lifecycle_data.buildpacks)
          expect(droplet_model.reload.lifecycle_data.stack).to eq(lifecycle_data.stack)
        end

        it 'deletes the dependent buildpack_lifecycle_data_models when a droplet is deleted' do
          expect do
            droplet_model.destroy
          end.to change(BuildpackLifecycleDataModel, :count).by(-1).
            and change(BuildpackLifecycleBuildpackModel, :count).by(-2)
        end
      end

      context 'when there is kpack_lifecycle_data associated to the droplet' do
        let(:droplet_model) { DropletModel.make(:kpack, app: nil) }
        let!(:lifecycle_data) do
          KpackLifecycleDataModel.make(droplet: droplet_model)
        end

        before do
          droplet_model.kpack_lifecycle_data = lifecycle_data
          droplet_model.save
        end

        it 'deletes the dependent kpack_lifecycle_data_models when a droplet is deleted' do
          expect do
            droplet_model.destroy
          end.to change(KpackLifecycleDataModel, :count).by(-1)
        end
      end

      context 'when there is cnb_lifecycle_data associated to the droplet' do
        let(:droplet_model) { DropletModel.make(:kpack, app: nil) }
        let!(:lifecycle_data) do
          CNBLifecycleDataModel.make(
            droplet: droplet_model,
            buildpacks: ['http://some-buildpack.com', 'http://another-buildpack.net']
          )
        end

        before do
          droplet_model.cnb_lifecycle_data = lifecycle_data
          droplet_model.save
        end

        it 'returns cnb_lifecycle_data if it is on the model' do
          expect(droplet_model.lifecycle_data).to eq(lifecycle_data)
        end

        it 'is a persistable hash' do
          expect(droplet_model.reload.cnb_lifecycle_data.buildpacks).to eq(lifecycle_data.buildpacks)
          expect(droplet_model.reload.cnb_lifecycle_data.stack).to eq(lifecycle_data.stack)
        end

        it 'deletes the dependent cnb_lifecycle_data_models when a droplet is deleted' do
          expect do
            droplet_model.destroy
          end.to change(CNBLifecycleDataModel, :count).by(-1).
            and change(BuildpackLifecycleBuildpackModel, :count).by(-2)
        end
      end

      context 'when there is no lifecycle data associated to the droplet' do
        let(:droplet_model) { DropletModel.make(:docker, app: nil) }

        before do
          droplet_model.buildpack_lifecycle_data = nil
          droplet_model.save
        end

        it 'returns a docker lifecycle model' do
          expect(droplet_model.lifecycle_data).to be_a(DockerLifecycleDataModel)
        end
      end
    end

    describe '#set_buildpack_receipt' do
      let!(:droplet_model) { DropletModel.make(state: 'STAGED', app: nil) }

      it 'records the output of the detect script' do
        droplet_model.set_buildpack_receipt(buildpack_key: nil, requested_buildpack: nil, detect_output: 'detect-output')
        expect(droplet_model.buildpack_receipt_detect_output).to eq('detect-output')
      end

      describe 'admin buildpack' do
        let(:buildpack) { Buildpack.make }
        let(:buildpack_key) { buildpack.key }

        it 'records the admin buildpack info' do
          droplet_model.set_buildpack_receipt(buildpack_key: buildpack_key, requested_buildpack: nil, detect_output: nil)
          expect(droplet_model.buildpack_receipt_buildpack_guid).to eq(buildpack.guid)
          expect(droplet_model.buildpack_receipt_buildpack).to eq(buildpack.name)
        end
      end

      describe 'custom buildpack' do
        it 'records the custom buildpack info' do
          droplet_model.set_buildpack_receipt(buildpack_url: 'http://buildpack.example.com', buildpack_key: nil, requested_buildpack: nil, detect_output: nil)
          expect(droplet_model.buildpack_receipt_buildpack).to eq('http://buildpack.example.com')
        end

        context 'when buildpack_url contains username and password' do
          it 'obfuscates the username and password' do
            droplet_model.set_buildpack_receipt(buildpack_url: 'https://amelia:meow@neopets.com', buildpack_key: nil, requested_buildpack: nil, detect_output: nil)
            expect(droplet_model.buildpack_receipt_buildpack).to eq('https://***:***@neopets.com')
          end
        end

        context 'when requested_buildpack contains username and password' do
          it 'obfuscates the username and password' do
            droplet_model.set_buildpack_receipt(buildpack_key: nil, requested_buildpack: 'https://amelia:meow@neopets.com', detect_output: nil)
            expect(droplet_model.buildpack_receipt_buildpack).to eq('https://***:***@neopets.com')
          end
        end
      end

      describe 'unknown buildpack from response' do
        it 'records the requested buildpack' do
          droplet_model.set_buildpack_receipt(buildpack_key: nil, requested_buildpack: 'requested-buildpack', detect_output: nil)
          expect(droplet_model.buildpack_receipt_buildpack).to eq('requested-buildpack')
        end
      end
    end

    describe '#fail_to_stage!' do
      subject(:droplet) { DropletModel.make(state: DropletModel::STAGING_STATE, app: nil) }

      it 'sets the state to FAILED' do
        expect { droplet.fail_to_stage! }.to change(droplet, :state).to(DropletModel::FAILED_STATE)
      end

      context 'when a valid reason is specified' do
        DropletModel::STAGING_FAILED_REASONS.each do |reason|
          it 'sets the requested staging failed reason' do
            expect do
              droplet.fail_to_stage!(reason)
            end.to change(droplet, :error_id).to(reason)
          end
        end
      end

      context 'when an unexpected reason is specifed' do
        it 'uses the default, generic reason' do
          expect do
            droplet.fail_to_stage!('bogus')
          end.to change(droplet, :error_id).to('StagingError')
        end
      end

      context 'when a reason is not specified' do
        it 'uses the default, generic reason' do
          expect do
            droplet.fail_to_stage!
          end.to change(droplet, :error_id).to('StagingError')
        end
      end

      describe 'setting staging_failed_description' do
        it 'sets the staging_failed_description to the v2.yml description of the error type' do
          expect do
            droplet.fail_to_stage!('NoAppDetectedError')
          end.to change(droplet, :error_description).to('An app was not successfully detected by any available buildpack')
        end

        it 'provides a string for interpolation on errors that require it' do
          expect do
            droplet.fail_to_stage!('StagingError')
          end.to change(droplet, :error_description).to('Staging error: staging failed')
        end

        DropletModel::STAGING_FAILED_REASONS.each do |reason|
          it "successfully sets staging_failed_description for reason: #{reason}" do
            expect do
              droplet.fail_to_stage!(reason)
            end.not_to raise_error
          end
        end
      end
    end

    describe '#droplet_checksum' do
      let!(:droplet_model_with_both) { DropletModel.make(sha256_checksum: 'foo', droplet_hash: 'bar', app: nil) }
      let!(:droplet_model_with_only_sha1) { DropletModel.make(sha256_checksum: nil, droplet_hash: 'baz', app: nil) }

      it 'returns the sha256_checksum when present' do
        expect(droplet_model_with_both.checksum).to eq('foo')
      end

      it 'returns the sha1 checksum when there is no sha256' do
        expect(droplet_model_with_only_sha1.checksum).to eq('baz')
      end
    end

    describe '#labels' do
      let!(:droplet) { DropletModel.make(app: nil) }
      let!(:label) do
        VCAP::CloudController::DropletLabelModel.make(
          key_name: 'potato',
          value: 'spielgasse',
          resource_guid: droplet.guid
        )
      end
      let!(:annotation) do
        VCAP::CloudController::DropletAnnotationModel.make(
          key_name: 'vegetable',
          value: 'asparagus',
          resource_guid: droplet.guid
        )
      end

      it 'can find the associated labels' do
        expect(droplet.labels.first.key_prefix).to be_nil
        expect(droplet.labels.first.key_name).to eq('potato')
        expect(droplet.labels.first.value).to eq('spielgasse')
        expect(droplet.annotations.first.key_name).to eq('vegetable')
        expect(droplet.annotations.first.value).to eq('asparagus')
      end
    end
  end
end