project_wiki_spec.rb 7.79 KB
Newer Older
1 2
require "spec_helper"

Douwe Maan's avatar
Douwe Maan committed
3
describe ProjectWiki, models: true do
4
  let(:project) { create(:empty_project) }
5 6 7
  let(:repository) { project.repository }
  let(:user) { project.owner }
  let(:gitlab_shell) { Gitlab::Shell.new }
8
  let(:project_wiki) { ProjectWiki.new(project, user) }
9

10 11
  subject { project_wiki }
  before { project_wiki.wiki }
12 13 14

  describe "#path_with_namespace" do
    it "returns the project path with namespace with the .wiki extension" do
15
      expect(subject.path_with_namespace).to eq(project.path_with_namespace + ".wiki")
16 17 18 19 20
    end
  end

  describe "#url_to_repo" do
    it "returns the correct ssh url to the repo" do
21
      expect(subject.url_to_repo).to eq(gitlab_shell.url_to_repo(subject.path_with_namespace))
22 23 24 25 26
    end
  end

  describe "#ssh_url_to_repo" do
    it "equals #url_to_repo" do
27
      expect(subject.ssh_url_to_repo).to eq(subject.url_to_repo)
28 29 30 31 32 33 34
    end
  end

  describe "#http_url_to_repo" do
    it "provides the full http url to the repo" do
      gitlab_url = Gitlab.config.gitlab.url
      repo_http_url = "#{gitlab_url}/#{subject.path_with_namespace}.git"
35
      expect(subject.http_url_to_repo).to eq(repo_http_url)
36 37 38
    end
  end

39 40 41 42 43 44 45
  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

46 47
  describe "#wiki" do
    it "contains a Gollum::Wiki instance" do
48
      expect(subject.wiki).to be_a Gollum::Wiki
49 50 51
    end

    it "creates a new wiki repo if one does not yet exist" do
52
      expect(project_wiki.create_page("index", "test content")).to be_truthy
53 54 55
    end

    it "raises CouldNotCreateWikiError if it can't create the wiki repository" do
56
      allow(project_wiki).to receive(:init_repo).and_return(false)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
57
      expect { project_wiki.send(:create_repo!) }.to raise_exception(ProjectWiki::CouldNotCreateWikiError)
58 59 60
    end
  end

Jacob Vosmaer's avatar
Jacob Vosmaer committed
61 62 63
  describe "#empty?" do
    context "when the wiki repository is empty" do
      before do
64
        allow_any_instance_of(Gitlab::Shell).to receive(:add_repository) do
Jacob Vosmaer's avatar
Jacob Vosmaer committed
65 66
          create_temp_repo("#{Rails.root}/tmp/test-git-base-path/non-existant.wiki.git")
        end
67
        allow(project).to receive(:path_with_namespace).and_return("non-existant")
Jacob Vosmaer's avatar
Jacob Vosmaer committed
68 69
      end

70 71 72 73
      describe '#empty?' do
        subject { super().empty? }
        it { is_expected.to be_truthy }
      end
Jacob Vosmaer's avatar
Jacob Vosmaer committed
74 75 76 77
    end

    context "when the wiki has pages" do
      before do
78
        project_wiki.create_page("index", "This is an awesome new Gollum Wiki")
Jacob Vosmaer's avatar
Jacob Vosmaer committed
79 80
      end

81 82 83 84
      describe '#empty?' do
        subject { super().empty? }
        it { is_expected.to be_falsey }
      end
Jacob Vosmaer's avatar
Jacob Vosmaer committed
85 86 87
    end
  end

88 89 90 91 92 93 94 95 96 97 98
  describe "#pages" do
    before do
      create_page("index", "This is an awesome new Gollum Wiki")
      @pages = subject.pages
    end

    after do
      destroy_page(@pages.first.page)
    end

    it "returns an array of WikiPage instances" do
99
      expect(@pages.first).to be_a WikiPage
100 101 102
    end

    it "returns the correct number of pages" do
103
      expect(@pages.count).to eq(1)
104 105 106 107 108 109 110 111 112 113 114 115 116 117
    end
  end

  describe "#find_page" do
    before do
      create_page("index page", "This is an awesome Gollum Wiki")
    end

    after do
      destroy_page(subject.pages.first.page)
    end

    it "returns the latest version of the page if it exists" do
      page = subject.find_page("index page")
118
      expect(page.title).to eq("index page")
119 120 121
    end

    it "returns nil if the page does not exist" do
122
      expect(subject.find_page("non-existant")).to eq(nil)
123 124 125 126
    end

    it "can find a page by slug" do
      page = subject.find_page("index-page")
127
      expect(page.title).to eq("index page")
