Merge pull request #4335 from dependabot/jurre/ghes-host

Treat GHES hosted sources as github sources

bundler/spec/dependabot/bundler/metadata_finder_spec.rb

@@ -33,6 +33,20 @@
   end
   let(:dependency_name) { "business" }
 
+  before do
+    stub_request(:get, "https://example.com/status").to_return(
+      status: 200,
+      body: "Not GHES",
+      headers: {}
+    )
+
+    stub_request(:get, "https://www.rubydoc.info/status").to_return(
+      status: 200,
+      body: "Not GHES",
+      headers: {}
+    )
+  end
+
   describe "#source_url" do
     subject(:source_url) { finder.source_url }
 

cargo/spec/dependabot/cargo/metadata_finder_spec.rb

@@ -35,6 +35,14 @@
   let(:dependency_name) { "bitflags" }
   let(:dependency_source) { nil }
 
+  before do
+    stub_request(:get, "https://example.com/status").to_return(
+      status: 200,
+      body: "Not GHES",
+      headers: {}
+    )
+  end
+
   describe "#source_url" do
     subject(:source_url) { finder.source_url }
     let(:crates_url) { "https://crates.io/api/v1/crates/bitflags" }

common/lib/dependabot/source.rb

@@ -9,6 +9,15 @@ class Source
       (?:(?:/tree|/blob)/(?<branch>[^/]+)/(?<directory>.*)[\#|/])?
     }x.freeze
 
+    GITHUB_ENTERPRISE_SOURCE = %r{
+      (?<protocol>(http://|https://|git://|ssh://))*
+      (?<username>[^@]+@)*
+      (?<host>[^/]+)
+      [/:]
+      (?<repo>[\w.-]+/(?:(?!\.git|\.\s)[\w.-])+)
+      (?:(?:/tree|/blob)/(?<branch>[^/]+)/(?<directory>.*)[\#|/])?
+    }x.freeze
+
     GITLAB_SOURCE = %r{
       (?<provider>gitlab)
       (?:\.com)[/:]
@@ -40,7 +49,7 @@ class Source
                   :hostname, :api_endpoint
 
     def self.from_url(url_string)
-      return unless url_string&.match?(SOURCE_REGEX)
+      return github_enterprise_from_url(url_string) unless url_string&.match?(SOURCE_REGEX)
 
       captures = url_string.match(SOURCE_REGEX).named_captures
 
@@ -52,6 +61,33 @@ def self.from_url(url_string)
       )
     end
 
+    def self.github_enterprise_from_url(url_string)
+      captures = url_string&.match(GITHUB_ENTERPRISE_SOURCE)&.named_captures
+      return unless captures
+
+      base_url = "https://#{captures.fetch('host')}"
+
+      return unless github_enterprise?(base_url)
+
+      new(
+        provider: "github",
+        repo: captures.fetch("repo"),
+        directory: captures.fetch("directory"),
+        branch: captures.fetch("branch"),
+        hostname: captures.fetch("host"),
+        api_endpoint: File.join(base_url, "api", "v3")
+      )
+    end
+
+    def self.github_enterprise?(base_url)
+      resp = Excon.get(File.join(base_url, "status"))
+      resp.status == 200 &&
+        # Alternatively: resp.headers["Server"] == "GitHub.com", but this
+        # currently doesn't work with development environments
+        resp.headers["X-GitHub-Request-Id"] &&
+        !resp.headers["X-GitHub-Request-Id"].empty?
+    end
+
     def initialize(provider:, repo:, directory: nil, branch: nil, commit: nil,
                    hostname: nil, api_endpoint: nil)
       if (hostname.nil? ^ api_endpoint.nil?) && (provider != "codecommit")

common/spec/dependabot/source_spec.rb

@@ -133,6 +133,108 @@
       end
     end
 
+    context "with a GitHub Enterprise URL" do
+      before do
+        stub_request(:get, "https://ghes.mycorp.com/status").to_return(
+          status: 200,
+          body: "GitHub lives!",
+          headers: {
+            Server: "GitHub.com",
+            "X-GitHub-Request-Id": "24e4e058-fdab-5ff4-8d79-be3493b7fa8e"
+          }
+        )
+      end
+      let(:url) { "https://ghes.mycorp.com/org/abc" }
+      its(:provider) { is_expected.to eq("github") }
+      its(:repo) { is_expected.to eq("org/abc") }
+      its(:directory) { is_expected.to be_nil }
+      its(:branch) { is_expected.to be_nil }
+
+      context "with a git protocol" do
+        let(:url) { "ssh://[email protected]:org/abc" }
+        its(:provider) { is_expected.to eq("github") }
+        its(:repo) { is_expected.to eq("org/abc") }
+        its(:directory) { is_expected.to be_nil }
+      end
+
+      context "with a trailing .git" do
+        let(:url) { "https://ghes.mycorp.com/org/abc.git" }
+        its(:provider) { is_expected.to eq("github") }
+        its(:repo) { is_expected.to eq("org/abc") }
+        its(:directory) { is_expected.to be_nil }
+      end
+
+      context "with a trailing ." do
+        let(:url) { "https://ghes.mycorp.com/org/abc. " }
+        its(:provider) { is_expected.to eq("github") }
+        its(:repo) { is_expected.to eq("org/abc") }
+        its(:directory) { is_expected.to be_nil }
+      end
+
+      context "with a trailing space" do
+        let(:url) { "https://ghes.mycorp.com/org/abc " }
+        its(:provider) { is_expected.to eq("github") }
+        its(:repo) { is_expected.to eq("org/abc") }
+        its(:directory) { is_expected.to be_nil }
+      end
+
+      context "with a trailing /" do
+        let(:url) { "https://ghes.mycorp.com/org/abc/" }
+        its(:provider) { is_expected.to eq("github") }
+        its(:repo) { is_expected.to eq("org/abc") }
+        its(:directory) { is_expected.to be_nil }
+      end
+
+      context "with a trailing quote" do
+        let(:url) { "<a href=\"https://ghes.mycorp.com/org/abc\">" }
+        its(:provider) { is_expected.to eq("github") }
+        its(:repo) { is_expected.to eq("org/abc") }
+        its(:directory) { is_expected.to be_nil }
+      end
+
+      context "with no directory" do
+        let(:url) { "https://ghes.mycorp.com/org/abc/tree/master/readme.md" }
+        its(:provider) { is_expected.to eq("github") }
+        its(:repo) { is_expected.to eq("org/abc") }
+        its(:directory) { is_expected.to be_nil }
+      end
+
+      context "with a directory" do
+        let(:url) { "https://ghes.mycorp.com/org/abc/tree/master/dir/readme.md" }
+        its(:provider) { is_expected.to eq("github") }
+        its(:repo) { is_expected.to eq("org/abc") }
+        its(:directory) { is_expected.to eq("dir") }
+        its(:branch) { is_expected.to eq("master") }
+
+        context "with the filename specified by a #" do
+          let(:url) { "https://ghes.mycorp.com/org/abc/tree/master/dir#readme.md" }
+          its(:provider) { is_expected.to eq("github") }
+          its(:repo) { is_expected.to eq("org/abc") }
+          its(:directory) { is_expected.to eq("dir") }
+        end
+
+        context "when not looking at the master branch" do
+          let(:url) { "https://ghes.mycorp.com/org/abc/tree/custom/dir/readme.md" }
+          its(:provider) { is_expected.to eq("github") }
+          its(:repo) { is_expected.to eq("org/abc") }
+          its(:directory) { is_expected.to eq("dir") }
+          its(:branch) { is_expected.to eq("custom") }
+        end
+      end
+
+      context "when the source is not GHES" do
+        before do
+          stub_request(:get, "https://not-ghes.mycorp.com/status").to_return(
+            status: 200,
+            body: "This is not GHES!",
+            headers: { Server: "nginx" }
+          )
+        end
+        let(:url) { "https://not-ghes.mycorp.com/org/abc" }
+        it { is_expected.to be_nil }
+      end
+    end
+
     context "with a Bitbucket URL" do
       let(:url) do
         "https://bitbucket.org/org/abc/src/master/dir/readme.md?at=default"

composer/spec/dependabot/composer/metadata_finder_spec.rb

@@ -33,6 +33,14 @@
   end
   let(:dependency_name) { "monolog/monolog" }
 
+  before do
+    stub_request(:get, "https://example.com/status").to_return(
+      status: 200,
+      body: "Not GHES",
+      headers: {}
+    )
+  end
+
   describe "#source_url" do
     subject(:source_url) { finder.source_url }
     let(:packagist_url) { "https://packagist.org/p/monolog/monolog.json" }

git_submodules/spec/dependabot/git_submodules/metadata_finder_spec.rb

@@ -42,6 +42,15 @@
     }]
   end
 
+  before do
+    # Not hosted on GitHub Enterprise Server
+    stub_request(:get, "https://example.com/status").to_return(
+      status: 200,
+      body: "Not GHES",
+      headers: {}
+    )
+  end
+
   describe "#source_url" do
     subject(:source_url) { finder.source_url }
 

go_modules/spec/dependabot/go_modules/metadata_finder_spec.rb

@@ -38,6 +38,14 @@
   let(:dependency_name) { "github.com/satori/go.uuid" }
   let(:source) { nil }
 
+  before do
+    stub_request(:get, "https://example.com/status").to_return(
+      status: 200,
+      body: "Not GHES",
+      headers: {}
+    )
+  end
+
   describe "#source_url" do
     subject(:source_url) { finder.source_url }
 

gradle/spec/dependabot/gradle/metadata_finder_spec.rb

@@ -49,6 +49,12 @@
 
     before do
       stub_request(:get, maven_url).to_return(status: 200, body: maven_response)
+
+      stub_request(:get, "https://example.com/status").to_return(
+        status: 200,
+        body: "Not GHES",
+        headers: {}
+      )
     end
 
     context "when there is a github link in the maven response" do

hex/spec/dependabot/hex/metadata_finder_spec.rb

@@ -41,6 +41,12 @@
 
     before do
       stub_request(:get, hex_url).to_return(status: 200, body: hex_response)
+
+      stub_request(:get, "https://example.com/status").to_return(
+        status: 200,
+        body: "Not GHES",
+        headers: {}
+      )
     end
 
     context "when there is a github link in the hex.pm response" do

maven/spec/dependabot/maven/metadata_finder_spec.rb

@@ -54,6 +54,12 @@
     before do
       stub_request(:get, maven_url).to_return(status: 200, body: maven_response)
       stub_request(:get, mockk_url).to_return(status: 200, body: mockk_response)
+
+      stub_request(:get, "https://example.com/status").to_return(
+        status: 200,
+        body: "Not GHES",
+        headers: {}
+      )
     end
 
     context "when the dependency name has a classifier" do

npm_and_yarn/spec/dependabot/npm_and_yarn/metadata_finder_spec.rb

@@ -41,6 +41,12 @@
         to_return(status: 200, body: npm_latest_version_response)
       stub_request(:get, npm_url).
         to_return(status: 200, body: npm_all_versions_response)
+      stub_request(:get, "https://example.come/status").to_return(
+        status: 200,
+        body: "Not GHES",
+        headers: {}
+      )
+      stub_request(:get, "https://jshttp/status").to_return(status: 404)
     end
 
     context "for a git dependency" do

nuget/spec/dependabot/nuget/metadata_finder_spec.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "spec_helper"
 require "dependabot/dependency"
 require "dependabot/nuget/metadata_finder"
 require_common_spec "metadata_finders/shared_examples_for_metadata_finders"
@@ -51,6 +52,11 @@
 
     before do
       stub_request(:get, nuget_url).to_return(status: 200, body: nuget_response)
+      stub_request(:get, "https://example.com/status").to_return(
+        status: 200,
+        body: "Not GHES",
+        headers: {}
+      )
     end
 
     context "with a github link in the nuspec" do

python/spec/dependabot/python/metadata_finder_spec.rb

@@ -36,6 +36,16 @@
   let(:dependency_name) { "luigi" }
   let(:version) { "1.0" }
 
+  before do
+    stub_request(:get, "https://example.com/status").to_return(
+      status: 200,
+      body: "Not GHES",
+      headers: {}
+    )
+    stub_request(:get, "https://initd.org/status").to_return(status: 404)
+    stub_request(:get, "https://pypi.org/status").to_return(status: 404)
+  end
+
   describe "#source_url" do
     subject(:source_url) { finder.source_url }
     let(:pypi_url) { "https://pypi.org/pypi/#{dependency_name}/json" }