# frozen_string_literal: true require 'spec_helper' RSpec.describe ProtectedBranch do subject { build_stubbed(:protected_branch) } describe 'Associations' do it { is_expected.to belong_to(:project) } end describe 'Validation' do it { is_expected.to validate_presence_of(:project) } it { is_expected.to validate_presence_of(:name) } end describe "#matches?" do context "when the protected branch setting is not a wildcard" do let(:protected_branch) { build(:protected_branch, name: "production/some-branch") } it "returns true for branch names that are an exact match" do expect(protected_branch.matches?("production/some-branch")).to be true end it "returns false for branch names that are not an exact match" do expect(protected_branch.matches?("staging/some-branch")).to be false end end context "when the protected branch name contains wildcard(s)" do context "when there is a single '*'" do let(:protected_branch) { build(:protected_branch, name: "production/*") } it "returns true for branch names matching the wildcard" do expect(protected_branch.matches?("production/some-branch")).to be true expect(protected_branch.matches?("production/")).to be true end it "returns false for branch names not matching the wildcard" do expect(protected_branch.matches?("staging/some-branch")).to be false expect(protected_branch.matches?("production")).to be false end end context "when the wildcard contains regex symbols other than a '*'" do let(:protected_branch) { build(:protected_branch, name: "pro.duc.tion/*") } it "returns true for branch names matching the wildcard" do expect(protected_branch.matches?("pro.duc.tion/some-branch")).to be true end it "returns false for branch names not matching the wildcard" do expect(protected_branch.matches?("production/some-branch")).to be false expect(protected_branch.matches?("proXducYtion/some-branch")).to be false end end context "when there are '*'s at either end" do let(:protected_branch) { build(:protected_branch, name: "*/production/*") } it "returns true for branch names matching the wildcard" do expect(protected_branch.matches?("gitlab/production/some-branch")).to be true expect(protected_branch.matches?("/production/some-branch")).to be true expect(protected_branch.matches?("gitlab/production/")).to be true expect(protected_branch.matches?("/production/")).to be true end it "returns false for branch names not matching the wildcard" do expect(protected_branch.matches?("gitlabproductionsome-branch")).to be false expect(protected_branch.matches?("production/some-branch")).to be false expect(protected_branch.matches?("gitlab/production")).to be false expect(protected_branch.matches?("production")).to be false end end context "when there are arbitrarily placed '*'s" do let(:protected_branch) { build(:protected_branch, name: "pro*duction/*/gitlab/*") } it "returns true for branch names matching the wildcard" do expect(protected_branch.matches?("production/some-branch/gitlab/second-branch")).to be true expect(protected_branch.matches?("proXYZduction/some-branch/gitlab/second-branch")).to be true expect(protected_branch.matches?("proXYZduction/gitlab/gitlab/gitlab")).to be true expect(protected_branch.matches?("proXYZduction//gitlab/")).to be true expect(protected_branch.matches?("proXYZduction/some-branch/gitlab/")).to be true expect(protected_branch.matches?("proXYZduction//gitlab/some-branch")).to be true end it "returns false for branch names not matching the wildcard" do expect(protected_branch.matches?("production/some-branch/not-gitlab/second-branch")).to be false expect(protected_branch.matches?("prodXYZuction/some-branch/gitlab/second-branch")).to be false expect(protected_branch.matches?("proXYZduction/gitlab/some-branch/gitlab")).to be false expect(protected_branch.matches?("proXYZduction/gitlab//")).to be false expect(protected_branch.matches?("proXYZduction/gitlab/")).to be false expect(protected_branch.matches?("proXYZduction//some-branch/gitlab")).to be false end end end end describe "#matching" do context "for direct matches" do it "returns a list of protected branches matching the given branch name" do production = create(:protected_branch, name: "production") staging = create(:protected_branch, name: "staging") expect(described_class.matching("production")).to include(production) expect(described_class.matching("production")).not_to include(staging) end it "accepts a list of protected branches to search from, so as to avoid a DB call" do production = build(:protected_branch, name: "production") staging = build(:protected_branch, name: "staging") expect(described_class.matching("production")).to be_empty expect(described_class.matching("production", protected_refs: [production, staging])).to include(production) expect(described_class.matching("production", protected_refs: [production, staging])).not_to include(staging) end end context "for wildcard matches" do it "returns a list of protected branches matching the given branch name" do production = create(:protected_branch, name: "production/*") staging = create(:protected_branch, name: "staging/*") expect(described_class.matching("production/some-branch")).to include(production) expect(described_class.matching("production/some-branch")).not_to include(staging) end it "accepts a list of protected branches to search from, so as to avoid a DB call" do production = build(:protected_branch, name: "production/*") staging = build(:protected_branch, name: "staging/*") expect(described_class.matching("production/some-branch")).to be_empty expect(described_class.matching("production/some-branch", protected_refs: [production, staging])).to include(production) expect(described_class.matching("production/some-branch", protected_refs: [production, staging])).not_to include(staging) end end end describe '#protected?' do context 'existing project' do let(:project) { create(:project, :repository) } it 'returns true when the branch matches a protected branch via direct match' do create(:protected_branch, project: project, name: "foo") expect(described_class.protected?(project, 'foo')).to eq(true) end it 'returns true when the branch matches a protected branch via wildcard match' do create(:protected_branch, project: project, name: "production/*") expect(described_class.protected?(project, 'production/some-branch')).to eq(true) end it 'returns false when the branch does not match a protected branch via direct match' do expect(described_class.protected?(project, 'foo')).to eq(false) end it 'returns false when the branch does not match a protected branch via wildcard match' do create(:protected_branch, project: project, name: "production/*") expect(described_class.protected?(project, 'staging/some-branch')).to eq(false) end end context 'new project' do using RSpec::Parameterized::TableSyntax let(:project) { create(:project) } context 'when the group has set their own default_branch_protection level' do where(:default_branch_protection_level, :result) do Gitlab::Access::PROTECTION_NONE | false Gitlab::Access::PROTECTION_DEV_CAN_PUSH | false Gitlab::Access::PROTECTION_DEV_CAN_MERGE | true Gitlab::Access::PROTECTION_FULL | true end with_them do it 'protects the default branch based on the default branch protection setting of the group' do expect(project.namespace).to receive(:default_branch_protection).and_return(default_branch_protection_level) expect(described_class.protected?(project, 'master')).to eq(result) end end end context 'when the group has not set their own default_branch_protection level' do where(:default_branch_protection_level, :result) do Gitlab::Access::PROTECTION_NONE | false Gitlab::Access::PROTECTION_DEV_CAN_PUSH | false Gitlab::Access::PROTECTION_DEV_CAN_MERGE | true Gitlab::Access::PROTECTION_FULL | true end with_them do before do stub_application_setting(default_branch_protection: default_branch_protection_level) end it 'protects the default branch based on the instance level default branch protection setting' do expect(described_class.protected?(project, 'master')).to eq(result) end end end end end describe '#any_protected?' do context 'existing project' do let(:project) { create(:project, :repository) } it 'returns true when any of the branch names match a protected branch via direct match' do create(:protected_branch, project: project, name: 'foo') expect(described_class.any_protected?(project, ['foo', 'production/some-branch'])).to eq(true) end it 'returns true when any of the branch matches a protected branch via wildcard match' do create(:protected_branch, project: project, name: 'production/*') expect(described_class.any_protected?(project, ['foo', 'production/some-branch'])).to eq(true) end it 'returns false when none of branches does not match a protected branch via direct match' do expect(described_class.any_protected?(project, ['foo'])).to eq(false) end it 'returns false when none of the branches does not match a protected branch via wildcard match' do create(:protected_branch, project: project, name: 'production/*') expect(described_class.any_protected?(project, ['staging/some-branch'])).to eq(false) end end end describe '.by_name' do let!(:protected_branch) { create(:protected_branch, name: 'master') } let!(:another_protected_branch) { create(:protected_branch, name: 'stable') } it 'returns protected branches with a matching name' do expect(described_class.by_name(protected_branch.name)) .to eq([protected_branch]) end it 'returns protected branches with a partially matching name' do expect(described_class.by_name(protected_branch.name[0..2])) .to eq([protected_branch]) end it 'returns protected branches with a matching name regardless of the casing' do expect(described_class.by_name(protected_branch.name.upcase)) .to eq([protected_branch]) end it 'returns nothing when nothing matches' do expect(described_class.by_name('unknown')).to be_empty end it 'return nothing when query is blank' do expect(described_class.by_name('')).to be_empty end end end