gitlab-foss/qa/spec/page/element_spec.rb

# frozen_string_literal: true

RSpec.describe QA::Page::Element do
  describe '#selector_css' do
    it 'transforms element name into QA-specific clickable css selector' do
      expect(described_class.new(:sign_in_button).selector_css)
        .to eq('[data-testid="sign_in_button"]')
    end
  end

  context 'when pattern is an expression' do
    subject { described_class.new(:something, /button 'Sign in'/) }

    it 'matches when there is a match' do
      expect(subject.matches?("button 'Sign in'")).to be true
    end

    it 'does not match if pattern is not present' do
      expect(subject.matches?("button 'Sign out'")).to be false
    end
  end

  context 'when pattern is a string' do
    subject { described_class.new(:something, 'button') }

    it 'matches when there is match' do
      expect(subject.matches?('some button in the view')).to be true
    end

    it 'does not match if pattern is not present' do
      expect(subject.matches?('text_field :name')).to be false
    end
  end

  context 'when pattern is not provided' do
    subject { described_class.new(:some_name) }

    it 'does not match if QA selector is not there' do
      expect(subject.matches?('some_name selector')).to be false
    end

    it 'matches when element name is specified' do
      expect(subject.matches?('data:{qa:{selector:"some_name"}}')).to be true
    end

    it 'matches when element name is specified (single quotes)' do
      expect(subject.matches?("data:{qa:{selector:'some_name'}}")).to be true
    end
  end

  describe 'attributes' do
    context 'element with no args' do
      subject { described_class.new(:something) }

      it 'has no attribute[pattern]' do
        expect(subject.attributes[:pattern]).to be_nil
      end

      it 'is not required by default' do
        expect(subject.required?).to be false
      end
    end

    context 'element with a pattern' do
      subject { described_class.new(:something, /link_to 'something'/) }

      it 'has an attribute[pattern] of the pattern' do
        expect(subject.attributes[:pattern]).to eq(/link_to 'something'/)
      end

      it 'is not required by default' do
        expect(subject.required?).to be false
      end
    end

    context 'element with requirement; no pattern' do
      subject { described_class.new(:something, required: true) }

      it 'is required' do
        expect(subject.required?).to be true
      end
    end

    context 'element with requirement and pattern' do
      subject { described_class.new(:something, /link_to 'something_else_entirely'/, required: true) }

      it 'has an attribute[pattern] of the passed pattern' do
        expect(subject.attributes[:pattern]).to eq(/link_to 'something_else_entirely'/)
      end

      it 'is required' do
        expect(subject.required?).to be true
      end
    end
  end

  describe 'data-testid selectors' do
    subject { described_class.new(:my_element) }

    it 'does not translate to a deprecated qa selector' do
      expect(subject.selector_css).not_to include(%q([data-qa-selector="my_element"]))
    end

    it 'properly translates to a data-testid' do
      expect(subject.selector_css).to include(%q([data-testid="my_element"]))
    end

    context 'additional selectors' do
      let(:element) { described_class.new(:my_element, index: 3, another_match: 'something') }
      let(:required_element) { described_class.new(:my_element, required: true, index: 3) }

      it 'matches on additional data-qa properties translating snake_case to kebab-case' do
        expect(element.selector_css)
          .to include('[data-testid="my_element"][data-qa-index="3"][data-qa-another-match="something"]')
      end

      it 'doesnt conflict with element requirement' do
        expect(element).not_to be_required
        expect(element.selector_css).not_to include(%q(data-qa-required))

        expect(required_element).to be_required
        expect(required_element.selector_css).not_to include(%q(data-qa-required))
      end
    end
  end
end