128 129 130 131
    end

    it "returns a WikiPage instance" do
      page = subject.find_page("index page")
132
      expect(page).to be_a WikiPage
133 134 135
    end
  end

136 137 138
  describe '#find_file' do
    before do
      file = Gollum::File.new(subject.wiki)
139 140
      allow_any_instance_of(Gollum::Wiki).
                   to receive(:file).with('image.jpg', 'master', true).
141
                   and_return(file)
142 143
      allow_any_instance_of(Gollum::File).
                   to receive(:mime_type).
144
                   and_return('image/jpeg')
145 146
      allow_any_instance_of(Gollum::Wiki).
                   to receive(:file).with('non-existant', 'master', true).
147 148 149 150
                   and_return(nil)
    end

    after do
151 152
      allow_any_instance_of(Gollum::Wiki).to receive(:file).and_call_original
      allow_any_instance_of(Gollum::File).to receive(:mime_type).and_call_original
153 154 155 156
    end

    it 'returns the latest version of the file if it exists' do
      file = subject.find_file('image.jpg')
157
      expect(file.mime_type).to eq('image/jpeg')
158 159 160
    end

    it 'returns nil if the page does not exist' do
161
      expect(subject.find_file('non-existant')).to eq(nil)
162 163 164 165
    end

    it 'returns a Gollum::File instance' do
      file = subject.find_file('image.jpg')
166
      expect(file).to be_a Gollum::File
167 168 169
    end
  end

170 171 172 173 174 175
  describe "#create_page" do
    after do
      destroy_page(subject.pages.first.page)
    end

    it "creates a new wiki page" do
176 177
      expect(subject.create_page("test page", "this is content")).not_to eq(false)
      expect(subject.pages.count).to eq(1)
178 179 180 181
    end

    it "returns false when a duplicate page exists" do
      subject.create_page("test page", "content")
182
      expect(subject.create_page("test page", "content")).to eq(false)
183 184 185 186
    end

    it "stores an error message when a duplicate page exists" do
      2.times { subject.create_page("test page", "content") }
187
      expect(subject.error_message).to match(/Duplicate page:/)
188 189 190 191
    end

    it "sets the correct commit message" do
      subject.create_page("test page", "some content", :markdown, "commit message")
192
      expect(subject.pages.first.page.version.message).to eq("commit message")
193
    end
194 195 196 197 198 199

    it 'updates project activity' do
      expect(subject).to receive(:update_project_activity)

      subject.create_page('Test Page', 'This is content')
    end
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
  end

  describe "#update_page" do
    before do
      create_page("update-page", "some content")
      @gollum_page = subject.wiki.paged("update-page")
      subject.update_page(@gollum_page, "some other content", :markdown, "updated page")
      @page = subject.pages.first.page
    end

    after do
      destroy_page(@page)
    end

    it "updates the content of the page" do
215
      expect(@page.raw_data).to eq("some other content")
216 217 218
    end

    it "sets the correct commit message" do
219
      expect(@page.version.message).to eq("updated page")
220
    end
221 222 223 224 225 226

    it 'updates project activity' do
      expect(subject).to receive(:update_project_activity)

      subject.update_page(@gollum_page, 'Yet more content', :markdown, 'Updated page again')
    end
227 228 229 230 231 232 233 234 235 236
  end

  describe "#delete_page" do
    before do
      create_page("index", "some content")
      @page = subject.wiki.paged("index")
    end

    it "deletes the page" do
      subject.delete_page(@page)
237
      expect(subject.pages.count).to eq(0)
238
    end
239 240 241 242 243 244

    it 'updates project activity' do
      expect(subject).to receive(:update_project_activity)

      subject.delete_page(@page)
    end
245 246
  end

247 248 249 250 251 252 253 254 255 256 257 258
  describe '#create_repo!' do
    it 'creates a repository' do
      expect(subject).to receive(:init_repo).
        with(subject.path_with_namespace).
        and_return(true)

      expect(subject.repository).to receive(:after_create)

      expect(subject.create_repo!).to be_an_instance_of(Gollum::Wiki)
    end
  end

259 260 261 262
  private

  def create_temp_repo(path)
    FileUtils.mkdir_p path
263
    system(*%W(#{Gitlab.config.git.bin_path} init --quiet --bare -- #{path}))
264 265 266 267 268 269 270
  end

  def remove_temp_repo(path)
    FileUtils.rm_rf path
  end

  def commit_details
271
    { name: user.name, email: user.email, message: "test commit" }
272 273 274 275 276 277 278 279 280
  end

  def create_page(name, content)
    subject.wiki.write_page(name, :markdown, content, commit_details)
  end

  def destroy_page(page)
    subject.wiki.delete_page(page, commit_details)
  end
281
end