Autolink package names in Godeps.json

This commit is contained in:
Douwe Maan 2017-05-16 15:30:18 -05:00
parent e780259a65
commit 640440c9d8
4 changed files with 119 additions and 0 deletions

View File

@ -9,6 +9,7 @@ module Gitlab
PodspecLinker,
PodspecJsonLinker,
CartfileLinker,
GodepsJsonLinker,
].freeze
def self.linker(blob_name)

View File

@ -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

View File

@ -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

View File

@ -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