Skip to content

A platform for community discussion. Free, open, simple.

4.8 KB
Raw Blame
# frozen_string_literal: true

RSpec.describe Onebox::Engine::GithubActionsOnebox do
  describe "PR check run" do
    let(:pr_run_uri) { "https://api.github.com/repos/discourse/discourse/pulls/13128" }
    let(:run_uri) { "https://api.github.com/repos/discourse/discourse/check-runs/2660861130" }

    before do
      stub_request(:get, pr_run_uri).to_return(
        status: 200,
        body: onebox_response("githubactions_pr"),
      )

      stub_request(:get, run_uri).to_return(
        status: 200,
        body: onebox_response("githubactions_pr_run"),
      )
    end

    include_context "with engines" do
      let(:link) do
        "https://github.com/discourse/discourse/pull/13128/checks?check_run_id=2660861130"
      end
    end
    it_behaves_like "an engine"

    describe "#to_html" do
      it "shows the check type, result and repository in the header" do
        preview = Nokogiri::HTML5.fragment(html)
        header = preview.at_css("aside > header")

        expect(header.at_css(".github-onebox__label").text.strip).to eq("Check run")
        expect(header.at_css("a").text.strip).to eq("discourse/discourse")
        expect(header.at_css("a")["href"]).to eq(link)
        expect(preview.at_css("aside")["class"].split).to include("--github-success")
      end

      it "includes title" do
        expect(html).to include("simplify post and topic deletion language")
      end
    end

    context "when github_onebox_access_token is configured" do
      before { SiteSetting.github_onebox_access_tokens = "discourse|github_pat_1234" }

      it "sends it as part of the request" do
        html
        expect(WebMock).to have_requested(:get, run_uri).with(
          headers: {
            "Authorization" => "Bearer github_pat_1234",
          },
        )
      end
    end
  end

  describe "GitHub Actions run" do
    let(:pr_run_uri) { "https://api.github.com/repos/discourse/discourse/actions/runs/873214216" }

    let(:run_response) { onebox_response("githubactions_actions_run") }

    before { stub_request(:get, pr_run_uri).to_return(status: 200, body: run_response) }

    include_context "with engines" do
      let(:link) { "https://github.com/discourse/discourse/actions/runs/873214216" }
    end
    it_behaves_like "an engine"

    describe "#to_html" do
      it "shows the workflow result and repository in the header" do
        preview = Nokogiri::HTML5.fragment(html)
        header = preview.at_css("aside > header")

        expect(header.at_css(".github-onebox__label").text.strip).to eq("Success")
        expect(header.at_css("a").text.strip).to eq("discourse/discourse")
        expect(header.at_css("a")["href"]).to eq(link)
        expect(preview.at_css("aside")["class"].split).to include("--github-success")
      end

      it "includes title" do
        expect(html).to include("Remove deleted_by_author key")
      end

      it "shows Failure for a failed workflow" do
        run = MultiJson.load(run_response)
        run.merge!("status" => "completed", "conclusion" => "failure")
        stub_request(:get, pr_run_uri).to_return(body: MultiJson.dump(run))

        preview = Nokogiri::HTML5.fragment(html)

        expect(preview.at_css(".github-onebox__label").text.strip).to eq("Failure")
        expect(preview.at_css("aside")["class"].split.grep(/\A--github-/)).to eq(
          ["--github-failure"],
        )
      end

      it "shows In progress for a running workflow" do
        run = MultiJson.load(run_response)
        run.merge!("status" => "in_progress", "conclusion" => nil)
        stub_request(:get, pr_run_uri).to_return(body: MultiJson.dump(run))

        preview = Nokogiri::HTML5.fragment(html)

        expect(preview.at_css(".github-onebox__label").text.strip).to eq("In progress")
        expect(preview.at_css("aside")["class"].split.grep(/\A--github-/)).to eq(
          ["--github-pending"],
        )
      end

      it "shows Unknown or queued for a queued workflow" do
        run = MultiJson.load(run_response)
        run.merge!("status" => "queued", "conclusion" => nil)
        stub_request(:get, pr_run_uri).to_return(body: MultiJson.dump(run))

        preview = Nokogiri::HTML5.fragment(html)

        expect(preview.at_css(".github-onebox__label").text.strip).to eq("Unknown or queued")
        expect(preview.at_css("aside")["class"].split.grep(/\A--github-/)).to eq(
          ["--github-unknown"],
        )
      end

      it "includes action name" do
        expect(html).to include("Linting")
      end
    end

    context "when github_onebox_access_token is configured" do
      before { SiteSetting.github_onebox_access_tokens = "discourse|github_pat_1234" }

      it "sends it as part of the request" do
        html
        expect(WebMock).to have_requested(:get, pr_run_uri).with(
          headers: {
            "Authorization" => "Bearer github_pat_1234",
          },
        )
      end
    end
  end
end