BigW Consortium Gitlab

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

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

19 20 21 22 23 24
  describe '#web_url' do
    it 'returns the full web URL to the wiki' do
      expect(subject.web_url).to eq("#{Gitlab.config.gitlab.url}/#{project.path_with_namespace}/wikis/home")
    end
  end

25 26
  describe "#url_to_repo" do
    it "returns the correct ssh url to the repo" do
27
      expect(subject.url_to_repo).to eq(gitlab_shell.url_to_repo(subject.path_with_namespace))
28 29 30 31 32
    end
  end

  describe "#ssh_url_to_repo" do
    it "equals #url_to_repo" do
33
      expect(subject.ssh_url_to_repo).to eq(subject.url_to_repo)
34 35 36 37 38 39 40
    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"
41
      expect(subject.http_url_to_repo).to eq(repo_http_url)
42 43 44
    end
  end

45 46
  describe "#wiki_base_path" do
    it "returns the wiki base path" do
47 48
      wiki_base_path = "#{Gitlab.config.gitlab.relative_url_root}/#{project.path_with_namespace}/wikis"

49 50 51 52
      expect(subject.wiki_base_path).to eq(wiki_base_path)
    end
  end

53 54
  describe "#wiki" do
    it "contains a Gollum::Wiki instance" do
55
      expect(subject.wiki).to be_a Gollum::Wiki
56 57 58
    end

    it "creates a new wiki repo if one does not yet exist" do
59
      expect(project_wiki.create_page("index", "test content")).to be_truthy
60 61 62
    end

    it "raises CouldNotCreateWikiError if it can't create the wiki repository" do
63
      allow(project_wiki).to receive(:init_repo).and_return(false)
Dmitriy Zaporozhets committed
64
      expect { project_wiki.send(:create_repo!) }.to raise_exception(ProjectWiki::CouldNotCreateWikiError)
65 66 67
    end
  end

68 69 70
  describe "#empty?" do
    context "when the wiki repository is empty" do
      before do
71
        allow_any_instance_of(Gitlab::Shell).to receive(:add_repository) do
72 73
          create_temp_repo("#{Rails.root}/tmp/test-git-base-path/non-existant.wiki.git")
        end
74
        allow(project).to receive(:path_with_namespace).and_return("non-existant")
75 76
      end

77 78 79 80
      describe '#empty?' do
        subject { super().empty? }
        it { is_expected.to be_truthy }
      end
81 82 83 84
    end

    context "when the wiki has pages" do
      before do
85
        project_wiki.create_page("index", "This is an awesome new Gollum Wiki")
86 87
      end

88 89 90 91
      describe '#empty?' do
        subject { super().empty? }
        it { is_expected.to be_falsey }
      end
92 93 94
    end
  end

95 96 97 98 99 100 101 102 103 104 105
  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
106
      expect(@pages.first).to be_a WikiPage
107 108 109
    end

    it "returns the correct number of pages" do
110
      expect(@pages.count).to eq(1)
111 112 113 114 115 116 117 118 119 120 121 122 123 124
    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")
125
      expect(page.title).to eq("index page")
126 127 128
    end

    it "returns nil if the page does not exist" do
129
      expect(subject.find_page("non-existant")).to eq(nil)
130 131 132 133
    end

    it "can find a page by slug" do
      page = subject.find_page("index-page")
134
      expect(page.title).to eq("index page")
135 136 137 138
    end

    it "returns a WikiPage instance" do
      page = subject.find_page("index page")
139
      expect(page).to be_a WikiPage
140 141 142
    end
  end

143 144 145
  describe '#find_file' do
    before do
      file = Gollum::File.new(subject.wiki)
146 147
      allow_any_instance_of(Gollum::Wiki).
                   to receive(:file).with('image.jpg', 'master', true).
148
                   and_return(file)
149 150
      allow_any_instance_of(Gollum::File).
                   to receive(:mime_type).
151
                   and_return('image/jpeg')
152 153
      allow_any_instance_of(Gollum::Wiki).
                   to receive(:file).with('non-existant', 'master', true).
154 155 156 157
                   and_return(nil)
    end

    after do
158 159
      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
160 161 162 163
    end

    it 'returns the latest version of the file if it exists' do
      file = subject.find_file('image.jpg')
164
      expect(file.mime_type).to eq('image/jpeg')
165 166 167
    end

    it 'returns nil if the page does not exist' do
168
      expect(subject.find_file('non-existant')).to eq(nil)
169 170 171 172
    end

    it 'returns a Gollum::File instance' do
      file = subject.find_file('image.jpg')
173
      expect(file).to be_a Gollum::File
174 175 176
    end
  end

177 178 179 180 181 182
  describe "#create_page" do
    after do
      destroy_page(subject.pages.first.page)
    end

    it "creates a new wiki page" do
183 184
      expect(subject.create_page("test page", "this is content")).not_to eq(false)
      expect(subject.pages.count).to eq(1)
185 186 187 188
    end

    it "returns false when a duplicate page exists" do
      subject.create_page("test page", "content")
189
      expect(subject.create_page("test page", "content")).to eq(false)
190 191 192 193
    end

    it "stores an error message when a duplicate page exists" do
      2.times { subject.create_page("test page", "content") }
194
      expect(subject.error_message).to match(/Duplicate page:/)
195 196 197 198
    end

    it "sets the correct commit message" do
      subject.create_page("test page", "some content", :markdown, "commit message")
199
      expect(subject.pages.first.page.version.message).to eq("commit message")
200
    end
201 202 203 204 205 206

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

      subject.create_page('Test Page', 'This is content')
    end
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
  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
222
      expect(@page.raw_data).to eq("some other content")
223 224 225
    end

    it "sets the correct commit message" do
226
      expect(@page.version.message).to eq("updated page")
227
    end
228 229 230 231 232 233

    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
234 235 236 237 238 239 240 241 242 243
  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)
244
      expect(subject.pages.count).to eq(0)
245
    end
246 247 248 249 250 251

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

      subject.delete_page(@page)
    end
252 253
  end

254 255 256 257 258 259 260 261 262 263 264 265
  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

266 267 268 269 270 271 272
  describe '#hook_attrs' do
    it 'returns a hash with values' do
      expect(subject.hook_attrs).to be_a Hash
      expect(subject.hook_attrs.keys).to contain_exactly(:web_url, :git_ssh_url, :git_http_url, :path_with_namespace, :default_branch)
    end
  end

273 274 275 276
  private

  def create_temp_repo(path)
    FileUtils.mkdir_p path
277
    system(*%W(#{Gitlab.config.git.bin_path} init --quiet --bare -- #{path}))
278 279 280 281 282 283 284
  end

  def remove_temp_repo(path)
    FileUtils.rm_rf path
  end

  def commit_details
285
    { name: user.name, email: user.email, message: "test commit" }
286 287 288 289 290 291 292 293 294
  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
295
end