gitlab-foss/spec/models/release_spec.rb

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Release, feature_category: :release_orchestration do
  let_it_be(:user) { create(:user) }
  let_it_be(:project) { create(:project, :public, :repository) }

  let_it_be_with_reload(:release) { create(:release, project: project, author: user) }

  it { expect(release).to be_valid }

  describe 'associations' do
    it { is_expected.to belong_to(:project).touch(true) }
    it { is_expected.to belong_to(:author).class_name('User') }
    it { is_expected.to have_many(:links).class_name('Releases::Link') }
    it { is_expected.to have_many(:milestones) }
    it { is_expected.to have_many(:milestone_releases) }
    it { is_expected.to have_many(:evidences).class_name('Releases::Evidence') }
    it { is_expected.to have_one(:catalog_resource_version).class_name('Ci::Catalog::Resources::Version') }
  end

  describe 'validation' do
    it { is_expected.to validate_presence_of(:project) }
    it { is_expected.to validate_presence_of(:tag) }

    context 'when a release exists in the database without a name' do
      it 'does not require name' do
        existing_release_without_name = build(:release, project: project, author: user, name: nil)
        existing_release_without_name.save!(validate: false)

        existing_release_without_name.description = "change"
        existing_release_without_name.save!
        existing_release_without_name.reload

        expect(existing_release_without_name).to be_valid
        expect(existing_release_without_name.description).to eq("change")
        expect(existing_release_without_name.name).not_to be_nil
      end
    end

    it 'validates sha is not changed on update' do
      release.sha = "new_sha"

      release.validate

      expect(release.errors.full_messages).to include("Sha cannot be changed")
    end

    describe 'scopes' do
      let_it_be(:another_project) { create(:project) }
      let_it_be(:another_release) { create(:release, project: another_project, tag: 'v2') }

      describe '.for_projects' do
        it 'returns releases for the given projects' do
          expect(described_class.for_projects([project])).to eq([release])
        end
      end

      describe '.by_tag' do
        it 'returns releases with the given tag' do
          expect(described_class.by_tag(release.tag)).to eq([release])
        end
      end
    end

    context 'when description of a release is longer than the limit' do
      let(:description) { 'a' * (Gitlab::Database::MAX_TEXT_SIZE_LIMIT + 1) }
      let(:release) { build(:release, project: project, description: description) }

      it 'creates a validation error' do
        release.validate

        expect(release.errors.full_messages)
          .to include("Description is too long (maximum is #{Gitlab::Database::MAX_TEXT_SIZE_LIMIT} characters)")
      end
    end

    context 'when a release is tied to a milestone for another project' do
      it 'creates a validation error' do
        milestone = build(:milestone, project: create(:project))

        expect { release.milestones << milestone }.to raise_error(
          ActiveRecord::RecordInvalid, 'Validation failed: Release does not have the same project as the milestone'
        )
      end
    end

    context 'when a release is tied to a milestone linked to the same project' do
      it 'successfully links this release to this milestone' do
        milestone = build(:milestone, project: project)
        expect { release.milestones << milestone }.to change { MilestoneRelease.count }.by(1)
      end
    end

    context 'when creating new release' do
      subject { build(:release, project: project, name: 'Release 1.0') }

      it { is_expected.to validate_presence_of(:author_id) }
    end

    # Deleting user along with their contributions, nullifies releases author_id.
    context 'when updating existing release without author' do
      let(:release) { create(:release, :legacy) }

      it 'updates successfully' do
        release.description += 'Update'

        expect { release.save! }.not_to raise_error
      end
    end
  end

  describe 'tagged' do
    # We only test for empty string since there's a not null constraint at the database level
    it 'does not return the tagless release' do
      empty_string_tag = create(:release, tag: 'v99.0.0')
      empty_string_tag.update_column(:tag, '')

      expect(described_class.tagged).not_to include(empty_string_tag)
    end

    it 'does return the tagged releases' do
      expect(described_class.tagged).to include(release)
    end
  end

  describe 'latest releases' do
    let_it_be(:yesterday) { Time.zone.now - 1.day }
    let_it_be(:today) { Time.zone.now }
    let_it_be(:tomorrow) { Time.zone.now + 1.day }

    let_it_be(:project2) { create(:project) }

    let_it_be(:project_release1) do
      create(:release, project: project, released_at: yesterday, created_at: tomorrow)
    end

    let_it_be(:project_release2) do
      create(:release, project: project, released_at: tomorrow, created_at: yesterday)
    end

    let_it_be(:project2_release1) do
      create(:release, project: project2, released_at: yesterday, created_at: tomorrow)
    end

    let_it_be(:project2_release2) do
      create(:release, project: project2, released_at: tomorrow, created_at: yesterday)
    end

    let_it_be(:project2_release3) do
      create(:release, project: project2, released_at: today, created_at: yesterday)
    end

    let_it_be(:project2_release4) do
      create(:release, project: project2, released_at: today, created_at: yesterday, release_published_at: today)
    end

    let(:args) { {} }

    describe '.latest' do
      subject(:latest) { project.releases.latest(**args) }

      context 'without order_by' do
        it 'returns the latest release by released date' do
          expect(latest).to eq(project_release2)
        end
      end

      context 'with order_by: created_at' do
        let(:args) { { order_by: 'created_at' } }

        it 'returns the latest release by created date' do
          expect(latest).to eq(project_release1)
        end
      end

      context 'when there are no releases' do
        it 'returns nil' do
          project.releases.delete_all(:delete_all)

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

    describe '.latest_for_projects' do
      let(:projects) { [project, project2] }

      subject(:latest_for_projects) { described_class.latest_for_projects(projects, **args) }

      context 'without order_by' do
        it 'returns the latest release by released date for each project' do
          expect(latest_for_projects).to match_array([project_release2, project2_release2])
        end
      end

      context 'with order_by: created_at' do
        let(:args) { { order_by: 'created_at' } }

        it 'returns the latest release by created date for each project' do
          expect(latest_for_projects).to match_array([project_release1, project2_release1])
        end
      end

      context 'when no projects are provided' do
        let(:projects) { [] }

        it 'returns empty response' do
          expect(latest_for_projects).to be_empty
        end
      end

      context 'when there are no releases' do
        it 'returns empty response' do
          project.releases.delete_all(:delete_all)
          project2.releases.delete_all(:delete_all)

          expect(latest_for_projects).to be_empty
        end
      end
    end

    describe '.waiting_for_publish_event' do
      let(:releases) { [project2_release3] }

      subject(:waiting) { described_class.waiting_for_publish_event }

      it "find today's releases not yet published" do
        expect(waiting).to match_array(releases)
      end
    end
  end

  describe '#assets_count' do
    subject { described_class.find(release.id).assets_count }

    it 'returns the number of sources' do
      is_expected.to eq(Gitlab::Workhorse::ARCHIVE_FORMATS.count)
    end

    context 'when a links exists' do
      let!(:link) { create(:release_link, release: release) }

      it 'counts the link as an asset' do
        is_expected.to eq(1 + Gitlab::Workhorse::ARCHIVE_FORMATS.count)
      end

      it "excludes sources count when asked" do
        assets_count = described_class.find(release.id).assets_count(except: [:sources])
        expect(assets_count).to eq(1)
      end
    end
  end

  describe '.create' do
    it "fills released_at using created_at if it's not set" do
      release = create(:release, project: project, author: user, released_at: nil)

      expect(release.released_at).to eq(release.created_at)
    end

    it "does not change released_at if it's set explicitly" do
      released_at = Time.zone.parse('2018-10-20T18:00:00Z')

      release = create(:release, project: project, author: user, released_at: released_at)

      expect(release.released_at).to eq(released_at)
    end
  end

  describe '#update' do
    subject { release.update!(params) }

    context 'when links do not exist' do
      context 'when params are specified for creation' do
        let(:params) do
          { links_attributes: [{ name: 'test', url: 'https://www.google.com/' }] }
        end

        it 'creates a link successfully' do
          is_expected.to eq(true)

          expect(release.links.count).to eq(1)
          expect(release.links.first.name).to eq('test')
          expect(release.links.first.url).to eq('https://www.google.com/')
        end
      end
    end

    context 'when a link exists' do
      let!(:link1) { create(:release_link, release: release, name: 'test1', url: 'https://www.google1.com/') }
      let!(:link2) { create(:release_link, release: release, name: 'test2', url: 'https://www.google2.com/') }

      before do
        release.reload
      end

      context 'when params are specified for update' do
        let(:params) do
          { links_attributes: [{ id: link1.id, name: 'new' }] }
        end

        it 'updates the link successfully' do
          is_expected.to eq(true)

          expect(release.links.count).to eq(2)
          expect(release.links.first.name).to eq('new')
        end
      end

      context 'when params are specified for deletion' do
        let(:params) do
          { links_attributes: [{ id: link1.id, _destroy: true }] }
        end

        it 'removes the link successfully' do
          is_expected.to eq(true)

          expect(release.links.count).to eq(1)
          expect(release.links.first.name).to eq(link2.name)
        end
      end
    end
  end

  describe '#sources' do
    subject { release.sources }

    it 'returns sources' do
      is_expected.to all(be_a(Releases::Source))
    end
  end

  describe '#upcoming_release?' do
    context 'during the backfill migration when released_at could be nil' do
      it 'handles a nil released_at value and returns false' do
        allow(release).to receive(:released_at).and_return nil

        expect(release.upcoming_release?).to eq(false)
      end
    end
  end

  describe 'evidence' do
    let(:release_with_evidence) { create(:release, :with_evidence, project: project) }

    context 'when a release is deleted' do
      it 'also deletes the associated evidence' do
        release_with_evidence

        expect { release_with_evidence.destroy! }.to change(Releases::Evidence, :count).by(-1)
      end
    end
  end

  describe '#name' do
    context 'name is nil' do
      before do
        release.update!(name: nil)
      end

      it 'returns tag' do
        expect(release.name).to eq(release.tag)
      end
    end
  end

  describe '#milestone_titles' do
    let_it_be(:milestone_1) { create(:milestone, project: project, title: 'Milestone 1') }
    let_it_be(:milestone_2) { create(:milestone, project: project, title: 'Milestone 2') }
    let_it_be(:release) { create(:release, project: project, milestones: [milestone_1, milestone_2]) }

    it { expect(release.milestone_titles).to eq("#{milestone_1.title}, #{milestone_2.title}") }
  end

  describe 'updating catalog resource version' do
    let_it_be(:project) { create(:project) }
    let_it_be(:resource) { create(:ci_catalog_resource, project: project) }

    let_it_be_with_reload(:release) do
      create(:release, :with_catalog_resource_version, project: project, tag: 'v1', released_at: '2023-01-01T00:00:00Z')
    end

    let(:version) { release.catalog_resource_version }

    context 'when released_at has changed' do
      it 'calls sync_with_release! on the catalog resource version' do
        expect(version).to receive(:sync_with_release!).once

        release.update!(released_at: '2023-02-02T00:00:00Z')
      end
    end

    context 'when released_at has not changed' do
      it 'does not call sync_with_release! on the catalog resource version' do
        expect(version).not_to receive(:sync_with_release!)

        release.update!(released_at: '2023-01-01T00:00:00Z')
      end
    end
  end

  describe '#related_deployments' do
    let_it_be(:release) { create(:release, project: project, tag: 'v1.0.0') }
    let_it_be(:ref) { release.tag }
    let_it_be(:environment) { create(:environment, project: project) }
    let_it_be_with_reload(:deployment) { create(:deployment, environment: environment, ref: ref) }

    it 'returns deployments for the release tag in the available environments' do
      expect(release.related_deployments).to contain_exactly(deployment)
    end

    context 'when environment is not available' do
      before do
        environment.stop
      end

      it 'does not return deployments' do
        expect(release.related_deployments).to be_empty
      end
    end

    context 'when deployment ref does not match the release tag' do
      it 'does not return deployments' do
        deployment.update!(ref: 'other-tag')

        expect(release.related_deployments).to be_empty
      end
    end
  end
end