spec/lib/release_tools/version_spec.rb

# frozen_string_literal: true

require 'spec_helper'

describe ReleaseTools::Version do
  def version(version_string)
    described_class.new(version_string)
  end

  describe '#initialize' do
    it { expect(version('1.2.3')).to eq(version('1.2.3')) } # rubocop:disable RSpec/IdenticalEqualityAssertion
    it { expect(version('1.2')).to eq(version('1.2.0')) }
    it { expect(version('1.2.0-rc1')).to eq(version('1.2.0-rc1')) } # rubocop:disable RSpec/IdenticalEqualityAssertion
    it { expect(version('1.2.0-internal1')).to eq(version('1.2.0-internal1')) } # rubocop:disable RSpec/IdenticalEqualityAssertion
    it { expect(version('1.2.0-ee')).to eq(version('1.2.0-ee')) } # rubocop:disable RSpec/IdenticalEqualityAssertion
    it { expect(version('1.2.0-rc1-ee')).to eq(version('1.2.0-rc1-ee')) } # rubocop:disable RSpec/IdenticalEqualityAssertion
    it { expect(version('1.2-rc1-ee')).to eq(version('1.2.0-rc1-ee')) }
    it { expect(version("1.2.0\n")).to eq(version('1.2.0')) }
  end

  describe '#==' do
    it { expect(version('1.2.3')).to eq version('1.2.3-ee') }
    it { expect(version('1.2.3-rc1')).to eq version('1.2.3-rc1-ee') }
  end

  describe '#<=>' do
    it { expect(version('1.2.3')).to be >= version('1.2.2') }
    it { expect(version('1.2.3')).to be > version('1.2.2') }
    it { expect(version('1.2.3')).to be > version('1.1.12') }
    it { expect(version('1.2.3')).to be > version('0.12.12') }
    it { expect(version('1.2.3')).to be > version('1.2.3-rc') }
    it { expect(version('1.2.3')).to be > version('1.2.3-rc2') }
    it { expect(version('1.2.3-rc3')).to be > version('1.2.3-rc1') }
    it { expect(version('1.2.3-rc1')).to be > version('1.2.2') }
    it { expect(version('1.2.4')).to be > version('1.2.3-internal0') }
    it { expect(version('1.2.3')).to be < version('1.2.3-internal0') }
    it { expect(version('1.2.3-internal3')).to be > version('1.2.3-internal1') }
    it { expect(version('1.2.3-internal0')).to be < version('1.2.3-internal1') }
    it { expect(version('1.2.3-internal1')).to be > version('1.2.2') }

    it { expect(version('1.2.3-rc1')).to be < version('1.2.3-rc3') }
    it { expect(version('1.2.3')).to be < version('1.2.4-rc') }
    it { expect(version('1.2.3')).to be < version('1.2.4') }
    it { expect(version('1.2.3')).to be < version('1.3.0') }
    it { expect(version('1.2.3')).to be < version('2.0.8') }
    it { expect(version('1.2.3')).to be <= version('2.0.8') }
  end

  describe '#ee?' do
    it 'returns true when EE' do
      expect(version('8.3.2-ee')).to be_ee
    end

    it 'returns false when not EE' do
      expect(version('8.3.2')).not_to be_ee
    end
  end

  describe '#milestone_name' do
    it 'returns the milestone name' do
      expect(version('8.3.2').milestone_name).to eq '8.3'
    end
  end

  describe '#monthly?' do
    it 'is true for monthly releases' do
      expect(version('1.2.0')).to be_monthly
      expect(version('1.2.0-ee')).to be_monthly
    end

    it 'is false for patch releases' do
      expect(version('1.2.3')).not_to be_monthly
      expect(version('1.2.3-ee')).not_to be_monthly
    end

    it 'is false for pre-releases' do
      expect(version('1.2.0-rc1')).not_to be_monthly
      expect(version('1.2.0-rc1-ee')).not_to be_monthly
    end

    it 'is false for internal releases' do
      expect(version('1.2.0-internal1')).not_to be_monthly
    end
  end

  describe '#patch?' do
    it 'is true for patch releases' do
      expect(version('1.2.3')).to be_patch
    end

    it 'is false for pre-releases' do
      expect(version('1.2.0-rc1')).not_to be_patch
    end

    it 'is false for internal releases' do
      expect(version('1.2.3-internal1')).not_to be_patch
    end

    it 'is false for minor releases' do
      expect(version('1.2.0')).not_to be_patch
    end

    it 'is false for invalid releases' do
      expect(version('wow.1')).not_to be_patch
    end
  end

  describe '#minor?' do
    it 'is false for patch releases' do
      expect(version('1.2.3')).not_to be_minor
    end

    it 'is true for minor releases' do
      expect(version('1.2.0')).to be_minor
    end

    it 'is false for major releases' do
      expect(version('2.0.0')).not_to be_minor
    end

    it 'is false for invalid releases' do
      expect(version('wow.1')).not_to be_minor
    end
  end

  describe '#major?' do
    it 'is false for patch releases' do
      expect(version('1.2.3')).not_to be_major
    end

    it 'is false for minor releases' do
      expect(version('1.2.0')).not_to be_major
    end

    it 'is true for major releases' do
      expect(version('2.0.0')).to be_major
    end

    it 'is false for invalid releases' do
      expect(version('wow.1')).not_to be_minor
    end
  end

  describe '#major' do
    it { expect(version('1.2.3').major).to eq(1) }
    it { expect(version('1.2.0-rc1').major).to eq(1) }
    it { expect(version('1.2.0-internal1').major).to eq(1) }
    it { expect(version('1.2.0-ee').major).to eq(1) }
    it { expect(version('wow.1').major).to eq(0) }
  end

  describe '#minor' do
    it { expect(version('1.2.3').minor).to eq(2) }
    it { expect(version('1.2.0-rc1').minor).to eq(2) }
    it { expect(version('1.2.0-internal1').minor).to eq(2) }
    it { expect(version('1.2.0-ee').minor).to eq(2) }
    it { expect(version('wow.1').minor).to eq(0) }
  end

  describe '#rc' do
    it { expect(version('1.2.3-rc').rc).to eq(0) }
    it { expect(version('1.2.3-rc1').rc).to eq(1) }
    it { expect(version('1.2.3').rc).to be_nil }
    it { expect(version('wow-rc1').rc).to be_nil }
  end

  describe '#internal' do
    it { expect(version('1.2.3-internal1').internal).to eq(1) }
    it { expect(version('1.2.3').internal).to be_nil }
    it { expect(version('wow-interal1').internal).to be_nil }
  end

  describe '#rc?' do
    it { expect(version('1.2.3-rc')).to be_rc }
    it { expect(version('1.2.3-rc1')).to be_rc }
    it { expect(version('1.2.3')).not_to be_rc }
    it { expect(version('wow-rc1')).not_to be_rc }
  end

  describe '#internal?' do
    it { expect(version('1.2.3-internal1')).to be_internal }
    it { expect(version('1.2.0')).not_to be_internal }
    it { expect(version('1.2.3')).not_to be_internal }
    it { expect(version('wow-internal1')).not_to be_internal }
  end

  describe '#release?' do
    it 'is true for release versions' do
      expect(version('1.2.3')).to be_release
    end

    it 'is false for internal release versions' do
      expect(version('1.2.3-internal1')).not_to be_release
    end

    it 'is false for pre-release versions' do
      expect(version('1.2.3-rc1')).not_to be_release
    end

    it 'is false for invalid versions' do
      expect(version('wow.1')).not_to be_release
    end
  end

  describe '#next_minor' do
    it 'returns next minor version' do
      expect(version('1.2.0').next_minor).to eq '1.3.0'
    end

    it 'returns next minor version when patch version is omitted' do
      expect(version('1.2').next_minor).to eq '1.3.0'
    end

    it 'returns next minor version when version is not a release' do
      expect(version('1.2.3-rc1').next_minor).to eq '1.3.0'
    end

    it 'returns next minor version when version is an internal release' do
      expect(version('1.2.3-internal1').next_minor).to eq '1.3.0'
    end

    it 'returns next minor version when version is EE' do
      expect(version('1.2.3-ee').next_minor).to eq '1.3.0'
    end

    it 'returns next minor version when patch is > 0' do
      expect(version('1.2.3').next_minor).to eq '1.3.0'
    end

    it 'returns next major version when at max minor version' do
      expect(version('1.11.0').next_minor).to eq '2.0.0'
    end
  end

  describe '#next_major' do
    it 'returns next minor version' do
      expect(version('1.2.0').next_major).to eq '2.0.0'
    end

    it 'returns next major version when version is not a release' do
      expect(version('1.2.3-rc1').next_major).to eq '2.0.0'
    end

    it 'returns next major version when version is an internal release' do
      expect(version('1.2.3-internal1').next_major).to eq '2.0.0'
    end

    it 'returns next major version when version is EE' do
      expect(version('1.2.3-ee').next_major).to eq '2.0.0'
    end

    it 'returns next major version when patch is > 0' do
      expect(version('1.2.3').next_major).to eq '2.0.0'
    end
  end

  describe '#previous_patch' do
    it 'returns nil when patch is missing' do
      expect(version('1.2').previous_patch).to be_nil
    end

    it 'returns nil when version is not a release' do
      expect(version('1.2.3-rc1').previous_patch).to eq '1.2.2'
    end

    it 'returns nil when version is EE' do
      expect(version('1.2.3-ee').previous_patch).to eq '1.2.2-ee'
    end

    it 'returns previous patch when patch is 0' do
      expect(version('1.2.0').previous_patch).to be_nil
    end

    it 'returns previous patch when patch is > 0' do
      expect(version('1.2.3').previous_patch).to eq '1.2.2'
    end
  end

  describe '#next_patch' do
    it 'returns next patch when patch version is missing' do
      expect(version('1.2').next_patch).to eq '1.2.1'
    end

    it 'returns next patch when version is not a release' do
      expect(version('1.2.3-rc1').next_patch).to eq '1.2.4'
    end

    it 'returns next patch when version is an internal release' do
      expect(version('1.2.3-internal1').next_patch).to eq '1.2.4'
    end

    it 'returns next ee patch when version is EE' do
      expect(version('1.2.3-ee').next_patch).to eq '1.2.4-ee'
    end

    it 'returns next patch when patch version is 0' do
      expect(version('1.2.0').next_patch).to eq '1.2.1'
    end

    it 'returns next patch when patch is > 0' do
      expect(version('1.2.3').next_patch).to eq '1.2.4'
    end
  end

  describe '#next_internal' do
    it 'returns internal version of the last patch version' do
      expect(version('1.2.3').next_internal).to eq '1.2.2-internal0'
    end

    it 'returns next internal version of the internal version' do
      expect(version('1.2.3-internal0').next_internal).to eq '1.2.3-internal1'
    end
  end

  describe '#stable_branch' do
    it { expect(version('1.2.3').stable_branch).to eq '1-2-stable' }
    it { expect(version('1.23.45').stable_branch).to eq '1-23-stable' }
    it { expect(version('1.23.45-rc67').stable_branch).to eq '1-23-stable' }
    it { expect(version('1.23.45-ee').stable_branch).to eq '1-23-stable-ee' }
    it { expect(version('1.23.45-rc2-ee').stable_branch).to eq '1-23-stable-ee' }
    it { expect(version('1.23-rc2-ee').stable_branch).to eq '1-23-stable-ee' }
    it { expect(version('1.23.45-internal1').stable_branch).to eq '1-23-stable' }
  end

  describe '#tag' do
    it 'returns a tag name when version is RC' do
      expect(version('1.2.3-rc1').tag).to eq 'v1.2.3-rc1'
    end

    it 'returns a tag name when version is internal' do
      expect(version('1.2.3-internal1').tag).to eq 'v1.2.3-internal1'
    end

    it 'returns a tag name when patch is present' do
      expect(version('1.2.3').tag).to eq 'v1.2.3'
    end
  end

  describe '#previous_tag' do
    it 'returns nil when patch is missing' do
      expect(version('1.2').previous_tag).to be_nil
    end

    it 'returns nil when version is not a release' do
      expect(version('1.2.3-rc1').previous_tag).to be_nil
    end

    it 'returns nil when version is an internal release' do
      expect(version('1.2.3-internal1').previous_tag).to be_nil
    end

    it 'returns nil when version is EE' do
      expect(version('1.2.3-ee').previous_tag).to eq 'v1.2.2-ee'
    end

    it 'returns nil when patch is 0' do
      expect(version('1.2.0').previous_tag).to be_nil
    end

    it 'returns previous tag when patch is > 0' do
      expect(version('1.2.3').previous_tag).to eq 'v1.2.2'
    end

    it 'returns previous EE tag when patch is > 0 and ee: true' do
      expect(version('1.2.3').previous_tag(ee: true)).to eq 'v1.2.2-ee'
    end
  end

  describe '#to_ce' do
    it 'returns self when already CE' do
      version = version('1.2.3')

      expect(version.to_ce).to eql version
    end

    it 'returns a CE version when EE' do
      version = version('1.2.3-ee')

      expect(version.to_ce.to_s).to eq '1.2.3'
    end
  end

  describe '#to_ee' do
    it 'returns self when already EE' do
      version = version('1.2.3-ee')

      expect(version.to_ee).to eql version
    end

    it 'returns an EE version when CE' do
      version = version('1.2.3')

      expect(version.to_ee.to_s).to eq '1.2.3-ee'
    end
  end

  describe '#to_minor' do
    it 'returns the minor version' do
      expect(version('1.23.4').to_minor).to eq '1.23'
    end
  end

  describe '#to_omnibus' do
    it 'converts pre-releases' do
      aggregate_failures do
        expect(version('1.23.4-rc1').to_omnibus).to eq '1.23.4+rc1.ce.0'

        expect(version('1.23.4-rc1').to_omnibus(ee: true)).to eq '1.23.4+rc1.ee.0'
        expect(version('1.23.4-rc1').to_omnibus).to eq '1.23.4+rc1.ce.0'
      end
    end

    it 'converts minor releases' do
      aggregate_failures do
        expect(version('1.23.0').to_omnibus).to eq '1.23.0+ce.0'
        expect(version('1.23.0').to_omnibus(ee: true)).to eq '1.23.0+ee.0'
      end
    end

    it 'converts patch releases' do
      aggregate_failures do
        expect(version('1.23.2').to_omnibus).to eq '1.23.2+ce.0'
        expect(version('1.23.2').to_omnibus(ee: true)).to eq '1.23.2+ee.0'
      end
    end
  end

  describe '#to_docker' do
    it 'converts pre-releases' do
      aggregate_failures do
        expect(version('1.23.4-rc1').to_docker).to eq '1.23.4-rc1.ce.0'

        expect(version('1.23.4-rc1').to_docker(ee: true)).to eq '1.23.4-rc1.ee.0'
      end
    end

    it 'converts internal releases' do
      aggregate_failures do
        expect(version('1.23.4-internal1').to_docker).to eq '1.23.4-internal1.ce.0'
      end
    end

    it 'converts minor releases' do
      aggregate_failures do
        expect(version('1.23.0').to_docker).to eq '1.23.0-ce.0'
        expect(version('1.23.0').to_docker(ee: true)).to eq '1.23.0-ee.0'
      end
    end

    it 'converts patch releases' do
      aggregate_failures do
        expect(version('1.23.2').to_docker).to eq '1.23.2-ce.0'
        expect(version('1.23.2').to_docker(ee: true)).to eq '1.23.2-ee.0'
      end
    end
  end

  describe '#to_patch' do
    it 'returns the patch version' do
      expect(version('1.23.4-rc1').to_patch).to eq '1.23.4'
    end
  end

  describe '#to_rc' do
    it 'defaults to rc1' do
      aggregate_failures do
        expect(version('8.3.0').to_rc).to eq '8.3.0-rc1'
        expect(version('8.3.0-rc2').to_rc).to eq '8.3.0-rc1'
      end
    end

    it 'accepts an optional number' do
      expect(version('8.3.0').to_rc(3)).to eq '8.3.0-rc3'
    end

    context 'when version is EE' do
      it 'keeps the -ee suffix' do
        aggregate_failures do
          expect(version('8.3.0-ee').to_rc(3)).to eq '8.3.0-rc3-ee'
          expect(version('8.3.0-rc2-ee').to_rc(3)).to eq '8.3.0-rc3-ee'
          expect(version('8.3-rc2-ee').to_rc(3)).to eq '8.3.0-rc3-ee'
        end
      end
    end
  end

  describe '#to_internal' do
    it 'defaults to internal0' do
      aggregate_failures do
        expect(version('8.3.0').to_internal).to eq '8.3.0-internal0'
        expect(version('8.3.0-internal2').to_internal).to eq '8.3.0-internal0'
      end
    end

    it 'accepts an optional number' do
      expect(version('8.3.0').to_internal(3)).to eq '8.3.0-internal3'
    end
  end

  describe '#valid?' do
    it { expect(version('1.2.3')).to be_valid }
    it { expect(version('11.22.33')).to be_valid }
    it { expect(version('2.2.3-rc1')).to be_valid }
    it { expect(version('12.0.2019-123.456')).to be_valid }
    it { expect(version('12.5.0-rc43.ee.0')).to be_valid }
    it { expect(version('2.2.3.rc1')).not_to be_valid }
    it { expect(version('2.2.3-internal1')).to be_valid }
    it { expect(version('1.2.3.4')).not_to be_valid }
    it { expect(version('wow')).not_to be_valid }
  end

  describe '#previous_minor' do
    it 'returns the version of the previous minor release' do
      ver = version('12.4.0')

      expect(ver.previous_minor).to eq('12.3.0')
    end

    it 'retrieves the previous minor version from the API for a .0 minor release' do
      ver = version('12.0.0')

      expect(ReleaseTools::Versions)
        .to receive(:last_version_for_major)
        .with(11)
        .and_return('11.11.8')

      expect(ver.previous_minor).to eq('11.11.8')
    end

    it 'raises if no minor version could be determined' do
      ver = version('12.0.0')

      expect(ReleaseTools::Versions)
        .to receive(:last_version_for_major)
        .with(11)
        .and_return(nil)

      expect { ver.previous_minor }.to raise_error(RuntimeError)
    end
  end

  describe '#to_normalized_version' do
    it 'returns a normalized version string' do
      expect(version('1.2.3').to_normalized_version).to eq('1.2.3')
      expect(version('1.2.3-ee').to_normalized_version).to eq('1.2.3')
      expect(version('1.2.3-rc42').to_normalized_version).to eq('1.2.3-rc42')
      expect(version('1.2.3-rc42-ee').to_normalized_version).to eq('1.2.3-rc42')
      expect(version('1.2.3-internal1').to_normalized_version).to eq('1.2.3-internal1')
    end
  end

  describe '#to_upcoming_pre_release' do
    it 'converts a version to an upcoming pre-release version' do
      allow(ReleaseTools::ProductMilestone)
        .to receive(:after)
        .with(version('1.2.3'))
        .and_return(double(title: '2.0'))

      expect(version('1.2.3').to_upcoming_pre_release)
        .to eql('2.0.0-pre')
    end
  end

  describe '#next_milestone' do
    it 'returns the next milestone' do
      allow(ReleaseTools::ProductMilestone)
        .to receive(:after)
        .with(version('17.11.1'))
        .and_return(double(title: '18.0'))

      expect(version('17.11.1').next_milestone)
        .to eql('18.0')
    end
  end

  describe '#slug' do
    it 'converts version strings to slug form' do
      expect(version('1.2.3').slug).to eq('1-2-3')
      expect(version('1.2.3-ee').slug).to eq('1-2-3-ee')
      expect(version('1.2.3-rc42').slug).to eq('1-2-3-rc42')
      expect(version('1.2.3-rc42-ee').slug).to eq('1-2-3-rc42-ee')
      expect(version('1.2.3-internal1').slug).to eq('1-2-3-internal1')
    end
  end
end