From 640440c9d8e1dea94067825e79734eb0f9774acf Mon Sep 17 00:00:00 2001
From: Douwe Maan <douwe@selenight.nl>
Date: Tue, 16 May 2017 15:30:18 -0500
Subject: [PATCH] Autolink package names in Godeps.json

---
 lib/gitlab/dependency_linker.rb               |  1 +
 .../dependency_linker/godeps_json_linker.rb   | 26 ++++++
 .../godeps_json_linker_spec.rb                | 84 +++++++++++++++++++
 spec/lib/gitlab/dependency_linker_spec.rb     |  8 ++
 4 files changed, 119 insertions(+)
 create mode 100644 lib/gitlab/dependency_linker/godeps_json_linker.rb
 create mode 100644 spec/lib/gitlab/dependency_linker/godeps_json_linker_spec.rb

diff --git a/lib/gitlab/dependency_linker.rb b/lib/gitlab/dependency_linker.rb
index 2f68dfc00fb..9ff355a9085 100644
--- a/lib/gitlab/dependency_linker.rb
+++ b/lib/gitlab/dependency_linker.rb
@@ -9,6 +9,7 @@ module Gitlab
       PodspecLinker,
       PodspecJsonLinker,
       CartfileLinker,
+      GodepsJsonLinker,
     ].freeze
 
     def self.linker(blob_name)
diff --git a/lib/gitlab/dependency_linker/godeps_json_linker.rb b/lib/gitlab/dependency_linker/godeps_json_linker.rb
new file mode 100644
index 00000000000..fe091baee6d
--- /dev/null
+++ b/lib/gitlab/dependency_linker/godeps_json_linker.rb
@@ -0,0 +1,26 @@
+module Gitlab
+  module DependencyLinker
+    class GodepsJsonLinker < JsonLinker
+      NESTED_REPO_REGEX = %r{([^/]+/)+[^/]+?}.freeze
+
+      self.file_type = :godeps_json
+
+      private
+
+      def link_dependencies
+        link_json('ImportPath') do |path|
+          case path
+          when %r{\A(?<repo>gitlab\.com/#{NESTED_REPO_REGEX})\.git/(?<path>.+)\z},
+              %r{\A(?<repo>git(lab|hub)\.com/#{REPO_REGEX})/(?<path>.+)\z}
+
+            "https://#{$~[:repo]}/tree/master/#{$~[:path]}"
+          when /\Agolang\.org/
+            "https://godoc.org/#{path}"
+          else
+            "https://#{path}"
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/spec/lib/gitlab/dependency_linker/godeps_json_linker_spec.rb b/spec/lib/gitlab/dependency_linker/godeps_json_linker_spec.rb
new file mode 100644
index 00000000000..e279e0c9019
--- /dev/null
+++ b/spec/lib/gitlab/dependency_linker/godeps_json_linker_spec.rb
@@ -0,0 +1,84 @@
+require 'rails_helper'
+
+describe Gitlab::DependencyLinker::GodepsJsonLinker, lib: true do
+  describe '.support?' do
+    it 'supports Godeps.json' do
+      expect(described_class.support?('Godeps.json')).to be_truthy
+    end
+
+    it 'does not support other files' do
+      expect(described_class.support?('Godeps.json.example')).to be_falsey
+    end
+  end
+
+  describe '#link' do
+    let(:file_name) { "Godeps.json" }
+
+    let(:file_content) do
+      <<-CONTENT.strip_heredoc
+        {
+        	"ImportPath": "gitlab.com/gitlab-org/gitlab-pages",
+        	"GoVersion": "go1.5",
+        	"Packages": [
+        		"./..."
+        	],
+        	"Deps": [
+        		{
+        			"ImportPath": "github.com/kardianos/osext",
+        			"Rev": "efacde03154693404c65e7aa7d461ac9014acd0c"
+        		},
+        		{
+        			"ImportPath": "github.com/stretchr/testify/assert",
+        			"Rev": "1297dc01ed0a819ff634c89707081a4df43baf6b"
+        		},
+        		{
+        			"ImportPath": "github.com/stretchr/testify/require",
+        			"Rev": "1297dc01ed0a819ff634c89707081a4df43baf6b"
+        		},
+        		{
+        			"ImportPath": "gitlab.com/group/project/path",
+        			"Rev": "1297dc01ed0a819ff634c89707081a4df43baf6b"
+        		},
+        		{
+        			"ImportPath": "gitlab.com/group/subgroup/project.git/path",
+        			"Rev": "1297dc01ed0a819ff634c89707081a4df43baf6b"
+        		},
+        		{
+        			"ImportPath": "golang.org/x/crypto/ssh/terminal",
+        			"Rev": "1351f936d976c60a0a48d728281922cf63eafb8d"
+        		},
+        		{
+        			"ImportPath": "golang.org/x/net/http2",
+        			"Rev": "b4e17d61b15679caf2335da776c614169a1b4643"
+        		}
+        	]
+        }
+      CONTENT
+    end
+
+    subject { Gitlab::Highlight.highlight(file_name, file_content) }
+
+    def link(name, url)
+      %{<a href="#{url}" rel="nofollow noreferrer noopener" target="_blank">#{name}</a>}
+    end
+
+    it 'links the package name' do
+      expect(subject).to include(link('gitlab.com/gitlab-org/gitlab-pages', 'https://gitlab.com/gitlab-org/gitlab-pages'))
+    end
+
+    it 'links GitHub repos' do
+      expect(subject).to include(link('github.com/kardianos/osext', 'https://github.com/kardianos/osext'))
+      expect(subject).to include(link('github.com/stretchr/testify/assert', 'https://github.com/stretchr/testify/tree/master/assert'))
+      expect(subject).to include(link('github.com/stretchr/testify/require', 'https://github.com/stretchr/testify/tree/master/require'))
+    end
+
+    it 'links GitLab projects' do
+      expect(subject).to include(link('gitlab.com/group/project/path', 'https://gitlab.com/group/project/tree/master/path'))
+      expect(subject).to include(link('gitlab.com/group/subgroup/project.git/path', 'https://gitlab.com/group/subgroup/project/tree/master/path'))
+    end
+
+    it 'links Golang packages' do
+      expect(subject).to include(link('golang.org/x/net/http2', 'https://godoc.org/golang.org/x/net/http2'))
+    end
+  end
+end
diff --git a/spec/lib/gitlab/dependency_linker_spec.rb b/spec/lib/gitlab/dependency_linker_spec.rb
index f27f633a62c..15a8bf6a426 100644
--- a/spec/lib/gitlab/dependency_linker_spec.rb
+++ b/spec/lib/gitlab/dependency_linker_spec.rb
@@ -65,5 +65,13 @@ describe Gitlab::DependencyLinker, lib: true do
 
       described_class.link(blob_name, nil, nil)
     end
+
+    it 'links using GodepsJsonLinker' do
+      blob_name = 'Godeps.json'
+
+      expect(described_class::GodepsJsonLinker).to receive(:link)
+
+      described_class.link(blob_name, nil, nil)
+    end
   end
 end