Merge branch 'import-gh-wiki' into 'master'

Import GitHub wiki into GitLab

Closes #2834 

GitHub doesn’t apply any constraints to theirs wiki slug allowing chars like ,, :, *, etc, we need to remove our constraints or some wiki pages will not be available after they are imported.

Some wikis use the Gollum's tags to link its internal/external resources like: images, urls, wiki pages, etc. So, to avoid that wiki links/images displays completely broken after they were imported, we added a new `WikiPipeline`, that for now will parse only simple links, and image tags.

##### Before `WikiPipeline`:

![Screenshot_2016-01-11_20.14.48](/uploads/46fd5dbb5acfc70aa8ecca3050b675e4/Screenshot_2016-01-11_20.14.48.png)

##### After `WikiPipeline`:

![Screenshot_2016-01-11_20.15.56](/uploads/b1d94aa852f385f867a7868c358b4257/Screenshot_2016-01-11_20.15.56.png)

See merge request !2324

8 files changed, 210 insertions, 7 deletions

diff --git a/spec/features/markdown_spec.rb b/spec/features/markdown_spec.rb
index e836d81c40b..12fd8d37210 100644
--- a/spec/features/markdown_spec.rb
+++ b/spec/features/markdown_spec.rb
@@ -175,13 +175,15 @@ describe 'GitLab Markdown', feature: true do
     end
   end
 
-  context 'default pipeline' do
-    before(:all) do
-      @feat = MarkdownFeature.new
+  before(:all) do
+    @feat = MarkdownFeature.new
 
-      # `markdown` helper expects a `@project` variable
-      @project = @feat.project
+    # `markdown` helper expects a `@project` variable
+    @project = @feat.project
+  end
 
+  context 'default pipeline' do
+    before(:all) do
       @html = markdown(@feat.raw_markdown)
     end
 
@@ -221,6 +223,57 @@ describe 'GitLab Markdown', feature: true do
     end
   end
 
+  context 'wiki pipeline' do
+    before do
+      @project_wiki = @feat.project_wiki
+
+      file = Gollum::File.new(@project_wiki.wiki)
+      expect(file).to receive(:path).and_return('images/example.jpg')
+      expect(@project_wiki).to receive(:find_file).with('images/example.jpg').and_return(file)
+
+      @html = markdown(@feat.raw_markdown, { pipeline: :wiki, project_wiki: @project_wiki })
+    end
+
+    it_behaves_like 'all pipelines'
+
+    it 'includes RelativeLinkFilter' do
+      expect(doc).not_to parse_relative_links
+    end
+
+    it 'includes EmojiFilter' do
+      expect(doc).to parse_emoji
+    end
+
+    it 'includes TableOfContentsFilter' do
+      expect(doc).to create_header_links
+    end
+
+    it 'includes AutolinkFilter' do
+      expect(doc).to create_autolinks
+    end
+
+    it 'includes all reference filters' do
+      aggregate_failures do
+        expect(doc).to reference_users
+        expect(doc).to reference_issues
+        expect(doc).to reference_merge_requests
+        expect(doc).to reference_snippets
+        expect(doc).to reference_commit_ranges
+        expect(doc).to reference_commits
+        expect(doc).to reference_labels
+        expect(doc).to reference_milestones
+      end
+    end
+
+    it 'includes TaskListFilter' do
+      expect(doc).to parse_task_lists
+    end
+
+    it 'includes GollumTagsFilter' do
+      expect(doc).to parse_gollum_tags
+    end
+  end
+
   # Fake a `current_user` helper
   def current_user
     @feat.user
diff --git a/spec/fixtures/markdown.md.erb b/spec/fixtures/markdown.md.erb
index 0620096d689..fe6d42acee2 100644
--- a/spec/fixtures/markdown.md.erb
+++ b/spec/fixtures/markdown.md.erb
@@ -230,3 +230,12 @@ References should be parseable even inside _<%= merge_request.to_reference %>_ e
   - [ ] Incomplete sub-task 2
   - [x] Complete sub-task 1
 - [X] Complete task 2
