github_webhooks_controller_push_spec.rb

# frozen_string_literal: true

require 'rails_helper'

RSpec.describe GithubWebhooksController do
  let(:github_webhook_secret) { 'secret' }
  let(:params) do
    {
      ref:,
      commits:
    }
  end

  let(:headers) do
    {
      'X-Hub-Signature-256': "sha256=#{OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), github_webhook_secret, params.to_json)}",
      'X-GitHub-Event': 'push',
      'Content-Type': 'application/json'
    }
  end

  before do
    allow(Rails.configuration.x.github_webhook).to receive(:secret).and_return(github_webhook_secret)
    allow(Rails.configuration.x.github_webhook).to receive(:ref).and_return('branches/whatever')
    allow(UploadJob).to receive(:perform_later)
    post '/github_webhooks', env: { RAW_POST_DATA: params.to_json }, headers:
  end

  shared_examples 'upload job' do
    it 'schedules the job' do
      expect(UploadJob).to have_received(:perform_later).with(params)
    end
  end

  describe 'when webhook ref matches branch of interest on github push' do
    let(:ref) { 'branches/whatever' }

    context 'when code has been added' do
      let(:commits) { [{ added: ['en/code/project1/main.py'], modified: [], removed: [] }] }

      it_behaves_like 'upload job'
    end

    context 'when code has been modified' do
      let(:commits) { [{ added: [], modified: ['en/code/project1/main.py'], removed: [] }] }

      it_behaves_like 'upload job'
    end

    context 'when code has been removed' do
      let(:commits) { [{ added: [], modified: [], removed: ['en/code/project1/main.py'] }] }

      it_behaves_like 'upload job'
    end

    context 'when code has not been changed' do
      let(:commits) { [{ added: ['en/step2.md'], modified: ['en/step1.md'], removed: ['en/step0.md'] }] }

      it 'does not schedule the upload job' do
        expect(UploadJob).not_to have_received(:perform_later)
      end
    end
  end

  describe 'when webhook ref does not match branch of interest on github push' do
    let(:ref) { 'branches/master' }
    let(:commits) { [{ added: [], modified: ['en/code/project1/main.py'], removed: [] }] }

    it 'does not schedule the upload job' do
      expect(UploadJob).not_to have_received(:perform_later)
    end
  end
end