+
+#### Gollum Tags
+
+- [[linked-resource]]
+- [[link-text|linked-resource]]
+- [[http://example.com]]
+- [[link-text|http://example.com/pdfs/gollum.pdf]]
+- [[images/example.jpg]]
+- [[http://example.com/images/example.jpg]]
diff --git a/spec/helpers/gitlab_markdown_helper_spec.rb b/spec/helpers/gitlab_markdown_helper_spec.rb
index 762ec25c4f5..9a05b21335c 100644
--- a/spec/helpers/gitlab_markdown_helper_spec.rb
+++ b/spec/helpers/gitlab_markdown_helper_spec.rb
@@ -121,12 +121,13 @@ describe GitlabMarkdownHelper do
     before do
       @wiki = double('WikiPage')
       allow(@wiki).to receive(:content).and_return('wiki content')
+      helper.instance_variable_set(:@project_wiki, @wiki)
     end
 
-    it "should use GitLab Flavored Markdown for markdown files" do
+    it "should use Wiki pipeline for markdown files" do
       allow(@wiki).to receive(:format).and_return(:markdown)
 
-      expect(helper).to receive(:markdown).with('wiki content')
+      expect(helper).to receive(:markdown).with('wiki content', pipeline: :wiki, project_wiki: @wiki)
 
       helper.render_wiki_content(@wiki)
     end
diff --git a/spec/lib/banzai/filter/gollum_tags_filter_spec.rb b/spec/lib/banzai/filter/gollum_tags_filter_spec.rb
new file mode 100644
index 00000000000..38baa819957
--- /dev/null
+++ b/spec/lib/banzai/filter/gollum_tags_filter_spec.rb
@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Banzai::Filter::GollumTagsFilter, lib: true do
+  include FilterSpecHelper
+
+  let(:project) { create(:project) }
+  let(:user) { double }
+  let(:project_wiki) { ProjectWiki.new(project, user) }
+
+  describe 'validation' do
+    it 'ensure that a :project_wiki key exists in context' do
+      expect { filter("See [[images/image.jpg]]", {}) }.to raise_error ArgumentError, "Missing context keys for Banzai::Filter::GollumTagsFilter: :project_wiki"
+    end
+  end
+
+  context 'linking internal images' do
+    it 'creates img tag if image exists' do
+      file = Gollum::File.new(project_wiki.wiki)
+      expect(file).to receive(:path).and_return('images/image.jpg')
+      expect(project_wiki).to receive(:find_file).with('images/image.jpg').and_return(file)
+
+      tag = '[[images/image.jpg]]'
+      doc = filter("See #{tag}", project_wiki: project_wiki)
+
+      expect(doc.at_css('img')['src']).to eq "#{project_wiki.wiki_base_path}/images/image.jpg"
+    end
+
+    it 'does not creates img tag if image does not exist' do
+      expect(project_wiki).to receive(:find_file).with('images/image.jpg').and_return(nil)
+
+      tag = '[[images/image.jpg]]'
+      doc = filter("See #{tag}", project_wiki: project_wiki)
+
+      expect(doc.css('img').size).to eq 0
+    end
+  end
+
+  context 'linking external images' do
+    it 'creates img tag for valid URL' do
+      tag = '[[http://example.com/image.jpg]]'
+      doc = filter("See #{tag}", project_wiki: project_wiki)
+
+      expect(doc.at_css('img')['src']).to eq "http://example.com/image.jpg"
+    end
+
+    it 'does not creates img tag for invalid URL' do
+      tag = '[[http://example.com/image.pdf]]'
+      doc = filter("See #{tag}", project_wiki: project_wiki)
+
+      expect(doc.css('img').size).to eq 0
+    end
+  end
+
+  context 'linking external resources' do
+    it "the created link's text will be equal to the resource's text" do
+      tag = '[[http://example.com]]'
+      doc = filter("See #{tag}", project_wiki: project_wiki)
+
+      expect(doc.at_css('a').text).to eq 'http://example.com'
+      expect(doc.at_css('a')['href']).to eq 'http://example.com'
+    end
+
+    it "the created link's text will be link-text" do
+      tag = '[[link-text|http://example.com/pdfs/gollum.pdf]]'
+      doc = filter("See #{tag}", project_wiki: project_wiki)
+
+      expect(doc.at_css('a').text).to eq 'link-text'
+      expect(doc.at_css('a')['href']).to eq 'http://example.com/pdfs/gollum.pdf'
+    end
+  end
+
+  context 'linking internal resources' do
+    it "the created link's text will be equal to the resource's text" do
+      tag = '[[wiki-slug]]'
+      doc = filter("See #{tag}", project_wiki: project_wiki)
+
+      expect(doc.at_css('a').text).to eq 'wiki-slug'
+      expect(doc.at_css('a')['href']).to eq 'wiki-slug'
+    end
+
+    it "the created link's text will be link-text" do
+      tag = '[[link-text|wiki-slug]]'
+      doc = filter("See #{tag}", project_wiki: project_wiki)
+
+      expect(doc.at_css('a').text).to eq 'link-text'
+      expect(doc.at_css('a')['href']).to eq 'wiki-slug'
+    end
+  end
+end
diff --git a/spec/lib/gitlab/github_import/wiki_formatter_spec.rb b/spec/lib/gitlab/github_import/wiki_formatter_spec.rb
new file mode 100644
index 00000000000..aed2aa39e3a
--- /dev/null
+++ b/spec/lib/gitlab/github_import/wiki_formatter_spec.rb
@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Gitlab::GithubImport::WikiFormatter, lib: true do
+  let(:project) do
+    create(:project, namespace: create(:namespace, path: 'gitlabhq'),
+                     import_url: 'https://xxx@github.com/gitlabhq/sample.gitlabhq.git')
+  end
+
+  subject(:wiki) { described_class.new(project)}
+
+  describe '#path_with_namespace' do
+    it 'appends .wiki to project path' do
+      expect(wiki.path_with_namespace).to eq 'gitlabhq/gitlabhq.wiki'
+    end
+  end
+
+  describe '#import_url' do
+    it 'returns URL of the wiki repository' do
+      expect(wiki.import_url).to eq 'https://xxx@github.com/gitlabhq/sample.gitlabhq.wiki.git'
+    end
+  end
+end
diff --git a/spec/models/project_wiki_spec.rb b/spec/models/project_wiki_spec.rb
index 876b927eaea..a2085df5bcd 100644
--- a/spec/models/project_wiki_spec.rb
+++ b/spec/models/project_wiki_spec.rb
@@ -36,6 +36,13 @@ describe ProjectWiki, models: true do
     end
   end
 
+  describe "#wiki_base_path" do
+    it "returns the wiki base path" do
+      wiki_base_path = "/#{project.path_with_namespace}/wikis"
+      expect(subject.wiki_base_path).to eq(wiki_base_path)
+    end
+  end
+
   describe "#wiki" do
     it "contains a Gollum::Wiki instance" do
       expect(subject.wiki).to be_a Gollum::Wiki
diff --git a/spec/support/markdown_feature.rb b/spec/support/markdown_feature.rb
index 5d97fdd4882..73c6792b65f 100644
--- a/spec/support/markdown_feature.rb
+++ b/spec/support/markdown_feature.rb
@@ -28,6 +28,10 @@ class MarkdownFeature
     end
   end
 
+  def project_wiki
+    @project_wiki ||= ProjectWiki.new(project, user)
+  end
+
   def issue
     @issue ||= create(:issue, project: project)
   end
diff --git a/spec/support/matchers/markdown_matchers.rb b/spec/support/matchers/markdown_matchers.rb
index b251e7f8f23..1d52489e804 100644
--- a/spec/support/matchers/markdown_matchers.rb
+++ b/spec/support/matchers/markdown_matchers.rb
@@ -66,6 +66,24 @@ module MarkdownMatchers
     end
   end
 
+  # GollumTagsFilter
+  matcher :parse_gollum_tags do
+    def have_image(src)
+      have_css("img[src$='#{src}']")
+    end
+
+    set_default_markdown_messages
+
+    match do |actual|
+      expect(actual).to have_link('linked-resource', href: 'linked-resource')
+      expect(actual).to have_link('link-text', href: 'linked-resource')
+      expect(actual).to have_link('http://example.com', href: 'http://example.com')
+      expect(actual).to have_link('link-text', href: 'http://example.com/pdfs/gollum.pdf')
+      expect(actual).to have_image('/gitlabhq/wikis/images/example.jpg')
+      expect(actual).to have_image('http://example.com/images/example.jpg')
+    end
+  end
+
   # UserReferenceFilter
   matcher :reference_users do
     set_default_markdown_messages